Отдельный клиент

URL: https://api.usedesk.ru/client

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

Метод возвращает информацию об указанном клиенте компании. Принимает один id клиента

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

Параметр Значение
api_token* Токен API канала
client_id* id клиента
Пример запроса на PHP
$data = array(
    'api_token'=> 'e1cbe1c1c9d910ef2ae975215644cb53dd555de4',
    'client_id'=>'2261648',
);
$mch_api = curl_init(); 
curl_setopt($mch_api, CURLOPT_URL, 'https://api.usedesk.ru/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": 2,
            "name": "Ekaterina Arhipova",
            "avatar": null,
            "position": null,
            "note": null,
            "company_id": 153561,
            "spammer": 0,
            "vip": 0,
            "client_company_id": null,
            "created_at": "2015-02-24 19:50:03",
            "tickets": [
                2,
                3000640,
                3000652,
                3000708,
                3000784,
                3000794,
                3027058
            ],
            "emails": [
                {
                    "id": 2,
                    "email": "arhipova1206@gmail.com",
                    "client_id": 2,
                    "fullcontact": 0,
                    "status": "",
                    "created_at": "2020-08-21 14:12:14",
                    "updated_at": "2020-08-21 14:12:14"
                }
            ],
            "phones": [
                {
                    "id": 96548669,
                    "phone": "7987918046355",
                    "type": "home",
                    "client_id": 109815438
                    "created_at": "2020-08-21 14:12:14",
                    "updated_at": "2020-08-21 14:12:14"
                },
                {
                    "id": 96538781,
                    "phone": "7987999887743",
                    "type": "mobile",
                    "client_id": 109821438
                }
            ],
            "social_networks": [
                {
                    "id": 1891275,
                    "url": "https://www.facebook.com/3067001726690637",
                    "type": "facebook",
                    "client_id": 27747627,
                    "uid": null,
                    "fullcontact": 0
                },
                {
                    "id": 1891276,
                    "url": "https://www.facebook.com/Boyarara",
                    "type": "facebook",
                    "client_id": 27747627,
                    "uid": null,
                    "fullcontact": 0
                },
                {
                    "id": 1891277,
                    "url": "https://www.instagram.com/nickname/",
                    "type": "instagram",
                    "client_id": 27747627,
                    "uid": null,
                    "fullcontact": 0
                },
                {
                    "id": 1891279,
                    "url": "https://vk.com/id111111111",
                    "type": "vk",
                    "client_id": 27747627,
                    "uid": null,
                    "fullcontact": 0,
                    "created_at": "2020-08-21 14:12:14",
                    "updated_at": "2020-08-21 14:12:14"
                },
                {
                    "id": 1891280,
                    "url": "https://vk.com/public111111111",
                    "type": "vk",
                    "client_id": 27747627,
                    "uid": null,
                    "fullcontact": 0,
                    "created_at": "2020-08-21 14:12:14",
                    "updated_at": "2020-08-21 14:12:14"
                }
                {
                    "id": 1600915,
                    "url": "",
                    "type": "",
                    "client_id": 23927259,
                    "uid": "UU4L88CJG",
                    "fullcontact": 0,
                    "created_at": null,
                    "updated_at": null
                }
            ],
            "messengers": [
                {
                    "id": 395036,
                    "identity": "J7b7Hb8HUcksljAZp683wA==",
                    "type": "imessage",
                    "client_id": 27747627
                },
                {
                    "id": 395799,
                    "identity": "79251110011",
                    "type": "whatsapp",
                    "client_id": 27747627
                },
                {
                    "id": 395800,
                    "identity": "280303646",
                    "type": "telegram",
                    "client_id": 27747627
                }
            ],
            "addresses": [
                {
                    "id": 83629,
                    "country": "Россия",
                    "city": "Самара",
                    "address": "Адрес",
                    "type": "home",
                    "client_id": 109814438
                },
                {
                    "id": 83631,
                    "country": "Россия",
                    "city": "Самара",
                    "address": "Адрес",
                    "type": "home",
                    "client_id": 109821438
                }
            ],
            "sites": [],
            "client_company": {
                "id": 444195,
                "name": "Тестовый ",
                "note": "fuf",
                "domains": "",
                "phone": "+7917016777277",
                "address": "a:3:{s:7:\"country\";s:12:\"Россия\";s:4:\"city\";s:6:\"Samara\";s:7:\"address\";s:0:\"\";}",
                "vip": 0,
                "company_id": 1537312,
                "avatar": "/images/client_companies/files/15373312/15223712_5d401e310d663422_avatar.jpg"
            }
        }
    }
]
        

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

Параметр Значение
id ID клиента
name Имя клиента
avatar URL аватара клиента
position Должность клиента
note Текст заметки
company_id ID компании
spammer Флаг, обозначающий спам-статус клиента
vip Флаг, обозначающий VIP-статус клиента
client_company_id ID компании клиента
created_at Дата создания клиента
Часовая зона UTC+0
tickets Массив идентификаторов запросов клиента
emails Массив Email клиента

ПараметрОписание
idID записи
emailEmail клиента
client_idID клиента
fullcontactDepricated, не используется
statusСтатус
created_atДата создания записи
Часовая зона UTC+0
updated_atДата обновления записи
Часовая зона UTC+0
phones Массив телефонов клиента

ПараметрОписание
idID записи
phoneТелефон
typeТип телефона
Возможные значения:


  • home;
  • mobile;
  • stationary;
  • fax;
  • other
client_idID клиента
created_atДата создания записи
Часовая зона UTC+0
updated_atДата обновления записи
Часовая зона UTC+0
social_networks Массив социальных сетей клиента

ПараметрОписание
idID записи
urlСсылка на социальную сеть
typeТип социальной сети
client_idID клиента
uidID клиента в социальной сети
fullcontactDepricated, не используется
messengers Массив мессенджеров клиента

ПараметрОписание
idID записи
identityИдентификатор клиента в мессенджере
typeТип мессенджера
Принимает следующие значения:


  • telegram,
  • whatsapp,
  • viber,
  • skype,
  • gtalk,
  • iMessage,
  • other
client_idID клиента
addresses Массив адресов клиента

ПараметрОписание
idID записи
countryСтрана
cityГород
addressАдрес
typeТип адреса
client_idID клиента
sites Массив сайтов клиента
client_company Данные о компании клиента

ПараметрОписание
idID компании
nameНазвание компании
noteЗаметка
domainsДомены компании
phoneТелефон
addressАдрес
vipФлаг, обозначающий VIP-статус компании
company_idID компании
avatarURL аватара компании клиента