Категории

Создать клиента

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

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

Метод создаёт нового клиента.

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

Параметр Значение
api_token* Токен API канала
name Новое имя клиента
emails Массив с почтовыми адресами
messengers

Массив с данными мессенджеров

Содержит параметры:

  • identity — никнейм, номер телефона, другие идентификаторы, которые отображаются в карточке клиента (обязательный).
    Строка, 64 символа.
  • type — тип мессенджера (обязательный)
    Принимает значения:
    • telegram,
    • whatsapp,
    • viber,
    • skype,
    • gtalk,
    • imessage,
    • other
  • uid — id пользователя в мессенджере (необязательный)
social_networks

Массив с данными социальных сетей

Содержит параметры:

  • type — тип мессенджера (обязательный)
    Принимает значения:
    • vk
  • value — идентификатор пользователя в социальной сети (обязательный)
    Для ВК передаётся числовой id пользователя (например, 12345 или id12345)
    Строка, 255 символов.
note Текст заметки
phone Телефон пользователя

От 10 до 15 символов, только цифры
sites

Массив с сайтами клиента

Содержит параметры:

  • url — ссылка на сайт клиента (обязательный)
avatar

Файл с изображением

multipart/form-data

status_vip

Статус клиента vip-клиента

Допустимые значения:

  • true;
  • false

Не может использоваться одновременно с параметром status_spam

status_spam

Статус клиента-спамера

Допустимые значения:

  • true;
  • false

Не может использоваться одновременно с параметром status_vip

position Должность клиента
merge_id Идентификатор клиента, с которым будет объединён пользователь с идентификатором client_id
client_country Страна клиента
client_city Город клиента
client_address Адрес клиента
new_address Дополнительный адрес
phone_type

Тип телефона при сохранении

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

  • home;
  • mobile;
  • stationary;
  • fax;
  • other


Важно: параметр status устарел — вместо него появились параметры status_spam и status_vip.

Пример запроса на PHP 

$data = array(
    'api_token'=> 'e1cbe1c1c9d910ef2ae975215644cb53dd555de4',
    'name' =>'Jon',
    'emails'=>['test@gmail.com'],
    'messengers'=>[
        {
            'identity'=>'test',
            'type"=>"telegram',
            'uid'=>'test_uid'
        },
        {
            'identity'=>'test2',
            'type"=>'whatsapp'
        },
    ]
);
$mch_api = curl_init();
curl_setopt($mch_api, CURLOPT_URL, 'https://api.usedesk.ru/create/client');
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;

Пример ответа от сервера 
{
    "client_id": 1234,
    "status": true
}

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

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