View Categories

Call Unhold

Overview

ENDPOINT/admin/api/nexbro/v1/call/unhold/{call_uuid}
Methods SupportedPOST
DescriptionThis endpoint is used to unhold an active call in the Nexbro. By providing the call_uuid

Parameters

The following parameter’s required to unhold the call.

Parameter NameParameter RequirementParameter Data TypeExampleDescription
call_uuidrequiredStringca3a834a-d4a7-48ab-a7fc-7a20fd577884The uuid of the active running call.

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.
422HTTP_UNPROCESSABLE_ENTITYReturned when the unhold request is valid but cannot be processed due to the current call state.
200HTTP_OKReturned when the call unhold 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/unhold/ca3a834a-d4a7-48ab-a7fc-7a20fd577884
{
    "message": "Call is unhold successfully.",
    "data": []
}