'set_message_status' Request 'messages' Array
The 'messages' array is a set of one or more 'message' nodes. Each 'message' node contains:
Field |
Required |
Description |
|---|---|---|
message_id |
Yes |
'message_id' value from the 'send_message' request |
status |
Yes |
new value of the 'status' to be set for the message; possible case-sensitive values are: sending – message still in the internal queue of the Middleware waiting to be delivered (another call of 'set_message_status' will be required later to set the final status of the delivery) delivered – message successfully transferred to the back office system failed – transaction failed sent – message sent but there is no way to confirm that it has reached the final recipient (for example E-mails) Note: these are the default statuses to be returned, though for each specific project they may be agreed at the implementation phase. |
description |
No |
new value of the 'desc' field customer-specific additional value that along with Message Status can influence the flow of a message scenario e.g Message Status 'failed' can differ subject to its descriptions. |
data |
No |
new value of the 'data' field |
external_id |
No |
ID of the message in the external system |
duration |
No |
new value of the 'duration' field |
sent |
No |
new value of the 'sent' field |
fault_attempt |
No |
number of the remaining attempts to resend the message in case the notification has failed this way the external system can change the number of the remaining attempts (e.g.stop or continue resending until success) unless there is a particular need to use the functionality, the field should be omitted, so the fault attempt logic remains in accordance to the corresponding message scenario step Note: resending in this case does not create a new message, the same message (with the same id) is being resent. |
stop_further_attempts |
No |
this field should be set to '1' which means that notification attempts are stopped. No other values should be used |
time_delivered_start |
No |
time delivered interval (promised to the customer) in HH:MM:SS format if 'status' returned is 'delivered' or 'sent', the fields are updated for activity/visit in HH:MM:SS format |
time_delivered_end |
No |