API Guides
Voice API
Start outbound Voice calls, inspect call sessions, and connect agent tools through MCP.
The Voice Developer API starts outbound click-to-call attempts and reads call activity owned by the API-key customer.
Get StartedPrepare Voice access, configure an API key, and start the first call.CallsStart a call, list owned calls, and retrieve one call session.MCP ServerMCPExpose Voice calling tools to MCP-compatible agents.
Integration Flow
Activate Voice for the Notify Africa customer account.
Create an API key with the Voice service grant.
Store the key in a server-side secret manager.
Start an outbound click-to-call attempt.
Store the returned call attempt or session identifier.
List or retrieve call sessions for reporting and follow-up.
Responsibility Boundary
| Notify Africa Portal | Developer API |
|---|---|
| Activate and manage the Voice subscription | Start an outbound click-to-call attempt |
| Create, rotate, and revoke API keys | List calls owned by the API-key customer |
| Manage account-level Voice configuration | Retrieve one call by local session row ID or backend attempt ID |
| Review operational account settings | Connect MCP tools to the same API surface |
Portal operations use an interactive account session. Your application uses a Voice-authorized API key.
Public API Surface
| Method | Path | Purpose |
|---|---|---|
POST | /api/v1/voice-api/calls | Start an outbound Voice click-to-call attempt |
GET | /api/v1/voice-api/calls | List Voice calls owned by the API-key customer |
GET | /api/v1/voice-api/calls/{callSessionId} | Retrieve one owned Voice call |
