SmsSendStateChangedEvent

Notification Object
      ↪ SmsSendStateChangedEvent


Notification when the send state of a sent SMS message is changed.

Subscribing

Subscribe to the smsSendStateChangedEvent notification type.
The event is sent when the SMS provider (CM) returns a status report for a sent SMS indicating that the message could not be delivered, for example because the recipient’s number does not exist. In that case the send state is failed.

How to process

When this event is received, the send state of a previously sent SMS (see NewSmsEvent) has changed. Use the communication reference to find the related SMS and update its displayed state.
If the field silent is set to true, do not show a notification, only refresh the active communication screen(s).
If silent is false and the send state is failed, inform the user that the message was not delivered, using the errorInfo field to explain why.

Fields

Name Type Notes

errorInfo

String

Information about why the SMS could not be delivered (for example: the number does not exist).

communication

Entity

Reference to the Communication object of the SMS.

from

Entity

Reference to the sender of the SMS.

to

Entity

Reference to the recipient of the SMS.

phoneLine

Entity

Reference to the Phone Line used to send the SMS.

sendState

String

The updated send state of the SMS, for example failed when the message could not be delivered.

silent

Boolean

If true, do not show a notification, only refresh the active communication screens.