Skip to content

Block contact

Add a subscriber to the blacklist

Method block.contact
API version v4.0
Description Blacklist a subscriber during a conversation
Return to list of methods

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.informer_call, 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": "block.contact",
  "id": "req1",
  "params": {
    "access_token": "2fRN4g217ca0b4224a67988aff3e584f91964a692045415f36fa66146f5a3c1ae1f6093d",
    "call_session_id": 27485639
  }
}

Example response

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

List of returned errors

Error text Error code Mnemonics Description
The contact with phone number {contact_phone_number} already exists -32602 duplicate_contact

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