Overview
| ENDPOINT | /admin/api/nexbro/v1/call/hold/{call_uuid} |
| Methods Supported | POST |
| Description | This endpoint is used to hold an active call in the Nexbro. By providing the call_uuid |
Parameters
The following parameter’s required to hold the call.
| Parameter Name | Parameter Requirement | Parameter Data Type | Example | Description |
| call_uuid | required | String | ca3a834a-d4a7-48ab-a7fc-7a20fd577884 | The uuid of the active running call. |
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. |
| 422 | HTTP_UNPROCESSABLE_ENTITY | Returned when the hold request is valid but cannot be processed due to the current call state. |
| 200 | HTTP_OK | Returned when the call hold 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/hold/6075d782-1fd2-40a4-bcfe-d29638f2d598' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: sk_live_tTD9RQfK2q2pdsqIEIca53y3gkGll1brp0mWLMeG6vnmrDHYZ1ThOupslBHg'
Response
Copy to clipboard
{
"message": "Call is hold successfully.",
"data": []
}