Agent Versioning - Drafts

Test call with draft config

Deprecated
View as Markdown

Deprecated. Test-calls are exempt from the v1 write-block and remain functional. Migrate to POST /agent/{id}/branches/{branchId}/test-call with includeDraft: true. Will be removed at the sunset date.

Initiate a test call using the draft’s resolved configuration.

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.
draftIdstringRequired
The draft ID

Request

This endpoint expects an object.
modeenumOptionalDefaults to webcall

Test call mode. Defaults to webcall when omitted.

toPhonestringOptional

Phone number to call. Required only when mode is telephony. Omit for webcall and chat.

Response

Test call initiated
statusboolean
dataobject
Test call result details

Errors

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