'message' Element of 'send_message' Request

The 'messages' array is a set of 'message' elements. Each 'message' element contains message fields. The list of fields is configured in the course of implementation:

'message' element parameters

Field

Required

Description

app_host

Yes

three fields that define SOAP API location of the calling application.

The address may be used to submit message results ('set_messages_status')

Note: These fields may be ignored by Middleware as the SOAP API location of OFSC endpoint is known beforehand.

app_port

app_url

message_id

Yes

unique ID of the message in the OFSC system used in all other methods to refer to this message

integer number that cannot be empty

32-bit integer

address

No

message destination

for email – corresponds to the recipient's e-mail address specified for the corresponding message step

for external system – the field is empty

send_to

No

time limit for sending the message

date and time field represented in GMT (YYYY-MM-DD HH24:MI:SS); value sent in the field is defined in the message step configuration of OFSC and defines the latest time by which message has to be sent

agents that deal with a back office system usually should ignore this field, unless it is a part of the solution defined with OFSC

subject

No

filled and preprocessed templates for 'subject' and 'body'

text blocks defined in message step configuration that contain all fields required for the information transfer (activity fields, inventory fields, etc.)

body

No

format and content of the text blocks are defined in the course of implementation, but can be changed via OFSC Manage.