Send Message

post

{protocol}://{server}{basePath}/v1/messages

Send end user messages asynchronously to the contact center. Based on the 'channel' and 'headers' fields, Avaya Infinity will determine if the message sent needs to be part of a new or existing conversation session. If a new conversation session is created, the interaction will be routed according to the routing policies configured for the 'headers.destination' in the Admin Console.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

A conversation message

connectorId

string

required

length ≤ 50

The id that represents the connector

channel

string

enum

required

length ≤ 100

The channel of the message. Currently only 'text' and 'messaging' are supported

Allowed:

body

object

required

The body element containing the rich media content

headers

object

required

Header fields for a custom messaging message

attachmentIds

array of strings

length ≤ 5

List of identifiers for the attachments in the message.

attachmentIds

contextParameters

object

Optional key/value context information. This information might be used to make business decisions on how the conversation session is treated. For example, the client application might want to send hints about customer's interest based on the customer's searches or FAQ browsing

contextMessages

array of objects | null

A list of messages that the third-party messaging application might have shown to the customer at the start of the conversation. For example, a greeting/welcome message, a message giving options to customer for starting the conversation, or a reminder to customer to send a message.

contextMessages

providerMetaData

object | null

The metadata from the provider

sender

object

The sender information for the message

correlationId

string

length ≤ 256

The correlation id can be used to uniquely identify the client request.

Headers