Категории

Создать комментарий

POST https://api.usedesk.ru/create/comment

Внимание. Если вы используете коробочную версию Юздеска на собственном сервере, URL методов у вас будет отличаться. Уточните URL для работы с API у поддержки — support@usedesk.ru.

Метод создаёт комментарий внутри запроса

* — обязательные поля

Параметр Значение
api_token* Токен API канала
ticket_id* id запроса
message*

Сообщение

Если это внутренний комментарий private_comment = true, то можете добавить упоминание сотрудника [~test@gmail.com]

сс Массив копий
bсс Массив скрытых копий
user_id

id юзера от лица которого будут произведены изменения

Если установлен, ответ будет совершен от данного юзера. Иначе будет выбран первый пользователь компании

type Тип комментария
  • public — публичный;
  • private — приватный.
Если не установлен, то комментарий будет приватным
files Массив вложенных файлов
multipart/form-data
from Сторона, от лица которой создается комментарий
Возможные значения:
  • user — агент;
  • client — клиент.
Если передается параметр user, то в запросе должен содержаться параметр user_id
template_id Идентификатор шаблона WhatsApp Business (pact)
template_name
 Название шаблона WhatsApp Business (Landbot, infobip)
template_variables

Переменные шаблона WhatsApp Business

Массив строк. Переменные подставляются в шаблон по порядку

template_lang

Язык шаблона WhatsApp Business

Значение по умолчанию: ru


Пример запроса 
{
    "api_token": "ed22e2c09c1567629ea2a912907e60c6027ddf58",
    "ticket_id": "37344609",
    "message": "комментарий",
    "type": "public",
    "bcc": [
                "random@e.mail",
                "random2@e.mail",
                "random3@e.mail"
            ],
    "cc": [
                "random4@e.mail",
                "random5@e.mail",
                "random6@e.mail"
            ]
}

Пример запроса на PHP 
$data = array(
    'api_token'=> 'ba82c31d43b286e43e0e5489fb522ec57dc4c3fd',
    'message' => "New message text",
    'user_id'=>'545',
    'ticket_id'=>'2152490',
    'type'  => 'public',
);
$mch_api = curl_init();
curl_setopt($mch_api, CURLOPT_URL, 'https://api.usedesk.ru/create/comment');
curl_setopt($mch_api, CURLOPT_USERAGENT, 'PHP-MCAPI/2.0');
curl_setopt($mch_api, CURLOPT_RETURNTRANSFER, true);
curl_setopt($mch_api, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($mch_api, CURLOPT_TIMEOUT, 10);
curl_setopt($mch_api, CURLOPT_POST, true);
curl_setopt($mch_api, CURLOPT_SSL_VERIFYPEER, false);
curl_setopt($mch_api, CURLOPT_POSTFIELDS, $data);
$result = curl_exec($mch_api);
return $result;


При успешном запросе сервер вернёт сообщение об успешном создании и id комментария

Пример ответа от сервера 
{
    "status":"success",
    "comment_id":2154861
}

Пример создания комментария с вложенным файлом
$file_name_with_full_path = realpath('../1480538622583f39fe53d18_logo.png');
$cFile = curl_file_create($file_name_with_full_path);


Если запрос составляется через CURL, важно указать полный путь до файла на сервере

Пример запроса на PHP 
$file_name_with_full_path = realpath('../1480538622583f39fe53d18_logo.png');
$cFile = curl_file_create($file_name_with_full_path);
$data = array(
    'api_token'=> 'ba82c31d43b286e43e0e5489fb522ec57dc4c3fd',
    'message' => "New message text",
    'user_id'=>'545',
    'ticket_id'=>'2154814',
    'type'  => 'public',
    'files[]'=>$cFile
);
$mch_api = curl_init(); // initialize cURL connection
curl_setopt($mch_api, CURLOPT_URL, 'https://api.usedesk.ru/create/comment');
curl_setopt($mch_api, CURLOPT_USERAGENT, 'PHP-MCAPI/2.0');
curl_setopt($mch_api, CURLOPT_RETURNTRANSFER, true);
curl_setopt($mch_api, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($mch_api, CURLOPT_TIMEOUT, 10);
curl_setopt($mch_api, CURLOPT_POST, true);
curl_setopt($mch_api, CURLOPT_SSL_VERIFYPEER, false);
curl_setopt($mch_api, CURLOPT_POSTFIELDS, $data);
$result = curl_exec($mch_api);
return $result;