Adds a comment to a communication.
Reports >
Adds a comment to a communication.
Method
create.communication_comment
Description
Adds a comment to a communication.
Who has access
Agents and clients
Required components
Data API for configuration
Request weight
1 point
Request parameters
Name
Type
Required
Valid values
Description
access_token
string
yes
Authentication session key
user_id
number
no
Unique user identifier of the agent client on behalf of which the request is made (Is required for the agent) To obtain a list of client users, you must use the method "get.customer_users "
communication_id
number
Unique communication ID.
communication_type
enum
call,offline_message,chat,email
Communication type.
comment
string
Comment on request
Example request
{
"refresh_cache": false,
"jsonrpc": "2.0",
"id": "rMiS6Y5qt1OYo2m9S3S3z",
"method": "create.communication_comment",
"params": {
"communication_id": "number",
"communication_type": "enum",
"comment": "string"
}
}
Example response
{
"jsonrpc": "2.0",
"id": "number",
"result": {
"success": true
}
}
Possible errors
See the "Errors for create methods" section.