Create Orchestration

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.

SecurityoAuthClient

Request

Request Body schema: application/json

name required	string Name for orchestration
description	string [ 1 .. 1023 ] characters
active	boolean Default: true
required	object

Responses

201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal server error

post/orchestrations

Request samples

Payload
curl
JavaScript
Node.js

application/json

{"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"
}
}
}
}

Response samples

application/json

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