Skip to main content

Operator API

Operator API is the REST API that can be used to integrate customer engagement platforms with JAICP.

You can use the Operator API to connect any customer engagement platform to the chatbot project created on JAICP. When the agent application is integrated with the platform, data received by the chatbot during the conversation with the client is sent to the application.

tip
Learn more about Operator API methods

Create a channel​

  1. Sign in to JAICP and go to your project.

  2. Click Channels → Customer engagement platforms → Connect channel in the control panel.

  3. Select Operator API.

  4. Fill out the following fields:

    • Name — specify the channel name.
    • API URL — the URL where Operator API requests will be routed to.

  5. Click Add group to transfer the dialog not to the particular agent, but to the agent group.

    The dialog will be assigned to one of the agents from the group you’ve specified. The agent will be selected according to the dialog assignment logic of the customer engagement platform you are using.

    Fill out the following fields:

    • First name — specify the name for the agent group.
    • Name — add the description for the agent group.
    • Ids — from the drop-down list, choose the identifier of the agent group.
    tip

    You can add several groups this way.

    To delete the agent group, click in the upper right corner of the group you’ve added.

  6. Click Create.

Connect the channel​

  1. Click next to an existing inbound channel.
  2. Select Edit.
  3. Select the customer engagement platform from the list in the Agent field.
  4. Click Save.