Sender IDs

List the sender IDs assigned to your organisation. Use the sender_id value when sending an SMS to control which name appears on the recipient's device.

Endpoint

GET /v1/bulk-sms/sender-ids/

Authentication: Bearer API key

Request

No body or query parameters required.

curl https://api.talkntalk.africa/v1/bulk-sms/sender-ids/ \
  -H "Authorization: Bearer tk_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

Response

200 OK

{
  "count": 2,
  "results": [
    {
      "id": 12,
      "sender_id": "TALKNTALK",
      "type": "promotional",
      "network": "safaricom",
      "status": "active",
      "is_default": true,
      "provider": "textsms"
    },
    {
      "id": 13,
      "sender_id": "TALKNTALK",
      "type": "transactional",
      "network": "airtel",
      "status": "active",
      "is_default": false,
      "provider": "usermobivas"
    }
  ]
}

Field	Type	Description
`count`	integer	Total number of assigned sender IDs
`results[].id`	integer	Assignment ID
`results[].sender_id`	string	The sender name shown on recipient devices
`results[].type`	string	`promotional` or `transactional`
`results[].network`	string	Target network: `safaricom`, `airtel`, `telkom`, `faiba`, or `other`
`results[].status`	string	`active` or `inactive`
`results[].is_default`	boolean	Whether this sender ID is used when none is specified in a send request
`results[].provider`	string	Underlying SMS provider routing this sender ID

The default sender ID (is_default: true) is used automatically when you do not specify a sender_id in your send request. If your organisation has multiple sender IDs for different networks, the API selects the best match for the recipient's network automatically.

Code Examples

curl https://api.talkntalk.africa/v1/bulk-sms/sender-ids/ \
  -H "Authorization: Bearer tk_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

Error Responses

Status	Meaning
`401 Unauthorized`	Missing or invalid API key

{
  "detail": "Invalid or revoked API key."
}

Get Balance Send SMS