Agent Versioning - Branches

Start a test call against a branch

View as Markdown
Start a test call using the branch's current config. Send `includeDraft: true` to test the open draft, or send `revisionId` to test a specific committed revision on the branch. Sending both is a validation error. The response always includes `conversationId` and `callId`. For `webcall` and `chat`, it also includes `token`, `roomName`, and `host`. Those fields are omitted for `telephony`.

Authentication

AuthorizationBearer

API key from the console ApiKey collection, sent as Bearer token. Also accepts session cookies for browser-based auth.

Path parameters

idstringRequiredformat: "^[a-f\d]{24}$"
The agent ID.
branchIdstringRequiredformat: "^[a-f\d]{24}$"
The branch ID.

Request

This endpoint expects an object.
includeDraftbooleanOptionalDefaults to false

When true, the test call uses the branch’s open draft. Mutually exclusive with revisionId.

revisionIdstringOptionalformat: "^[a-f\d]{24}$"

Test against a specific committed revision on the branch. Mutually exclusive with includeDraft: true.

modeenumOptionalDefaults to webcall
toPhonestringOptional

E.164-formatted number. Required when mode is telephony. Omit for webcall and chat.

Response

Test call initiated.
statusboolean
dataobject

Returned by POST /agent/{id}/branches/{branchId}/test-call.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
500
Internal Server Error