SMS API

Transactional SMS. Approved Sender ID, E.164, delivery status.

POST/v1/messages

Send one SMS message. country and network are optional; omit them to let the API detect routing from the recipient number when possible.

AuthX-API-Key

Parameters

Name	Type	Description	Required
`to`	string	Recipient in international format.	Yes
`sender`	string	Approved Sender ID.	Yes
`text`	string	SMS content.	Yes
`country`	string	Optional ISO country override, for example TG. Not required for normal sending.	No
`network`	string	Optional target network override. Not required for normal sending.	No

Request samplePOST /v1/messages

{
  "to": "+22890000000",
  "sender": "SEED",
  "text": "Your code is 482913"
}

Response sample200 OK

{
  "status": "submitted",
  "message_id": "msg_123",
  "country": "TG",
  "network": "TOGOCOM",
  "charged_credits": 1
}

GET/v1/messages

List SMS message activity and delivery statuses for the authenticated account.

AuthX-API-Key or portal token

Request sampleGET /v1/messages

No request body.

Response sample200 OK

[
  {
    "id": "msg_123",
    "message_id": "6850740",
    "to": "+22890000000",
    "sender": "SEED",
    "text": "Your code is 482913",
    "status": "delivered",
    "reference": "cmd-1001",
    "country": "TG",
    "network": "TOGOCOM",
    "charged_credits": 1,
    "created_at": "2026-05-14T12:00:00Z",
    "updated_at": "2026-05-14T12:00:05Z"
  }
]

GET/v1/messages/{message_id}

Fetch one SMS message by platform id, provider message id, or reference.

AuthX-API-Key or portal token

Parameters

Name	Type	Description	Required
`message_id`	path	Platform id, provider message id, or reference.	Yes

Request sampleGET /v1/messages/{message_id}

No request body.

Response sample200 OK

{
  "id": "msg_123",
  "message_id": "6850740",
  "to": "+22890000000",
  "sender": "SEED",
  "text": "Your code is 482913",
  "status": "delivered",
  "reference": "cmd-1001",
  "country": "TG",
  "network": "TOGOCOM",
  "charged_credits": 1,
  "created_at": "2026-05-14T12:00:00Z",
  "updated_at": "2026-05-14T12:00:05Z"
}

POST/v1/messages/bulk

Send multiple SMS messages in one request. Each item uses the same optional country and network overrides as /v1/messages.

AuthX-API-Key

Parameters

Name	Type	Description	Required
`messages`	array	List of SMS payloads.	Yes

Request samplePOST /v1/messages/bulk

{
  "messages": [
    {
      "to": "+22890000000",
      "sender": "SEED",
      "text": "Hello"
    }
  ]
}

Response sample200 OK

{
  "status": "submitted",
  "results": [
    {
      "status": "submitted",
      "message_id": "msg_123",
      "country": "TG",
      "network": "TOGOCOM"
    }
  ]
}