Skip to content

Tag call

Tagging call

Method tag.call
API version v4.0
Description Tagging an active call
Go back to List of methods

You can only tag an active call. You can tag inactive calls via REST API method - Tagging a request

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.
tag_id number yes Tag unique ID that you can access via REST API method - Receiving a list of tags

Example of a request

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

Example of a reply

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

List of returning errors

Text of error Code of error Mnemonics or error Description
Tag with {tag_id} not found -32602 tag_not_found
Duplicate tag -32602 duplicate_tag

Refer to List of errors common for all methods