Skip to content

Block contact

Block a contact

Method block.contact
API version v4.0
Description Block a contact during call
Go back to list of methods

Parameters of a request

Name 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.informer_call, start.vnumber_call, start.scenario_call, start.employee_call, via a notification server or REST API.

Example of a request

{
  "jsonrpc": "2.0",
  "method": "block.contact",
  "id": "req1",
  "params": {
    "access_token": "2fRN4g217ca0b4224a67988aff3e584f91964a692045415f36fa66146f5a3c1ae1f6093d",
    "call_session_id": 27485639
  }
}

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
The contact with phone number {contact_phone_number} already exists -32602 duplicate_contact

Refer to List or errors common for all methods