Beem Africa (BYOK) — connector documentation
- MCP endpoint:
https://byok-beem-africa.connectorbay.com/mcp - REST API:
POST https://byok-beem-africa.connectorbay.com/v1/tools/{tool_name}, described by the OpenAPI 3.1 spec athttps://byok-beem-africa.connectorbay.com/openapi.json - Transport: Streamable HTTP, stateless, MCP specification 2025-06-18 or later
- Authentication: your own Beem Africa Beem API key, sent in the
X-Upstream-Keyheader and the Beem API secret inX-Upstream-Key-2of every request (never stored, logged or cached) - Health:
https://byok-beem-africa.connectorbay.com/health· Tool schemas:https://byok-beem-africa.connectorbay.com/tools.json - Publisher: Unify Dynamics LLC · connectorbay.com/byok-beem-africa · agent@connectorbay.com
What Beem Africa (BYOK) is for
Beem Africa (BYOK) lets an AI assistant read your own Beem Africa data through the Beem Africa API with a key you supply (Beem API key). Read-only: 6 tools (get_sms_balance, list_sender_names, list_sms_templates, list_address_books, list_whatsapp_templates, get_credit_balance). The BYOK key travels with each request, is used for that one call only and is never stored, logged or cached; it is only ever sent to apisms.beem.africa, api-contact.beem.africa, apichatcore.beem.africa, apitopup.beem.africa. Unofficial connector by Unify Dynamics LLC: not affiliated with, endorsed by or sponsored by Beem Africa. Beem Africa and its logos are trademarks of their owners and are used only to say which service the connector works with.
Ask your assistant things like:
- "How many SMS credits are left on my Beem account?"
- "Which sender names are approved on my Beem account?"
- "Which SMS templates have I saved on Beem?"
- "How many contacts are in each of my Beem address books?"
- "Which WhatsApp templates are approved on my Beem Moja account?"
- "How much airtime or USSD credit do I have left on Beem?"
What it does
get_sms_balance: Show the SMS credit balance of the account.list_sender_names: List the SMS sender names (sender IDs) with status, sample content and creation date.list_sms_templates: List the saved SMS templates with title, text and creation date.list_address_books: List the contact address books with description, creation date and number of contacts. Individual contacts are not returned.list_whatsapp_templates: List the WhatsApp (Moja) message templates with name, category, type, language, approval status, text, header, footer and buttons.get_credit_balance: Show the credit balance and low-balance reminder settings of one Beem product (SMS, OTP, airtime, USSD, Bpay, Moja and more).
BYOK key
You bring your own Beem Africa Beem API key (https://docs.beem.africa/guides/sms/authentication). Your assistant sends it in the X-Upstream-Key header with each request. ConnectorBay uses it for that one call only: it is never stored, logged or cached, never shown in an answer, and it is only sent to apisms.beem.africa, api-contact.beem.africa, apichatcore.beem.africa, apitopup.beem.africa over https, with no redirects followed. Create a key with the fewest permissions the tools need (read-only if the provider offers it), and revoke it at the provider whenever you like.
Data sources
- https://docs.beem.africa/guides/sms/authentication (the API this connector calls, with a BYOK key)
Live from the Beem Africa API (apisms.beem.africa, api-contact.beem.africa, apichatcore.beem.africa, apitopup.beem.africa) with a BYOK key; documentation: https://docs.beem.africa/guides/sms/authentication. Endpoints checked against that documentation on 2026-10-16.
What it is not
Unofficial connector by Unify Dynamics LLC: not affiliated with, endorsed by or sponsored by Beem Africa. Beem Africa and its logos are trademarks of their owners and are used only to say which service the connector works with. It is read-only: it never creates, changes, sends or deletes anything in your Beem Africa account.
Built for: Worldwide. Languages: English.