Получить список клиентов
POST https://api.usedesk.ru/clients
Внимание. Если вы используете коробочную версию Юздеска на собственном сервере, URL методов у вас будет отличаться. Уточните URL для работы с API у поддержки — support@usedesk.ru.
Метод возвращает список клиентов, удовлетворяющих заданным условиям фильтров.
В методе реализована постраничная разбивка. В ответе максимум 100 записей, для смещения используется параметр offset.
* — обязательные поля
| Параметр | Значение |
| api_token* | Токен API канала |
| created_after |
Фильтрация по дате и времени создания В выдачу попадут клиенты, созданные после указанной даты (включительно) Пример использования: "created_after": "2022-01-01 00:00" |
| created_before |
Фильтрация по дате и времени создания В выдачу попадут клиенты, созданные до указанной даты (включительно) Пример использования: "created_before": "2022-12-31 23:59" |
| offset |
Смещение Не принимает значение null Смещение на 1 покажет следующие 100 записей |
| query |
Поиск по имени, email и телефону клиента Принимает только одно значение |
|
search_type |
Тип поиска Принимает 2 значения:
Если не указан параметр, выбирается по умолчанию partial_match |
$data = array(
'api_token'=> 'e1cbe1c1c9d910ef2ae975215644cb53dd555de4',
'offset'=>0,
'created_after' =>'2016-11-25 00:00',
'created_before'=>'2016-11-25 15:08',
);
$mch_api = curl_init();
curl_setopt($mch_api, CURLOPT_URL, 'https://api.usedesk.ru/clients');
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": 1,
"name": "UseDesk",
"emails": "support@usedesk.ru",
"phone": null,
"tickets": [
1,
3089372,
3091416
]
},
{
"id": 16,
"name": "Google+",
"emails": "noreply-9557e437@plus.google.com",
"phone": null,
"tickets": []
},
{
"id": 17,
"name": "Shazam",
"emails": null,
"phone": null,
"tickets": []
},
{
"id": 18,
"name": "Google Play",
"emails": "news-googleplay@google.com",
"phone": null,
"tickets": [
3088240
]
}
]
Параметры ответа от сервера
| Параметр | Значение |
| id | ID клиента |
| name | Имя клиента |
| emails | Email клиента |
| phone | Телефон клиента |
| tickets | Массив с ID запросов клиента |