Envoy （预览版）

一个 Envoy 连接器，可用于将 Envoy 帐户（我们的 REST API 终结点）连接到任何其他连接器。 例如，在 Envoy 中创建批量邀请，其中包含来自Microsoft Excel Online 电子表格的详细信息。

此连接器在以下产品和区域中可用：

服务	Class	区域
Copilot Studio	高级	除以下各项外的所有 Power Automate 区域 ：      - 美国政府 （GCC）      - 美国政府 （GCC High）      - 由世纪互联运营的中国云      - 美国国防部（DoD）
逻辑应用程序	标准	除以下各项外的所有 逻辑应用区域 ：      - Azure 政府区域      - Azure 中国区域      - 美国国防部（DoD）
Power Apps	高级	除以下各项外的所有 Power Apps 区域 ：      - 美国政府 （GCC）      - 美国政府 （GCC High）      - 由世纪互联运营的中国云      - 美国国防部（DoD）
Power Automate	高级	除以下各项外的所有 Power Automate 区域 ：      - 美国政府 （GCC）      - 美国政府 （GCC High）      - 由世纪互联运营的中国云      - 美国国防部（DoD）

联系人​​
Name	Envoy 支持团队
URL	https://envoy.help/
Email	hi@envoy.com

连接器元数据
发布者	Envoy， Inc.
网站	https://envoy.com/
隐私策略	https://envoy.com/privacypolicy/
类别	商业智能;数据

在版本 2.0 中，还可以使用 Envoy 邀请创建作为触发器。

先决条件

若要使用此连接器，需要具有用户名和密码的 Envoy 帐户。 对于触发功能，还需要安装 Envoy 集成“Microsoft流”。

如何获取凭据

若要向 Envoy 进行身份验证，需要 Envoy 用户名和密码。

若要触发功能，需要在 Envoy 中“Microsoft流”集成设置的步骤 2 中提供安装令牌。

已知问题和限制

目前，唯一可用的触发器是“邀请创建”。 我们预计在不久的将来将添加更多触发器。

正在创建连接

连接器支持以下身份验证类型：

默认	用于创建连接的参数。	所有区域	不可共享

违约

适用：所有区域

用于创建连接的参数。

这是不可共享的连接。 如果 Power App 与另一个用户共享，系统会提示其他用户显式创建新连接。

Name	类型	Description	必选
用户名	securestring	此 API 的用户名	True
密码	securestring	此 API 的密码	True

限制

名称	调用	续订期
每个连接的 API 调用数	100	60 秒

操作

创建邀请	这是创建邀请的 POST 请求
更新一个邀请	用于更新邀请信息的 PATCH 请求。
添加阻止列表筛选器	添加阻止列表筛选器的 POST 请求
获取一个条目	用于检索有关单个条目的信息的 GET 请求。
获取一个邀请	用于检索有关单个邀请的信息的 GET 请求。
获取位置	用于检索位置的 GET 请求
获取公司信息	检索有关公司的信息（GET）
获取员工列表	用于检索员工列表的 GET 请求
获取流	GET 请求以检索有关位置的流的信息。
获取邀请	基于筛选检索邀请信息的 GET 请求。
获取阻止列表筛选器	用于检索阻止列表筛选器的 GET 请求。

创建邀请

操作 ID:

addInvite

这是创建邀请的 POST 请求

参数

名称	密钥	必需	类型	说明
Content-Type	Content-Type		string	Content-Type
full-name	full-name		string	full-name
电子邮件	email		string	电子邮件
inviter-name	inviter-name		string	inviter-name
expected-arrival-time	expected-arrival-time		string	expected-arrival-time
定期规则	recurring-rule		string	定期规则
rrule-until	rrule-until		string	rrule-until
private-notes	private-notes		string	private-notes
been-here-before	been-here-before		boolean	been-here-before
其他来宾	additional-guests		integer	其他来宾
skip-guest-notification	skip-guest-notification		boolean	skip-guest-notification
agreements-status	agreements-status		string	agreements-status
place-id	place-id		string	place-id
flow-name	flow-name		string	flow-name
group-name	group-name		string	group-name
到	arrived		boolean	到
审批状态	approval-status		string	审批状态
字段	field		string	字段
value	value		string	value
类型	type		string	类型
id	id		string	id （员工）
类型	type		string	类型
id	id		string	id （位置）
类型	type		string	类型

返回

名称	路径	类型	说明
id	data.id	string	id
类型	data.type	string	类型
自我	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
报表	data.attributes.approval-status.report	array of object	报表
结果	data.attributes.approval-status.report.result	string	结果
源	data.attributes.approval-status.report.source	string	源
blacklistReportUUID	data.attributes.approval-status.report.blacklistReportUUID	string	blacklistReportUUID
原因	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	电子邮件
expected-arrival-time	data.attributes.expected-arrival-time	string	expected-arrival-time
expected-departure-time	data.attributes.expected-departure-time	string	expected-departure-time
full-name	data.attributes.full-name	string	full-name
guest-updated-at	data.attributes.guest-updated-at	string	guest-updated-at
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
private-notes	data.attributes.private-notes	string	private-notes
user-data	data.attributes.user-data	array of object	user-data
	data.attributes.user-data.field	string	字段
	data.attributes.user-data.value	string	value
notify-visitor	data.attributes.notify-visitor	boolean	notify-visitor
created-from	data.attributes.created-from	string	created-from
到	data.attributes.arrived	boolean	到
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
预注册链接	data.attributes.preregistration-link	string	预注册链接
created-at	data.attributes.created-at	string	created-at
updated-at	data.attributes.updated-at	string	updated-at
自我	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	相关
类型	data.relationships.employee.data.type	string	类型
id	data.relationships.employee.data.id	string	id
自我	data.relationships.entry.links.self	string	自我
相关	data.relationships.entry.links.related	string	相关
类型	data.relationships.entry.data.type	object	类型
id	data.relationships.entry.data.id	string	id
自我	data.relationships.flow.links.self	string	自我
相关	data.relationships.flow.links.related	string	相关
类型	data.relationships.flow.data.type	string	类型
id	data.relationships.flow.data.id	string	id
自我	data.relationships.location.links.self	string	自我
相关	data.relationships.location.links.related	string	相关
类型	data.relationships.location.data.type	string	类型
id	data.relationships.location.data.id	string	id
自我	data.relationships.platform-jobs.links.self	string	自我
相关	data.relationships.platform-jobs.links.related	string	相关

更新一个邀请

操作 ID:

updateInvite

用于更新邀请信息的 PATCH 请求。

参数

名称	密钥	必需	类型	说明
invite_id	invite_id	True	string	invite_id
Content-Type	Content-Type		string	Content-Type
id	id		string	id
full-name	full-name		string	full-name
电子邮件	email		string	电子邮件
inviter-name	inviter-name		string	inviter-name
expected-arrival-time	expected-arrival-time		string	expected-arrival-time （预期格式：2019-03-24T21：15：00.000Z）
定期规则	recurring-rule		string	定期规则
rrule-until	rrule-until		string	rrule-until
private-notes	private-notes		string	private-notes
been-here-before	been-here-before		boolean	been-here-before
其他来宾	additional-guests		integer	其他来宾
skip-guest-notification	skip-guest-notification		boolean	skip-guest-notification
nda	nda		string	nda
guest-updated-at	guest-updated-at		string	guest-updated-at （格式：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
到	arrived		boolean	到
审批状态	approval-status		string	审批状态
字段	field		string	字段
value	value		string	value
类型	type		string	类型
id	id		string	id
类型	type		string	类型
id	id		string	id （员工）
类型	type		string	类型
id	id		string	id （位置）
类型	type		string	类型

返回

名称	路径	类型	说明
id	data.id	string	id
类型	data.type	string	类型
agreements-status	data.attributes.agreements-status	string	agreements-status
full-name	data.attributes.full-name	string	full-name
电子邮件	data.attributes.email	string	电子邮件
inviter-name	data.attributes.inviter-name	string	inviter-name
inviter-email	data.attributes.inviter-email	string	inviter-email
expected-arrival-time	data.attributes.expected-arrival-time	string	expected-arrival-time
private-notes	data.attributes.private-notes	string	private-notes
到	data.attributes.arrived	boolean	到
been-here-before	data.attributes.been-here-before	boolean	been-here-before
flow-name	data.attributes.flow-name	string	flow-name
flow-id	data.attributes.flow-id	integer	flow-id
user-data	data.attributes.user-data	array of object	user-data
字段	data.attributes.user-data.field	string	字段
value	data.attributes.user-data.value	string	value
其他来宾	data.attributes.additional-guests	integer	其他来宾
guest-updated-at	data.attributes.guest-updated-at	string	guest-updated-at
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
group-name	data.attributes.group-name	string	group-name
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
状态	data.attributes.approval-status.status	string	状态
自动批准	data.attributes.approval-status.auto-approved	boolean	自动批准
报表	data.attributes.approval-status.report	array of object	报表
结果	data.attributes.approval-status.report.result	string	结果
源	data.attributes.approval-status.report.source	string	源
blacklistReportUUID	data.attributes.approval-status.report.blacklistReportUUID	string	blacklistReportUUID
原因	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.relationships.entry.data.type	string	类型
id	data.relationships.entry.data.id	string	id
id	data.relationships.location.data.id	string	id
类型	data.relationships.location.data.type	string	类型
类型	data.relationships.flow.data.type	string	类型
id	data.relationships.flow.data.id	string	id
类型	data.relationships.employee.data.type	string	类型
id	data.relationships.employee.data.id	string	id
类型	data.relationships.creator.data.type	string	类型
id	data.relationships.creator.data.id	string	id
相关	data.relationships.platform-jobs.links.related	string	相关
包括	included	array of object	包括
id	included.id	string	id
类型	included.type	string	类型
姓名	included.attributes.name	string	姓名
自我	links.self	string	自我

添加阻止列表筛选器

操作 ID:

addBlockListFilter

添加阻止列表筛选器的 POST 请求

参数

名称	密钥	必需	类型	说明
aliases	aliases		array of	aliases
描述	description		string	描述
电子邮件	emails		array of string	电子邮件
full-name	full-name		string	full-name
关键字	keyword		string	关键字
other-keywords	other-keywords		array of	other-keywords
原因	reason		string	原因
电话号码	phone-numbers		array of	电话号码
类型	type		string	类型
id	id		string	id （位置）
类型	type		string	类型

返回

名称	路径	类型	说明
id	data.id	string	id
类型	data.type	string	类型
自我	data.links.self	string	自我
aliases	data.attributes.aliases	array of	aliases
描述	data.attributes.description	string	描述
电子邮件	data.attributes.emails	array of string	电子邮件
full-name	data.attributes.full-name	string	full-name
关键字	data.attributes.keyword	string	关键字
other-keywords	data.attributes.other-keywords	array of	other-keywords
电话号码	data.attributes.phone-numbers	array of	电话号码
源语言	data.attributes.photo.original	string	源语言
拇指	data.attributes.photo.thumb	string	拇指
原因	data.attributes.reason	string	原因
created-by	data.attributes.created-by	string	created-by
自我	data.relationships.location.links.self	string	自我
相关	data.relationships.location.links.related	string	相关
自我	data.relationships.user.links.self	string	自我
相关	data.relationships.user.links.related	string	相关

获取一个条目

操作 ID:

getEntryInfoByID

用于检索有关单个条目的信息的 GET 请求。

参数

名称	密钥	必需	类型	说明
entry_id	entry_id	True	string	entry_id
filter[location]	filter[location]		integer	filter[location]
接受	Accept		string	接受

返回

名称	路径	类型	说明
id	data.id	string	id
类型	data.type	string	类型
full-name	data.attributes.full-name	string	full-name
电子邮件	data.attributes.email	string	电子邮件
主持人	data.attributes.host	string	主持人
host-email	data.attributes.host-email	string	host-email
private-notes	data.attributes.private-notes	string	private-notes
已签名 -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	小
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
is-delivery	data.attributes.is-delivery	boolean	is-delivery
协议拒绝	data.attributes.agreement-refused	boolean	协议拒绝
pov-key	data.attributes.pov-key	string	pov-key
user-data	data.attributes.user-data	array of object	user-data
字段	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-status	data.attributes.push-status	string	push-status
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
类型	data.relationships.location.data.type	string	类型
id	data.relationships.location.data.id	string	id
类型	data.relationships.employee.data.type	string	类型
id	data.relationships.employee.data.id	string	id
类型	data.relationships.invite.data.type	string	类型
id	data.relationships.invite.data.id	string	id
类型	data.relationships.flow.data.type	string	类型
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	自我

获取一个邀请

操作 ID:

getInviteByID

用于检索有关单个邀请的信息的 GET 请求。

参数

名称	密钥	必需	类型	说明
invite_id	invite_id	True	string	invite_id
接受	Accept		string	接受

返回

名称	路径	类型	说明
id	data.id	string	id
类型	data.type	string	类型
full-name	data.attributes.full-name	string	full-name
电子邮件	data.attributes.email	string	电子邮件
inviter-name	data.attributes.inviter-name	string	inviter-name
expected-arrival-time	data.attributes.expected-arrival-time	string	expected-arrival-time
private-notes	data.attributes.private-notes	string	private-notes
到	data.attributes.arrived	boolean	到
been-here-before	data.attributes.been-here-before	boolean	been-here-before
flow-name	data.attributes.flow-name	string	flow-name
flow-id	data.attributes.flow-id	integer	flow-id
user-data	data.attributes.user-data	array of object	user-data
字段	data.attributes.user-data.field	string	字段
value	data.attributes.user-data.value	string	value
其他来宾	data.attributes.additional-guests	integer	其他来宾
guest-updated-at	data.attributes.guest-updated-at	string	guest-updated-at
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
审批状态	data.attributes.approval-status	string	审批状态
类型	data.relationships.entry.data.type	string	类型
id	data.relationships.entry.data.id	string	id
id	data.relationships.location.data.id	string	id
类型	data.relationships.location.data.type	string	类型
类型	data.relationships.flow.data.type	string	类型
id	data.relationships.flow.data.id	string	id
类型	data.relationships.employee.data.type	string	类型
id	data.relationships.employee.data.id	string	id
类型	data.relationships.creator.data.type	string	类型
id	data.relationships.creator.data.id	string	id
包括	included	array of object	包括
id	included.id	string	id
类型	included.type	string	类型
full-name	included.attributes.full-name	string	full-name
电子邮件	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	included.attributes.slack-enabled	boolean	已启用 slack
已启用 hipchat	included.attributes.hipchat-enabled	boolean	已启用 hipchat
已启用 push-enabled	included.attributes.push-enabled	boolean	已启用 push-enabled
已启用 invite-push-enabled	included.attributes.invite-push-enabled	boolean	已启用 invite-push-enabled
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	数据
类型	included.relationships.emails.data.type	string	类型
id	included.relationships.emails.data.id	string	id
自我	links.self	string	自我

获取位置

操作 ID:

getLocationInfo

用于检索位置的 GET 请求

参数

名称	密钥	必需	类型	说明
接受	Accept		string	接受

返回

名称	路径	类型	说明
数据	data	array of object	数据
id	data.id	string	id
类型	data.type	string	类型
自我	data.links.self	string	自我
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
auto-sign-out-at-midnight	data.attributes.auto-sign-out-at-midnight	boolean	auto-sign-out-at-midnight
auto-sign-out-minutes	data.attributes.auto-sign-out-minutes	string	auto-sign-out-minutes
城市	data.attributes.city	string	城市
company-name-override	data.attributes.company-name-override	string	company-name-override
禁用的	data.attributes.disabled	boolean	禁用的
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
已启用 fallback-notifications-enabled	data.attributes.fallback-notifications-enabled	boolean	已启用 fallback-notifications-enabled
预注册 -required-enabled	data.attributes.pre-registration-required-enabled	boolean	预注册 -required-enabled
latitude	data.attributes.latitude	float	latitude
区域设置	data.attributes.locale	string	区域设置
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
姓名	data.attributes.name	string	姓名
已启用 printer-notifications-enabled	data.attributes.printer-notifications-enabled	boolean	已启用 printer-notifications-enabled
已启用多种语言	data.attributes.multiple-languages-enabled	boolean	已启用多种语言
enabled-locales	data.attributes.enabled-locales	array of	enabled-locales
状态	data.attributes.state	string	状态
timezone	data.attributes.timezone	string	timezone
压缩包	data.attributes.zip	string	压缩包
平均每月访问者数	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
updated-at	data.attributes.updated-at	string	updated-at
自我	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	第一
last	links.last	string	last

获取公司信息

操作 ID:

getCompanyInfo

检索有关公司的信息（GET）

参数

名称	密钥	必需	类型	说明
接受	Accept		string	接受

返回

名称	路径	类型	说明
总	meta.total	integer	总
limit	meta.limit	integer	limit
偏移	meta.offset	integer	偏移
数据	data	array of object	数据
id	data.id	string	id
类型	data.type	string	类型
姓名	data.attributes.name	string	姓名
plan-intent	data.attributes.plan-intent	string	plan-intent
buy-intent	data.attributes.buy-intent	boolean	buy-intent
已启用呼叫	data.attributes.call-enabled	boolean	已启用呼叫
已启用 appletv	data.attributes.appletv-enabled	boolean	已启用 appletv
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
updated-at	data.attributes.updated-at	string	updated-at
onboarding-status	data.attributes.onboarding-status	string	onboarding-status
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
类型	data.relationships.subscription.data.type	string	类型
id	data.relationships.subscription.data.id	string	id
类型	data.relationships.deliveries-subscription.data.type	string	类型
id	data.relationships.deliveries-subscription.data.id	string	id
数据	data.relationships.contracts.data	array of object	数据
类型	data.relationships.contracts.data.type	string	类型
id	data.relationships.contracts.data.id	string	id
数据	data.relationships.administrators.data	array of object	数据
类型	data.relationships.administrators.data.type	string	类型
id	data.relationships.administrators.data.id	string	id
数据	data.relationships.locations.data	array of object	数据
类型	data.relationships.locations.data.type	string	类型
id	data.relationships.locations.data.id	string	id
类型	data.relationships.saml.data.type	string	类型
id	data.relationships.saml.data.id	string	id
自我	links.self	string	自我
第一	links.first	string	第一
last	links.last	string	last

获取员工列表

操作 ID:

getEmployee

用于检索员工列表的 GET 请求

返回

名称	路径	类型	说明
数据	data	array of object	数据
id	data.id	string	id
类型	data.type	string	类型
自我	data.links.self	string	自我
cc-employee	data.attributes.cc-employee	boolean	cc-employee
company-id	data.attributes.company-id	integer	company-id
已删除	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	手动添加
manually-added-location-present	data.attributes.manually-added-location-present	boolean	manually-added-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
updated-at	data.attributes.updated-at	string	updated-at
自我	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	第一
last	links.last	string	last

获取流

操作 ID:

getFlowsInfo

GET 请求以检索有关位置的流的信息。

参数

名称	密钥	必需	类型	说明
filter[location]	filter[location]		integer	filter[location]

返回

名称	路径	类型	说明
数据	data	array of object	数据
id	data.id	string	id
类型	data.type	string	类型
自我	data.links.self	string	自我
其他来宾	data.attributes.additional-guests	boolean	其他来宾
auto-sign-out-minutes	data.attributes.auto-sign-out-minutes	string	auto-sign-out-minutes
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
id-check	data.attributes.id-check	boolean	id-check
ipad-localized-names	data.attributes.ipad-localized-names	array of object	ipad-localized-names
language-code	data.attributes.ipad-localized-names.language-code	string	language-code
region-code	data.attributes.ipad-localized-names.region-code	string	region-code
display-name	data.attributes.ipad-localized-names.display-name	string	display-name
姓名	data.attributes.name	string	姓名
位置	data.attributes.position	integer	位置
use-existing-photo	data.attributes.use-existing-photo	boolean	use-existing-photo
created-at	data.attributes.created-at	string	created-at
updated-at	data.attributes.updated-at	string	updated-at
自我	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	第一
last	links.last	string	last

获取邀请

操作 ID:

getInviteInfo

基于筛选检索邀请信息的 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
类型	data.type	string	类型
自我	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
报表	data.attributes.approval-status.report	array of object	报表
结果	data.attributes.approval-status.report.result	string	结果
源	data.attributes.approval-status.report.source	string	源
blacklistReportUUID	data.attributes.approval-status.report.blacklistReportUUID	string	blacklistReportUUID
原因	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	电子邮件
expected-arrival-time	data.attributes.expected-arrival-time	string	expected-arrival-time
expected-departure-time	data.attributes.expected-departure-time	string	expected-departure-time
full-name	data.attributes.full-name	string	full-name
guest-updated-at	data.attributes.guest-updated-at	string	guest-updated-at
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
private-notes	data.attributes.private-notes	string	private-notes
user-data	data.attributes.user-data	array of object	user-data
字段	data.attributes.user-data.field	string	字段
value	data.attributes.user-data.value	string	value
notify-visitor	data.attributes.notify-visitor	boolean	notify-visitor
created-from	data.attributes.created-from	string	created-from
place_id	data.attributes.locality.place_id	string	place_id
place-id	data.attributes.locality.place-id	string	place-id
到	data.attributes.arrived	boolean	到
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
证明	data.attributes.attested	string	证明
phone	data.attributes.phone	string	phone
预注册链接	data.attributes.preregistration-link	string	预注册链接
preregistration-status-link	data.attributes.preregistration-status-link	string	preregistration-status-link
reminder-sent-at	data.attributes.reminder-sent-at	string	reminder-sent-at
created-at	data.attributes.created-at	string	created-at
updated-at	data.attributes.updated-at	string	updated-at
自我	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	相关
类型	data.relationships.employee.data.type	string	类型
id	data.relationships.employee.data.id	string	id
自我	data.relationships.entry.links.self	string	自我
相关	data.relationships.entry.links.related	string	相关
类型	data.relationships.entry.data.type	string	类型
id	data.relationships.entry.data.id	string	id
自我	data.relationships.flow.links.self	string	自我
相关	data.relationships.flow.links.related	string	相关
类型	data.relationships.flow.data.type	string	类型
id	data.relationships.flow.data.id	string	id
自我	data.relationships.location.links.self	string	自我
相关	data.relationships.location.links.related	string	相关
类型	data.relationships.location.data.type	string	类型
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	第一
下一个	links.next	string	下一个
last	links.last	string	last

获取阻止列表筛选器

操作 ID:

getblockListFilters

用于检索阻止列表筛选器的 GET 请求。

参数

名称	密钥	必需	类型	说明
filter[company]	filter[company]		integer	filter[company]
Content-Type	Content-Type		string	Content-Type

返回

名称	路径	类型	说明
数据	data	array of object	数据
id	data.id	string	id
类型	data.type	string	类型
自我	data.links.self	string	自我
aliases	data.attributes.aliases	array of	aliases
描述	data.attributes.description	string	描述
电子邮件	data.attributes.emails	array of string	电子邮件
full-name	data.attributes.full-name	string	full-name
关键字	data.attributes.keyword	string	关键字
other-keywords	data.attributes.other-keywords	array of string	other-keywords
电话号码	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
created-by	data.attributes.created-by	string	created-by
自我	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	总

触发器

Invite-Created 触发器

创建 Envoy 邀请时，在 MS Flow 中触发作。

Invite-Created 触发器

操作 ID:

InviteCreated

创建 Envoy 邀请时，在 MS Flow 中触发作。

参数

名称	密钥	必需	类型	说明
代币	token		string	代币