Transactional Message — SMS¶
The SMS payload sent when the transactional message is sent.
Note
The SMS sender ID is configured at the platform level and cannot be set per message. Contact your account manager to change the registered sender ID.
Endpoint¶
All verbs: /transactional/<transactional>/message/<transactionalmessage>/sms
GET¶
Payload: No payload.
Returns: The SMS.
Example:
curl -u "username:api_key" -H "Accept: application/json" \
https://app.duo.pt/transactional/{transactional_id}/message/{message_id}/sms
Response:
{
"success": true,
"data": {
"transactionalMessage": {
"id": 1,
"name": "Order Confirmation",
"send_transactional": 1,
"event_callback": null
},
"sms": {
"message": "TX SMS text",
"send_transactional": null,
"send_transactional_message": 95
}
}
}
POST¶
| Parameter | Type | Description |
|---|---|---|
message |
string | The message text |
Returns: The new SMS.
Example:
curl -u "username:api_key" -H "Accept: application/json" \
-d "message=Your+order+#{{order_id}}+has+been+confirmed." \
https://app.duo.pt/transactional/{transactional_id}/message/{message_id}/sms
Response:
{
"success": true,
"data": {
"transactionalMessage": {
"id": 1,
"name": "Order Confirmation",
"send_transactional": 1,
"event_callback": null
},
"sms": {
"message": "TX SMS text",
"send_transactional": null,
"send_transactional_message": 95
}
}
}
PUT¶
Same payload as POST.
Returns: The edited SMS.
Example:
curl -u "username:api_key" -H "Accept: application/json" -X PUT \
-d "message=Updated+SMS+text." \
https://app.duo.pt/transactional/{transactional_id}/message/{message_id}/sms
Response:
{
"success": true,
"data": {
"transactionalMessage": {
"id": 1,
"name": "Order Confirmation",
"send_transactional": 1,
"event_callback": null
},
"sms": {
"message": "TX SMS text",
"send_transactional": null,
"send_transactional_message": 95
}
}
}
DELETE¶
Payload: No payload.
Returns: The deleted SMS.
Example: