sms.md

{% method %}

SMS Event

Bandwidth API sends this event to the application when an SMS is sent or received.

Properties

Property	Description
eventType	The event type, value is sms.
direction	Direction of message, * in - a message that came from the telephone network to one of your numbers (an “inbound” message) * out - a message that was sent from one of your numbers to the telephone network (an “outbound” message)
from	The message sender’s telephone number (or short code).
to	Message recipient telephone number (or short code).
messageId	The unique id of the message resource for this event.
messageUri	The full URL of the message resource.
text	The message’s text contents.
applicationId	The application id associated with the phone number receiving the inbound message.
time	The time the message resource was created (UTC, follows the ISO 8601 format).
state	Message state, values are received queued sending sent error
deliveryState	One of the message delivery states waiting delivered not-delivered
deliveryCode	Numeric value of deliver code
deliveryDescription	Message delivery description for the respective delivery code.
segmentCount	The number of segments the message was sent as.

Message States

State	Description
received	The message was received.
queued	The message is waiting in queue and will be sent soon.
sending	The message was removed from queue and is being sent.
sent	The message was sent successfully.
error	There was an error sending or receiving a message (check errors resource for details).

Message Delivery State

State	Description
waiting	Waiting for receipt.
delivered	Receipt indicating that message was delivered.
not-delivered	Receipt indicating that message was not delivered.

Message Delivery Code

Code	Description
0	Message Delivered to Carrier
187	Spam Detected – Statistical
188	Spam Detected -Keyword
189	Spam Detected
482	Loop Detected
600	Destination Carrier Queue Full
610	submit_sm or submit_multi failed
620	Destination App Error
630	NACK
650	Destination Failure
700	Invalid Service Type
720	Invalid Destination Address
740	Invalid Source Address
750	Destination Rejected Message
751	Destination Rejected Message too large
770	Destination Rejected due to spam
775	Rejected due to user opt out
902	Message Expired
999	Unknown Error
{% common %}

Example JSON

{
  "eventType"           : "string",
  "direction"           : "string",
  "from"                : "string",
  "to"                  : "string",
  "messageId"           : "string",
  "messageUri"          : "string",
  "text"                : "string",
  "applicationId"       : "string",
  "time"                : "date",
  "state"               : "string",
  "deliveryState"       : "string",
  "deliveryCode"        : "string",
  "deliveryDescription" : "string",
  "segmentCount"        : "integer"
}

Example: Incoming SMS Event

POST /your_url HTTP/1.1
Content-Type: application/json; charset=utf-8
User-Agent: BandwidthAPI/v1 ({CURRENT_BUILD_TIMESTAMP})

{
 "eventType"     : "sms",
 "direction"     : "in",
 "messageId"     : "{messageId}",
 "messageUri"    : "https://api.catapult.inetwork.com/v1/users/{userId}/messages/{messageId}",
 "from"          : "+13233326955",
 "to"            : "+13865245000",
 "text"          : "Example",
 "applicationId" : "{appId}",
 "time"          : "2012-11-14T16:13:06.076Z",
 "state"         : "received",
 "segmentCount"  : 1
}

Example: Outgoing SMS Event

POST /your_url HTTP/1.1
Content-Type: application/json; charset=utf-8
User-Agent: BandwidthAPI/v1 ({CURRENT_BUILD_TIMESTAMP})

{
   "eventType"    : "sms",
   "direction"    : "out",
   "messageId"    : "{messageId}",
   "messageUri"   : "https://api.catapult.inetwork.com/v1/users/{userId}/messages/{messageId}",
   "from"         : "+13233326955",
   "to"           : "+13865245000",
   "text"         : "Example",
   "time"         : "2012-11-14T16:13:06.076Z",
   "state"        : "sent",
   "segmentCount" : 1
}

Example: Outgoing SMS with Delivery Request Event

POST /your_url HTTP/1.1
Content-Type: application/json; charset=utf-8
User-Agent: BandwidthAPI/v1 ({CURRENT_BUILD_TIMESTAMP})

{
   "eventType"     : "sms",
   "direction"     : "in",
   "messageId"     : "{messageId}",
   "messageUri"    : "https://api.catapult.inetwork.com/v1/users/{userId}/messages/{messageId}",
   "from"          : "+13233326955",
   "to"            : "+13865245000",
   "text"          : "Example",
   "applicationId" : "{appId}",
   "time"          : "2012-11-14T16:13:06.076Z",
   "state"         : "received",
   "segmentCount"  : 1
}

{% endmethod %}