Unhold call

Removing a call from hold

Method	unhold.call
API version	v4.0
Description	Removing a call from hold
Return to list of methods

The method is available for use only after calling hold.call - see the "Call state diagram" section.

Request parameters

Name	Type	Required	Description
access_token	string	yes	Authentication session key
call_session_id	number	yes	A unique call session identifier that can be obtained in the response of the start.vnumber_call, start.scenario_call, and start.employee_call methods, using the notification server or the DATA API.

Example request

{
  "jsonrpc": "2.0",
  "method": "unhold.call",
  "id": "req1",
  "params": {
    "access_token": "2fRN4g217ca0b4224a67988aff3e584f91964a692045415f36fa66146f5a3c1ae1f6093d",
    "call_session_id": 2846590
  }
}

Example response

{
  "jsonrpc": "2.0",
  "id": "req1",
  "result": {
    "data": {
      "success": "true"
    }
  }
}

List of returned errors

Error text	Error code	Mnemonics	Description
This method cannot be called in this state	-32004	invalid_state	The method can only be called in the hold state (see the Call state diagram section)

See also the section "List of errors common for all methods".