Skip to main content
PATCH
Transfer call to external number

Authorizations

Authorization
string
header
default:App
required

This is the most secure authorization type and the one with the most flexibility.

API keys can be generated by calling the dedicated API method. Furthermore, API keys can have a limited scope and cover only some API methods. Lastly, they can be revoked at any time. This range of possibilities makes API keys well suited for separating the API access rights across multiple applications or use cases. Finally, the loss of an API key is easily manageable.

You can manage your API keys from GUI, or programmatically with dedicated API.

API key Authorization header example:

Path Parameters

conversationId
string
required

Conversation ID whose call is being transferred.

Body

application/json
externalNumber
string

Valid phone number in the E.164 format to which a call should be transferred.

Example:

"353861234577"

from
string

Caller identifier. Must be a phone number in the E.164 format

Example:

"353861234582"

Response

OK

Status
enum<string>
Available options:
SUCCESS,
ERROR
message
string