Mensagem Transacional — SMS¶
O payload SMS enviado quando a mensagem transacional é enviada.
Endpoint¶
Todos os verbos: /transactional/<transactional>/message/<transactionalmessage>/sms
GET¶
Payload: Sem payload.
Devolve: O 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¶
| Parâmetro | Tipo | Descrição |
|---|---|---|
message |
string | O texto da mensagem |
Devolve: O novo 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¶
Mesmo payload que o POST.
Devolve: O SMS editado.
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: Sem payload.
Devolve: O SMS eliminado.
Example: