Set tag communications
Method |
set.tag_communications |
Description |
Setting communications tags |
Who has access |
Partner, Customer |
Parameters of a request
Title |
Type |
Required |
Valid values |
Description |
access_token |
string |
yes |
|
Authentication session key |
user_id |
number |
no |
|
Unique ID of an agent's customer user who makes request Is required for agent To access a list of customer users, use the method "get.customer_users" |
communication_id |
number |
yes |
|
Communication unique ID. With this ID you can get detailed information using the following methods "get.communications_report" , "get.chats_report " , "get.goals_report" , "get.offline_messages_report " , "get.calls_report" |
communication_type |
enum |
yes |
chat , call , goal , offline_message |
Communication type |
tag_id |
number |
yes |
|
Tag unique ID, refer to the method "get.tags" |
JSON request structure
{
"jsonrpc":"2.0",
"id":"number",
"method":"set.tag_communications",
"params":{
"access_token":"string",
"user_id":"number",
"communication_id":"number",
"communication_type":"enum",
"tag_id":"number"
}
}
JSON reply structure
{
"jsonrpc":"2.0",
"id":"number",
"result":{
}
}
List of returning errors
Refer to the section "List of errors for the methods withe verb set"