Udostępnij przez

Wysłana (wersja zapoznawcza)

Łącznik usługi Envoy, który umożliwia łączenie konta usługi Envoy (naszych punktów końcowych interfejsu API REST) z innymi łącznikami. Przykładem może być utworzenie zaproszeń zbiorczych w usłudze Envoy ze szczegółami z arkusza kalkulacyjnego usługi Microsoft Excel Online.

Ten łącznik jest dostępny w następujących produktach i regionach:

Usługa Class Regions
Copilot Studio Premium Wszystkie regiony usługi Power Automate z wyjątkiem następujących:
     - Rząd USA (GCC)
     - Rząd USA (GCC High)
     - China Cloud obsługiwane przez firmę 21Vianet
     - Departament Obrony USA (DoD)
Logic Apps Standard Wszystkie regiony usługi Logic Apps z wyjątkiem następujących:
     — Regiony platformy Azure Government
     — Regiony platformy Azure (Chiny)
     - Departament Obrony USA (DoD)
Power Apps Premium Wszystkie regiony usługi Power Apps z wyjątkiem następujących:
     - Rząd USA (GCC)
     - Rząd USA (GCC High)
     - China Cloud obsługiwane przez firmę 21Vianet
     - Departament Obrony USA (DoD)
Power Automate Premium Wszystkie regiony usługi Power Automate z wyjątkiem następujących:
     - Rząd USA (GCC)
     - Rząd USA (GCC High)
     - China Cloud obsługiwane przez firmę 21Vianet
     - Departament Obrony USA (DoD)
Kontakt
Name Zespół pomocy technicznej aplikacji Envoy
adres URL https://envoy.help/
Email hi@envoy.com
Metadane łącznika
Publisher Envoy, Inc.
Witryna internetowa https://envoy.com/
Zasady ochrony prywatności https://envoy.com/privacypolicy/
Kategorie Analiza biznesowa; Dane

W wersji 2.0 można również użyć funkcji tworzenia zaproszenia usługi Envoy jako wyzwalacza.

Wymagania wstępne

Aby użyć tego łącznika, musisz mieć konto usługi Envoy z nazwą użytkownika i hasłem. W przypadku wyzwalania funkcji należy również zainstalować integrację aplikacji Envoy "Microsoft Flow".

Jak uzyskać poświadczenia

Aby uwierzytelnić się w aplikacji Envoy, musisz mieć nazwę użytkownika i hasło aplikacji Envoy.

Aby wyzwalać funkcjonalność, musisz udostępnić token instalacji podczas kroku 2 konfiguracji integracji "Microsoft Flow" w aplikacji Envoy.

Znane problemy i ograniczenia

Obecnie jedynym dostępnym wyzwalaczem jest tworzenie zaproś. Spodziewamy się dodać więcej wyzwalaczy w najbliższej przyszłości.

Tworzenie połączenia

Łącznik obsługuje następujące typy uwierzytelniania:
Wartość domyślna Parametry tworzenia połączenia. Wszystkie regiony Nie można udostępniać

Domyślny

Dotyczy: wszystkie regiony

Parametry tworzenia połączenia.

Nie jest to możliwe do udostępnienia połączenie. Jeśli aplikacja power zostanie udostępniona innemu użytkownikowi, zostanie wyświetlony monit o jawne utworzenie nowego połączenia.

Name Typ Description Wymagane
nazwa użytkownika securestring Nazwa użytkownika dla tego interfejsu API Prawda
hasło securestring Hasło dla tego interfejsu API Prawda

Limity ograniczania

Nazwa Wywołania Okres odnowienia
Wywołania interfejsu API na połączenie 100 60 sekund

Akcje

Dodawanie filtru listy bloków

Żądanie POST w celu dodania filtru listy zablokowanych
Pobieranie filtrów listy bloków

Żądanie GET w celu pobrania filtrów listy bloków.
Pobieranie listy pracowników

Żądanie GET dotyczące pobierania listy pracowników
Pobieranie lokalizacji

Żądanie GET dotyczące pobierania lokalizacji
Pobieranie przepływów

Żądanie GET w celu pobrania informacji dotyczących przepływów dla twojej lokalizacji.
Pobieranie zaproszeń

Żądanie GET w celu pobrania informacji o zaproszeniu na podstawie filtrowania.
Pobierz jedno zaproszenie

Żądanie GET w celu pobrania informacji o pojedynczym zaproszeniu.
Tworzenie zaproszeń

Jest to żądanie POST, aby utworzyć zaproszenie
Uzyskiwanie informacji o firmie

Pobieranie informacji dotyczących firmy (GET)
Uzyskiwanie jednego wpisu

Żądanie GET w celu pobrania informacji o pojedynczym wpisie.
Zaktualizuj jedno zaproszenie

ŻĄDANIE PATCH w celu zaktualizowania informacji o zaproszeniu.

Dodawanie filtru listy bloków

Identyfikator operacji:
addBlockListFilter

Żądanie POST w celu dodania filtru listy zablokowanych

Parametry

Nazwa Klucz Wymagane Typ Opis
aliases
 aliases array of

aliases
opis
 description string

opis
wiadomości e-mail
 emails array of string

wiadomości e-mail
pełna nazwa
 full-name string

pełna nazwa
słowo kluczowe
 keyword string

słowo kluczowe
inne słowa kluczowe
 other-keywords array of

inne słowa kluczowe
powód
 reason string

powód
numery telefonów
 phone-numbers array of

numery telefonów
typ
 type string

typ
id
 id string

id (lokalizacja)
typ
 type string

typ

Zwraca

Nazwa Ścieżka Typ Opis
id
 data.id string

id
typ
 data.type string

typ
jaźń
 data.links.self string

jaźń
aliases
 data.attributes.aliases array of

aliases
opis
 data.attributes.description string

opis
wiadomości e-mail
 data.attributes.emails array of string

wiadomości e-mail
pełna nazwa
 data.attributes.full-name string

pełna nazwa
słowo kluczowe
 data.attributes.keyword string

słowo kluczowe
inne słowa kluczowe
 data.attributes.other-keywords array of

inne słowa kluczowe
numery telefonów
 data.attributes.phone-numbers array of

numery telefonów
Oryginał
 data.attributes.photo.original string

Oryginał
kciuk
 data.attributes.photo.thumb string

kciuk
powód
 data.attributes.reason string

powód
created-by
 data.attributes.created-by string

created-by
jaźń
 data.relationships.location.links.self string

jaźń
Powiązane
 data.relationships.location.links.related string

Powiązane
jaźń
 data.relationships.user.links.self string

jaźń
Powiązane
 data.relationships.user.links.related string

Powiązane

Pobieranie filtrów listy bloków

Identyfikator operacji:
getblockListFilters

Żądanie GET w celu pobrania filtrów listy bloków.

Parametry

Nazwa Klucz Wymagane Typ Opis
filter[company]
 filter[company] integer

filter[company]
Typ zawartości
 Content-Type string

Typ zawartości

Zwraca

Nazwa Ścieżka Typ Opis
dane
 data array of object

dane
id
 data.id string

id
typ
 data.type string

typ
jaźń
 data.links.self string

jaźń
aliases
 data.attributes.aliases array of

aliases
opis
 data.attributes.description string

opis
wiadomości e-mail
 data.attributes.emails array of string

wiadomości e-mail
pełna nazwa
 data.attributes.full-name string

pełna nazwa
słowo kluczowe
 data.attributes.keyword string

słowo kluczowe
inne słowa kluczowe
 data.attributes.other-keywords array of string

inne słowa kluczowe
numery telefonów
 data.attributes.phone-numbers array of

numery telefonów
Oryginał
 data.attributes.photo.original string

Oryginał
kciuk
 data.attributes.photo.thumb string

kciuk
powód
 data.attributes.reason string

powód
image-url
 data.attributes.image-url string

image-url
identyfikator zewnętrzny
 data.attributes.external-id string

identyfikator zewnętrzny
created-by
 data.attributes.created-by string

created-by
jaźń
 data.relationships.location.links.self string

jaźń
Powiązane
 data.relationships.location.links.related string

Powiązane
jaźń
 data.relationships.user.links.self string

jaźń
Powiązane
 data.relationships.user.links.related string

Powiązane
łączny
 meta.total integer

łączny

Pobieranie listy pracowników

Identyfikator operacji:
getEmployee

Żądanie GET dotyczące pobierania listy pracowników

Zwraca

Nazwa Ścieżka Typ Opis
dane
 data array of object

dane
id
 data.id string

id
typ
 data.type string

typ
jaźń
 data.links.self string

jaźń
cc-employee
 data.attributes.cc-employee boolean

cc-employee
identyfikator firmy
 data.attributes.company-id integer

identyfikator firmy
usunięta
 data.attributes.deleted boolean

usunięta
niezsynchronizuj
 data.attributes.do-not-sync boolean

niezsynchronizuj
e-mail
 data.attributes.email string

e-mail
hide-from-host-list
 data.attributes.hide-from-host-list boolean

hide-from-host-list
ręcznie dodane
 data.attributes.manually-added boolean

ręcznie dodane
ręcznie dodany-lokalizacja-obecny
 data.attributes.manually-added-location-present boolean

ręcznie dodany-lokalizacja-obecny
nazwa
 data.attributes.name string

nazwa
numer telefonu
 data.attributes.phone-number string

numer telefonu
created-at
 data.attributes.created-at string

created-at
usunięto pod adresem
 data.attributes.deleted-at string

usunięto pod adresem
zaktualizowano pod adresem
 data.attributes.updated-at string

zaktualizowano pod adresem
jaźń
 data.relationships.company.links.self string

jaźń
Powiązane
 data.relationships.company.links.related string

Powiązane
jaźń
 data.relationships.user.links.self string

jaźń
Powiązane
 data.relationships.user.links.related string

Powiązane
jaźń
 data.relationships.assistants.links.self string

jaźń
Powiązane
 data.relationships.assistants.links.related string

Powiązane
jaźń
 data.relationships.bosses.links.self string

jaźń
Powiązane
 data.relationships.bosses.links.related string

Powiązane
jaźń
 data.relationships.employee-locations.links.self string

jaźń
Powiązane
 data.relationships.employee-locations.links.related string

Powiązane
jaźń
 data.relationships.locations.links.self string

jaźń
Powiązane
 data.relationships.locations.links.related string

Powiązane
łączny
 meta.total integer

łączny
pierwszy
 links.first string

pierwszy
last
 links.last string

last

Pobieranie lokalizacji

Identyfikator operacji:
getLocationInfo

Żądanie GET dotyczące pobierania lokalizacji

Parametry

Nazwa Klucz Wymagane Typ Opis
Akceptuj
 Accept string

Akceptuj

Zwraca

Nazwa Ścieżka Typ Opis
dane
 data array of object

dane
id
 data.id string

id
typ
 data.type string

typ
jaźń
 data.links.self string

jaźń
address
 data.attributes.address string

address
address-line-one
 data.attributes.address-line-one string

address-line-one
adres-wiersz-dwa
 data.attributes.address-line-two string

adres-wiersz-dwa
automatyczne wylogowywanie o północy
 data.attributes.auto-sign-out-at-midnight boolean

automatyczne wylogowywanie o północy
automatyczne wylogowywanie w minutach
 data.attributes.auto-sign-out-minutes string

automatyczne wylogowywanie w minutach
city
 data.attributes.city string

city
zastąpienie nazwy firmy
 data.attributes.company-name-override string

zastąpienie nazwy firmy
wygaszony
 data.attributes.disabled boolean

wygaszony
employees-csv-upload-status
 data.attributes.employees-csv-upload-status string

employees-csv-upload-status
employees-sync-message
 data.attributes.employees-sync-message string

employees-sync-message
powiadomienia rezerwowe z włączoną obsługą
 data.attributes.fallback-notifications-enabled boolean

powiadomienia rezerwowe z włączoną obsługą
wstępnie włączona rejestracja
 data.attributes.pre-registration-required-enabled boolean

wstępnie włączona rejestracja
latitude
 data.attributes.latitude float

latitude
regionalny
 data.attributes.locale string

regionalny
logo-small-url
 data.attributes.logo-small-url string

logo-small-url
logo-thumb-url
 data.attributes.logo-thumb-url string

logo-thumb-url
logo-url
 data.attributes.logo-url string

logo-url
długość geograficzna
 data.attributes.longitude float

długość geograficzna
nazwa
 data.attributes.name string

nazwa
obsługa powiadomień drukarki
 data.attributes.printer-notifications-enabled boolean

obsługa powiadomień drukarki
z obsługą wielu języków
 data.attributes.multiple-languages-enabled boolean

z obsługą wielu języków
włączone ustawienia regionalne
 data.attributes.enabled-locales array of

włączone ustawienia regionalne
stan
 data.attributes.state string

stan
timezone
 data.attributes.timezone string

timezone
zip
 data.attributes.zip string

zip
średnia liczba odwiedzających co miesiąc
 data.attributes.average-monthly-visitors float

średnia liczba odwiedzających co miesiąc
created-at
 data.attributes.created-at string

created-at
last-entry-at
 data.attributes.last-entry-at string

last-entry-at
zaktualizowano pod adresem
 data.attributes.updated-at string

zaktualizowano pod adresem
jaźń
 data.relationships.company.links.self string

jaźń
Powiązane
 data.relationships.company.links.related string

Powiązane
jaźń
 data.relationships.device-config.links.self string

jaźń
Powiązane
 data.relationships.device-config.links.related string

Powiązane
jaźń
 data.relationships.gdpr-configuration.links.self string

jaźń
Powiązane
 data.relationships.gdpr-configuration.links.related string

Powiązane
jaźń
 data.relationships.printer.links.self string

jaźń
Powiązane
 data.relationships.printer.links.related string

Powiązane
jaźń
 data.relationships.devices.links.self string

jaźń
Powiązane
 data.relationships.devices.links.related string

Powiązane
jaźń
 data.relationships.employees.links.self string

jaźń
Powiązane
 data.relationships.employees.links.related string

Powiązane
jaźń
 data.relationships.fallback-contacts.links.self string

jaźń
Powiązane
 data.relationships.fallback-contacts.links.related string

Powiązane
jaźń
 data.relationships.flows.links.self string

jaźń
Powiązane
 data.relationships.flows.links.related string

Powiązane
jaźń
 data.relationships.locations-setup-guide-steps.links.self string

jaźń
Powiązane
 data.relationships.locations-setup-guide-steps.links.related string

Powiązane
jaźń
 data.relationships.printers.links.self string

jaźń
Powiązane
 data.relationships.printers.links.related string

Powiązane
jaźń
 data.relationships.printer-contacts.links.self string

jaźń
Powiązane
 data.relationships.printer-contacts.links.related string

Powiązane
łączny
 meta.total integer

łączny
pierwszy
 links.first string

pierwszy
last
 links.last string

last

Pobieranie przepływów

Identyfikator operacji:
getFlowsInfo

Żądanie GET w celu pobrania informacji dotyczących przepływów dla twojej lokalizacji.

Parametry

Nazwa Klucz Wymagane Typ Opis
filter[location]
 filter[location] integer

filter[location]

Zwraca

Nazwa Ścieżka Typ Opis
dane
 data array of object

dane
id
 data.id string

id
typ
 data.type string

typ
jaźń
 data.links.self string

jaźń
dodatkowi goście
 data.attributes.additional-guests boolean

dodatkowi goście
automatyczne wylogowywanie w minutach
 data.attributes.auto-sign-out-minutes string

automatyczne wylogowywanie w minutach
automatyczne wylogowywanie o północy
 data.attributes.auto-sign-out-at-midnight boolean

automatyczne wylogowywanie o północy
z włączonym znaczkiem
 data.attributes.badge-enabled boolean

z włączonym znaczkiem
enabled
 data.attributes.enabled boolean

enabled
sprawdzanie identyfikatora
 data.attributes.id-check boolean

sprawdzanie identyfikatora
zlokalizowane nazwy tabletu iPad
 data.attributes.ipad-localized-names array of object

zlokalizowane nazwy tabletu iPad
kod języka
 data.attributes.ipad-localized-names.language-code string

kod języka
kod regionu
 data.attributes.ipad-localized-names.region-code string

kod regionu
nazwa wyświetlana
 data.attributes.ipad-localized-names.display-name string

nazwa wyświetlana
nazwa
 data.attributes.name string

nazwa
pozycja
 data.attributes.position integer

pozycja
use-existing-photo
 data.attributes.use-existing-photo boolean

use-existing-photo
created-at
 data.attributes.created-at string

created-at
zaktualizowano pod adresem
 data.attributes.updated-at string

zaktualizowano pod adresem
jaźń
 data.relationships.agreement-page.links.self string

jaźń
Powiązane
 data.relationships.agreement-page.links.related string

Powiązane
jaźń
 data.relationships.badge.links.self string

jaźń
Powiązane
 data.relationships.badge.links.related string

Powiązane
jaźń
 data.relationships.location.links.self string

jaźń
Powiązane
 data.relationships.location.links.related string

Powiązane
jaźń
 data.relationships.photo-page.links.self string

jaźń
Powiązane
 data.relationships.photo-page.links.related string

Powiązane
jaźń
 data.relationships.sign-in-field-page.links.self string

jaźń
Powiązane
 data.relationships.sign-in-field-page.links.related string

Powiązane
jaźń
 data.relationships.summary-page.links.self string

jaźń
Powiązane
 data.relationships.summary-page.links.related string

Powiązane
łączny
 meta.total integer

łączny
pierwszy
 links.first string

pierwszy
last
 links.last string

last

Pobieranie zaproszeń

Identyfikator operacji:
getInviteInfo

Żądanie GET w celu pobrania informacji o zaproszeniu na podstawie filtrowania.

Parametry

Nazwa Klucz Wymagane Typ Opis
filter[location]
 filter[location] integer

filter[location]
filter[date]
 filter[date] string

filter[date]
Akceptuj
 Accept string

Akceptuj

Zwraca

Nazwa Ścieżka Typ Opis
dane
 data array of object

dane
id
 data.id string

id
typ
 data.type string

typ
jaźń
 data.links.self string

jaźń
dodatkowi goście
 data.attributes.additional-guests integer

dodatkowi goście
stan
 data.attributes.approval-status.status string

stan
auto_approved
 data.attributes.approval-status.auto_approved boolean

auto_approved
raport
 data.attributes.approval-status.report array of object

raport
wynik
 data.attributes.approval-status.report.result string

wynik
przesłać źródło
 data.attributes.approval-status.report.source string

przesłać źródło
blacklistReportUID
 data.attributes.approval-status.report.blacklistReportUUID string

blacklistReportUID
powód
 data.attributes.approval-status.report.reason string

powód
SMS
 data.attributes.approval-status.report.messages.failure.text string

SMS
nagłówek
 data.attributes.approval-status.report.messages.failure.header string

nagłówek
reviewer_id
 data.attributes.approval-status.reviewer_id string

reviewer_id
reviewer_name
 data.attributes.approval-status.reviewer_name string

reviewer_name
review_note
 data.attributes.approval-status.review_note string

review_note
reviewed_at
 data.attributes.approval-status.reviewed_at string

reviewed_at
e-mail
 data.attributes.email string

e-mail
oczekiwany czas przyjazdu
 data.attributes.expected-arrival-time string

oczekiwany czas przyjazdu
oczekiwany czas odlotu
 data.attributes.expected-departure-time string

oczekiwany czas odlotu
pełna nazwa
 data.attributes.full-name string

pełna nazwa
guest-updated-at
 data.attributes.guest-updated-at string

guest-updated-at
jest wstępnie podpisany
 data.attributes.is-presigned boolean

jest wstępnie podpisany
address
 data.attributes.location-info.address string

address
id
 data.attributes.location-info.id integer

id
nazwa
 data.attributes.location-info.name string

nazwa
logo_url
 data.attributes.location-info.logo_url string

logo_url
company_name
 data.attributes.location-info.company_name string

company_name
timezone
 data.attributes.location-info.timezone string

timezone
notatki prywatne
 data.attributes.private-notes string

notatki prywatne
dane użytkownika
 data.attributes.user-data array of object

dane użytkownika
pole
 data.attributes.user-data.field string

pole
value
 data.attributes.user-data.value string

value
notify-visitor
 data.attributes.notify-visitor boolean

notify-visitor
utworzony na podstawie
 data.attributes.created-from string

utworzony na podstawie
place_id
 data.attributes.locality.place_id string

place_id
identyfikator place-id
 data.attributes.locality.place-id string

identyfikator place-id
Przybył
 data.attributes.arrived boolean

Przybył
czas bezdotykowego logowania
 data.attributes.touchless-sign-in-available-time string

czas bezdotykowego logowania
wymagane logowanie bezobsługowe
 data.attributes.touchless-sign-in-presence-required boolean

wymagane logowanie bezobsługowe
entry-signed-out-at
 data.attributes.entry-signed-out-at string

entry-signed-out-at
Potwierdzone
 data.attributes.attested string

Potwierdzone
phone
 data.attributes.phone string

phone
link wstępny do wyrejestrowania
 data.attributes.preregistration-link string

link wstępny do wyrejestrowania
preregistration-status-link
 data.attributes.preregistration-status-link string

preregistration-status-link
reminder-sent-at
 data.attributes.reminder-sent-at string

reminder-sent-at
created-at
 data.attributes.created-at string

created-at
zaktualizowano pod adresem
 data.attributes.updated-at string

zaktualizowano pod adresem
jaźń
 data.relationships.attendee.links.self string

jaźń
Powiązane
 data.relationships.attendee.links.related string

Powiązane
jaźń
 data.relationships.creator.links.self string

jaźń
Powiązane
 data.relationships.creator.links.related string

Powiązane
jaźń
 data.relationships.employee.links.self string

jaźń
Powiązane
 data.relationships.employee.links.related string

Powiązane
typ
 data.relationships.employee.data.type string

typ
id
 data.relationships.employee.data.id string

id
jaźń
 data.relationships.entry.links.self string

jaźń
Powiązane
 data.relationships.entry.links.related string

Powiązane
typ
 data.relationships.entry.data.type string

typ
id
 data.relationships.entry.data.id string

id
jaźń
 data.relationships.flow.links.self string

jaźń
Powiązane
 data.relationships.flow.links.related string

Powiązane
typ
 data.relationships.flow.data.type string

typ
id
 data.relationships.flow.data.id string

id
jaźń
 data.relationships.location.links.self string

jaźń
Powiązane
 data.relationships.location.links.related string

Powiązane
typ
 data.relationships.location.data.type string

typ
id
 data.relationships.location.data.id string

id
jaźń
 data.relationships.platform-jobs.links.self string

jaźń
Powiązane
 data.relationships.platform-jobs.links.related string

Powiązane
łączny
 meta.total integer

łączny
pierwszy
 links.first string

pierwszy
następny
 links.next string

następny
last
 links.last string

last

Pobierz jedno zaproszenie

Identyfikator operacji:
getInviteByID

Żądanie GET w celu pobrania informacji o pojedynczym zaproszeniu.

Parametry

Nazwa Klucz Wymagane Typ Opis
invite_id
 invite_id True string

invite_id
Akceptuj
 Accept string

Akceptuj

Zwraca

Nazwa Ścieżka Typ Opis
id
 data.id string

id
typ
 data.type string

typ
pełna nazwa
 data.attributes.full-name string

pełna nazwa
e-mail
 data.attributes.email string

e-mail
nazwa osoby zapraszanej
 data.attributes.inviter-name string

nazwa osoby zapraszanej
oczekiwany czas przyjazdu
 data.attributes.expected-arrival-time string

oczekiwany czas przyjazdu
notatki prywatne
 data.attributes.private-notes string

notatki prywatne
Przybył
 data.attributes.arrived boolean

Przybył
by-here-before
 data.attributes.been-here-before boolean

by-here-before
nazwa przepływu
 data.attributes.flow-name string

nazwa przepływu
flow-id
 data.attributes.flow-id integer

flow-id
dane użytkownika
 data.attributes.user-data array of object

dane użytkownika
pole
 data.attributes.user-data.field string

pole
value
 data.attributes.user-data.value string

value
dodatkowi goście
 data.attributes.additional-guests integer

dodatkowi goście
guest-updated-at
 data.attributes.guest-updated-at string

guest-updated-at
Nda
 data.attributes.nda string

Nda
Dostępne nda
 data.attributes.nda-available boolean

Dostępne nda
original-nda-sign-date
 data.attributes.original-nda-sign-date string

original-nda-sign-date
token wpisu tajnego
 data.attributes.secret-token string

token wpisu tajnego
stan zatwierdzenia
 data.attributes.approval-status string

stan zatwierdzenia
typ
 data.relationships.entry.data.type string

typ
id
 data.relationships.entry.data.id string

id
id
 data.relationships.location.data.id string

id
typ
 data.relationships.location.data.type string

typ
typ
 data.relationships.flow.data.type string

typ
id
 data.relationships.flow.data.id string

id
typ
 data.relationships.employee.data.type string

typ
id
 data.relationships.employee.data.id string

id
typ
 data.relationships.creator.data.type string

typ
id
 data.relationships.creator.data.id string

id
Zawarte
 included array of object

Zawarte
id
 included.id string

id
typ
 included.type string

typ
pełna nazwa
 included.attributes.full-name string

pełna nazwa
e-mail
 included.attributes.email string

e-mail
numer telefonu
 included.attributes.phone-number string

numer telefonu
awatar
 included.attributes.avatar string

awatar
created-at
 included.attributes.created-at string

created-at
obsługa poczty e-mail
 included.attributes.email-enabled boolean

obsługa poczty e-mail
obsługa wiadomości SMS
 included.attributes.sms-enabled boolean

obsługa wiadomości SMS
obsługa wywołań
 included.attributes.call-enabled string

obsługa wywołań
slack-enabled
 included.attributes.slack-enabled boolean

slack-enabled
z obsługą hipchat
 included.attributes.hipchat-enabled boolean

z obsługą hipchat
obsługa wypychania
 included.attributes.push-enabled boolean

obsługa wypychania
zaproszenie z obsługą wypychania
 included.attributes.invite-push-enabled boolean

zaproszenie z obsługą wypychania
has-profile
 included.attributes.has-profile boolean

has-profile
intercom-identity-hash
 included.attributes.intercom-identity-hash string

intercom-identity-hash
Powiązane
 included.relationships.location-roles.links.related string

Powiązane
Powiązane
 included.relationships.company-roles.links.related string

Powiązane
dane
 included.relationships.emails.data array of object

dane
typ
 included.relationships.emails.data.type string

typ
id
 included.relationships.emails.data.id string

id
jaźń
 links.self string

jaźń

Tworzenie zaproszeń

Identyfikator operacji:
addInvite

Jest to żądanie POST, aby utworzyć zaproszenie

Parametry

Nazwa Klucz Wymagane Typ Opis
Typ zawartości
 Content-Type string

Typ zawartości
pełna nazwa
 full-name string

pełna nazwa
e-mail
 email string

e-mail
nazwa osoby zapraszanej
 inviter-name string

nazwa osoby zapraszanej
oczekiwany czas przyjazdu
 expected-arrival-time string

oczekiwany czas przyjazdu
reguła cykliczna
 recurring-rule string

reguła cykliczna
rrule-until
 rrule-until string

rrule-until
notatki prywatne
 private-notes string

notatki prywatne
by-here-before
 been-here-before boolean

by-here-before
dodatkowi goście
 additional-guests integer

dodatkowi goście
skip-guest-notification
 skip-guest-notification boolean

skip-guest-notification
stan umów
 agreements-status string

stan umów
identyfikator place-id
 place-id string

identyfikator place-id
nazwa przepływu
 flow-name string

nazwa przepływu
nazwa grupy
 group-name string

nazwa grupy
Przybył
 arrived boolean

Przybył
stan zatwierdzenia
 approval-status string

stan zatwierdzenia
pole
 field string

pole
value
 value string

value
typ
 type string

typ
id
 id string

id (pracownik)
typ
 type string

typ
id
 id string

id (lokalizacja)
typ
 type string

typ

Zwraca

Nazwa Ścieżka Typ Opis
id
 data.id string

id
typ
 data.type string

typ
jaźń
 data.links.self string

jaźń
dodatkowi goście
 data.attributes.additional-guests integer

dodatkowi goście
stan
 data.attributes.approval-status.status string

stan
auto_approved
 data.attributes.approval-status.auto_approved boolean

auto_approved
raport
 data.attributes.approval-status.report array of object

raport
wynik
 data.attributes.approval-status.report.result string

wynik
przesłać źródło
 data.attributes.approval-status.report.source string

przesłać źródło
blacklistReportUID
 data.attributes.approval-status.report.blacklistReportUUID string

blacklistReportUID
powód
 data.attributes.approval-status.report.reason string

powód
SMS
 data.attributes.approval-status.report.messages.failure.text string

SMS
nagłówek
 data.attributes.approval-status.report.messages.failure.header string

nagłówek
reviewer_id
 data.attributes.approval-status.reviewer_id string

reviewer_id
reviewer_name
 data.attributes.approval-status.reviewer_name string

reviewer_name
review_note
 data.attributes.approval-status.review_note string

review_note
reviewed_at
 data.attributes.approval-status.reviewed_at string

reviewed_at
e-mail
 data.attributes.email string

e-mail
oczekiwany czas przyjazdu
 data.attributes.expected-arrival-time string

oczekiwany czas przyjazdu
oczekiwany czas odlotu
 data.attributes.expected-departure-time string

oczekiwany czas odlotu
pełna nazwa
 data.attributes.full-name string

pełna nazwa
guest-updated-at
 data.attributes.guest-updated-at string

guest-updated-at
jest wstępnie podpisany
 data.attributes.is-presigned boolean

jest wstępnie podpisany
address
 data.attributes.location-info.address string

address
id
 data.attributes.location-info.id integer

id
nazwa
 data.attributes.location-info.name string

nazwa
logo_url
 data.attributes.location-info.logo_url string

logo_url
notatki prywatne
 data.attributes.private-notes string

notatki prywatne
dane użytkownika
 data.attributes.user-data array of object

dane użytkownika
data.attributes.user-data.field string

pole
data.attributes.user-data.value string

value
notify-visitor
 data.attributes.notify-visitor boolean

notify-visitor
utworzony na podstawie
 data.attributes.created-from string

utworzony na podstawie
Przybył
 data.attributes.arrived boolean

Przybył
czas bezdotykowego logowania
 data.attributes.touchless-sign-in-available-time string

czas bezdotykowego logowania
wymagane logowanie bezobsługowe
 data.attributes.touchless-sign-in-presence-required boolean

wymagane logowanie bezobsługowe
entry-signed-out-at
 data.attributes.entry-signed-out-at string

entry-signed-out-at
link wstępny do wyrejestrowania
 data.attributes.preregistration-link string

link wstępny do wyrejestrowania
created-at
 data.attributes.created-at string

created-at
zaktualizowano pod adresem
 data.attributes.updated-at string

zaktualizowano pod adresem
jaźń
 data.relationships.attendee.links.self string

jaźń
Powiązane
 data.relationships.attendee.links.related string

Powiązane
jaźń
 data.relationships.creator.links.self string

jaźń
Powiązane
 data.relationships.creator.links.related string

Powiązane
jaźń
 data.relationships.employee.links.self string

jaźń
Powiązane
 data.relationships.employee.links.related string

Powiązane
typ
 data.relationships.employee.data.type string

typ
id
 data.relationships.employee.data.id string

id
jaźń
 data.relationships.entry.links.self string

jaźń
Powiązane
 data.relationships.entry.links.related string

Powiązane
typ
 data.relationships.entry.data.type object

typ
id
 data.relationships.entry.data.id string

id
jaźń
 data.relationships.flow.links.self string

jaźń
Powiązane
 data.relationships.flow.links.related string

Powiązane
typ
 data.relationships.flow.data.type string

typ
id
 data.relationships.flow.data.id string

id
jaźń
 data.relationships.location.links.self string

jaźń
Powiązane
 data.relationships.location.links.related string

Powiązane
typ
 data.relationships.location.data.type string

typ
id
 data.relationships.location.data.id string

id
jaźń
 data.relationships.platform-jobs.links.self string

jaźń
Powiązane
 data.relationships.platform-jobs.links.related string

Powiązane

Uzyskiwanie informacji o firmie

Identyfikator operacji:
getCompanyInfo

Pobieranie informacji dotyczących firmy (GET)

Parametry

Nazwa Klucz Wymagane Typ Opis
Akceptuj
 Accept string

Akceptuj

Zwraca

Nazwa Ścieżka Typ Opis
łączny
 meta.total integer

łączny
limit
 meta.limit integer

limit
przesunąć
 meta.offset integer

przesunąć
dane
 data array of object

dane
id
 data.id string

id
typ
 data.type string

typ
nazwa
 data.attributes.name string

nazwa
plan-intent
 data.attributes.plan-intent string

plan-intent
intencja buy-intent
 data.attributes.buy-intent boolean

intencja buy-intent
obsługa wywołań
 data.attributes.call-enabled boolean

obsługa wywołań
z włączoną usługą appletv
 data.attributes.appletv-enabled boolean

z włączoną usługą appletv
saml-connected
 data.attributes.saml-connected boolean

saml-connected
aktywny
 data.attributes.active boolean

aktywny
stan synchronizacji pracowników
 data.attributes.employees-sync-state string

stan synchronizacji pracowników
dostawca synchronizacji pracowników
 data.attributes.employees-sync-provider string

dostawca synchronizacji pracowników
employees-last-sync-at
 data.attributes.employees-last-sync-at string

employees-last-sync-at
created-at
 data.attributes.created-at string

created-at
zaktualizowano pod adresem
 data.attributes.updated-at string

zaktualizowano pod adresem
stan dołączania
 data.attributes.onboarding-status string

stan dołączania
liczba lokalizacji dołączania
 data.attributes.onboarding-locations-count string

liczba lokalizacji dołączania
is-beta
 data.attributes.is-beta boolean

is-beta
adhoc-plugins
 data.attributes.adhoc-plugins array of

adhoc-plugins
cached-locations-quantity
 data.attributes.cached-locations-quantity integer

cached-locations-quantity
typ
 data.relationships.subscription.data.type string

typ
id
 data.relationships.subscription.data.id string

id
typ
 data.relationships.deliveries-subscription.data.type string

typ
id
 data.relationships.deliveries-subscription.data.id string

id
dane
 data.relationships.contracts.data array of object

dane
typ
 data.relationships.contracts.data.type string

typ
id
 data.relationships.contracts.data.id string

id
dane
 data.relationships.administrators.data array of object

dane
typ
 data.relationships.administrators.data.type string

typ
id
 data.relationships.administrators.data.id string

id
dane
 data.relationships.locations.data array of object

dane
typ
 data.relationships.locations.data.type string

typ
id
 data.relationships.locations.data.id string

id
typ
 data.relationships.saml.data.type string

typ
id
 data.relationships.saml.data.id string

id
jaźń
 links.self string

jaźń
pierwszy
 links.first string

pierwszy
last
 links.last string

last

Uzyskiwanie jednego wpisu

Identyfikator operacji:
getEntryInfoByID

Żądanie GET w celu pobrania informacji o pojedynczym wpisie.

Parametry

Nazwa Klucz Wymagane Typ Opis
entry_id
 entry_id True string

entry_id
filter[location]
 filter[location] integer

filter[location]
Akceptuj
 Accept string

Akceptuj

Zwraca

Nazwa Ścieżka Typ Opis
id
 data.id string

id
typ
 data.type string

typ
pełna nazwa
 data.attributes.full-name string

pełna nazwa
e-mail
 data.attributes.email string

e-mail
gospodarz
 data.attributes.host string

gospodarz
host-poczta e-mail
 data.attributes.host-email string

host-poczta e-mail
notatki prywatne
 data.attributes.private-notes string

notatki prywatne
signed-in-at
 data.attributes.signed-in-at string

signed-in-at
device-session-uuid
 data.attributes.device-session-uuid string

device-session-uuid
zalogowane za pośrednictwem
 data.attributes.signed-in-via string

zalogowane za pośrednictwem
signed-in-by
 data.attributes.signed-in-by string

signed-in-by
wylogowywane przez
 data.attributes.signed-out-via string

wylogowywane przez
wylogowane przez
 data.attributes.signed-out-by string

wylogowane przez
duży
 data.attributes.thumbnails.large string

duży
mały
 data.attributes.thumbnails.small string

mały
nazwa przepływu
 data.attributes.flow-name string

nazwa przepływu
original-nda-sign-date
 data.attributes.original-nda-sign-date string

original-nda-sign-date
id-check-status
 data.attributes.id-check-status string

id-check-status
is-delivery
 data.attributes.is-delivery boolean

is-delivery
odmowa umowy
 data.attributes.agreement-refused boolean

odmowa umowy
klucz pov-key
 data.attributes.pov-key string

klucz pov-key
dane użytkownika
 data.attributes.user-data array of object

dane użytkownika
pole
 data.attributes.user-data.field string

pole
value
 data.attributes.user-data.value string

value
sms-status
 data.attributes.sms-status string

sms-status
stan zatwierdzenia
 data.attributes.approval-status string

stan zatwierdzenia
stan wypychania
 data.attributes.push-status string

stan wypychania
stan wiadomości e-mail
 data.attributes.email-status string

stan wiadomości e-mail
slack-status
 data.attributes.slack-status string

slack-status
hipchat-status
 data.attributes.hipchat-status string

hipchat-status
typ
 data.relationships.location.data.type string

typ
id
 data.relationships.location.data.id string

id
typ
 data.relationships.employee.data.type string

typ
id
 data.relationships.employee.data.id string

id
typ
 data.relationships.invite.data.type string

typ
id
 data.relationships.invite.data.id string

id
typ
 data.relationships.flow.data.type string

typ
id
 data.relationships.flow.data.id string

id
Powiązane
 data.relationships.previous-entries.links.related string

Powiązane
Powiązane
 data.relationships.platform-jobs.links.related string

Powiązane
jaźń
 links.self string

jaźń

Zaktualizuj jedno zaproszenie

Identyfikator operacji:
updateInvite

ŻĄDANIE PATCH w celu zaktualizowania informacji o zaproszeniu.

Parametry

Nazwa Klucz Wymagane Typ Opis
invite_id
 invite_id True string

invite_id
Typ zawartości
 Content-Type string

Typ zawartości
id
 id string

id
pełna nazwa
 full-name string

pełna nazwa
e-mail
 email string

e-mail
nazwa osoby zapraszanej
 inviter-name string

nazwa osoby zapraszanej
oczekiwany czas przyjazdu
 expected-arrival-time string

oczekiwany czas przyjazdu (oczekiwany format: 2019-03-24T21:15:00.000Z)
reguła cykliczna
 recurring-rule string

reguła cykliczna
rrule-until
 rrule-until string

rrule-until
notatki prywatne
 private-notes string

notatki prywatne
by-here-before
 been-here-before boolean

by-here-before
dodatkowi goście
 additional-guests integer

dodatkowi goście
skip-guest-notification
 skip-guest-notification boolean

skip-guest-notification
Nda
 nda string

Nda
guest-updated-at
 guest-updated-at string

guest-updated-at (Formatowanie: 2019-03-24T21:15:00.000Z)
original-nda-sign-date
 original-nda-sign-date string

original-nda-sign-date
Dostępne nda
 nda-available boolean

Dostępne nda
nazwa przepływu
 flow-name string

nazwa przepływu
Przybył
 arrived boolean

Przybył
stan zatwierdzenia
 approval-status string

stan zatwierdzenia
pole
 field string

pole
value
 value string

value
typ
 type string

typ
id
 id string

id
typ
 type string

typ
id
 id string

id (pracownik)
typ
 type string

typ
id
 id string

id (lokalizacja)
typ
 type string

typ

Zwraca

Nazwa Ścieżka Typ Opis
id
 data.id string

id
typ
 data.type string

typ
stan umów
 data.attributes.agreements-status string

stan umów
pełna nazwa
 data.attributes.full-name string

pełna nazwa
e-mail
 data.attributes.email string

e-mail
nazwa osoby zapraszanej
 data.attributes.inviter-name string

nazwa osoby zapraszanej
wiadomość e-mail z zaproszeniem
 data.attributes.inviter-email string

wiadomość e-mail z zaproszeniem
oczekiwany czas przyjazdu
 data.attributes.expected-arrival-time string

oczekiwany czas przyjazdu
notatki prywatne
 data.attributes.private-notes string

notatki prywatne
Przybył
 data.attributes.arrived boolean

Przybył
by-here-before
 data.attributes.been-here-before boolean

by-here-before
nazwa przepływu
 data.attributes.flow-name string

nazwa przepływu
flow-id
 data.attributes.flow-id integer

flow-id
dane użytkownika
 data.attributes.user-data array of object

dane użytkownika
pole
 data.attributes.user-data.field string

pole
value
 data.attributes.user-data.value string

value
dodatkowi goście
 data.attributes.additional-guests integer

dodatkowi goście
guest-updated-at
 data.attributes.guest-updated-at string

guest-updated-at
Nda
 data.attributes.nda string

Nda
Dostępne nda
 data.attributes.nda-available boolean

Dostępne nda
original-nda-sign-date
 data.attributes.original-nda-sign-date string

original-nda-sign-date
token wpisu tajnego
 data.attributes.secret-token string

token wpisu tajnego
nazwa grupy
 data.attributes.group-name string

nazwa grupy
photo-url
 data.attributes.photo-url string

photo-url
qr-code
 data.attributes.qr-code string

qr-code
qr-code-sent-at
 data.attributes.qr-code-sent-at string

qr-code-sent-at
wstępne wyrejestrowanie
 data.attributes.preregistration-complete string

wstępne wyrejestrowanie
stan
 data.attributes.approval-status.status string

stan
automatycznie zatwierdzane
 data.attributes.approval-status.auto-approved boolean

automatycznie zatwierdzane
raport
 data.attributes.approval-status.report array of object

raport
wynik
 data.attributes.approval-status.report.result string

wynik
przesłać źródło
 data.attributes.approval-status.report.source string

przesłać źródło
blacklistReportUID
 data.attributes.approval-status.report.blacklistReportUUID string

blacklistReportUID
powód
 data.attributes.approval-status.report.reason string

powód
SMS
 data.attributes.approval-status.report.messages.failure.text string

SMS
nagłówek
 data.attributes.approval-status.report.messages.failure.header string

nagłówek
identyfikator recenzenta
 data.attributes.approval-status.reviewer-id string

identyfikator recenzenta
nazwa-recenzenta
 data.attributes.approval-status.reviewer-name string

nazwa-recenzenta
review-note
 data.attributes.approval-status.review-note string

review-note
recenzowany pod adresem
 data.attributes.approval-status.reviewed-at string

recenzowany pod adresem
typ
 data.relationships.entry.data.type string

typ
id
 data.relationships.entry.data.id string

id
id
 data.relationships.location.data.id string

id
typ
 data.relationships.location.data.type string

typ
typ
 data.relationships.flow.data.type string

typ
id
 data.relationships.flow.data.id string

id
typ
 data.relationships.employee.data.type string

typ
id
 data.relationships.employee.data.id string

id
typ
 data.relationships.creator.data.type string

typ
id
 data.relationships.creator.data.id string

id
Powiązane
 data.relationships.platform-jobs.links.related string

Powiązane
Zawarte
 included array of object

Zawarte
id
 included.id string

id
typ
 included.type string

typ
nazwa
 included.attributes.name string

nazwa
jaźń
 links.self string

jaźń

Wyzwalacze

Wyzwalacz Invite-Created

Wyzwalanie akcji w usłudze MS Flow po utworzeniu zaproszenia wysłana.

Wyzwalacz Invite-Created

Identyfikator operacji:
InviteCreated

Wyzwalanie akcji w usłudze MS Flow po utworzeniu zaproszenia wysłana.

Parametry

Nazwa Klucz Wymagane Typ Opis
kod przedpłaty
 token string

kod przedpłaty