Sign in

v1

latestOpenAPI 3.0.0raw.githubusercontent.com2025-10-15121927.4 KB
Messages

Send a single text or attachment message

Queues an outbound iMessage/SMS to the specified phone number.

Supports optional media attachments via public URLs, and arbitrary metadata for correlation.

For safe retries, provide an Idempotency-Key header. If the same key is used twice, the original message will be returned with 200; otherwise a new message is queued with 202.

post/v1/api/messages

Headers

Idempotency-Keystring

Optional key to ensure idempotent message creation. If the same key is used twice, the original message will be returned.

Request body

tostring required

Recipient phone number in E.164 format (e.g., +15551234567)

textstring

Text body of the message.

attachmentsstring[]

Array of publicly accessible URLs to media attachments.

metadataobject

Arbitrary key/value pairs to associate with the message.

Example request

{
  "to": "+15551234567",
  "text": "Hello world!",
  "attachments": [
    "https://example.com/image.png"
  ]
}

Response

Message already exists (idempotency key match).

message_idstring
statusstring

Example response

{
  "message_id": "Qm8FhbH3P7R",
  "status": "queued"
}