Skip to content

Unhold call

Unholding call

Method unhold.call
API version v4.0
Description Unholding call
Go back to List of methods

Method can only be used after calling "hold.call". Refer to "Diagram of call statuses"

Parameters of a request

Title Type Required Description
access_token string yes Authentication session key
call_session_id number yes Unique ID of a call session, that you can get in a reply message after calling the methods start.vnumber_call, start.scenario_call, start.employee_call, via a notification server or REST API.

Example of a request

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

Example of a reply

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

List of returning errors

Text of error Code of error Mnemonics of error Description
This method can not be called in this state -32004 invalid_state Method can be called only in condition hold (Refer to Diagram of call statuses)

Refer to List of errors common for all methods