Docs
Esc

Suggested

QuickstartGet started
Webhooks and signaturesMessaging
Create a messagemessages.create · POST /v1/accounts/{AC}/messages
RATE_LIMITED429 · Rate limit exceeded.
message.deliveredMessage resource
Contents

API reference

Sandbox

API reference descriptions are provided in English to preserve the exact published contract.

realTest.list

GET/v1/accounts/{AC}/real-test

realTest.listSDK operation getV1AccountsByAcRealTest

realTest.events.list

GET/v1/accounts/{AC}/real-test/events

realTest.events.listSDK operation getV1AccountsByAcRealTestEvents

realTest.messages.list

GET/v1/accounts/{AC}/real-test/messages

realTest.messages.listSDK operation getV1AccountsByAcRealTestMessages

Parameters

  • limitinteger (1–100)query

realTest.messages.create

POST/v1/accounts/{AC}/real-test/messages

realTest.messages.createSDK operation postV1AccountsByAcRealTestMessages

Request body

  • acknowledgeRealContacttrueRequired
  • idempotencyKeystring (max 255 chars)Required
  • recipientIdstring (uuid)Required
  • textstring (max 4096 chars)Required

realTest.messages.retrieve

GET/v1/accounts/{AC}/real-test/messages/{attemptId}

realTest.messages.retrieveSDK operation getV1AccountsByAcRealTestMessagesByAttemptid

Parameters

  • attemptIdstring (uuid)Required

realTest.recipients

POST/v1/accounts/{AC}/real-test/recipients

realTest.recipientsSDK operation postV1AccountsByAcRealTestRecipients

Request body

  • acknowledgeRealContacttrueRequired
  • phonestring (max 30 chars)Required
  • idempotencyKeystring (uuid)

realTest.recipients.optOut

POST/v1/accounts/{AC}/real-test/recipients/{recipientId}/opt-out

realTest.recipients.optOutSDK operation postV1AccountsByAcRealTestRecipientsByRecipientidOptOut

Parameters

  • recipientIdstring (uuid)Required

realTest.recipients.rejoin

POST/v1/accounts/{AC}/real-test/recipients/{recipientId}/rejoin

realTest.recipients.rejoinSDK operation postV1AccountsByAcRealTestRecipientsByRecipientidRejoin

Parameters

  • recipientIdstring (uuid)Required

realTest.recipients.remove

POST/v1/accounts/{AC}/real-test/recipients/{recipientId}/remove

realTest.recipients.removeSDK operation postV1AccountsByAcRealTestRecipientsByRecipientidRemove

Parameters

  • recipientIdstring (uuid)Required

realTest.recipients.verify

POST/v1/accounts/{AC}/real-test/recipients/{recipientId}/verify

realTest.recipients.verifySDK operation postV1AccountsByAcRealTestRecipientsByRecipientidVerify

Parameters

  • recipientIdstring (uuid)Required

Request body

  • codestring (max 100 chars)Required

Execute an allow-listed request with an owned sandbox key

POST/v1/accounts/{AC}/sandbox-explorer

sandboxExplorer.createSDK operation postV1AccountsByAcSandboxExplorer

Request body

  • apiKeySidstring (SK… SID)Required
  • methodenumRequired

    GETDELETEPOSTPUTPATCH

  • pathstring (max 1000 chars)Required
  • bodyany
  • executionKeystring (uuid)