'send_message' Response

When the middleware accepts the 'send_message' request it has to return the 'message_response'.

Note: Responses to 'send_message' must be returned as soon as possible.

This structure contains the following parameter fields:

'send_message' response parameters

Name	Required	Description
message_id	Yes	'message_id' value from the request
status	Yes	new value of the 'status' field. Possible values are: for messages that do not pass validation the status is 'failed' for messages that are correct but do not require actual transfer to the back office system the status is 'sent' for messages that require data transfer to the back office system the status is 'sending' (and the messages are placed on the internal queue of the middleware) for messages successfully delivered to the back office system the status is 'delivered' Note: this is a standard set of statuses to be returned and their sending conditions, but for each project it should be agreed with implementation
description	No	new value of the 'description' field; customer-specific additional value that along with Message Status can influence the flow of a message scenario. For example Message Status 'Failed' can differ subject to its descriptions. Note: set of possible descriptions should be agreed with implementation
data	No	new value of the 'data' field – used only if so required by OFSC solution (e.g. can be used to assign values to activity and inventory properties, cancel activities and set them as 'non-scheduled' as described in more details below)
external_id	No	new value of 'external_id' field – identifier of the message in the internal queue (usually not used)
duration	No	new value of 'duration' field for the message record in OFSC (usually not used)
sent	No	actual time when the message was sent: GMT YYYY-MM-DDTHH24:MI:SS+00:00 format date and time
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 that the fault attempt logic remains in accordance with 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
time_delivered_end	No