Создать агента

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

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

Метод создаёт агента.

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

Параметр Значение
api_token* Токен API канала
name* Имя агента
email* Почта агента
role

Тип или роль пользователя

Возможные значения:

  • admin — администратор;
  • employee — внутренний сотрудник;
  • support — агент поддержки

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

password* Пароль для входа
group*

Группа по умолчанию

Агент при создании будет добавлен в данную группу

phone Телефон агента
avatar

Изображение

Не больше 15 МБ

send_invite

Отправка письма с данными для входа на указанный e-mail агенту при создании

Содержание письма на языке, указанном при создании агента

Возможные значения:

  • true
  • false

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

lang

Язык агента

Возможные значения:

  • ru — русский;
  • en — английский;
  • es — испанский;
  • kk — казахский
  • pt-br — португальский

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


Пример запроса
{
    'name': 'Agent Name',
    'email': 'agentemail@gmail.com',
    'role': 'admin',
    'password': 'qwerty123',
    'group': '123',
    'phone': '89156743287',
    'send_invite': 'true',
    'lang':'ru'
}
        

Пример запроса на PHP
$data = array(
    'api_token'=> 'e1cbe1c1c9d910ef2ae975215644cb53dd555de4',
    'name' => 'Agent Name',
    'email' => 'agentemail@gmail.com',
    'role' => 'admin',
    'password' => 'qwerty123',
    'group' => '123',
    'phone'  => '89156743287'
);
$mch_api = curl_init();
curl_setopt($mch_api, CURLOPT_URL, 'https://api.usedesk.ru/create/user');
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",
    "user_id":2154861
}
        

Параметры ответа от сервера

ПараметрОписание
user_idID агента
statusСтатус выполнения запроса