Send SMS message
org.intentschema.communication.sms.message.send.v1
JSON: bare · @sha256:cdc5d78fa90d…
Hash: sha256:cdc5d78fa90d273e39afe131ca46346f7451d92161d448aaa7b2361b8c4eef2e
Send an SMS to a phone number. TCPA prior express consent required for marketing; STOP/HELP keywords MUST be honored.
Payload
| Field | Type | Description |
|---|
target * | Target | |
object * | object | |
idempotency_key | string | |
object
| Field | Type | Description |
|---|
to * | string | E.164 phone number. |
from | string | E.164 sender number or alphanumeric sender id. |
text * | string (maxLength 1600) | |
Result
| Field | Type | Description |
|---|
external_id * | string | Provider-assigned id. |
created_at * | string (date-time) | |
sent_at | string (date-time) | |
Examples
basic SMS
{
"target": {
"system": "twilio"
},
"object": {
"to": "+15551234567",
"text": "Your code is 123456"
}
}
Profiles