API GuidesVoice API
MCP Server
Configure the Notify Africa Voice MCP server for agent-accessible Voice tools.
The Voice MCP server wraps the same Developer API routes used by direct HTTP integrations.
Package
@notifyafrica/voice-mcp-serverRun it directly:
NOTIFY_API_KEY="ntfy_your_api_key" \
npx -y @notifyafrica/voice-mcp-serverOr install it globally:
npm install -g @notifyafrica/voice-mcp-server
NOTIFY_API_KEY="ntfy_your_api_key" notify-voice-mcp-serverEnvironment
export NOTIFY_API_KEY="ntfy_your_api_key"
export NOTIFY_VOICE_API_BASE_URL="https://api.notify.africa/api/v1"NOTIFY_VOICE_API_BASE_URL defaults to https://api.notify.africa/api/v1. For local service development, point it at the local Voice API base URL.
MCP Client Config
{
"mcpServers": {
"notify-voice": {
"command": "npx",
"args": ["-y", "@notifyafrica/voice-mcp-server"],
"env": {
"NOTIFY_API_KEY": "ntfy_your_api_key",
"NOTIFY_VOICE_API_BASE_URL": "https://api.notify.africa/api/v1"
}
}
}
}Tools
| Tool | API route | Purpose |
|---|---|---|
notify_voice_start_call | POST /voice-api/calls | Start an outbound click-to-call attempt |
notify_voice_list_calls | GET /voice-api/calls | List owned Voice calls |
notify_voice_get_call | GET /voice-api/calls/:callSessionId | Retrieve one owned Voice call |
notify_voice_start_call
| Input | Type | Required | Notes |
|---|---|---|---|
customer_number | string | Yes | E.164 phone number, for example +255700000001 |
response_format | markdown or json | No | Defaults to markdown |
notify_voice_list_calls
| Input | Type | Required | Notes |
|---|---|---|---|
q | string | No | Search session ID, caller number, or destination number |
current_page | number | No | Defaults to 1 |
page_size | number | No | Defaults to 20; max 100 |
sort_by | string | No | Sort field, such as startedAt or createdAt |
sort_order | ASC or DESC | No | Defaults to DESC |
response_format | markdown or json | No | Defaults to markdown |
notify_voice_get_call
| Input | Type | Required | Notes |
|---|---|---|---|
call_session_id | string | Yes | Voice call session row ID or backend call attempt ID; max 128 characters |
response_format | markdown or json | No | Defaults to markdown |
Authentication Boundary
The MCP server reads NOTIFY_API_KEY from its environment. Use a server-side key with the Voice service grant and avoid embedding keys in prompts, source control, browser code, or mobile application code.
