Send message

Overview

Use this API to send different types of messages to the Conversation Hub. Conversation Hub delivers messages on a callback URL of registered client applications of recipient. Recipient client applications should discard messages of various types, if it doesn't support them.

Following table tells which client app can send which type of message

Message Type customer egain_agent custom_agent egain_bot custom_bot
text Y Y Y Y Y
typing.start Y Y Y Y Y
typing.end Y Y Y Y Y
escalation.transfer N Y Y Y Y
pagePush N Y Y Y Y
conversation.state N Y Y N N
agent.join N Y Y N N
agent.available N Y Y N N
agent.unavailable N Y Y N N
agent.transfer N Y Y N N
queue.transfer N Y Y N N
richMessage.listpicker N Y Y Y Y
richMessage.quickreply N Y Y Y Y
richMessage.template N Y Y Y Y
richMessage.timepicker N Y Y Y Y
richMessage.richlink N Y Y Y Y
richMessage.form N Y Y Y Y
richMessage.payment N Y Y Y Y
richMessage.app N Y Y Y Y
richMessage.authentication N Y Y Y Y
authentication.success Y N N N N
authentication.failure Y N N N N
customer.info Y Y Y Y Y
customer.active Y N N N N
customer.inactive Y N N N N
error Y Y Y Y Y
delete.soft Y N N N N
delete.permanent Y N N N N
undo Y N N N N
conversation.end Y Y Y Y Y

Scope

Client application must have 'app.conversation.conversationmgr.interaction.manage' assigned to call this API

SecurityoAuthClient
Request
Request Body schema: application/json

Send Message

object
required
object (RequestMessages)
Responses
202

Accepted

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal server error

Callbacks
postFrom Conversation Hub to custom bot.
postFrom Conversation Hub to eGain Agent.
postFrom Conversation Hub to customer.
post/conversations/messages
Request samples
application/json

This example shows how customer client app can start conversation.

{
  • "metadata": {
    },
  • "messages": {
    }
}
Response samples
application/json
{
  • "messages": {
    }
}
Callback payload samples
application/json
{
  • "metadata": {
    }
}