Send a message

POST/v1/messages

Authorization

bearerAuth

AuthorizationBearer <token>

API token issued from the dashboard (Settings → API Tokens). Sent as Authorization: Bearer <token>.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

fromNumber*string

Must be an SMS-capable number owned by your org, in E.164 format.

Match^\+?[1-9]\d{1,14}$

to?string

Destination number in E.164 format. Optional when contactId resolves one.

Match^\+?[1-9]\d{1,14}$

contactId?string

When set, the contact's own DND-SMS/DND-all flags are enforced.

Match

^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Formatuuid

body*string

Length1 <= length <= 1600

mediaUrls?array<>

Itemsitems <= 10

Response Body

`application/json`

cURL

curl -X POST "https://example.com/messages" \  -H "Content-Type: application/json" \  -d '{    "fromNumber": "+15551234567",    "body": "string"  }'

{
  "success": true,
  "message": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "contactId": "b5ec5d98-4bee-4da1-ad24-dde86346cb1d",
    "phoneNumberId": "8e9ce3fb-4d22-4fe3-baa7-b7892dd942d7",
    "fromNumber": "string",
    "toNumber": "string",
    "body": "string",
    "direction": "inbound",
    "status": "string",
    "errorCode": "string",
    "errorMessage": "string",
    "mediaUrls": [
      "string"
    ],
    "numMedia": -9007199254740991,
    "provider": "string",
    "llmModel": "string",
    "readAt": "2019-08-24T14:15:22Z",
    "scheduledAt": "2019-08-24T14:15:22Z",
    "scheduledTimezone": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z"
  }
}

{
  "error": "validation_failed",
  "message": "string",
  "issues": null
}

{
  "error": "validation_failed",
  "message": "string",
  "issues": null
}

{
  "error": "validation_failed",
  "message": "string",
  "issues": null
}

{
  "error": "validation_failed",
  "message": "string",
  "issues": null
}

{
  "error": "validation_failed",
  "message": "string",
  "issues": null
}

Authorization

Request Body

Response Body

201application/json

400application/json

403application/json

404application/json

409application/json

502application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`