CIM Messages

sender

Required  for inbound and outbound messages

It contains sender information. Helps to identify sender type and role e.g. Agent or Customer. 

Sender object.

• 
  

  • id - String - unique identifier of the sender - Required

  • type - Enum - sender type with options: agent/bot/connector/app/system - Required

  • senderName - String - Required

  • additionalDetail - Map (String, Object) - Optional

channelData

Required for outbound messages

It contains the parameters of the channel type opted by the customer for conversing with the agent.

ChannelData class object

• 
  

  • serviceIdentifier - String - required - channel service identifier

  • channelCustomerIdentifier - String - required - unique ID usually MSISDN

• Additional properties for inbound messages:

  • customerFirstName - String - Optional (first name of the customer.)

  • customerLastName - String - Optional (last name of the customer. If you are only receiving name of customer in a single field from provider then add it in customerFirstName only and leave this field).

  • requestPriority  - String - Optional (channel service identifier)

  • additionalAttributes - Optional - 

  • 
    

    • key - String - channel service identifier

    • type - String - channel service identifier

    • value - String - channel service identifier

channelsessionId

Required for outbound messages

System generated ID to manage the session.

String

-

schedulingMetaData Optional for outbound messages

contains data for scheduled campaigns

Map (string or object)

-

roomId  Optional

inbound messages - send roomId in the header

String

-

conversationId

Required for outbound messages

System generated ID to manage the conversation.

String

-

customer

Required for outbound messages

Optional for inbound messages

contains attributes related to the customer. It can be sent as null or customer information can also be sent by 3rd party.

Customer class object

• id - UUID - system generated ID assigned to customer

• firstName - String - name of the customer

• isAnonymous - bool - if no name is specified, then it is marked true.

• additionalDetail - Map (String, Object) - Optional

Intent

Optional for conversation bot and bot connector only.

Intents are system events to inform the conversational bot to take action on the intent. It is NULL when agent send a message.

Enum

For example,

• START_CHAT

• END_CHAT

• START_VOICE

• END_VOICE

• REPLY_TO - used for quote reply. Set the intent to REPLY_TO, then add the parent message id to the originalMessageId field 

• UPDATE - used to update/edit a message

stamps

List (String)

-

Entities

Optional for conversation bot and bot connector only.

Entities are the data of intent. e.g. channel session object etc. 
Entities are used to inform conversational bot about the event and is null for messages sent by agent.

Map (string or object)

-

providerMessageId

Optional

Channel provider message ID 

String

originalMessageId

Optional

ID of a message within a conversation. See Intent field above for REPLY_TO intent.

String

-

timestamp

Optional

It contains the timestamp at which the message was received.

System datetime class object

-

language

Optional

Used to specify unicode in case of language change. By default, it is English.

LanguageCode class object

-

securityInfo

Optional

MessageSecurity class object

-

200

Code 200 implies that the message has been accepted and delivered successfully. The response body will contain the delivery notification. Example is given as follows:

Response Body:

	{ 
		"type": "DELIVERYNOTIFICATION",
        "markdownText": "Optional",
        "messageId": "abc12345",
        "status":"DELIVERED",
        "reasonCode":200
    }

202

Code 202 means that the message has been accepted. Once, it is delivered, separate delivery notification will be sent. 

400

Code 400 is sent in case of error in message delivery.