sms

Send an outbound SMS (queued; delivered asynchronously)

Changed on
post/v1/sms/send

Request

Request body

from_numberstring required

Sender E.164

tostring required

Recipient E.164

bodystring required
agent_idstring uuid required

Authorized agent for outbound sends.

context_variablesobject nullable

Optional seed values for the agent's typed context variables, applied once at session bootstrap. Each key must be a variable declared on the agent or one of its bound workflows; values are coerced to the variable's type/enum (unknown key or uncoercible value → 422). System vars are frozen on-file; derived seeds satisfy the collection gate.

media_urlsstring[]
idempotency_keystring nullable

Alphanumeric + dash/underscore, 1-120 chars. Used to claim a durable operation so repeat POSTs with the same key are deduped.

Response

Successful Response

operation_idstring uuid required
session_idstring uuid required
end_user_idstring uuid required
idempotency_keystring nullable required

Changes

    • info

      the request property's minLength was decreased from 1 to 0

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status