Chat API: List of available Endpoints

There are two types of Endpoints depending on who provides them: third parties or Codemonkey. In this article, we will explore each of these:

Third-party System Endpoints

Third-party-provided Endpoints are used to notify the claim of an agent and post messages for the third-party system to keep track of the conversation. The clients who want to integrate their systems with Codemonkey to automate conversations will need to create two Webhooks:

  1. A Webhook in which Codemonkey can notify the third-party system that a user is claiming to talk with a human agent. This Webhook needs to accept a POST message with a JSON Body.
  2. A Webhook in which Codemonkey can send the messages from the conversation between the user and the bot. This Webhook is also needed when the human agent takes over the conversation in order to receive the messages from the user.

Codemonkey Endpoints

In this section, we'll discuss the Codemonkey-provided Endpoints for handover, takeover, and keeping track of the conversation. The placeholder {botdep_id} refers to the Bot Deployment ID.

  1. Get chat configuration: styles, persistent menu, etc: It is working right now without access_token.
GET /webbot/api/webchat/{botdep_id}/config/
  1. Conversational endpoint using Websockets: It is working right now without access_token.
    It is the actual conversational endpoint. This endpoint is used when the user is talking with the bot or when the human agent has taken over the conversation. The flow of messages goes through the WebSocket connection.
GET /webbot/api/webchat/{botdep_id}/
  1. Handover Request to tell the bot to be set to listen mode as the external agent takes control of the conversation between the bot and the user.
GET /webbot/api/webchat/{botdep_id}/handover/{user_id}/
  1. Endpoint for the external agent to send messages to the user directly while the bot is in listen mode.
POST /webbot/api/webchat/{botdep_id}/handover/{user_id}/
  1. Endpoint to takeover request to tell the bot to resume the control of the conversation in case it is needed.
GET /webbot/api/webchat/{botdep_id}/takeover/{user_id}/
  1. Endpoint to setup a webhook to notify the Codemonkey Platform that human/external intervention is required
https://app.certainly.io/bot/transfer/human/

     7. Endpoint to allow an external agent to send messages of the desired Module to the user and drive the conversation to that Module.

POST /webbot/api/webchat/trigger-response/

Was this article helpful?

0 out of 0 found this helpful
Have more questions? Submit a request

Comments (0 comments)

Please sign in to leave a comment.