From Bright Pattern Documentation
(Created page with "<translate> = Set Status Callback = This method is used for setting a status callback URL, which is where the SMS/MMS API will POST information about your message. Information...") |
(Updated via BpDeleteTranslateTags script) |
||
| Line 1: | Line 1: | ||
| − | + | ||
= Set Status Callback = | = Set Status Callback = | ||
This method is used for setting a status callback URL, which is where the SMS/MMS API will POST information about your message. Information about your message will be posted to this URL every time the status of your message changes (see section Message Statuses below). | This method is used for setting a status callback URL, which is where the SMS/MMS API will POST information about your message. Information about your message will be posted to this URL every time the status of your message changes (see section Message Statuses below). | ||
| Line 71: | Line 71: | ||
| Failed to send message | | Failed to send message | ||
|} | |} | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
Latest revision as of 04:32, 29 May 2024
Set Status Callback
This method is used for setting a status callback URL, which is where the SMS/MMS API will POST information about your message. Information about your message will be posted to this URL every time the status of your message changes (see section Message Statuses below).
Note: For messages with StatusCallback provided, that value will override the "url" value provided here.
URL
https://<TENANT_URL>/clientweb/smsapi/v1/SetStatusCallback
HTTP Method
POST
Content-Type
application/JSON
Parameters
| Name | Description | Additional Info |
| url | Callback URL | Mandatory |
| number | Service number | Mandatory |
Status Callback Message
{
"account_sid": “<TENANT_ID>”
"api_version": "1",
"body": "Let's grab lunch at Milliways tomorrow!",
"num_segments": "1",
"num_media": "0",
"date_created": "Wed, 18 Aug 2010 20:01:40 +0000",
"date_sent": "Wed, 18 Aug 2010 20:01:41 +0000",
"date_updated": "Wed, 18 Aug 2010 20:01:41 +0000",
"direction": "outbound-api",
"error_code": null,
"error_message": null,
"from": "14158141829",
"sid": "MM90c6fc909d8504d45ecdb3a3d5b3556e",
"status": "delivered",
"to": "15558675310",
"uri": "/clientweb/smsapi/v1/Messages/MM90c6fc909d8504d45ecdb3a3d5b3556e"
}
Message Statuses
The possible values for status (see above, in section "Status Callback Message") are as follows.
| Name | Description |
| queued | Message is in internal queue |
| sent | Message is accepted by SMS/MMS service provider |
| received | Message is received |
| delivered | SMS/MMS Service provider provided confirmation |
| failed | Failed to send message |