Overview
| ENDPOINT | /admin/api/nexbro/v1/call/transfer |
| Methods Supported | POST |
| Description | This endpoint is used to transfer active call to internally or externally. |
Parameters
The following parameter’s required to mute the call.
| Parameter Name | Parameter Requirement | Parameter Data Type | Example | Description |
| call_uuid | required | String | ca3a834a-d4a7-48ab-a7fc-7a20fd577884 | The unique identifier (UUID) of the currently active call that needs to be transferred. |
| transfer_type | required | String | internal/external | Specifies 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_destination | required | String | 8556900900 | The 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 CODE | Summary | Description |
| 404 | HTTP_NOT_FOUND | Returned when the specified call cannot be found or is no longer active. |
| 409 | HTTP_CONFLICT | Returned when the transfer request is valid but cannot be processed due to a conflict with the current call state. |
| 200 | HTTP_OK | Returned when the call transfer request is processed successfully. |
| 500 | INTERNAL_SERVER_ERROR | Returned when an unexpected error occurs on the server while processing the request. |
Example
cURL
Copy to clipboard
curl --location --request POST 'https://your-nexbro-domain.com/admin/api/nexbro/v1/call/transfer' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: sk_live_tTD9RQfK2q2pdsqIEIca53y3gkGll1brp0mWLMeG6vnmrDHYZ1ThOupslBHg' \
--data '{
"call_uuid": "72921ca9-9bc0-4207-b21d-84dd68c45e7b",
"transfer_destination": 8556900900,
"transfer_type" : "external"
}'
Response
Copy to clipboard
{
"message": "Call transferred successfully.",
"data": []
}