API reference · SMS

Send bulk SMS

Send one message to a contact group, a list of numbers or an uploaded CSV, as a campaign.

POST/v1/sms/send-bulk

Bearer API key
Rate limit 10 / min
Returns 201 Created
Needs the SMS permission · 1 credit per person per 160 characters

POST /v1/sms/send-bulk

curl https://api.talks.africa/v1/sms/send-bulk \
  -H "Authorization: Bearer $TALKS_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "campaign_name": "Friday deals",
    "from": "DUKAFRESH",
    "group_id": "grp_loyal",
    "message": "Friday deals are live: 20% off until 8pm"
  }'

{
  "campaign_id": "cmp_41xk",
  "status": "queued",
  "recipient_count": 12480,
  "estimated_credits": 12480
}

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

Body parameters

messagestringrequired
The text to send.
group_idstringoptional
Send to a contact group.
recipientsstring[]optional
Or: a list of numbers.
csv_upload_idstringoptional
Or: numbers from an uploaded CSV.
fromstringoptional
Approved sender ID.
campaign_namestringoptional
Name to find it by later.
scheduled_atstringoptional
ISO 8601 time to send later.

Response fieldsResponse

campaign_id
Campaign ID
recipient_count
Numbers it will reach
estimated_credits
Expected credits
status
Campaign status

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?