Даний API метод дозволить експортувати всю інформацію про працівників, котрі на поточний момент створені в проєкті.
Цей метод зазвичай використовується для таких задач:
для зв’язки співробітників на боці CRM/ERP та Ringostat;
у поєднанні з функціоналом переадресації за допомогою Webhook, можна перевірити всі доступні напрямки, закріплені за співробітниками й використовувати для переадресації дзвінків.
За допомогою даного API методу ви можете отримати такі дані співробітників:
ID співробітників;
ПІБ;
Електронні пошти;
Основні та додаткові номери телефонів, які прив’язані до працівника;
Перелік закріплених sip-акаунтів працівника і їх актуальний статус (онлайн - true або офлайн - false);
Назва та ID відділу чи відділів, за якими закріплено співробітника.
Опис параметрів запиту
Адреса API-запиту: https://api.ringostat.net/api/json-rpc
Метод: POST
Json-rpc метод: getProjectStaffListAndDirections
Auth-key: електронний ключ для доступу до вашого проєкту в Ringostat.
projectId: ID проєкту
Фільтри, які можна використовувати в запиті:
Фільтри необхідні для пошуку певного співробітника і даних про нього за заданими параметрами.
Фільтр складається з імені параметра і введеного значення для пошуку.
Для додавання фільтра використовується ключ filters, який дає змогу додавати один або кілька фільтрів, розділених комами.
Ім’я параметра | Опис |
staffId | ID співробітника. Пошук за повним збігом параметра. |
fio | ПІБ співробітника. Пошук за частковим збігом параметра або повним збігом параметра. |
Електронна пошта співробітника. Пошук за частковим збігом параметра або повним збігом параметра. |
Якщо співробітника за заданим фільтром у проєкті не було знайдено — у відповідь на API запит буде повернуто помилку "User does not exist".
Параметри, які можна експортувати:
Нижче наведено всі параметри, які ви можете отримати у відповідь на запит даного API методу.
Дані співробітника |
Ім’я параметра | Опис |
status | Статус sip-акаунта, закріпленого за співробітником. Значення:
|
fio | ПІБ співробітника. |
Електронна пошта співробітника. | |
extensionNumber | Додатковий номер співробітника. |
staffId | ID співробітника. |
Дані відділу (departments) |
Ім'я параметра | Опис |
id | ID відділу. |
name | Назва відділу. |
Напрямок для дзвінка, закріплений за співробітником (directions) |
Ім'я параметра | Опис |
main | Основні контакти співробітника. |
additional | Додаткові контакти співробітника |
type | Тип напрямку:
|
direction | Напрямок для дзвінка: логін sip-акаунта, мобільний номер. |
Приклад запиту без використання фільтрів
Метод: POST
HEADERS: Auth-key:***************
BODY:
{
"id": 1,
"jsonrpc": "2.0",
"method": "getProjectStaffListAndDirections",
"params": {
"projectId": xxxxx,
"departmentsFullFormat": true,
"filter": [{
}]
}
}Де:
xxxxx — ID проєкту;
*************** — електронний ключ для доступу до вашого проєкту в Ringostat.
Запит:
Відповідь:
Приклад запиту із використанням фільтрів
Метод: POST
HEADERS: Auth-key:***************
BODY:
{
"id": 1,
"jsonrpc": "2.0",
"method": "getProjectStaffListAndDirections",
"params": {
"projectId": xxxxx,
"departmentsFullFormat": true,
"filter": [{
"param": "email",
"value": "YYYYY"
}, {
"param": "fio",
"value": "WWWWW"
}, {
"param": "staffId",
"value": 111111
}
]
}
}Де:
xxxxx — ID проєкту;
*************** — електронний ключ для доступу до вашого проєкту в Ringostat;
YYYYY — частина або повна email адреса співробітника;
WWWWW — частина або повне значення ПІБ співробітника;
111111 — ID співробітника із особистого кабінету проєкту на боці Рінгостат.
Запит:
Відповідь:
