Pass conversation control

Pass conversation control

Recipes
Pass Conversation Control to Agent from Bot
Open Recipe

Details

You can pass conversation control from the bot to a Care agent using a PUT call to the/control endpoint. The request takes a control JSON payload as Body.

When processing a message from an external user, the Automation Framework automatically transfers control from BOT to AGENT if the current conversation control is undetermined or the conversation is owned by a BOT, but the currently registered bot is not in LIVE mode. See Bot handoffs and Bot Handoff tags to learn about handoff tags applied to messages upon handoff from Bot to Agent and Agent to Bot.

{  
  "type":"control",
  "owner":{  
    "type":"AGENT"
  },
  "author":{  
    "id":"urn:mbid:....",
    "fullName":"Anonymous Alligator"
  },
  "coordinate":{  
    "companyKey":"[COMPANY KEY]",
    "networkKey":"apple",
    "externalId":"117101b2-e66a-11e7-86ec-b1a405106b73",
    "messageId":"b7bee35c-0cfc-4de9-8a88-9b444d7b0475",
    "botId":"my-abc-bot",
    "scope":"PRIVATE"
  },
  "comment":"<custom text>",
  "conversationDisplayId":"<conversationDisplayId>",
  "lastUpdateTS":"<last-message-update-timestamp>"
}

Control Payload Fields

Field

Description

type

The payload type. Always control.

coordinate

A Coordinate object. This is object contains details about the bot and the message in context. It is used by Khoros Care.

author

An Author object representing the message author on the source channel.

owner

The new owner (controller) of the conversation.

  • type - AGENT or BOT
  • appId - Used only when passing control to a bot. This is the app ID of the bot as specified in the bot registration.

comment

Optional. Custom text that will be displayed in the response UI along with the handoff message.

conversationDisplayId

Optional. Set when control is transferred from a Khoros Care agent back to a bot.

lastUpdateTS

Optional. The timestamp in epoch milliseconds when control is passed.

Related endpoints

ActionEndpoint
GET/bots/v3/control/network/{networkKey}/externalId/{externalId}/author/{authorId}
Return which entity (agent or bot) has current control of the conversation associated with the specified author on the specified network.
Language