Deleting chats
Method | delete.chats |
---|---|
Description | Deleting chats |
Who has access | Agent, Customer |
Components required to work with the method | Data API, Uploading offline inquiries from an outside system |
You can only delete chats uploaded from Data API.
They are marked as "chat_channel_type": "dataapi" in the report "Getting information about chats" get.chats_report
Parameters of a request
Title | Type | Required | Description | |
---|---|---|---|---|
access_token |
string | yes | Authentication session key | |
user_id |
number | no | Unique user ID of a customer or an agent who makes a request. Is mandatory for an agentTo get a list of customer users you need to use the method "get.customer_users" |
|
id |
number | yes | Unique chat ID |
JSON request structure
{
"jsonrpc": "2.0",
"id": "number",
"method": "delete.chats",
"params": {
"access_token": "string",
"user_id": "number",
"id": "number"
}
}
JSON reply structure
{
"jsonrpc": "2.0",
"id": "number",
"result": {
"success": "true"
}
}
List of returning errors
Refer to section "List of errors common for methods with the verb delete"