sms.delivery.status
event
The sms.delivery.status event is triggered when the delivery status of an SMS is updated.
Form
Parameters
Name | Type | Required | Description |
---|---|---|---|
Connection tags | String Array | No | This trigger can be limited to connections specified by tags. Leave blank to not limit this trigger to connections specified by tag. When multiple tags are specified in the trigger event, the connection must have at least one tag in common for the trigger to execute. |
Delivery status | String | Yes | This trigger can be set to "Always execute" for all status changes, or it can be limited to only execute for status updates of "In transit", "Success", or "Failure". |
Event
variables
Name | Type | Description |
---|---|---|
$(event.conn.iccid) | String | The ICCID associated with the connection. |
$(event.conn.imei) | String | The IMEI associated with the connection. |
$(event.conn.meid) | String | The MEID associated with the connection. |
$(event.conn.msisdn) | String | The MSISDN associated with the connection. |
$(event.conn.imsi) | String | The IMSI associated with the connection. |
$(event.ts) | Timestamp | The timestamp that initiated this trigger. |
$(event.body) | String | The body sent in the SMS. |
$(event.uuid) | String | The universally unique identifier for the SMS. |
$(event.user) | String | An optional field that could contain the user initiating the message. |
$(event.from) | String | The originator of the message. |
$(event.to) | String | The destination of the message. |
$(event.type) | String | This will contain the string "mo" for mobile originated. |
$(event.encoding) | String | The message encoding type. |
$(event.preferredSmsc) | String | The preferred SMSC used to transmit the message. |
$(event.status) | String | The status of the message. |
$(event.deliveredTime) | Timestamp | An optional field that would contain the date and time of delivery if the message was delivered. |
$(event.failedTime) | Timestamp | An optional field that would contain the date and time of the failure to deliver the message. |