Ta metoda API umożliwia eksport wszystkich informacji o pracownikach, którzy są obecnie utworzeni w projekcie.
Metoda ta jest najczęściej wykorzystywana do:
powiązania pracowników po stronie CRM/ERP z Ringostat;
w połączeniu z funkcjonalnością przekierowania za pomocą Webhook — umożliwia sprawdzenie wszystkich dostępnych kierunków przypisanych do pracowników oraz wykorzystanie ich do przekierowania połączeń.
Za pomocą tej metody API mogą Państwo uzyskać następujące dane o pracownikach:
ID pracowników;
imię i nazwisko;
adresy e-mail;
główne i dodatkowe numery telefonów przypisane do pracownika;
listę przypisanych kont SIP wraz z ich aktualnym statusem (online – true, offline – false);
nazwę oraz ID działu lub działów, do których przypisany jest pracownik.
Opis parametrów zapytania
Adres zapytania API:
https://api.ringostat.net/api/json-rpcMetoda: POST
Metoda Json-rpc: getProjectStaffListAndDirections
Auth-key: elektroniczny klucz dostępu do Państwa projektu w Ringostat
projectId: ID projektu
Filtry dostępne w zapytaniu
Filtry służą do wyszukiwania konkretnego pracownika oraz jego danych według zadanych parametrów.
Filtr składa się z nazwy parametru oraz wartości użytej do wyszukiwania.
Aby dodać filtr, należy użyć klucza filters, który umożliwia dodanie jednego lub kilku filtrów oddzielonych przecinkami.
Dostępne parametry filtrów:
Nazwa parametru | Opis |
staffId | ID pracownika. Wyszukiwanie tylko po pełnym dopasowaniu. |
fio | Imię i nazwisko pracownika. Wyszukiwanie częściowe lub pełne. |
Adres e-mail pracownika. Wyszukiwanie częściowe lub pełne. |
Jeśli pracownik nie zostanie znaleziony według podanego filtra, w odpowiedzi API zostanie zwrócony błąd:
"User does not exist"
Parametry dostępne do eksportu
Poniżej przedstawiono wszystkie parametry, które mogą Państwo otrzymać w odpowiedzi API.
Dane pracownika
Nazwa parametru | Opis |
status | Status konta SIP przypisanego do pracownika: true – online, false – offline |
fio | Imię i nazwisko pracownika |
Adres e-mail pracownika | |
extensionNumber | Numer wewnętrzny pracownika |
staffId | ID pracownika |
Dane działu (departments)
Nazwa parametru | Opis |
id | ID działu |
name | Nazwa działu |
Kierunki połączeń przypisane do pracownika (directions)
Nazwa parametru | Opis |
main | Główne kontakty pracownika |
additional | Dodatkowe kontakty pracownika |
type | Typ kierunku:
|
direction | Kierunek połączenia: login SIP lub numer telefonu |
Przykład zapytania bez użycia filtrów
Metoda: POST
URL: https://api.ringostat.net/api/json-rpc
HEADERS: Auth-key:***************
BODY:
{ "id": 1, "jsonrpc": "2.0", "method": {
"id": 1,
"jsonrpc": "2.0",
"method": "getProjectStaffListAndDirections",
"params": {
"projectId": xxxxx,
"departmentsFullFormat": true,
"filter": [{
}]
}
}
Gdzie:
xxxxx — ID projektu
*************** — elektroniczny klucz dostępu do Państwa projektu w Ringostat
Zapytanie:
Odpowiedź:
Przykład zapytania z użyciem filtrów
Metoda: POST
URL: https://api.ringostat.net/api/json-rpc
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
}
]
}
}
Gdzie:
xxxxx — ID projektu
*************** — elektroniczny klucz dostępu do Państwa projektu w Ringostat
YYYYY — część lub pełny adres e-mail pracownika
WWWWW — część lub pełne imię i nazwisko pracownika
111111 — ID pracownika w panelu Ringostat
Zapytanie:
Odpowiedź: