SMS

Send a test SMS

Changed on

Sends a real test text message. Test sends charge credits, bypass quiet hours, are excluded from step stats, and are limited to 100 per company in a rolling 24-hour window. Requires the SMS add-on with a verified number.

post/sms/test

Request

  • Base URL
    https://api.sequenzy.com/api/v1
  • URL
    https://api.sequenzy.com/api/v1/sms/test
  • Auth
    HTTP bearer

Request body

tostring required

Destination phone number in international E.164 format.

textstring

Plain-text message body. Provide text or blocks, not both.

imageUrlsstring[]

Up to 2 publicly reachable image URLs sent as MMS media (US/CA only).

blocksobject[]

SMS content blocks (text + image subset). Provide text or blocks, not both.

fromNumberIdstring

Verified sending number ID from GET /sms/settings. Omit to use the oldest verified company number. An invalid explicit selection returns 400 instead of falling back.

Example request

{
  "to": "+15550100123",
  "text": "Test from Sequenzy"
}

Response

Test SMS queued successfully

successboolean
smsSendIdstring
toPhonestring
messagestring

Example response

{
  "success": true,
  "smsSendId": "sms_abc123",
  "toPhone": "+15550100123",
  "message": "Test SMS queued to +15550100123. Test sends bypass quiet hours, charge credits, and are excluded from step stats."
}

Changes

  • db3873ca3d4dRevision changes
    • 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 optional property to the response with the status

  • f1d8cfd9faafRevision changes
    • info

      added the new optional request property