Envoy (préversion)
Connecteur Envoy qui vous permet de connecter votre compte Envoy (nos points de terminaison d’API REST) à d’autres connecteurs. Un exemple serait de créer des invitations en bloc dans Envoy avec des détails à partir d’une feuille de calcul Microsoft Excel Online.
Ce connecteur est disponible dans les produits et régions suivants :
| Service | classe | Régions |
|---|---|---|
| Copilot Studio | Premium | Toutes les régions Power Automate , à l’exception des éléments suivants : - Us Government (GCC) - Us Government (GCC High) - China Cloud géré par 21Vianet - Us Department of Defense (DoD) |
| Applications logiques | Norme | Toutes les régions Logic Apps , à l’exception des suivantes : - Régions Azure Government - Régions Azure Chine - Us Department of Defense (DoD) |
| Power Apps | Premium | Toutes les régions Power Apps , à l’exception des suivantes : - Us Government (GCC) - Us Government (GCC High) - China Cloud géré par 21Vianet - Us Department of Defense (DoD) |
| Power Automate | Premium | Toutes les régions Power Automate , à l’exception des éléments suivants : - Us Government (GCC) - Us Government (GCC High) - China Cloud géré par 21Vianet - Us Department of Defense (DoD) |
| Contact | |
|---|---|
| Nom | Équipe du support technique Envoy |
| URL | https://envoy.help/ |
| Messagerie électronique | hi@envoy.com |
| Métadonnées du connecteur | |
|---|---|
| Éditeur | Envoy, Inc. |
| Website | https://envoy.com/ |
| Politique de confidentialité | https://envoy.com/privacypolicy/ |
| Catégories | Informatique décisionnelle; Données |
Dans la version 2.0, vous pouvez également utiliser la création d’Envoy Invite en tant que déclencheur.
Prerequisites
Pour utiliser ce connecteur, vous aurez besoin d’un compte Envoy avec nom d’utilisateur et mot de passe. Pour déclencher des fonctionnalités, vous devez également installer l’intégration d’Envoy « Microsoft Flow ».
Comment obtenir des informations d’identification
Pour vous authentifier auprès d’Envoy, vous aurez besoin de votre nom d’utilisateur et mot de passe Envoy.
Pour déclencher une fonctionnalité, vous aurez besoin du jeton d’installation fourni à l’étape 2 de la configuration de l’intégration « Microsoft Flow » dans Envoy.
Problèmes connus et limitations
Pour l’instant, le seul déclencheur disponible est La création d’invitations. Nous prévoyons d’ajouter d’autres déclencheurs dans un avenir proche.
Création d’une connexion
Le connecteur prend en charge les types d’authentification suivants :
| Par défaut | Paramètres de création de connexion. | Toutes les régions | Non partageable |
Faire défaut
Applicable : Toutes les régions
Paramètres de création de connexion.
Cette connexion n’est pas partageable. Si l’application power est partagée avec un autre utilisateur, un autre utilisateur est invité à créer une connexion explicitement.
| Nom | Type | Descriptif | Obligatoire |
|---|---|---|---|
| nom d'utilisateur | securestring | Nom d’utilisateur de cette API | Vrai |
| mot de passe | securestring | Mot de passe de cette API | Vrai |
Limitations
| Nom | Appels | Période de renouvellement |
|---|---|---|
| Appels d’API par connexion | 100 | 60 secondes |
Actions
| Ajouter un filtre de liste de blocs |
Requête POST pour ajouter un filtre de liste de blocs |
| Créer des invitations |
Il s’agit de la requête POST pour créer une invitation |
| Mettre à jour une invitation |
Demande PATCH pour mettre à jour les informations d’une invitation. |
| Obtenir des emplacements |
Demande GET pour la récupération d’emplacements |
| Obtenir des filtres de liste de blocs |
Demande GET pour récupérer des filtres de liste de blocs. |
| Obtenir des flux |
Demande GET pour récupérer des informations sur les flux de votre emplacement. |
| Obtenir des informations sur l’entreprise |
Récupérer des informations sur l’entreprise (GET) |
| Obtenir des invitations |
Demande GET pour récupérer des informations d’invitation en fonction du filtrage. |
| Obtenir la liste des employés |
Demande GET pour récupérer la liste des employés |
| Obtenir une entrée |
Demande GET pour récupérer des informations sur une seule entrée. |
| Obtenir une invitation |
Demande GET pour récupérer des informations sur une seule invitation. |
Ajouter un filtre de liste de blocs
Requête POST pour ajouter un filtre de liste de blocs
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
aliases
|
aliases | array of |
aliases |
|
|
descriptif
|
description | string |
descriptif |
|
|
e-mails
|
emails | array of string |
e-mails |
|
|
nom complet
|
full-name | string |
nom complet |
|
|
mot clé
|
keyword | string |
mot clé |
|
|
autres mots clés
|
other-keywords | array of |
autres mots clés |
|
|
reason
|
reason | string |
reason |
|
|
numéros de téléphone
|
phone-numbers | array of |
numéros de téléphone |
|
|
type
|
type | string |
type |
|
|
pièce d'identité
|
id | string |
ID (emplacement) |
|
|
type
|
type | string |
type |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
pièce d'identité
|
data.id | string |
pièce d'identité |
|
type
|
data.type | string |
type |
|
même
|
data.links.self | string |
même |
|
aliases
|
data.attributes.aliases | array of |
aliases |
|
descriptif
|
data.attributes.description | string |
descriptif |
|
e-mails
|
data.attributes.emails | array of string |
e-mails |
|
nom complet
|
data.attributes.full-name | string |
nom complet |
|
mot clé
|
data.attributes.keyword | string |
mot clé |
|
autres mots clés
|
data.attributes.other-keywords | array of |
autres mots clés |
|
numéros de téléphone
|
data.attributes.phone-numbers | array of |
numéros de téléphone |
|
Langue source
|
data.attributes.photo.original | string |
Langue source |
|
pouce
|
data.attributes.photo.thumb | string |
pouce |
|
reason
|
data.attributes.reason | string |
reason |
|
créé par
|
data.attributes.created-by | string |
créé par |
|
même
|
data.relationships.location.links.self | string |
même |
|
apparenté
|
data.relationships.location.links.related | string |
apparenté |
|
même
|
data.relationships.user.links.self | string |
même |
|
apparenté
|
data.relationships.user.links.related | string |
apparenté |
Créer des invitations
Il s’agit de la requête POST pour créer une invitation
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Type de contenu
|
Content-Type | string |
Type de contenu |
|
|
nom complet
|
full-name | string |
nom complet |
|
|
Messagerie électronique
|
string |
Messagerie électronique |
||
|
inviteur-name
|
inviter-name | string |
inviteur-name |
|
|
heure d’arrivée attendue
|
expected-arrival-time | string |
heure d’arrivée attendue |
|
|
périodique-règle
|
recurring-rule | string |
périodique-règle |
|
|
rrule-until
|
rrule-until | string |
rrule-until |
|
|
private-notes
|
private-notes | string |
private-notes |
|
|
été-ici-avant
|
been-here-before | boolean |
été-ici-avant |
|
|
invités supplémentaires
|
additional-guests | integer |
invités supplémentaires |
|
|
skip-guest-notification
|
skip-guest-notification | boolean |
skip-guest-notification |
|
|
contrats-status
|
agreements-status | string |
contrats-status |
|
|
place-id
|
place-id | string |
place-id |
|
|
flow-name
|
flow-name | string |
flow-name |
|
|
nom du groupe
|
group-name | string |
nom du groupe |
|
|
Arrivé
|
arrived | boolean |
Arrivé |
|
|
approbation-status
|
approval-status | string |
approbation-status |
|
|
field
|
field | string |
field |
|
|
value
|
value | string |
value |
|
|
type
|
type | string |
type |
|
|
pièce d'identité
|
id | string |
ID (employé) |
|
|
type
|
type | string |
type |
|
|
pièce d'identité
|
id | string |
ID (emplacement) |
|
|
type
|
type | string |
type |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
pièce d'identité
|
data.id | string |
pièce d'identité |
|
type
|
data.type | string |
type |
|
même
|
data.links.self | string |
même |
|
invités supplémentaires
|
data.attributes.additional-guests | integer |
invités supplémentaires |
|
status
|
data.attributes.approval-status.status | string |
status |
|
auto_approved
|
data.attributes.approval-status.auto_approved | boolean |
auto_approved |
|
report
|
data.attributes.approval-status.report | array of object |
report |
|
résultat
|
data.attributes.approval-status.report.result | string |
résultat |
|
Source
|
data.attributes.approval-status.report.source | string |
Source |
|
blacklistReportUUID
|
data.attributes.approval-status.report.blacklistReportUUID | string |
blacklistReportUUID |
|
reason
|
data.attributes.approval-status.report.reason | string |
reason |
|
texte
|
data.attributes.approval-status.report.messages.failure.text | string |
texte |
|
en-tête
|
data.attributes.approval-status.report.messages.failure.header | string |
en-tête |
|
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 |
|
Messagerie électronique
|
data.attributes.email | string |
Messagerie électronique |
|
heure d’arrivée attendue
|
data.attributes.expected-arrival-time | string |
heure d’arrivée attendue |
|
heure de départ prévue
|
data.attributes.expected-departure-time | string |
heure de départ prévue |
|
nom complet
|
data.attributes.full-name | string |
nom complet |
|
invité mis à jour à l’adresse
|
data.attributes.guest-updated-at | string |
invité mis à jour à l’adresse |
|
est présigné
|
data.attributes.is-presigned | boolean |
est présigné |
|
address
|
data.attributes.location-info.address | string |
address |
|
pièce d'identité
|
data.attributes.location-info.id | integer |
pièce d'identité |
|
nom
|
data.attributes.location-info.name | string |
nom |
|
logo_url
|
data.attributes.location-info.logo_url | string |
logo_url |
|
private-notes
|
data.attributes.private-notes | string |
private-notes |
|
données utilisateur
|
data.attributes.user-data | array of object |
données utilisateur |
|
|
data.attributes.user-data.field | string |
field |
|
|
data.attributes.user-data.value | string |
value |
|
notifier-visiteur
|
data.attributes.notify-visitor | boolean |
notifier-visiteur |
|
créé à partir de
|
data.attributes.created-from | string |
créé à partir de |
|
Arrivé
|
data.attributes.arrived | boolean |
Arrivé |
|
touchless-sign-in-available-time
|
data.attributes.touchless-sign-in-available-time | string |
touchless-sign-in-available-time |
|
touchless-sign-in-presence-required
|
data.attributes.touchless-sign-in-presence-required | boolean |
touchless-sign-in-presence-required |
|
entry-signed-out-at
|
data.attributes.entry-signed-out-at | string |
entry-signed-out-at |
|
preregistration-link
|
data.attributes.preregistration-link | string |
preregistration-link |
|
créé-at
|
data.attributes.created-at | string |
créé-at |
|
mise à jour à
|
data.attributes.updated-at | string |
mise à jour à |
|
même
|
data.relationships.attendee.links.self | string |
même |
|
apparenté
|
data.relationships.attendee.links.related | string |
apparenté |
|
même
|
data.relationships.creator.links.self | string |
même |
|
apparenté
|
data.relationships.creator.links.related | string |
apparenté |
|
même
|
data.relationships.employee.links.self | string |
même |
|
apparenté
|
data.relationships.employee.links.related | string |
apparenté |
|
type
|
data.relationships.employee.data.type | string |
type |
|
pièce d'identité
|
data.relationships.employee.data.id | string |
pièce d'identité |
|
même
|
data.relationships.entry.links.self | string |
même |
|
apparenté
|
data.relationships.entry.links.related | string |
apparenté |
|
type
|
data.relationships.entry.data.type | object |
type |
|
pièce d'identité
|
data.relationships.entry.data.id | string |
pièce d'identité |
|
même
|
data.relationships.flow.links.self | string |
même |
|
apparenté
|
data.relationships.flow.links.related | string |
apparenté |
|
type
|
data.relationships.flow.data.type | string |
type |
|
pièce d'identité
|
data.relationships.flow.data.id | string |
pièce d'identité |
|
même
|
data.relationships.location.links.self | string |
même |
|
apparenté
|
data.relationships.location.links.related | string |
apparenté |
|
type
|
data.relationships.location.data.type | string |
type |
|
pièce d'identité
|
data.relationships.location.data.id | string |
pièce d'identité |
|
même
|
data.relationships.platform-jobs.links.self | string |
même |
|
apparenté
|
data.relationships.platform-jobs.links.related | string |
apparenté |
Mettre à jour une invitation
Demande PATCH pour mettre à jour les informations d’une invitation.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
invite_id
|
invite_id | True | string |
invite_id |
|
Type de contenu
|
Content-Type | string |
Type de contenu |
|
|
pièce d'identité
|
id | string |
pièce d'identité |
|
|
nom complet
|
full-name | string |
nom complet |
|
|
Messagerie électronique
|
string |
Messagerie électronique |
||
|
inviteur-name
|
inviter-name | string |
inviteur-name |
|
|
heure d’arrivée attendue
|
expected-arrival-time | string |
heure d’arrivée attendue (Format attendu : 2019-03-24T21:15:00.000Z) |
|
|
périodique-règle
|
recurring-rule | string |
périodique-règle |
|
|
rrule-until
|
rrule-until | string |
rrule-until |
|
|
private-notes
|
private-notes | string |
private-notes |
|
|
été-ici-avant
|
been-here-before | boolean |
été-ici-avant |
|
|
invités supplémentaires
|
additional-guests | integer |
invités supplémentaires |
|
|
skip-guest-notification
|
skip-guest-notification | boolean |
skip-guest-notification |
|
|
nda
|
nda | string |
nda |
|
|
invité mis à jour à l’adresse
|
guest-updated-at | string |
guest-updated-at (Mise en forme : 2019-03-24T21:15:00.000Z) |
|
|
original-nda-sign-date
|
original-nda-sign-date | string |
original-nda-sign-date |
|
|
nda-available
|
nda-available | boolean |
nda-available |
|
|
flow-name
|
flow-name | string |
flow-name |
|
|
Arrivé
|
arrived | boolean |
Arrivé |
|
|
approbation-status
|
approval-status | string |
approbation-status |
|
|
field
|
field | string |
field |
|
|
value
|
value | string |
value |
|
|
type
|
type | string |
type |
|
|
pièce d'identité
|
id | string |
pièce d'identité |
|
|
type
|
type | string |
type |
|
|
pièce d'identité
|
id | string |
ID (employé) |
|
|
type
|
type | string |
type |
|
|
pièce d'identité
|
id | string |
ID (emplacement) |
|
|
type
|
type | string |
type |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
pièce d'identité
|
data.id | string |
pièce d'identité |
|
type
|
data.type | string |
type |
|
contrats-status
|
data.attributes.agreements-status | string |
contrats-status |
|
nom complet
|
data.attributes.full-name | string |
nom complet |
|
Messagerie électronique
|
data.attributes.email | string |
Messagerie électronique |
|
inviteur-name
|
data.attributes.inviter-name | string |
inviteur-name |
|
inviter-email
|
data.attributes.inviter-email | string |
inviter-email |
|
heure d’arrivée attendue
|
data.attributes.expected-arrival-time | string |
heure d’arrivée attendue |
|
private-notes
|
data.attributes.private-notes | string |
private-notes |
|
Arrivé
|
data.attributes.arrived | boolean |
Arrivé |
|
été-ici-avant
|
data.attributes.been-here-before | boolean |
été-ici-avant |
|
flow-name
|
data.attributes.flow-name | string |
flow-name |
|
flow-id
|
data.attributes.flow-id | integer |
flow-id |
|
données utilisateur
|
data.attributes.user-data | array of object |
données utilisateur |
|
field
|
data.attributes.user-data.field | string |
field |
|
value
|
data.attributes.user-data.value | string |
value |
|
invités supplémentaires
|
data.attributes.additional-guests | integer |
invités supplémentaires |
|
invité mis à jour à l’adresse
|
data.attributes.guest-updated-at | string |
invité mis à jour à l’adresse |
|
nda
|
data.attributes.nda | string |
nda |
|
nda-available
|
data.attributes.nda-available | boolean |
nda-available |
|
original-nda-sign-date
|
data.attributes.original-nda-sign-date | string |
original-nda-sign-date |
|
secret-token
|
data.attributes.secret-token | string |
secret-token |
|
nom du groupe
|
data.attributes.group-name | string |
nom du groupe |
|
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 |
|
preregistration-complete
|
data.attributes.preregistration-complete | string |
preregistration-complete |
|
status
|
data.attributes.approval-status.status | string |
status |
|
approuvé automatiquement
|
data.attributes.approval-status.auto-approved | boolean |
approuvé automatiquement |
|
report
|
data.attributes.approval-status.report | array of object |
report |
|
résultat
|
data.attributes.approval-status.report.result | string |
résultat |
|
Source
|
data.attributes.approval-status.report.source | string |
Source |
|
blacklistReportUUID
|
data.attributes.approval-status.report.blacklistReportUUID | string |
blacklistReportUUID |
|
reason
|
data.attributes.approval-status.report.reason | string |
reason |
|
texte
|
data.attributes.approval-status.report.messages.failure.text | string |
texte |
|
en-tête
|
data.attributes.approval-status.report.messages.failure.header | string |
en-tête |
|
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 |
|
révision-at
|
data.attributes.approval-status.reviewed-at | string |
révision-at |
|
type
|
data.relationships.entry.data.type | string |
type |
|
pièce d'identité
|
data.relationships.entry.data.id | string |
pièce d'identité |
|
pièce d'identité
|
data.relationships.location.data.id | string |
pièce d'identité |
|
type
|
data.relationships.location.data.type | string |
type |
|
type
|
data.relationships.flow.data.type | string |
type |
|
pièce d'identité
|
data.relationships.flow.data.id | string |
pièce d'identité |
|
type
|
data.relationships.employee.data.type | string |
type |
|
pièce d'identité
|
data.relationships.employee.data.id | string |
pièce d'identité |
|
type
|
data.relationships.creator.data.type | string |
type |
|
pièce d'identité
|
data.relationships.creator.data.id | string |
pièce d'identité |
|
apparenté
|
data.relationships.platform-jobs.links.related | string |
apparenté |
|
inclus
|
included | array of object |
inclus |
|
pièce d'identité
|
included.id | string |
pièce d'identité |
|
type
|
included.type | string |
type |
|
nom
|
included.attributes.name | string |
nom |
|
même
|
links.self | string |
même |
Obtenir des emplacements
Demande GET pour la récupération d’emplacements
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Accept
|
Accept | string |
Accept |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
données
|
data | array of object |
données |
|
pièce d'identité
|
data.id | string |
pièce d'identité |
|
type
|
data.type | string |
type |
|
même
|
data.links.self | string |
même |
|
address
|
data.attributes.address | string |
address |
|
address-line-one
|
data.attributes.address-line-one | string |
address-line-one |
|
address-line-two
|
data.attributes.address-line-two | string |
address-line-two |
|
déconnexion automatique à minuit
|
data.attributes.auto-sign-out-at-midnight | boolean |
déconnexion automatique à minuit |
|
déconnexion automatique-minutes
|
data.attributes.auto-sign-out-minutes | string |
déconnexion automatique-minutes |
|
city
|
data.attributes.city | string |
city |
|
company-name-override
|
data.attributes.company-name-override | string |
company-name-override |
|
handicapé
|
data.attributes.disabled | boolean |
handicapé |
|
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 |
|
notifications de secours activée
|
data.attributes.fallback-notifications-enabled | boolean |
notifications de secours activée |
|
préinscription requise
|
data.attributes.pre-registration-required-enabled | boolean |
préinscription requise |
|
latitude
|
data.attributes.latitude | float |
latitude |
|
paramètres régionaux
|
data.attributes.locale | string |
paramètres régionaux |
|
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 |
|
longitude
|
data.attributes.longitude | float |
longitude |
|
nom
|
data.attributes.name | string |
nom |
|
printer-notifications-enabled
|
data.attributes.printer-notifications-enabled | boolean |
printer-notifications-enabled |
|
plusieurs langues activées
|
data.attributes.multiple-languages-enabled | boolean |
plusieurs langues activées |
|
paramètres régionaux activés
|
data.attributes.enabled-locales | array of |
paramètres régionaux activés |
|
état
|
data.attributes.state | string |
état |
|
timezone
|
data.attributes.timezone | string |
timezone |
|
fichier ZIP
|
data.attributes.zip | string |
fichier ZIP |
|
visiteurs mensuels moyens
|
data.attributes.average-monthly-visitors | float |
visiteurs mensuels moyens |
|
créé-at
|
data.attributes.created-at | string |
créé-at |
|
last-entry-at
|
data.attributes.last-entry-at | string |
last-entry-at |
|
mise à jour à
|
data.attributes.updated-at | string |
mise à jour à |
|
même
|
data.relationships.company.links.self | string |
même |
|
apparenté
|
data.relationships.company.links.related | string |
apparenté |
|
même
|
data.relationships.device-config.links.self | string |
même |
|
apparenté
|
data.relationships.device-config.links.related | string |
apparenté |
|
même
|
data.relationships.gdpr-configuration.links.self | string |
même |
|
apparenté
|
data.relationships.gdpr-configuration.links.related | string |
apparenté |
|
même
|
data.relationships.printer.links.self | string |
même |
|
apparenté
|
data.relationships.printer.links.related | string |
apparenté |
|
même
|
data.relationships.devices.links.self | string |
même |
|
apparenté
|
data.relationships.devices.links.related | string |
apparenté |
|
même
|
data.relationships.employees.links.self | string |
même |
|
apparenté
|
data.relationships.employees.links.related | string |
apparenté |
|
même
|
data.relationships.fallback-contacts.links.self | string |
même |
|
apparenté
|
data.relationships.fallback-contacts.links.related | string |
apparenté |
|
même
|
data.relationships.flows.links.self | string |
même |
|
apparenté
|
data.relationships.flows.links.related | string |
apparenté |
|
même
|
data.relationships.locations-setup-guide-steps.links.self | string |
même |
|
apparenté
|
data.relationships.locations-setup-guide-steps.links.related | string |
apparenté |
|
même
|
data.relationships.printers.links.self | string |
même |
|
apparenté
|
data.relationships.printers.links.related | string |
apparenté |
|
même
|
data.relationships.printer-contacts.links.self | string |
même |
|
apparenté
|
data.relationships.printer-contacts.links.related | string |
apparenté |
|
total
|
meta.total | integer |
total |
|
premier
|
links.first | string |
premier |
|
last
|
links.last | string |
last |
Obtenir des filtres de liste de blocs
Demande GET pour récupérer des filtres de liste de blocs.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
filter[company]
|
filter[company] | integer |
filter[company] |
|
|
Type de contenu
|
Content-Type | string |
Type de contenu |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
données
|
data | array of object |
données |
|
pièce d'identité
|
data.id | string |
pièce d'identité |
|
type
|
data.type | string |
type |
|
même
|
data.links.self | string |
même |
|
aliases
|
data.attributes.aliases | array of |
aliases |
|
descriptif
|
data.attributes.description | string |
descriptif |
|
e-mails
|
data.attributes.emails | array of string |
e-mails |
|
nom complet
|
data.attributes.full-name | string |
nom complet |
|
mot clé
|
data.attributes.keyword | string |
mot clé |
|
autres mots clés
|
data.attributes.other-keywords | array of string |
autres mots clés |
|
numéros de téléphone
|
data.attributes.phone-numbers | array of |
numéros de téléphone |
|
Langue source
|
data.attributes.photo.original | string |
Langue source |
|
pouce
|
data.attributes.photo.thumb | string |
pouce |
|
reason
|
data.attributes.reason | string |
reason |
|
image-url
|
data.attributes.image-url | string |
image-url |
|
external-id
|
data.attributes.external-id | string |
external-id |
|
créé par
|
data.attributes.created-by | string |
créé par |
|
même
|
data.relationships.location.links.self | string |
même |
|
apparenté
|
data.relationships.location.links.related | string |
apparenté |
|
même
|
data.relationships.user.links.self | string |
même |
|
apparenté
|
data.relationships.user.links.related | string |
apparenté |
|
total
|
meta.total | integer |
total |
Obtenir des flux
Demande GET pour récupérer des informations sur les flux de votre emplacement.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
filter[location]
|
filter[location] | integer |
filter[location] |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
données
|
data | array of object |
données |
|
pièce d'identité
|
data.id | string |
pièce d'identité |
|
type
|
data.type | string |
type |
|
même
|
data.links.self | string |
même |
|
invités supplémentaires
|
data.attributes.additional-guests | boolean |
invités supplémentaires |
|
déconnexion automatique-minutes
|
data.attributes.auto-sign-out-minutes | string |
déconnexion automatique-minutes |
|
déconnexion automatique à minuit
|
data.attributes.auto-sign-out-at-midnight | boolean |
déconnexion automatique à minuit |
|
badge activé
|
data.attributes.badge-enabled | boolean |
badge activé |
|
enabled
|
data.attributes.enabled | boolean |
enabled |
|
id-check
|
data.attributes.id-check | boolean |
id-check |
|
ipad-localized-names
|
data.attributes.ipad-localized-names | array of object |
ipad-localized-names |
|
langage-code
|
data.attributes.ipad-localized-names.language-code | string |
langage-code |
|
region-code
|
data.attributes.ipad-localized-names.region-code | string |
region-code |
|
nom complet
|
data.attributes.ipad-localized-names.display-name | string |
nom complet |
|
nom
|
data.attributes.name | string |
nom |
|
position
|
data.attributes.position | integer |
position |
|
use-existing-photo
|
data.attributes.use-existing-photo | boolean |
use-existing-photo |
|
créé-at
|
data.attributes.created-at | string |
créé-at |
|
mise à jour à
|
data.attributes.updated-at | string |
mise à jour à |
|
même
|
data.relationships.agreement-page.links.self | string |
même |
|
apparenté
|
data.relationships.agreement-page.links.related | string |
apparenté |
|
même
|
data.relationships.badge.links.self | string |
même |
|
apparenté
|
data.relationships.badge.links.related | string |
apparenté |
|
même
|
data.relationships.location.links.self | string |
même |
|
apparenté
|
data.relationships.location.links.related | string |
apparenté |
|
même
|
data.relationships.photo-page.links.self | string |
même |
|
apparenté
|
data.relationships.photo-page.links.related | string |
apparenté |
|
même
|
data.relationships.sign-in-field-page.links.self | string |
même |
|
apparenté
|
data.relationships.sign-in-field-page.links.related | string |
apparenté |
|
même
|
data.relationships.summary-page.links.self | string |
même |
|
apparenté
|
data.relationships.summary-page.links.related | string |
apparenté |
|
total
|
meta.total | integer |
total |
|
premier
|
links.first | string |
premier |
|
last
|
links.last | string |
last |
Obtenir des informations sur l’entreprise
Récupérer des informations sur l’entreprise (GET)
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Accept
|
Accept | string |
Accept |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
total
|
meta.total | integer |
total |
|
limit
|
meta.limit | integer |
limit |
|
offset
|
meta.offset | integer |
offset |
|
données
|
data | array of object |
données |
|
pièce d'identité
|
data.id | string |
pièce d'identité |
|
type
|
data.type | string |
type |
|
nom
|
data.attributes.name | string |
nom |
|
plan-intention
|
data.attributes.plan-intent | string |
plan-intention |
|
buy-intent
|
data.attributes.buy-intent | boolean |
buy-intent |
|
activé pour l’appel
|
data.attributes.call-enabled | boolean |
activé pour l’appel |
|
appletv-enabled
|
data.attributes.appletv-enabled | boolean |
appletv-enabled |
|
saml-connected
|
data.attributes.saml-connected | boolean |
saml-connected |
|
active
|
data.attributes.active | boolean |
active |
|
employees-sync-state
|
data.attributes.employees-sync-state | string |
employees-sync-state |
|
employees-sync-provider
|
data.attributes.employees-sync-provider | string |
employees-sync-provider |
|
employés-last-sync-at
|
data.attributes.employees-last-sync-at | string |
employés-last-sync-at |
|
créé-at
|
data.attributes.created-at | string |
créé-at |
|
mise à jour à
|
data.attributes.updated-at | string |
mise à jour à |
|
intégration-état
|
data.attributes.onboarding-status | string |
intégration-état |
|
onboarding-locations-count
|
data.attributes.onboarding-locations-count | string |
onboarding-locations-count |
|
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 |
|
type
|
data.relationships.subscription.data.type | string |
type |
|
pièce d'identité
|
data.relationships.subscription.data.id | string |
pièce d'identité |
|
type
|
data.relationships.deliveries-subscription.data.type | string |
type |
|
pièce d'identité
|
data.relationships.deliveries-subscription.data.id | string |
pièce d'identité |
|
données
|
data.relationships.contracts.data | array of object |
données |
|
type
|
data.relationships.contracts.data.type | string |
type |
|
pièce d'identité
|
data.relationships.contracts.data.id | string |
pièce d'identité |
|
données
|
data.relationships.administrators.data | array of object |
données |
|
type
|
data.relationships.administrators.data.type | string |
type |
|
pièce d'identité
|
data.relationships.administrators.data.id | string |
pièce d'identité |
|
données
|
data.relationships.locations.data | array of object |
données |
|
type
|
data.relationships.locations.data.type | string |
type |
|
pièce d'identité
|
data.relationships.locations.data.id | string |
pièce d'identité |
|
type
|
data.relationships.saml.data.type | string |
type |
|
pièce d'identité
|
data.relationships.saml.data.id | string |
pièce d'identité |
|
même
|
links.self | string |
même |
|
premier
|
links.first | string |
premier |
|
last
|
links.last | string |
last |
Obtenir des invitations
Demande GET pour récupérer des informations d’invitation en fonction du filtrage.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
filter[location]
|
filter[location] | integer |
filter[location] |
|
|
filter[date]
|
filter[date] | string |
filter[date] |
|
|
Accept
|
Accept | string |
Accept |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
données
|
data | array of object |
données |
|
pièce d'identité
|
data.id | string |
pièce d'identité |
|
type
|
data.type | string |
type |
|
même
|
data.links.self | string |
même |
|
invités supplémentaires
|
data.attributes.additional-guests | integer |
invités supplémentaires |
|
status
|
data.attributes.approval-status.status | string |
status |
|
auto_approved
|
data.attributes.approval-status.auto_approved | boolean |
auto_approved |
|
report
|
data.attributes.approval-status.report | array of object |
report |
|
résultat
|
data.attributes.approval-status.report.result | string |
résultat |
|
Source
|
data.attributes.approval-status.report.source | string |
Source |
|
blacklistReportUUID
|
data.attributes.approval-status.report.blacklistReportUUID | string |
blacklistReportUUID |
|
reason
|
data.attributes.approval-status.report.reason | string |
reason |
|
texte
|
data.attributes.approval-status.report.messages.failure.text | string |
texte |
|
en-tête
|
data.attributes.approval-status.report.messages.failure.header | string |
en-tête |
|
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 |
|
Messagerie électronique
|
data.attributes.email | string |
Messagerie électronique |
|
heure d’arrivée attendue
|
data.attributes.expected-arrival-time | string |
heure d’arrivée attendue |
|
heure de départ prévue
|
data.attributes.expected-departure-time | string |
heure de départ prévue |
|
nom complet
|
data.attributes.full-name | string |
nom complet |
|
invité mis à jour à l’adresse
|
data.attributes.guest-updated-at | string |
invité mis à jour à l’adresse |
|
est présigné
|
data.attributes.is-presigned | boolean |
est présigné |
|
address
|
data.attributes.location-info.address | string |
address |
|
pièce d'identité
|
data.attributes.location-info.id | integer |
pièce d'identité |
|
nom
|
data.attributes.location-info.name | string |
nom |
|
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 |
|
private-notes
|
data.attributes.private-notes | string |
private-notes |
|
données utilisateur
|
data.attributes.user-data | array of object |
données utilisateur |
|
field
|
data.attributes.user-data.field | string |
field |
|
value
|
data.attributes.user-data.value | string |
value |
|
notifier-visiteur
|
data.attributes.notify-visitor | boolean |
notifier-visiteur |
|
créé à partir de
|
data.attributes.created-from | string |
créé à partir de |
|
place_id
|
data.attributes.locality.place_id | string |
place_id |
|
place-id
|
data.attributes.locality.place-id | string |
place-id |
|
Arrivé
|
data.attributes.arrived | boolean |
Arrivé |
|
touchless-sign-in-available-time
|
data.attributes.touchless-sign-in-available-time | string |
touchless-sign-in-available-time |
|
touchless-sign-in-presence-required
|
data.attributes.touchless-sign-in-presence-required | boolean |
touchless-sign-in-presence-required |
|
entry-signed-out-at
|
data.attributes.entry-signed-out-at | string |
entry-signed-out-at |
|
attesté
|
data.attributes.attested | string |
attesté |
|
phone
|
data.attributes.phone | string |
phone |
|
preregistration-link
|
data.attributes.preregistration-link | string |
preregistration-link |
|
preregistration-status-link
|
data.attributes.preregistration-status-link | string |
preregistration-status-link |
|
rappel envoyé-at
|
data.attributes.reminder-sent-at | string |
rappel envoyé-at |
|
créé-at
|
data.attributes.created-at | string |
créé-at |
|
mise à jour à
|
data.attributes.updated-at | string |
mise à jour à |
|
même
|
data.relationships.attendee.links.self | string |
même |
|
apparenté
|
data.relationships.attendee.links.related | string |
apparenté |
|
même
|
data.relationships.creator.links.self | string |
même |
|
apparenté
|
data.relationships.creator.links.related | string |
apparenté |
|
même
|
data.relationships.employee.links.self | string |
même |
|
apparenté
|
data.relationships.employee.links.related | string |
apparenté |
|
type
|
data.relationships.employee.data.type | string |
type |
|
pièce d'identité
|
data.relationships.employee.data.id | string |
pièce d'identité |
|
même
|
data.relationships.entry.links.self | string |
même |
|
apparenté
|
data.relationships.entry.links.related | string |
apparenté |
|
type
|
data.relationships.entry.data.type | string |
type |
|
pièce d'identité
|
data.relationships.entry.data.id | string |
pièce d'identité |
|
même
|
data.relationships.flow.links.self | string |
même |
|
apparenté
|
data.relationships.flow.links.related | string |
apparenté |
|
type
|
data.relationships.flow.data.type | string |
type |
|
pièce d'identité
|
data.relationships.flow.data.id | string |
pièce d'identité |
|
même
|
data.relationships.location.links.self | string |
même |
|
apparenté
|
data.relationships.location.links.related | string |
apparenté |
|
type
|
data.relationships.location.data.type | string |
type |
|
pièce d'identité
|
data.relationships.location.data.id | string |
pièce d'identité |
|
même
|
data.relationships.platform-jobs.links.self | string |
même |
|
apparenté
|
data.relationships.platform-jobs.links.related | string |
apparenté |
|
total
|
meta.total | integer |
total |
|
premier
|
links.first | string |
premier |
|
prochain
|
links.next | string |
prochain |
|
last
|
links.last | string |
last |
Obtenir la liste des employés
Demande GET pour récupérer la liste des employés
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
données
|
data | array of object |
données |
|
pièce d'identité
|
data.id | string |
pièce d'identité |
|
type
|
data.type | string |
type |
|
même
|
data.links.self | string |
même |
|
cc-employee
|
data.attributes.cc-employee | boolean |
cc-employee |
|
company-id
|
data.attributes.company-id | integer |
company-id |
|
supprimé
|
data.attributes.deleted | boolean |
supprimé |
|
ne pas synchroniser
|
data.attributes.do-not-sync | boolean |
ne pas synchroniser |
|
Messagerie électronique
|
data.attributes.email | string |
Messagerie électronique |
|
hide-from-host-list
|
data.attributes.hide-from-host-list | boolean |
hide-from-host-list |
|
ajout manuel
|
data.attributes.manually-added | boolean |
ajout manuel |
|
ajout manuel-location-present
|
data.attributes.manually-added-location-present | boolean |
ajout manuel-location-present |
|
nom
|
data.attributes.name | string |
nom |
|
numéro de téléphone
|
data.attributes.phone-number | string |
numéro de téléphone |
|
créé-at
|
data.attributes.created-at | string |
créé-at |
|
supprimé à
|
data.attributes.deleted-at | string |
supprimé à |
|
mise à jour à
|
data.attributes.updated-at | string |
mise à jour à |
|
même
|
data.relationships.company.links.self | string |
même |
|
apparenté
|
data.relationships.company.links.related | string |
apparenté |
|
même
|
data.relationships.user.links.self | string |
même |
|
apparenté
|
data.relationships.user.links.related | string |
apparenté |
|
même
|
data.relationships.assistants.links.self | string |
même |
|
apparenté
|
data.relationships.assistants.links.related | string |
apparenté |
|
même
|
data.relationships.bosses.links.self | string |
même |
|
apparenté
|
data.relationships.bosses.links.related | string |
apparenté |
|
même
|
data.relationships.employee-locations.links.self | string |
même |
|
apparenté
|
data.relationships.employee-locations.links.related | string |
apparenté |
|
même
|
data.relationships.locations.links.self | string |
même |
|
apparenté
|
data.relationships.locations.links.related | string |
apparenté |
|
total
|
meta.total | integer |
total |
|
premier
|
links.first | string |
premier |
|
last
|
links.last | string |
last |
Obtenir une entrée
Demande GET pour récupérer des informations sur une seule entrée.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
entry_id
|
entry_id | True | string |
entry_id |
|
filter[location]
|
filter[location] | integer |
filter[location] |
|
|
Accept
|
Accept | string |
Accept |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
pièce d'identité
|
data.id | string |
pièce d'identité |
|
type
|
data.type | string |
type |
|
nom complet
|
data.attributes.full-name | string |
nom complet |
|
Messagerie électronique
|
data.attributes.email | string |
Messagerie électronique |
|
host
|
data.attributes.host | string |
host |
|
host-email
|
data.attributes.host-email | string |
host-email |
|
private-notes
|
data.attributes.private-notes | string |
private-notes |
|
signé -in-at
|
data.attributes.signed-in-at | string |
signé -in-at |
|
device-session-uuid
|
data.attributes.device-session-uuid | string |
device-session-uuid |
|
connecté via
|
data.attributes.signed-in-via | string |
connecté via |
|
signé -in-by
|
data.attributes.signed-in-by | string |
signé -in-by |
|
déconnexion via
|
data.attributes.signed-out-via | string |
déconnexion via |
|
déconnecté par
|
data.attributes.signed-out-by | string |
déconnecté par |
|
grand
|
data.attributes.thumbnails.large | string |
grand |
|
petit
|
data.attributes.thumbnails.small | string |
petit |
|
flow-name
|
data.attributes.flow-name | string |
flow-name |
|
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 |
|
livraison
|
data.attributes.is-delivery | boolean |
livraison |
|
accord refusé
|
data.attributes.agreement-refused | boolean |
accord refusé |
|
pov-key
|
data.attributes.pov-key | string |
pov-key |
|
données utilisateur
|
data.attributes.user-data | array of object |
données utilisateur |
|
field
|
data.attributes.user-data.field | string |
field |
|
value
|
data.attributes.user-data.value | string |
value |
|
sms-status
|
data.attributes.sms-status | string |
sms-status |
|
approbation-status
|
data.attributes.approval-status | string |
approbation-status |
|
État push
|
data.attributes.push-status | string |
État push |
|
email-status
|
data.attributes.email-status | string |
email-status |
|
slack-status
|
data.attributes.slack-status | string |
slack-status |
|
hipchat-status
|
data.attributes.hipchat-status | string |
hipchat-status |
|
type
|
data.relationships.location.data.type | string |
type |
|
pièce d'identité
|
data.relationships.location.data.id | string |
pièce d'identité |
|
type
|
data.relationships.employee.data.type | string |
type |
|
pièce d'identité
|
data.relationships.employee.data.id | string |
pièce d'identité |
|
type
|
data.relationships.invite.data.type | string |
type |
|
pièce d'identité
|
data.relationships.invite.data.id | string |
pièce d'identité |
|
type
|
data.relationships.flow.data.type | string |
type |
|
pièce d'identité
|
data.relationships.flow.data.id | string |
pièce d'identité |
|
apparenté
|
data.relationships.previous-entries.links.related | string |
apparenté |
|
apparenté
|
data.relationships.platform-jobs.links.related | string |
apparenté |
|
même
|
links.self | string |
même |
Obtenir une invitation
Demande GET pour récupérer des informations sur une seule invitation.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
invite_id
|
invite_id | True | string |
invite_id |
|
Accept
|
Accept | string |
Accept |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
pièce d'identité
|
data.id | string |
pièce d'identité |
|
type
|
data.type | string |
type |
|
nom complet
|
data.attributes.full-name | string |
nom complet |
|
Messagerie électronique
|
data.attributes.email | string |
Messagerie électronique |
|
inviteur-name
|
data.attributes.inviter-name | string |
inviteur-name |
|
heure d’arrivée attendue
|
data.attributes.expected-arrival-time | string |
heure d’arrivée attendue |
|
private-notes
|
data.attributes.private-notes | string |
private-notes |
|
Arrivé
|
data.attributes.arrived | boolean |
Arrivé |
|
été-ici-avant
|
data.attributes.been-here-before | boolean |
été-ici-avant |
|
flow-name
|
data.attributes.flow-name | string |
flow-name |
|
flow-id
|
data.attributes.flow-id | integer |
flow-id |
|
données utilisateur
|
data.attributes.user-data | array of object |
données utilisateur |
|
field
|
data.attributes.user-data.field | string |
field |
|
value
|
data.attributes.user-data.value | string |
value |
|
invités supplémentaires
|
data.attributes.additional-guests | integer |
invités supplémentaires |
|
invité mis à jour à l’adresse
|
data.attributes.guest-updated-at | string |
invité mis à jour à l’adresse |
|
nda
|
data.attributes.nda | string |
nda |
|
nda-available
|
data.attributes.nda-available | boolean |
nda-available |
|
original-nda-sign-date
|
data.attributes.original-nda-sign-date | string |
original-nda-sign-date |
|
secret-token
|
data.attributes.secret-token | string |
secret-token |
|
approbation-status
|
data.attributes.approval-status | string |
approbation-status |
|
type
|
data.relationships.entry.data.type | string |
type |
|
pièce d'identité
|
data.relationships.entry.data.id | string |
pièce d'identité |
|
pièce d'identité
|
data.relationships.location.data.id | string |
pièce d'identité |
|
type
|
data.relationships.location.data.type | string |
type |
|
type
|
data.relationships.flow.data.type | string |
type |
|
pièce d'identité
|
data.relationships.flow.data.id | string |
pièce d'identité |
|
type
|
data.relationships.employee.data.type | string |
type |
|
pièce d'identité
|
data.relationships.employee.data.id | string |
pièce d'identité |
|
type
|
data.relationships.creator.data.type | string |
type |
|
pièce d'identité
|
data.relationships.creator.data.id | string |
pièce d'identité |
|
inclus
|
included | array of object |
inclus |
|
pièce d'identité
|
included.id | string |
pièce d'identité |
|
type
|
included.type | string |
type |
|
nom complet
|
included.attributes.full-name | string |
nom complet |
|
Messagerie électronique
|
included.attributes.email | string |
Messagerie électronique |
|
numéro de téléphone
|
included.attributes.phone-number | string |
numéro de téléphone |
|
avatar
|
included.attributes.avatar | string |
avatar |
|
créé-at
|
included.attributes.created-at | string |
créé-at |
|
e-mail activé
|
included.attributes.email-enabled | boolean |
e-mail activé |
|
sms activé
|
included.attributes.sms-enabled | boolean |
sms activé |
|
activé pour l’appel
|
included.attributes.call-enabled | string |
activé pour l’appel |
|
slack-enabled
|
included.attributes.slack-enabled | boolean |
slack-enabled |
|
hipchat-enabled
|
included.attributes.hipchat-enabled | boolean |
hipchat-enabled |
|
Activé par envoi (push)
|
included.attributes.push-enabled | boolean |
Activé par envoi (push) |
|
invite-push activée
|
included.attributes.invite-push-enabled | boolean |
invite-push activée |
|
has-profile
|
included.attributes.has-profile | boolean |
has-profile |
|
intercom-identity-hash
|
included.attributes.intercom-identity-hash | string |
intercom-identity-hash |
|
apparenté
|
included.relationships.location-roles.links.related | string |
apparenté |
|
apparenté
|
included.relationships.company-roles.links.related | string |
apparenté |
|
données
|
included.relationships.emails.data | array of object |
données |
|
type
|
included.relationships.emails.data.type | string |
type |
|
pièce d'identité
|
included.relationships.emails.data.id | string |
pièce d'identité |
|
même
|
links.self | string |
même |
Déclencheurs
| déclencheur Invite-Created |
Déclenchez une action dans MS Flow lors de la création d’une invitation Envoy. |
déclencheur Invite-Created
Déclenchez une action dans MS Flow lors de la création d’une invitation Envoy.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
token
|
token | string |
token |