Envoy (предварительная версия)
Соединитель Envoy, позволяющий подключать учетную запись Envoy (конечные точки REST API) к любым другим соединителям. Примером будет создание массовых приглашений в Envoy с подробными сведениями из электронной таблицы Microsoft Excel Online.
Этот соединитель доступен в следующих продуктах и регионах:
| Услуга | Class | Регионы |
|---|---|---|
| Copilot Studio | Премия | Все регионы Power Automate , кроме следующих: - Правительство США (GCC) - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet - Министерство обороны США (DoD) |
| Логические приложения | Стандарт | Все регионы Logic Apps , кроме следующих: — Регионы Azure для государственных организаций — Регионы Azure Для Китая - Министерство обороны США (DoD) |
| Power Apps | Премия | Все регионы Power Apps , кроме следующих: - Правительство США (GCC) - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet - Министерство обороны США (DoD) |
| Power Automate | Премия | Все регионы Power Automate , кроме следующих: - Правительство США (GCC) - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet - Министерство обороны США (DoD) |
| Контакт | |
|---|---|
| Имя | Группа поддержки Envoy |
| URL | https://envoy.help/ |
| Адрес электронной почты | hi@envoy.com |
| Метаданные соединителя | |
|---|---|
| Publisher | Envoy, Inc. |
| Website | https://envoy.com/ |
| Политика конфиденциальности | https://envoy.com/privacypolicy/ |
| Категории | Бизнес-аналитика; Данные |
В версии 2.0 вы также можете использовать создание приглашения Envoy в качестве триггера.
Предпосылки
Чтобы использовать этот соединитель, вам потребуется учетная запись Envoy с именем пользователя и паролем. Для активации функций также потребуется установить интеграцию Envoy "Microsoft Flow".
Получение учетных данных
Чтобы пройти проверку подлинности в Envoy, вам потребуется имя пользователя и пароль Envoy.
Для активации функциональной функциональности вам потребуется маркер установки, предоставленный вам во время шага 2 установки интеграции Microsoft Flow в Envoy.
Известные проблемы и ограничения
В настоящее время единственным триггером является создание приглашения. Мы ожидаем добавить дополнительные триггеры в ближайшее время.
Создание подключения
Соединитель поддерживает следующие типы проверки подлинности:
| По умолчанию | Параметры для создания подключения. | Все регионы | Недоступен для совместного использования |
По умолчанию
Применимо: все регионы
Параметры для создания подключения.
Это недоступно для общего доступа. Если приложение power предоставляется другому пользователю, пользователю будет предложено явно создать новое подключение.
| Имя | Тип | Description | Обязательно |
|---|---|---|---|
| username | securestring | Имя пользователя для этого API | True |
| пароль | securestring | Пароль для этого API | True |
Ограничения регулирования
| Имя | Вызовы | Период обновления |
|---|---|---|
| Вызовы API для каждого подключения | 100 | 60 секунд |
Действия
| Добавление фильтра списка блокировок |
Запрос POST для добавления фильтра блок-списка |
| Обновление одного приглашения |
Запрос PATCH для обновления сведений о приглашении. |
| Получение одного приглашения |
ЗАПРОС GET для получения сведений об одном приглашении. |
| Получение одной записи |
ЗАПРОС GET для получения сведений об одной записи. |
| Получение потоков |
ЗАПРОС GET для получения сведений о потоках для вашего расположения. |
| Получение приглашений |
Запрос GET для получения сведений о приглашении на основе фильтрации. |
| Получение расположений |
Запрос GET для получения расположений |
| Получение сведений о компании |
Получение сведений о компании (GET) |
| Получение списка сотрудников |
ЗАПРОС GET для получения списка сотрудников |
| Получение фильтров блок-списка |
ЗАПРОС GET для получения фильтров списка блоков. |
| Создание приглашений |
Это запрос POST для создания приглашения |
Добавление фильтра списка блокировок
Запрос POST для добавления фильтра блок-списка
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
псевдонимы
|
aliases | array of |
псевдонимы |
|
|
описание
|
description | string |
описание |
|
|
сообщения электронной почты
|
emails | array of string |
сообщения электронной почты |
|
|
полное имя
|
full-name | string |
полное имя |
|
|
ключевое слово
|
keyword | string |
ключевое слово |
|
|
другие ключевые слова
|
other-keywords | array of |
другие ключевые слова |
|
|
причина
|
reason | string |
причина |
|
|
номера телефонов
|
phone-numbers | array of |
номера телефонов |
|
|
type
|
type | string |
type |
|
|
id
|
id | string |
id (location) |
|
|
type
|
type | string |
type |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
id
|
data.id | string |
id |
|
type
|
data.type | string |
type |
|
сам
|
data.links.self | string |
сам |
|
псевдонимы
|
data.attributes.aliases | array of |
псевдонимы |
|
описание
|
data.attributes.description | string |
описание |
|
сообщения электронной почты
|
data.attributes.emails | array of string |
сообщения электронной почты |
|
полное имя
|
data.attributes.full-name | string |
полное имя |
|
ключевое слово
|
data.attributes.keyword | string |
ключевое слово |
|
другие ключевые слова
|
data.attributes.other-keywords | array of |
другие ключевые слова |
|
номера телефонов
|
data.attributes.phone-numbers | array of |
номера телефонов |
|
Исходный текст
|
data.attributes.photo.original | string |
Исходный текст |
|
большой палец
|
data.attributes.photo.thumb | string |
большой палец |
|
причина
|
data.attributes.reason | string |
причина |
|
создано по
|
data.attributes.created-by | string |
создано по |
|
сам
|
data.relationships.location.links.self | string |
сам |
|
родственный
|
data.relationships.location.links.related | string |
родственный |
|
сам
|
data.relationships.user.links.self | string |
сам |
|
родственный
|
data.relationships.user.links.related | string |
родственный |
Обновление одного приглашения
Запрос PATCH для обновления сведений о приглашении.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
invite_id
|
invite_id | True | string |
invite_id |
|
Тип контента
|
Content-Type | string |
Тип контента |
|
|
id
|
id | string |
id |
|
|
полное имя
|
full-name | string |
полное имя |
|
|
электронная почта
|
string |
электронная почта |
||
|
inviter-name
|
inviter-name | string |
inviter-name |
|
|
ожидаемое время прибытия
|
expected-arrival-time | string |
ожидаемое время прибытия (ожидаемый формат: 2019-03-24T21:15:00.000Z) |
|
|
повторяющееся правило
|
recurring-rule | string |
повторяющееся правило |
|
|
rrule-до
|
rrule-until | string |
rrule-до |
|
|
приватные заметки
|
private-notes | string |
приватные заметки |
|
|
были здесь-раньше
|
been-here-before | boolean |
были здесь-раньше |
|
|
дополнительные гости
|
additional-guests | integer |
дополнительные гости |
|
|
skip-guest-notification
|
skip-guest-notification | boolean |
skip-guest-notification |
|
|
nda
|
nda | string |
nda |
|
|
гостевая обновленная версия
|
guest-updated-at | string |
гостевая обновленная версия (форматирование: 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 | string |
имя потока |
|
|
прибыл
|
arrived | boolean |
прибыл |
|
|
состояние утверждения
|
approval-status | string |
состояние утверждения |
|
|
поле
|
field | string |
поле |
|
|
value
|
value | string |
value |
|
|
type
|
type | string |
type |
|
|
id
|
id | string |
id |
|
|
type
|
type | string |
type |
|
|
id
|
id | string |
id (employee) |
|
|
type
|
type | string |
type |
|
|
id
|
id | string |
id (location) |
|
|
type
|
type | string |
type |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
id
|
data.id | string |
id |
|
type
|
data.type | string |
type |
|
состояние соглашений
|
data.attributes.agreements-status | string |
состояние соглашений |
|
полное имя
|
data.attributes.full-name | string |
полное имя |
|
электронная почта
|
data.attributes.email | string |
электронная почта |
|
inviter-name
|
data.attributes.inviter-name | string |
inviter-name |
|
inviter-email
|
data.attributes.inviter-email | string |
inviter-email |
|
ожидаемое время прибытия
|
data.attributes.expected-arrival-time | string |
ожидаемое время прибытия |
|
приватные заметки
|
data.attributes.private-notes | string |
приватные заметки |
|
прибыл
|
data.attributes.arrived | boolean |
прибыл |
|
были здесь-раньше
|
data.attributes.been-here-before | boolean |
были здесь-раньше |
|
имя потока
|
data.attributes.flow-name | string |
имя потока |
|
flow-id
|
data.attributes.flow-id | integer |
flow-id |
|
пользовательские данные
|
data.attributes.user-data | array of object |
пользовательские данные |
|
поле
|
data.attributes.user-data.field | string |
поле |
|
value
|
data.attributes.user-data.value | string |
value |
|
дополнительные гости
|
data.attributes.additional-guests | integer |
дополнительные гости |
|
гостевая обновленная версия
|
data.attributes.guest-updated-at | string |
гостевая обновленная версия |
|
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 |
|
секретный маркер
|
data.attributes.secret-token | string |
секретный маркер |
|
имя группы
|
data.attributes.group-name | string |
имя группы |
|
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 |
|
предварительная регистрация— завершение
|
data.attributes.preregistration-complete | string |
предварительная регистрация— завершение |
|
статус
|
data.attributes.approval-status.status | string |
статус |
|
автозаверждён
|
data.attributes.approval-status.auto-approved | boolean |
автозаверждён |
|
report
|
data.attributes.approval-status.report | array of object |
report |
|
результат
|
data.attributes.approval-status.report.result | string |
результат |
|
source
|
data.attributes.approval-status.report.source | string |
source |
|
черный списокReportUUID
|
data.attributes.approval-status.report.blacklistReportUUID | string |
черный списокReportUUID |
|
причина
|
data.attributes.approval-status.report.reason | string |
причина |
|
текст
|
data.attributes.approval-status.report.messages.failure.text | string |
текст |
|
верхний колонтитул
|
data.attributes.approval-status.report.messages.failure.header | string |
верхний колонтитул |
|
рецензент-id
|
data.attributes.approval-status.reviewer-id | string |
рецензент-id |
|
рецензент-имя
|
data.attributes.approval-status.reviewer-name | string |
рецензент-имя |
|
примечание к обзору
|
data.attributes.approval-status.review-note | string |
примечание к обзору |
|
рецензируемый
|
data.attributes.approval-status.reviewed-at | string |
рецензируемый |
|
type
|
data.relationships.entry.data.type | string |
type |
|
id
|
data.relationships.entry.data.id | string |
id |
|
id
|
data.relationships.location.data.id | string |
id |
|
type
|
data.relationships.location.data.type | string |
type |
|
type
|
data.relationships.flow.data.type | string |
type |
|
id
|
data.relationships.flow.data.id | string |
id |
|
type
|
data.relationships.employee.data.type | string |
type |
|
id
|
data.relationships.employee.data.id | string |
id |
|
type
|
data.relationships.creator.data.type | string |
type |
|
id
|
data.relationships.creator.data.id | string |
id |
|
родственный
|
data.relationships.platform-jobs.links.related | string |
родственный |
|
включенный
|
included | array of object |
включенный |
|
id
|
included.id | string |
id |
|
type
|
included.type | string |
type |
|
имя
|
included.attributes.name | string |
имя |
|
сам
|
links.self | string |
сам |
Получение одного приглашения
ЗАПРОС GET для получения сведений об одном приглашении.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
invite_id
|
invite_id | True | string |
invite_id |
|
Принять
|
Accept | string |
Принять |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
id
|
data.id | string |
id |
|
type
|
data.type | string |
type |
|
полное имя
|
data.attributes.full-name | string |
полное имя |
|
электронная почта
|
data.attributes.email | string |
электронная почта |
|
inviter-name
|
data.attributes.inviter-name | string |
inviter-name |
|
ожидаемое время прибытия
|
data.attributes.expected-arrival-time | string |
ожидаемое время прибытия |
|
приватные заметки
|
data.attributes.private-notes | string |
приватные заметки |
|
прибыл
|
data.attributes.arrived | boolean |
прибыл |
|
были здесь-раньше
|
data.attributes.been-here-before | boolean |
были здесь-раньше |
|
имя потока
|
data.attributes.flow-name | string |
имя потока |
|
flow-id
|
data.attributes.flow-id | integer |
flow-id |
|
пользовательские данные
|
data.attributes.user-data | array of object |
пользовательские данные |
|
поле
|
data.attributes.user-data.field | string |
поле |
|
value
|
data.attributes.user-data.value | string |
value |
|
дополнительные гости
|
data.attributes.additional-guests | integer |
дополнительные гости |
|
гостевая обновленная версия
|
data.attributes.guest-updated-at | string |
гостевая обновленная версия |
|
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 |
|
секретный маркер
|
data.attributes.secret-token | string |
секретный маркер |
|
состояние утверждения
|
data.attributes.approval-status | string |
состояние утверждения |
|
type
|
data.relationships.entry.data.type | string |
type |
|
id
|
data.relationships.entry.data.id | string |
id |
|
id
|
data.relationships.location.data.id | string |
id |
|
type
|
data.relationships.location.data.type | string |
type |
|
type
|
data.relationships.flow.data.type | string |
type |
|
id
|
data.relationships.flow.data.id | string |
id |
|
type
|
data.relationships.employee.data.type | string |
type |
|
id
|
data.relationships.employee.data.id | string |
id |
|
type
|
data.relationships.creator.data.type | string |
type |
|
id
|
data.relationships.creator.data.id | string |
id |
|
включенный
|
included | array of object |
включенный |
|
id
|
included.id | string |
id |
|
type
|
included.type | string |
type |
|
полное имя
|
included.attributes.full-name | string |
полное имя |
|
электронная почта
|
included.attributes.email | string |
электронная почта |
|
номер телефона
|
included.attributes.phone-number | string |
номер телефона |
|
аватар
|
included.attributes.avatar | string |
аватар |
|
created-at
|
included.attributes.created-at | string |
created-at |
|
Включена электронная почта
|
included.attributes.email-enabled | boolean |
Включена электронная почта |
|
с поддержкой sms
|
included.attributes.sms-enabled | boolean |
с поддержкой sms |
|
Включен вызов
|
included.attributes.call-enabled | string |
Включен вызов |
|
slack-enabled
|
included.attributes.slack-enabled | boolean |
slack-enabled |
|
hipchat-enabled
|
included.attributes.hipchat-enabled | boolean |
hipchat-enabled |
|
включение push-уведомлений
|
included.attributes.push-enabled | boolean |
включение push-уведомлений |
|
Включение push-отправки приглашений
|
included.attributes.invite-push-enabled | boolean |
Включение push-отправки приглашений |
|
has-profile
|
included.attributes.has-profile | boolean |
has-profile |
|
intercom-identity-hash
|
included.attributes.intercom-identity-hash | string |
intercom-identity-hash |
|
родственный
|
included.relationships.location-roles.links.related | string |
родственный |
|
родственный
|
included.relationships.company-roles.links.related | string |
родственный |
|
данные
|
included.relationships.emails.data | array of object |
данные |
|
type
|
included.relationships.emails.data.type | string |
type |
|
id
|
included.relationships.emails.data.id | string |
id |
|
сам
|
links.self | string |
сам |
Получение одной записи
ЗАПРОС GET для получения сведений об одной записи.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
entry_id
|
entry_id | True | string |
entry_id |
|
filter[location]
|
filter[location] | integer |
filter[location] |
|
|
Принять
|
Accept | string |
Принять |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
id
|
data.id | string |
id |
|
type
|
data.type | string |
type |
|
полное имя
|
data.attributes.full-name | string |
полное имя |
|
электронная почта
|
data.attributes.email | string |
электронная почта |
|
host
|
data.attributes.host | string |
host |
|
host-email
|
data.attributes.host-email | string |
host-email |
|
приватные заметки
|
data.attributes.private-notes | string |
приватные заметки |
|
подписанныйin-at
|
data.attributes.signed-in-at | string |
подписанныйin-at |
|
device-session-uuid
|
data.attributes.device-session-uuid | string |
device-session-uuid |
|
Вход с помощью
|
data.attributes.signed-in-via | string |
Вход с помощью |
|
подписанныйin-by
|
data.attributes.signed-in-by | string |
подписанныйin-by |
|
выходить через
|
data.attributes.signed-out-via | string |
выходить через |
|
Выйдя из-за
|
data.attributes.signed-out-by | string |
Выйдя из-за |
|
большой
|
data.attributes.thumbnails.large | string |
большой |
|
маленький
|
data.attributes.thumbnails.small | string |
маленький |
|
имя потока
|
data.attributes.flow-name | string |
имя потока |
|
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 |
|
соглашение отказано
|
data.attributes.agreement-refused | boolean |
соглашение отказано |
|
pov-key
|
data.attributes.pov-key | string |
pov-key |
|
пользовательские данные
|
data.attributes.user-data | array of object |
пользовательские данные |
|
поле
|
data.attributes.user-data.field | string |
поле |
|
value
|
data.attributes.user-data.value | string |
value |
|
sms-status
|
data.attributes.sms-status | string |
sms-status |
|
состояние утверждения
|
data.attributes.approval-status | string |
состояние утверждения |
|
Состояние push-отправки
|
data.attributes.push-status | string |
Состояние push-отправки |
|
Состояние электронной почты
|
data.attributes.email-status | string |
Состояние электронной почты |
|
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 |
|
id
|
data.relationships.location.data.id | string |
id |
|
type
|
data.relationships.employee.data.type | string |
type |
|
id
|
data.relationships.employee.data.id | string |
id |
|
type
|
data.relationships.invite.data.type | string |
type |
|
id
|
data.relationships.invite.data.id | string |
id |
|
type
|
data.relationships.flow.data.type | string |
type |
|
id
|
data.relationships.flow.data.id | string |
id |
|
родственный
|
data.relationships.previous-entries.links.related | string |
родственный |
|
родственный
|
data.relationships.platform-jobs.links.related | string |
родственный |
|
сам
|
links.self | string |
сам |
Получение потоков
ЗАПРОС GET для получения сведений о потоках для вашего расположения.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
filter[location]
|
filter[location] | integer |
filter[location] |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
данные
|
data | array of object |
данные |
|
id
|
data.id | string |
id |
|
type
|
data.type | string |
type |
|
сам
|
data.links.self | string |
сам |
|
дополнительные гости
|
data.attributes.additional-guests | boolean |
дополнительные гости |
|
Автоматическое выход в минуты
|
data.attributes.auto-sign-out-minutes | string |
Автоматическое выход в минуты |
|
auto-sign-out-at-midnight
|
data.attributes.auto-sign-out-at-midnight | boolean |
auto-sign-out-at-midnight |
|
эмблема с поддержкой
|
data.attributes.badge-enabled | boolean |
эмблема с поддержкой |
|
enabled
|
data.attributes.enabled | boolean |
enabled |
|
проверка идентификатора
|
data.attributes.id-check | boolean |
проверка идентификатора |
|
ipad-localized-name
|
data.attributes.ipad-localized-names | array of object |
ipad-localized-name |
|
язык-код
|
data.attributes.ipad-localized-names.language-code | string |
язык-код |
|
код региона
|
data.attributes.ipad-localized-names.region-code | string |
код региона |
|
отображаемое имя
|
data.attributes.ipad-localized-names.display-name | string |
отображаемое имя |
|
имя
|
data.attributes.name | string |
имя |
|
позиция
|
data.attributes.position | integer |
позиция |
|
использование существующей фотографии
|
data.attributes.use-existing-photo | boolean |
использование существующей фотографии |
|
created-at
|
data.attributes.created-at | string |
created-at |
|
обновлено
|
data.attributes.updated-at | string |
обновлено |
|
сам
|
data.relationships.agreement-page.links.self | string |
сам |
|
родственный
|
data.relationships.agreement-page.links.related | string |
родственный |
|
сам
|
data.relationships.badge.links.self | string |
сам |
|
родственный
|
data.relationships.badge.links.related | string |
родственный |
|
сам
|
data.relationships.location.links.self | string |
сам |
|
родственный
|
data.relationships.location.links.related | string |
родственный |
|
сам
|
data.relationships.photo-page.links.self | string |
сам |
|
родственный
|
data.relationships.photo-page.links.related | string |
родственный |
|
сам
|
data.relationships.sign-in-field-page.links.self | string |
сам |
|
родственный
|
data.relationships.sign-in-field-page.links.related | string |
родственный |
|
сам
|
data.relationships.summary-page.links.self | string |
сам |
|
родственный
|
data.relationships.summary-page.links.related | string |
родственный |
|
итог
|
meta.total | integer |
итог |
|
первый
|
links.first | string |
первый |
|
последний
|
links.last | string |
последний |
Получение приглашений
Запрос GET для получения сведений о приглашении на основе фильтрации.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
filter[location]
|
filter[location] | integer |
filter[location] |
|
|
filter[date]
|
filter[date] | string |
filter[date] |
|
|
Принять
|
Accept | string |
Принять |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
данные
|
data | array of object |
данные |
|
id
|
data.id | string |
id |
|
type
|
data.type | string |
type |
|
сам
|
data.links.self | string |
сам |
|
дополнительные гости
|
data.attributes.additional-guests | integer |
дополнительные гости |
|
статус
|
data.attributes.approval-status.status | string |
статус |
|
auto_approved
|
data.attributes.approval-status.auto_approved | boolean |
auto_approved |
|
report
|
data.attributes.approval-status.report | array of object |
report |
|
результат
|
data.attributes.approval-status.report.result | string |
результат |
|
source
|
data.attributes.approval-status.report.source | string |
source |
|
черный списокReportUUID
|
data.attributes.approval-status.report.blacklistReportUUID | string |
черный списокReportUUID |
|
причина
|
data.attributes.approval-status.report.reason | string |
причина |
|
текст
|
data.attributes.approval-status.report.messages.failure.text | string |
текст |
|
верхний колонтитул
|
data.attributes.approval-status.report.messages.failure.header | string |
верхний колонтитул |
|
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 |
|
электронная почта
|
data.attributes.email | string |
электронная почта |
|
ожидаемое время прибытия
|
data.attributes.expected-arrival-time | string |
ожидаемое время прибытия |
|
ожидаемое время отъезда
|
data.attributes.expected-departure-time | string |
ожидаемое время отъезда |
|
полное имя
|
data.attributes.full-name | string |
полное имя |
|
гостевая обновленная версия
|
data.attributes.guest-updated-at | string |
гостевая обновленная версия |
|
is-presigned
|
data.attributes.is-presigned | boolean |
is-presigned |
|
address
|
data.attributes.location-info.address | string |
address |
|
id
|
data.attributes.location-info.id | integer |
id |
|
имя
|
data.attributes.location-info.name | string |
имя |
|
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 |
|
приватные заметки
|
data.attributes.private-notes | string |
приватные заметки |
|
пользовательские данные
|
data.attributes.user-data | array of object |
пользовательские данные |
|
поле
|
data.attributes.user-data.field | string |
поле |
|
value
|
data.attributes.user-data.value | string |
value |
|
notify-visitor
|
data.attributes.notify-visitor | boolean |
notify-visitor |
|
создано из
|
data.attributes.created-from | string |
создано из |
|
place_id
|
data.attributes.locality.place_id | string |
place_id |
|
идентификатор place-id
|
data.attributes.locality.place-id | string |
идентификатор place-id |
|
прибыл
|
data.attributes.arrived | boolean |
прибыл |
|
сенсорный вход в доступное время
|
data.attributes.touchless-sign-in-available-time | string |
сенсорный вход в доступное время |
|
требуется сенсорный вход в систему
|
data.attributes.touchless-sign-in-presence-required | boolean |
требуется сенсорный вход в систему |
|
entry-out-out-at
|
data.attributes.entry-signed-out-at | string |
entry-out-out-at |
|
аттестация
|
data.attributes.attested | string |
аттестация |
|
phone
|
data.attributes.phone | string |
phone |
|
preregistration-link
|
data.attributes.preregistration-link | string |
preregistration-link |
|
пререгистрация-status-link
|
data.attributes.preregistration-status-link | string |
пререгистрация-status-link |
|
напоминания отправляемые
|
data.attributes.reminder-sent-at | string |
напоминания отправляемые |
|
created-at
|
data.attributes.created-at | string |
created-at |
|
обновлено
|
data.attributes.updated-at | string |
обновлено |
|
сам
|
data.relationships.attendee.links.self | string |
сам |
|
родственный
|
data.relationships.attendee.links.related | string |
родственный |
|
сам
|
data.relationships.creator.links.self | string |
сам |
|
родственный
|
data.relationships.creator.links.related | string |
родственный |
|
сам
|
data.relationships.employee.links.self | string |
сам |
|
родственный
|
data.relationships.employee.links.related | string |
родственный |
|
type
|
data.relationships.employee.data.type | string |
type |
|
id
|
data.relationships.employee.data.id | string |
id |
|
сам
|
data.relationships.entry.links.self | string |
сам |
|
родственный
|
data.relationships.entry.links.related | string |
родственный |
|
type
|
data.relationships.entry.data.type | string |
type |
|
id
|
data.relationships.entry.data.id | string |
id |
|
сам
|
data.relationships.flow.links.self | string |
сам |
|
родственный
|
data.relationships.flow.links.related | string |
родственный |
|
type
|
data.relationships.flow.data.type | string |
type |
|
id
|
data.relationships.flow.data.id | string |
id |
|
сам
|
data.relationships.location.links.self | string |
сам |
|
родственный
|
data.relationships.location.links.related | string |
родственный |
|
type
|
data.relationships.location.data.type | string |
type |
|
id
|
data.relationships.location.data.id | string |
id |
|
сам
|
data.relationships.platform-jobs.links.self | string |
сам |
|
родственный
|
data.relationships.platform-jobs.links.related | string |
родственный |
|
итог
|
meta.total | integer |
итог |
|
первый
|
links.first | string |
первый |
|
next
|
links.next | string |
next |
|
последний
|
links.last | string |
последний |
Получение расположений
Запрос GET для получения расположений
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Принять
|
Accept | string |
Принять |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
данные
|
data | array of object |
данные |
|
id
|
data.id | string |
id |
|
type
|
data.type | string |
type |
|
сам
|
data.links.self | string |
сам |
|
address
|
data.attributes.address | string |
address |
|
address-line-one
|
data.attributes.address-line-one | string |
address-line-one |
|
адресная строка-два
|
data.attributes.address-line-two | string |
адресная строка-два |
|
auto-sign-out-at-midnight
|
data.attributes.auto-sign-out-at-midnight | boolean |
auto-sign-out-at-midnight |
|
Автоматическое выход в минуты
|
data.attributes.auto-sign-out-minutes | string |
Автоматическое выход в минуты |
|
city
|
data.attributes.city | string |
city |
|
переопределение имени компании
|
data.attributes.company-name-override | string |
переопределение имени компании |
|
disabled
|
data.attributes.disabled | boolean |
disabled |
|
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 |
|
функция резервного уведомления с поддержкой
|
data.attributes.fallback-notifications-enabled | boolean |
функция резервного уведомления с поддержкой |
|
предварительная регистрация с поддержкой
|
data.attributes.pre-registration-required-enabled | boolean |
предварительная регистрация с поддержкой |
|
широта
|
data.attributes.latitude | float |
широта |
|
местность
|
data.attributes.locale | string |
местность |
|
url-адрес с логотипом small-url
|
data.attributes.logo-small-url | string |
url-адрес с логотипом small-url |
|
URL-адрес логотипа
|
data.attributes.logo-thumb-url | string |
URL-адрес логотипа |
|
URL-адрес логотипа
|
data.attributes.logo-url | string |
URL-адрес логотипа |
|
долгота
|
data.attributes.longitude | float |
долгота |
|
имя
|
data.attributes.name | string |
имя |
|
С поддержкой принтеров-уведомлений
|
data.attributes.printer-notifications-enabled | boolean |
С поддержкой принтеров-уведомлений |
|
С поддержкой нескольких языков
|
data.attributes.multiple-languages-enabled | boolean |
С поддержкой нескольких языков |
|
Языковые параметры с поддержкой
|
data.attributes.enabled-locales | array of |
Языковые параметры с поддержкой |
|
государство
|
data.attributes.state | string |
государство |
|
timezone
|
data.attributes.timezone | string |
timezone |
|
ZIP-архив
|
data.attributes.zip | string |
ZIP-архив |
|
среднее ежемесячное число посетителей
|
data.attributes.average-monthly-visitors | float |
среднее ежемесячное число посетителей |
|
created-at
|
data.attributes.created-at | string |
created-at |
|
last-entry-at
|
data.attributes.last-entry-at | string |
last-entry-at |
|
обновлено
|
data.attributes.updated-at | string |
обновлено |
|
сам
|
data.relationships.company.links.self | string |
сам |
|
родственный
|
data.relationships.company.links.related | string |
родственный |
|
сам
|
data.relationships.device-config.links.self | string |
сам |
|
родственный
|
data.relationships.device-config.links.related | string |
родственный |
|
сам
|
data.relationships.gdpr-configuration.links.self | string |
сам |
|
родственный
|
data.relationships.gdpr-configuration.links.related | string |
родственный |
|
сам
|
data.relationships.printer.links.self | string |
сам |
|
родственный
|
data.relationships.printer.links.related | string |
родственный |
|
сам
|
data.relationships.devices.links.self | string |
сам |
|
родственный
|
data.relationships.devices.links.related | string |
родственный |
|
сам
|
data.relationships.employees.links.self | string |
сам |
|
родственный
|
data.relationships.employees.links.related | string |
родственный |
|
сам
|
data.relationships.fallback-contacts.links.self | string |
сам |
|
родственный
|
data.relationships.fallback-contacts.links.related | string |
родственный |
|
сам
|
data.relationships.flows.links.self | string |
сам |
|
родственный
|
data.relationships.flows.links.related | string |
родственный |
|
сам
|
data.relationships.locations-setup-guide-steps.links.self | string |
сам |
|
родственный
|
data.relationships.locations-setup-guide-steps.links.related | string |
родственный |
|
сам
|
data.relationships.printers.links.self | string |
сам |
|
родственный
|
data.relationships.printers.links.related | string |
родственный |
|
сам
|
data.relationships.printer-contacts.links.self | string |
сам |
|
родственный
|
data.relationships.printer-contacts.links.related | string |
родственный |
|
итог
|
meta.total | integer |
итог |
|
первый
|
links.first | string |
первый |
|
последний
|
links.last | string |
последний |
Получение сведений о компании
Получение сведений о компании (GET)
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Принять
|
Accept | string |
Принять |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
итог
|
meta.total | integer |
итог |
|
limit
|
meta.limit | integer |
limit |
|
offset
|
meta.offset | integer |
offset |
|
данные
|
data | array of object |
данные |
|
id
|
data.id | string |
id |
|
type
|
data.type | string |
type |
|
имя
|
data.attributes.name | string |
имя |
|
намерение плана
|
data.attributes.plan-intent | string |
намерение плана |
|
намерение покупки
|
data.attributes.buy-intent | boolean |
намерение покупки |
|
Включен вызов
|
data.attributes.call-enabled | boolean |
Включен вызов |
|
appletv-enabled
|
data.attributes.appletv-enabled | boolean |
appletv-enabled |
|
saml-connected
|
data.attributes.saml-connected | boolean |
saml-connected |
|
активный
|
data.attributes.active | boolean |
активный |
|
employees-sync-state
|
data.attributes.employees-sync-state | string |
employees-sync-state |
|
employees-sync-provider
|
data.attributes.employees-sync-provider | string |
employees-sync-provider |
|
employees-last-sync-at
|
data.attributes.employees-last-sync-at | string |
employees-last-sync-at |
|
created-at
|
data.attributes.created-at | string |
created-at |
|
обновлено
|
data.attributes.updated-at | string |
обновлено |
|
Состояние подключения
|
data.attributes.onboarding-status | string |
Состояние подключения |
|
подключение -locations-count
|
data.attributes.onboarding-locations-count | string |
подключение -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 |
|
id
|
data.relationships.subscription.data.id | string |
id |
|
type
|
data.relationships.deliveries-subscription.data.type | string |
type |
|
id
|
data.relationships.deliveries-subscription.data.id | string |
id |
|
данные
|
data.relationships.contracts.data | array of object |
данные |
|
type
|
data.relationships.contracts.data.type | string |
type |
|
id
|
data.relationships.contracts.data.id | string |
id |
|
данные
|
data.relationships.administrators.data | array of object |
данные |
|
type
|
data.relationships.administrators.data.type | string |
type |
|
id
|
data.relationships.administrators.data.id | string |
id |
|
данные
|
data.relationships.locations.data | array of object |
данные |
|
type
|
data.relationships.locations.data.type | string |
type |
|
id
|
data.relationships.locations.data.id | string |
id |
|
type
|
data.relationships.saml.data.type | string |
type |
|
id
|
data.relationships.saml.data.id | string |
id |
|
сам
|
links.self | string |
сам |
|
первый
|
links.first | string |
первый |
|
последний
|
links.last | string |
последний |
Получение списка сотрудников
ЗАПРОС GET для получения списка сотрудников
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
данные
|
data | array of object |
данные |
|
id
|
data.id | string |
id |
|
type
|
data.type | string |
type |
|
сам
|
data.links.self | string |
сам |
|
cc-employee
|
data.attributes.cc-employee | boolean |
cc-employee |
|
идентификатор компании
|
data.attributes.company-id | integer |
идентификатор компании |
|
удалено
|
data.attributes.deleted | boolean |
удалено |
|
do-not-sync
|
data.attributes.do-not-sync | boolean |
do-not-sync |
|
электронная почта
|
data.attributes.email | string |
электронная почта |
|
hide-from-host-list
|
data.attributes.hide-from-host-list | boolean |
hide-from-host-list |
|
Добавление вручную
|
data.attributes.manually-added | boolean |
Добавление вручную |
|
добавление вручную-location-present
|
data.attributes.manually-added-location-present | boolean |
добавление вручную-location-present |
|
имя
|
data.attributes.name | string |
имя |
|
номер телефона
|
data.attributes.phone-number | string |
номер телефона |
|
created-at
|
data.attributes.created-at | string |
created-at |
|
deleted-at
|
data.attributes.deleted-at | string |
deleted-at |
|
обновлено
|
data.attributes.updated-at | string |
обновлено |
|
сам
|
data.relationships.company.links.self | string |
сам |
|
родственный
|
data.relationships.company.links.related | string |
родственный |
|
сам
|
data.relationships.user.links.self | string |
сам |
|
родственный
|
data.relationships.user.links.related | string |
родственный |
|
сам
|
data.relationships.assistants.links.self | string |
сам |
|
родственный
|
data.relationships.assistants.links.related | string |
родственный |
|
сам
|
data.relationships.bosses.links.self | string |
сам |
|
родственный
|
data.relationships.bosses.links.related | string |
родственный |
|
сам
|
data.relationships.employee-locations.links.self | string |
сам |
|
родственный
|
data.relationships.employee-locations.links.related | string |
родственный |
|
сам
|
data.relationships.locations.links.self | string |
сам |
|
родственный
|
data.relationships.locations.links.related | string |
родственный |
|
итог
|
meta.total | integer |
итог |
|
первый
|
links.first | string |
первый |
|
последний
|
links.last | string |
последний |
Получение фильтров блок-списка
ЗАПРОС GET для получения фильтров списка блоков.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
filter[company]
|
filter[company] | integer |
filter[company] |
|
|
Тип контента
|
Content-Type | string |
Тип контента |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
данные
|
data | array of object |
данные |
|
id
|
data.id | string |
id |
|
type
|
data.type | string |
type |
|
сам
|
data.links.self | string |
сам |
|
псевдонимы
|
data.attributes.aliases | array of |
псевдонимы |
|
описание
|
data.attributes.description | string |
описание |
|
сообщения электронной почты
|
data.attributes.emails | array of string |
сообщения электронной почты |
|
полное имя
|
data.attributes.full-name | string |
полное имя |
|
ключевое слово
|
data.attributes.keyword | string |
ключевое слово |
|
другие ключевые слова
|
data.attributes.other-keywords | array of string |
другие ключевые слова |
|
номера телефонов
|
data.attributes.phone-numbers | array of |
номера телефонов |
|
Исходный текст
|
data.attributes.photo.original | string |
Исходный текст |
|
большой палец
|
data.attributes.photo.thumb | string |
большой палец |
|
причина
|
data.attributes.reason | string |
причина |
|
image-url
|
data.attributes.image-url | string |
image-url |
|
external-id
|
data.attributes.external-id | string |
external-id |
|
создано по
|
data.attributes.created-by | string |
создано по |
|
сам
|
data.relationships.location.links.self | string |
сам |
|
родственный
|
data.relationships.location.links.related | string |
родственный |
|
сам
|
data.relationships.user.links.self | string |
сам |
|
родственный
|
data.relationships.user.links.related | string |
родственный |
|
итог
|
meta.total | integer |
итог |
Создание приглашений
Это запрос POST для создания приглашения
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Тип контента
|
Content-Type | string |
Тип контента |
|
|
полное имя
|
full-name | string |
полное имя |
|
|
электронная почта
|
string |
электронная почта |
||
|
inviter-name
|
inviter-name | string |
inviter-name |
|
|
ожидаемое время прибытия
|
expected-arrival-time | string |
ожидаемое время прибытия |
|
|
повторяющееся правило
|
recurring-rule | string |
повторяющееся правило |
|
|
rrule-до
|
rrule-until | string |
rrule-до |
|
|
приватные заметки
|
private-notes | string |
приватные заметки |
|
|
были здесь-раньше
|
been-here-before | boolean |
были здесь-раньше |
|
|
дополнительные гости
|
additional-guests | integer |
дополнительные гости |
|
|
skip-guest-notification
|
skip-guest-notification | boolean |
skip-guest-notification |
|
|
состояние соглашений
|
agreements-status | string |
состояние соглашений |
|
|
идентификатор place-id
|
place-id | string |
идентификатор place-id |
|
|
имя потока
|
flow-name | string |
имя потока |
|
|
имя группы
|
group-name | string |
имя группы |
|
|
прибыл
|
arrived | boolean |
прибыл |
|
|
состояние утверждения
|
approval-status | string |
состояние утверждения |
|
|
поле
|
field | string |
поле |
|
|
value
|
value | string |
value |
|
|
type
|
type | string |
type |
|
|
id
|
id | string |
id (employee) |
|
|
type
|
type | string |
type |
|
|
id
|
id | string |
id (location) |
|
|
type
|
type | string |
type |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
id
|
data.id | string |
id |
|
type
|
data.type | string |
type |
|
сам
|
data.links.self | string |
сам |
|
дополнительные гости
|
data.attributes.additional-guests | integer |
дополнительные гости |
|
статус
|
data.attributes.approval-status.status | string |
статус |
|
auto_approved
|
data.attributes.approval-status.auto_approved | boolean |
auto_approved |
|
report
|
data.attributes.approval-status.report | array of object |
report |
|
результат
|
data.attributes.approval-status.report.result | string |
результат |
|
source
|
data.attributes.approval-status.report.source | string |
source |
|
черный списокReportUUID
|
data.attributes.approval-status.report.blacklistReportUUID | string |
черный списокReportUUID |
|
причина
|
data.attributes.approval-status.report.reason | string |
причина |
|
текст
|
data.attributes.approval-status.report.messages.failure.text | string |
текст |
|
верхний колонтитул
|
data.attributes.approval-status.report.messages.failure.header | string |
верхний колонтитул |
|
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 |
|
электронная почта
|
data.attributes.email | string |
электронная почта |
|
ожидаемое время прибытия
|
data.attributes.expected-arrival-time | string |
ожидаемое время прибытия |
|
ожидаемое время отъезда
|
data.attributes.expected-departure-time | string |
ожидаемое время отъезда |
|
полное имя
|
data.attributes.full-name | string |
полное имя |
|
гостевая обновленная версия
|
data.attributes.guest-updated-at | string |
гостевая обновленная версия |
|
is-presigned
|
data.attributes.is-presigned | boolean |
is-presigned |
|
address
|
data.attributes.location-info.address | string |
address |
|
id
|
data.attributes.location-info.id | integer |
id |
|
имя
|
data.attributes.location-info.name | string |
имя |
|
logo_url
|
data.attributes.location-info.logo_url | string |
logo_url |
|
приватные заметки
|
data.attributes.private-notes | string |
приватные заметки |
|
пользовательские данные
|
data.attributes.user-data | array of object |
пользовательские данные |
|
|
data.attributes.user-data.field | string |
поле |
|
|
data.attributes.user-data.value | string |
value |
|
notify-visitor
|
data.attributes.notify-visitor | boolean |
notify-visitor |
|
создано из
|
data.attributes.created-from | string |
создано из |
|
прибыл
|
data.attributes.arrived | boolean |
прибыл |
|
сенсорный вход в доступное время
|
data.attributes.touchless-sign-in-available-time | string |
сенсорный вход в доступное время |
|
требуется сенсорный вход в систему
|
data.attributes.touchless-sign-in-presence-required | boolean |
требуется сенсорный вход в систему |
|
entry-out-out-at
|
data.attributes.entry-signed-out-at | string |
entry-out-out-at |
|
preregistration-link
|
data.attributes.preregistration-link | string |
preregistration-link |
|
created-at
|
data.attributes.created-at | string |
created-at |
|
обновлено
|
data.attributes.updated-at | string |
обновлено |
|
сам
|
data.relationships.attendee.links.self | string |
сам |
|
родственный
|
data.relationships.attendee.links.related | string |
родственный |
|
сам
|
data.relationships.creator.links.self | string |
сам |
|
родственный
|
data.relationships.creator.links.related | string |
родственный |
|
сам
|
data.relationships.employee.links.self | string |
сам |
|
родственный
|
data.relationships.employee.links.related | string |
родственный |
|
type
|
data.relationships.employee.data.type | string |
type |
|
id
|
data.relationships.employee.data.id | string |
id |
|
сам
|
data.relationships.entry.links.self | string |
сам |
|
родственный
|
data.relationships.entry.links.related | string |
родственный |
|
type
|
data.relationships.entry.data.type | object |
type |
|
id
|
data.relationships.entry.data.id | string |
id |
|
сам
|
data.relationships.flow.links.self | string |
сам |
|
родственный
|
data.relationships.flow.links.related | string |
родственный |
|
type
|
data.relationships.flow.data.type | string |
type |
|
id
|
data.relationships.flow.data.id | string |
id |
|
сам
|
data.relationships.location.links.self | string |
сам |
|
родственный
|
data.relationships.location.links.related | string |
родственный |
|
type
|
data.relationships.location.data.type | string |
type |
|
id
|
data.relationships.location.data.id | string |
id |
|
сам
|
data.relationships.platform-jobs.links.self | string |
сам |
|
родственный
|
data.relationships.platform-jobs.links.related | string |
родственный |
Триггеры
| Триггер Invite-Created |
Активируйте действие в MS Flow при создании приглашения посланника. |
Триггер Invite-Created
Активируйте действие в MS Flow при создании приглашения посланника.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
token
|
token | string |
token |