From Bright Pattern Documentation
Set Message Receiver
This method is used to specify the URL for receiving inbound messages, as well as to track the delivery status of the messages you send. See the full list of message statuses below.
Note that in order to receive message status notifications, you have to have a status callback URL set up first.
URL
https://<TENANT_URL>/clientweb/smsapi/v1/SetMsgReceiver
HTTP Method
POST
Content-Type
application/JSON
Parameters
Name | Description | Additional Info |
url | Receiver URL | Mandatory |
number | Service number | Mandatory |
Receiver 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:40 +0000", "date_updated": "Wed, 18 Aug 2010 20:01:40 +0000", "direction": "inbound", "error_code": null, "error_message": null, "from": "14158141829", "sid": "MM90c6fc909d8504d45ecdb3a3d5b3556e", "status": "received", "to": "15558675310", "uri": "/clientweb/smsapi/v1/Messages/MM90c6fc909d8504d45ecdb3a3d5b3556e" }
Message Statuses
The possible values for status (see above, in section "Receiver 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 |