From Bright Pattern Documentation
Jump to: navigation, search
This page contains changes which are not marked for translation.
• 5.2 • 5.3 • 5.8

Get Message

This method is used to get an SMS/MMS message.

URL

https://<TENANT_URL>/clientweb/smsapi/v1/Messages/<MessageSid>

HTTP Method

GET

Response Type

JSON object

Response

{
  "account_sid": “<TENANT_ID>”, 
  "api_version": "1",
  "body": "Let's grab lunch at Milliways tomorrow!",
  "num_segments": "1",
  "num_media": "1",
  “subresource_uris”: {“media”: “https://example.com/nicepic.jpg”}
  "date_created": "Wed, 18 Aug 2010 20:01:40 +0000",
  "date_sent": null,
  "date_updated": "Wed, 18 Aug 2010 20:01:40 +0000",
  "direction": "outbound-api",
  "error_code": null,
  "error_message": null,
  "from": "14158141829",
  "sid": "MM90c6fc909d8504d45ecdb3a3d5b3556e",
  "status": "sent",
  "to": "15558675310",
  "uri": "/clientweb/smsapi/v1/Messages/MM90c6fc909d8504d45ecdb3a3d5b3556e"
}

Notes

The value of num_segments is always "1" (not accurate).

If num_media is more than 1 (maximum 10), subresource_uris would contain fields media0, media1, … up to media9.

For example:

“subresource_uris”: {“media0”: “media_url0”, “media1”:”media_url1”, … “media9”:”media_url9”}

Outbound Message Statuses

For outbound messages, possible values of “status” are the following:

  • queued - Message scheduled to be sent
  • sent - Message sent to SMS/MMS service provider, but not confirmed to be delivered
  • delivered - Message confirmed by SMS service provider to be delivered (currently not available for MMS)
  • failed - Failed to send the message (error_message would be present to provide more details)

Inbound Message Status

For inbound messages, status is received.


< Previous | Next >