View Categories

Call Transfer

Overview

ENDPOINT/admin/api/nexbro/v1/call/transfer
Methods SupportedPOST
DescriptionThis endpoint is used to transfer active call to internally or externally.

Parameters

The following parameter’s required to mute the call.

Parameter NameParameter RequirementParameter Data TypeExampleDescription
call_uuidrequiredStringca3a834a-d4a7-48ab-a7fc-7a20fd577884The unique identifier (UUID) of the currently active call that needs to be transferred.
transfer_typerequiredStringinternal/externalSpecifies the type of transfer. Use internal to transfer the call to another internal extension, or external to transfer the call to an external phone number.
transfer_destinationrequiredString8556900900The destination extension number or external phone number to which the call will be transferred, based on the selected transfer type.

Response Codes

The following response codes are returned by the API.

HTTP CODESummaryDescription
404HTTP_NOT_FOUNDReturned when the specified call cannot be found or is no longer active.
409HTTP_CONFLICTReturned when the transfer request is valid but cannot be processed due to a conflict with the current call state.
200HTTP_OKReturned when the call transfer request is processed successfully.
500INTERNAL_SERVER_ERRORReturned when an unexpected error occurs on the server while processing the request.

Example

POST https://nexbro.com/admin/api/nexbro/v1/call/transfer
{
    "message": "Call transferred successfully.",
    "data": []
}