Данный 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 сотрудника из личного кабинета проекта на стороне Рингостат.
Запрос:
Ответ:
