send-v2

Queue one SMS or MMS under the caller's current send policy

post/v2/send

Request

  • Base URL: https://api.tracklysms.com/api
  • URL: https://api.tracklysms.com/api/v2/send
  • Auth: API key in header X-Api-Key

Request body

bodystring

Required for SMS; optional MMS caption, at most 4096 characters

contact_dataobject

Optional contact data for macro substitution (first_name, last_name, custom_fields, timezone). {{contactId}} and {{listContactId}} are filled by Trackly from the recipient's list subscription.

interstitialMode'none' | 'list_default' | 'custom'

Interstitial page for every tracked link in this message, customUrl links included: none, list_default (the sending list's default page) or custom (requires interstitial). Overrides the referenced SMS offer's own setting; omit to keep it. Requires wrap_links=true and a {{linkN}} placeholder backed by linkOverrides.

list_numberstring required

Sending list phone number (E.164 format)

metadataobject

Optional metadata dict

subjectstring

Optional MMS subject; requires media

tostring required

Recipient phone number (E.164 format)

wrap_linksboolean

Wrap URLs in link shortener

Example request

{
  "interstitialMode": "none"
}

Response

Message queued

message_idstring

Opaque, variable-length message identifier

message_typestring

mms for an MMS request; omitted for SMS

statusstring

Message status

successboolean

Operation success

Changes

No recorded changes to this operation across all 1 revision of this API.