API reference · SMS

Register a sender ID

Ask for a branded sender name in a country. Approval takes a few days.

POST/v1/sms/sender-ids

Bearer API key
Rate limit 120 / min
Returns 201 Created
Needs the SMS permission · free

POST /v1/sms/sender-ids

curl https://api.talks.africa/v1/sms/sender-ids \
  -H "Authorization: Bearer $TALKS_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "DUKAFRESH",
    "country": "KE",
    "use_case": "Order updates and promotions"
  }'

{
  "id": "sid_3kq",
  "name": "DUKAFRESH",
  "country": "KE",
  "status": "pending",
  "estimated_approval_days": "3-5"
}

Use a tk_test_ key while you build. Nothing is sent and no credits are used.

Body parameters

namestringrequired
Up to 11 characters, e.g. DUKAFRESH.
countrystringrequired
Country code, e.g. KE.
use_casestringrequired
What you will send, e.g. order updates.

Response fieldsResponse

id
Sender ID record
status
pending, approved or rejected
estimated_approval_days
Expected wait

Errors

Tap one to see its response above.

All errors use the standard error object. Select one to see its response.

Was this page helpful?