COcommpeak
Messages

Send an SMS

send a single SMS to one recipient

post/messages

Request

  • Base URL
    https://api.commpeak.com/portal
  • URL
    https://api.commpeak.com/portal/messages
  • Auth
    API key in header Authorization

Request body

recipient_phonestring required

Recipient number in E.164 (no leading "+").

senderstring required

Sender ID: an E.164 number (no leading "+") or an alphanumeric sender name.

message_contentstring required

Message text.

internal_idstring nullable

Caller's own reference for this message; echoed back in the response so a delivery receipt can be correlated.

Example request

{
  "internal_id": "123",
  "message_content": "Hello John Doe",
  "recipient_phone": "12125551235",
  "sender": "12125551234"
}

Response

Successful Response

statusboolean required

Whether the upstream accepted the send request.

task_idstring nullable

Upstream batch/task identifier for the accepted send.

Example response

{
  "messages": [
    {
      "internal_id": "123",
      "message_uuid": "01d1e10f-9eb2-4543-a711-3707906010e2"
    }
  ],
  "status": true,
  "task_id": "75da8aa5-7381-4947-919c-a07003f266eb"
}

Changes

No recorded changes to this operation across all 1 revision of this API.