Skip to content
Conversation APIs
/
Conversation Manager
/
/Orchestration

Orchestration

Use this API to configure workflows for conversation between participants (Customer/Agent/Bot applications).

Operations

Create Orchestration

Request

Overview

Use this API to configure workflows for conversations between participants (Customer/Agent/Bot applications). New Account API process flow: Authenticiation > Client Application > Participant > Channel > Orchestration > Account

Scope

Client application must have 'app.conversation.conversationmgr.manage' scope assigned.

Security
oAuthClient(Required scopes:
https://api.egain.cloud/auth/.de...
)
Bodyapplication/json

Register new conversation orchestration

namestringrequired

Name for orchestration

Example:"default_orhchestration"
descriptionstring, [ 1 .. 1023 ] characters
activeboolean
Default:true
applicationsobjectrequired
POST
/orchestrations
curl -i -X POST \
  https://api.egain.cloud/conversation/conversationmgr/v3/orchestrations \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "default_orchestration",
    "description": "Created for Custom channel",
    "active": true,
    "applications": {
      "botConfiguration": {
        "forwardTranscript": true,
        "bots": [
          {
            "id": "a09dddd6-394b-4039-86bc-a5dd89ee5e8d",
            "participant": {
              "id": "a09dddd6-394b-4039-86bc-a5dd89ee5e8d"
            },
            "onEscalation": {
              "agent": {
                "id": "c09dddd6-394b-4039-86bc-a5dd89ee5e8d"
              }
            }
          }
        ]
      },
      "customerConfiguration": {
        "customer": {
          "id": "b09dddd6-394b-4039-86bc-a5dd89ee5e8d"
        }
      }
    }
  }'

Responses

Created

Bodyapplication/json
idstring, = 36 characters

UUID generated for the object.

Response
{
  "id": "45a095f4-d0ee-4220-a689-22b541c58f67"
}