Luware Nimbus
适用于 Nimbus 联系中心和企业路由许可服务的连接器,用于快速将 Nimbus 连接到第三方系统。 通过侦听和响应触发事件,连接器可以跟进流作,例如从外部系统检索数据,并将其存储在 Nimbus 参数中,以便稍后在 Nimbus 工作流中使用。
此连接器在以下产品和区域中可用:
| 服务 | 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 | Luware 支持人员 |
| URL | https://helpdesk.luware.cloud/ |
| nimbus.support@luware.com |
| 连接器元数据 | |
|---|---|
| 发布者 | Luware |
| 网站 | https://luware.com/ |
| 隐私策略 | https://luware.com/en/privacy-policy/ |
| 类别 | 通信;协作 |
Luware Nimbus 连接器允许在 Nimbus 和第三方软件(如 CRM 或票证系统)之间进行集成。 它允许你侦听 Luware Nimbus 中发生的任务和计划程序输入事件。 可以创建任务、使用调用方信息数据丰富现有任务、添加路由参数或在第三方系统中触发事件。 此外,还可以管理通讯簿、安排出站呼叫或添加外部任务。
一些用例包括:
- 在 Nimbus 中显示入站呼叫的联系人详细信息。
- 在 Nimbus 中保留从 IVR 到 CRM 的语言选择。
- 在 CRM 中的调用后创建一个呼叫后的工作项。
- 为 CRM 中错过的呼叫创建回叫任务。
- 基于 CRM 中的市场活动创建 Nimbus 出站呼叫。
- 根据客户首选项路由呼叫。
- 显示入站呼叫的呼叫者首选项。
- 在第三方系统中创建票证。
- 在第三方系统中创建错过的呼叫列表。
- 当代理接听呼叫时,打开客户的记录。
有关 Luware 知识库的详细信息和大量帮助, https://help.luware.com/nimbus-power-automate-connector
先决条件
- 具有“高级”层的Microsoft PowerApps 或 PowerAutomate 计划
- Azure 租户
- 至少预配了一个 Luware Nimbus 服务
- Luware Nimbus 中允许使用 Luware Nimbus 连接器的角色 (https://help.luware.com/power-automate-roles)
如何建立安全连接
Nimbus API 通过 Azure Active Directory /AAD/ Microsoft Entra ID 使用委派权限进行保护。 作为租户管理员,你需要为“Luware Nimbus 登录”应用程序授予这些权限,以便连接器可以安全地访问 Luware Nimbus。 在大多数情况下,这些权限已在载入 Nimbus 期间授予,无需重新确认。
完成此步骤后,可以通过建立与 Nimbus 群集的连接来使用该连接器。 请确保选择与 Nimbus 安装相同的群集位置。 如果对此不确定,请登录到 Nimbus 管理以检查要重定向到的群集。
连接器入门
- 选择 Luware Nimbus 触发器上的“任务更改状态”触发器。
- 配置要侦听传入呼叫的 Nimbus 服务。
- 选择事件“系统接受”(在到达工作流中的“接受对话”活动时触发)。
- 实现基于呼叫方电话号码的呼叫者信息的查找,例如,在 CRM 中或在 Sharepoint 上托管的 Excel 工作表中进行测试。
- 使用作“更新任务”设置任务上的客户信息,如名字/姓氏、地址、城市、国家/地区等。
请参阅有关知识库的用例部分: https://help.luware.com/power-automate-use-cases
已知问题和限制
- 在 Luware Nimbus 中丢失权限(RBAC)将禁用自动电源中的触发器,而不会为最终用户提供透明信息。 流不再触发。
- Luware 对流的执行时间没有影响,因此结果可能会延迟返回 Nimbus。 应根据流的完成情况生成工作流,同时牢记此限制。
常见错误和补救措施
HTTP 错误代码:
- 400:发送到 Luware Nimbus API 的请求包含无效参数或无法应用它们。 示例:所有传递的首选用户都无效,因此首选用户未设置,或者尝试在已分配给用户时删除外部任务。
- 401:提供的身份验证令牌无法分析或无效。 检查 Azure AD/Entra ID 应用程序注册的正确设置,并为 O365 帐户提供了正确的凭据。
- 403:帐户在 Nimbus 中缺少执行在流中配置的作所需的权限。 如需其他角色/权限,请参阅知识库并联系管理员。
- 404:传递的标识符(s)无法与后端中的任何实体匹配。
正在创建连接
连接器支持以下身份验证类型:
| 默认 | 用于创建连接的参数。 | 所有区域 | 不可共享 |
违约
适用:所有区域
用于创建连接的参数。
这是不可共享的连接。 如果 Power App 与另一个用户共享,系统会提示其他用户显式创建新连接。
| Name | 类型 | Description | 必选 |
|---|---|---|---|
| 位置 | 字符串 | 租户所在的位置。 | True |
限制
| 名称 | 调用 | 续订期 |
|---|---|---|
| 每个连接的 API 调用数 | 100 | 60 秒 |
操作
| 从通讯簿中删除联系人 |
从通讯簿中删除一个或多个联系人。 |
| 从通讯簿获取联系人 |
从通讯簿返回联系人。 |
| 使用工作流计划新的出站呼叫 |
使用工作流(计划程序条目)计划新的出站呼叫。 |
| 使用工作流计划程序条目更新出站调用 |
使用工作流计划程序条目更改已创建的出站调用的设置。 |
| 删除外部任务 |
删除外部任务 |
| 删除计划程序条目 |
从系统中删除计划程序条目。 只有可能,而计划程序条目尚未进行。 |
| 将联系人添加到通讯簿 |
将新联系人添加到特定通讯簿。 ExternalId 用作进一步请求中的引用。 |
| 更新任务 |
更新正在进行的任务的客户信息、上下文参数和/或首选用户设置。 |
| 更新计划程序条目 |
更改已创建的计划程序条目的设置。 |
| 更新通讯簿中的联系人 |
更新指定通讯簿中的单个联系人。 |
| 添加新的外部任务 |
添加新的外部任务 |
| 清空通讯簿 |
删除指定通讯簿中的所有联系人。 |
| 获取所有计划程序条目 |
返回指定服务的所有计划程序条目。 |
| 获取打开时间 |
获取服务打开时间:它在给定时间返回服务的状态(打开、关闭、假日等)。 |
| 获取虚拟用户助理数据 |
返回所选服务会话的虚拟用户助理数据。 |
| 计划新的出站呼叫 |
计划新的出站呼叫(计划程序条目)。 |
从通讯簿中删除联系人
从通讯簿中删除一个或多个联系人。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
Addressbook
|
AddressBook | True | string |
要从中删除联系人的通讯簿。 |
|
externalIds
|
externalIds | True | array of string |
从通讯簿获取联系人
从通讯簿返回联系人。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
Addressbook
|
AddressBook | True | string |
要从中获取联系人的通讯簿。 |
|
ExternalId
|
externalIds | array |
要提取的联系人的外部 ID。 可选:如果未提供任何联系人,将返回所有联系人。 |
返回
返回的联系人。
使用工作流计划新的出站呼叫
使用工作流(计划程序条目)计划新的出站呼叫。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
引用 ID
|
ReferenceId | string |
第三方系统传递的引用的 ID。 |
|
|
目的地
|
destination | True | string |
使用工作流进行出站调用的目标。 |
|
截止日期时间(UTC)
|
dueDateTimeUtc | True | date-time |
UTC 中的截止日期和时间:示例:“2020-03-23T11:00:00Z”。 |
|
服务 UPN
|
serviceUpn | True | string |
服务的 UPN。 |
|
最大尝试次数
|
maxAttempts | integer |
达到目标的最大尝试次数。 |
|
|
尝试超时(以秒为单位)
|
attemptTimeoutInSeconds | integer |
定义 Nimbus 在尝试停止之前尝试到达目标的时间。 |
|
|
Name
|
name | True | string |
自定义上下文参数的名称。 |
|
价值
|
value | string |
自定义上下文参数的值。 |
|
|
客户名字
|
firstName | string |
客户的名字。 |
|
|
客户姓氏
|
lastName | string |
客户的姓氏。 |
|
|
客户显示名称
|
displayName | string |
客户的显示名称。 |
|
|
客户公司
|
company | string |
客户的公司。 |
|
|
客户职务
|
jobTitle | string |
客户的职务。 |
|
|
客户部门
|
department | string |
客户的部门。 |
|
|
客户街道地址
|
streetAddress | string |
客户的街道地址。 |
|
|
客户邮政编码
|
postCode | string |
客户的邮政编码。 |
|
|
客户城市
|
city | string |
客户所在城市。 |
|
|
客户省/自治区/直辖市
|
state | string |
客户的状态。 |
|
|
客户国家/地区
|
country | string |
客户的国家/地区。 |
|
|
客户主电话号码
|
primaryTelNumber | string |
客户的主要电话号码。 |
|
|
Name
|
name | True | string |
指定电话号码。 |
|
价值
|
value | string |
电话号码的值。 |
|
|
客户 UPN
|
UPN | string |
客户的 UPN。 |
|
|
客户 IM 地址
|
imAddress | string |
客户的 IM 地址。 |
|
|
客户电子邮件
|
string |
客户的电子邮件。 |
||
|
Name
|
name | True | string |
指定自定义域。 |
|
价值
|
value | string |
自定义域的值。 |
返回
使用工作流计划程序条目更新出站调用
使用工作流计划程序条目更改已创建的出站调用的设置。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
计划程序条目 ID
|
SchedulerEntryID | True | string |
要更新的计划程序条目的 ID。 |
|
引用 ID
|
ReferenceId | string |
第三方系统传递的引用的 ID。 |
|
|
目的地
|
destination | True | string |
使用工作流进行出站调用的目标。 |
|
截止日期时间(UTC)
|
dueDateTimeUtc | True | date-time |
UTC 中的截止日期和时间:示例:“2020-03-23T11:00:00Z”。 |
|
服务 UPN
|
serviceUpn | True | string |
服务的 UPN。 |
|
最大尝试次数
|
maxAttempts | integer |
达到目标的最大尝试次数。 |
|
|
尝试超时(以秒为单位)
|
attemptTimeoutInSeconds | integer |
定义 Nimbus 在尝试停止之前尝试到达目标的时间。 |
|
|
Name
|
name | True | string |
自定义上下文参数的名称。 |
|
价值
|
value | string |
自定义上下文参数的值。 |
|
|
客户名字
|
firstName | string |
客户的名字。 |
|
|
客户姓氏
|
lastName | string |
客户的姓氏。 |
|
|
客户显示名称
|
displayName | string |
客户的显示名称。 |
|
|
客户公司
|
company | string |
客户的公司。 |
|
|
客户职务
|
jobTitle | string |
客户的职务。 |
|
|
客户部门
|
department | string |
客户的部门。 |
|
|
客户街道地址
|
streetAddress | string |
客户的街道地址。 |
|
|
客户邮政编码
|
postCode | string |
客户的邮政编码。 |
|
|
客户城市
|
city | string |
客户所在城市。 |
|
|
客户省/自治区/直辖市
|
state | string |
客户的状态。 |
|
|
客户国家/地区
|
country | string |
客户的国家/地区。 |
|
|
客户主电话号码
|
primaryTelNumber | string |
客户的主要电话号码。 |
|
|
Name
|
name | True | string |
指定电话号码。 |
|
价值
|
value | string |
电话号码的值。 |
|
|
客户 UPN
|
UPN | string |
客户的 UPN。 |
|
|
客户 IM 地址
|
imAddress | string |
客户的 IM 地址。 |
|
|
客户电子邮件
|
string |
客户的电子邮件。 |
||
|
Name
|
name | True | string |
指定自定义域。 |
|
价值
|
value | string |
自定义域的值。 |
返回
删除外部任务
删除外部任务
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
外部任务 ID
|
externalTaskId | True | string |
要删除的外部任务的 ID |
删除计划程序条目
从系统中删除计划程序条目。 只有可能,而计划程序条目尚未进行。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
计划程序条目 ID
|
SchedulerEntryID | True | string |
要删除的计划程序条目的 ID。 |
将联系人添加到通讯簿
将新联系人添加到特定通讯簿。 ExternalId 用作进一步请求中的引用。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
Addressbook
|
AddressBook | True | string |
要向其添加联系人的通讯簿。 |
|
联系外部 ID
|
externalId | True | string |
外部系统提供的联系人的 ID。 |
|
联系人名字
|
firstName | string |
联系人的名字。 |
|
|
联系人姓氏
|
lastName | string |
联系人的姓氏。 |
|
|
联系人显示名称
|
displayName | string |
联系人的显示名称。 |
|
|
联系人缩写
|
initials | string |
联系人的缩写。 |
|
|
联系公司
|
company | string |
联系人的公司。 |
|
|
联系部门
|
department | string |
联系人部门。 |
|
|
联系职务
|
jobTitle | string |
联系人的职务。 |
|
|
联系用户主体名称
|
userPrincipalName | string |
联系人的用户主体名称。 |
|
|
联系 IM 地址
|
imAddresses | array of string |
IM 地址列表。 |
|
|
联系人电子邮件地址
|
emailAddresses | array of string |
电子邮件地址列表。 |
|
|
联系商务电话
|
businessPhones | array of string |
商务电话列表。 |
|
|
联系移动电话
|
mobilePhones | array of string |
移动电话列表。 |
|
|
联系家庭电话
|
homePhones | array of string |
家庭电话列表。 |
|
|
地址街
|
street | string |
地址的街道和编号。 |
|
|
地址城市
|
city | string |
地址所在的城市。 |
|
|
地址国家/地区
|
country | string |
地址的国家/地区。 |
|
|
地址状态
|
state | string |
地址的状态。 |
|
|
地址邮政编码
|
postalCode | string |
地址的邮政编码。 |
|
|
Name
|
name | True | string |
指定自定义域。 |
|
价值
|
value | string |
自定义域的值。 |
返回
- Body
- ContactReadDto
更新任务
更新正在进行的任务的客户信息、上下文参数和/或首选用户设置。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
任务 ID
|
taskId | True | string |
任务的 Nimbus 特定 ID。 |
|
客户名字
|
firstName | string |
客户的名字。 |
|
|
客户姓氏
|
lastName | string |
客户的姓氏。 |
|
|
客户显示名称
|
displayName | string |
客户的显示名称。 |
|
|
客户公司
|
company | string |
客户的公司。 |
|
|
客户职务
|
jobTitle | string |
客户的职务。 |
|
|
客户部门
|
department | string |
客户的部门。 |
|
|
客户街道地址
|
streetAddress | string |
客户的街道地址。 |
|
|
客户邮政编码
|
postCode | string |
客户的邮政编码。 |
|
|
客户城市
|
city | string |
客户所在城市。 |
|
|
客户省/自治区/直辖市
|
state | string |
客户的状态。 |
|
|
客户国家/地区
|
country | string |
客户的国家/地区。 |
|
|
客户主电话号码
|
primaryTelNumber | string |
客户的主要电话号码。 |
|
|
Name
|
name | True | string |
指定电话号码。 |
|
价值
|
value | string |
电话号码的值。 |
|
|
客户 UPN
|
UPN | string |
客户的 UPN。 |
|
|
客户 IM 地址
|
imAddress | string |
客户的 IM 地址。 |
|
|
客户电子邮件
|
string |
客户的电子邮件。 |
||
|
Name
|
name | True | string |
指定自定义域。 |
|
价值
|
value | string |
自定义域的值。 |
|
|
Name
|
name | True | string |
自定义上下文参数的名称。 |
|
价值
|
value | string |
自定义上下文参数的值。 |
|
|
UPN
|
upn | True | string |
首选用户的 UPN。 |
|
Priority
|
priority | integer |
优先级。 1 高到 99 低。 |
|
|
服务会话 ID
|
serviceSessionId | string |
服务会话的 ID。 |
|
|
用户会话 ID
|
userSessionId | string |
用户会话的 ID。 |
更新计划程序条目
更改已创建的计划程序条目的设置。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
计划程序条目 ID
|
SchedulerEntryID | True | string |
要更新的计划程序条目的 ID。 |
|
引用 ID
|
ReferenceId | string |
第三方系统传递的引用的 ID。 |
|
|
目的地
|
destination | True | string |
具有“出站”方向的计划程序条目的目标。 |
|
分发优先级
|
distributionPriority | string |
应在 Nimbus 中处理任务的优先级。 |
|
|
截止日期时间(UTC)
|
dueDateTimeUtc | True | date-time |
UTC 中的截止日期和时间:示例:“2020-03-23T11:00:00Z”。 |
|
服务 UPN
|
serviceUpn | True | string |
服务的 UPN。 |
|
最大尝试次数
|
maxAttempts | integer |
达到目标的最大尝试次数。 |
|
|
尝试超时(以秒为单位)
|
attemptTimeoutInSeconds | integer |
连接重试之间的超时(间隔),直到达到最大尝试次数。 |
|
|
最长队列时间(以秒为单位)
|
maxQueueTimeInSeconds | integer |
定义 Nimbus 尝试解决任务的时间,直到任务被视为“达到限制”。 |
|
|
RONA 超时(以秒为单位)
|
ronaTimeoutInSeconds | integer |
定义 Nimbus 尝试访问用户的时间,直到该任务被视为 RONA,并将选择一个新用户。 |
|
|
Name
|
name | True | string |
自定义上下文参数的名称。 |
|
价值
|
value | string |
自定义上下文参数的值。 |
|
|
客户名字
|
firstName | string |
客户的名字。 |
|
|
客户姓氏
|
lastName | string |
客户的姓氏。 |
|
|
客户显示名称
|
displayName | string |
客户的显示名称。 |
|
|
客户公司
|
company | string |
客户的公司。 |
|
|
客户职务
|
jobTitle | string |
客户的职务。 |
|
|
客户部门
|
department | string |
客户的部门。 |
|
|
客户街道地址
|
streetAddress | string |
客户的街道地址。 |
|
|
客户邮政编码
|
postCode | string |
客户的邮政编码。 |
|
|
客户城市
|
city | string |
客户所在城市。 |
|
|
客户省/自治区/直辖市
|
state | string |
客户的状态。 |
|
|
客户国家/地区
|
country | string |
客户的国家/地区。 |
|
|
客户主电话号码
|
primaryTelNumber | string |
客户的主要电话号码。 |
|
|
Name
|
name | True | string |
指定电话号码。 |
|
价值
|
value | string |
电话号码的值。 |
|
|
客户 UPN
|
UPN | string |
客户的 UPN。 |
|
|
客户 IM 地址
|
imAddress | string |
客户的 IM 地址。 |
|
|
客户电子邮件
|
string |
客户的电子邮件。 |
||
|
Name
|
name | True | string |
指定自定义域。 |
|
价值
|
value | string |
自定义域的值。 |
返回
更新通讯簿中的联系人
更新指定通讯簿中的单个联系人。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
Addressbook
|
AddressBook | True | string |
要在其中更新联系人的通讯簿。 |
|
联系外部 ID
|
externalId | True | string |
外部系统提供的联系人的 ID。 |
|
联系人名字
|
firstName | string |
联系人的名字。 |
|
|
联系人姓氏
|
lastName | string |
联系人的姓氏。 |
|
|
联系人显示名称
|
displayName | string |
联系人的显示名称。 |
|
|
联系人缩写
|
initials | string |
联系人的缩写。 |
|
|
联系公司
|
company | string |
联系人的公司。 |
|
|
联系部门
|
department | string |
联系人部门。 |
|
|
联系职务
|
jobTitle | string |
联系人的职务。 |
|
|
联系用户主体名称
|
userPrincipalName | string |
联系人的用户主体名称。 |
|
|
联系 IM 地址
|
imAddresses | array of string |
IM 地址列表。 |
|
|
联系人电子邮件地址
|
emailAddresses | array of string |
电子邮件地址列表。 |
|
|
联系商务电话
|
businessPhones | array of string |
商务电话列表。 |
|
|
联系移动电话
|
mobilePhones | array of string |
移动电话列表。 |
|
|
联系家庭电话
|
homePhones | array of string |
家庭电话列表。 |
|
|
地址街
|
street | string |
地址的街道和编号。 |
|
|
地址城市
|
city | string |
地址所在的城市。 |
|
|
地址国家/地区
|
country | string |
地址的国家/地区。 |
|
|
地址状态
|
state | string |
地址的状态。 |
|
|
地址邮政编码
|
postalCode | string |
地址的邮政编码。 |
|
|
Name
|
name | True | string |
指定自定义域。 |
|
价值
|
value | string |
自定义域的值。 |
返回
- Body
- ContactReadDto
添加新的外部任务
添加新的外部任务
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
服务 UPN
|
serviceUpn | True | string |
服务的 UPN。 |
|
客户标识符
|
customerIdentifier | string |
可选的唯一报告标识符,当为空时匿名。 |
|
|
客户名字
|
firstName | string |
客户的名字。 |
|
|
客户姓氏
|
lastName | string |
客户的姓氏。 |
|
|
客户显示名称
|
displayName | string |
客户的显示名称。 |
|
|
客户公司
|
company | string |
客户的公司。 |
|
|
客户职务
|
jobTitle | string |
客户的职务。 |
|
|
客户部门
|
department | string |
客户的部门。 |
|
|
客户街道地址
|
streetAddress | string |
客户的街道地址。 |
|
|
客户邮政编码
|
postCode | string |
客户的邮政编码。 |
|
|
客户城市
|
city | string |
客户所在城市。 |
|
|
客户省/自治区/直辖市
|
state | string |
客户的状态。 |
|
|
客户国家/地区
|
country | string |
客户的国家/地区。 |
|
|
客户主电话号码
|
primaryTelNumber | string |
客户的主要电话号码。 |
|
|
Name
|
name | True | string |
指定电话号码。 |
|
价值
|
value | string |
电话号码的值。 |
|
|
客户 UPN
|
UPN | string |
客户的 UPN。 |
|
|
客户 IM 地址
|
imAddress | string |
客户的 IM 地址。 |
|
|
客户电子邮件
|
string |
客户的电子邮件。 |
||
|
Name
|
name | True | string |
指定自定义域。 |
|
价值
|
value | string |
自定义域的值。 |
|
|
Name
|
name | True | string |
自定义上下文参数的名称。 |
|
价值
|
value | string |
自定义上下文参数的值。 |
|
|
分发优先级
|
distributionPriority | string |
一旦到期,任务应在 Nimbus 中处理该任务的优先级。 |
|
|
UPN
|
upn | True | string |
首选用户的 UPN。 |
|
Priority
|
priority | integer |
优先级。 1 高到 99 低。 |
返回
清空通讯簿
删除指定通讯簿中的所有联系人。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
Addressbook
|
AddressBook | True | string |
要为空的通讯簿 |
获取所有计划程序条目
返回指定服务的所有计划程序条目。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
服务 UPN
|
serviceUpn | True | string |
应为其返回计划程序条目的服务的 UPN。 |
返回
指定服务的所有计划任务列表
获取打开时间
获取服务打开时间:它在给定时间返回服务的状态(打开、关闭、假日等)。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
服务 UPN
|
serviceUpn | True | string |
将检查其状态的服务的 UPN。 |
|
截止日期时间(UTC)
|
time | date-time |
UTC 中的截止日期和时间:示例:“2020-03-23T11:00:00Z”。 |
返回
服务的状态(打开、关闭等)。
- response
- CalendarStatus
获取虚拟用户助理数据
返回所选服务会话的虚拟用户助理数据。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
服务会话 ID
|
serviceSessionId | True | string |
应为其返回虚拟用户助理数据的服务会话的 ID。 |
|
用户会话 ID
|
userSessionId | string |
应为其返回虚拟用户助理数据的用户会话的 ID。 |
|
|
数据类型
|
dataType | True | string |
应为服务会话返回的数据的类型。 |
返回
计划新的出站呼叫
计划新的出站呼叫(计划程序条目)。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
引用 ID
|
ReferenceId | string |
第三方系统传递的引用的 ID。 |
|
|
目的地
|
destination | True | string |
具有“出站”方向的计划程序条目的目标。 |
|
分发优先级
|
distributionPriority | string |
应在 Nimbus 中处理任务的优先级。 |
|
|
截止日期时间(UTC)
|
dueDateTimeUtc | True | date-time |
UTC 中的截止日期和时间:示例:“2020-03-23T11:00:00Z”。 |
|
服务 UPN
|
serviceUpn | True | string |
服务的 UPN。 |
|
最大尝试次数
|
maxAttempts | integer |
达到目标的最大尝试次数。 |
|
|
尝试超时(以秒为单位)
|
attemptTimeoutInSeconds | integer |
连接重试之间的超时(间隔),直到达到最大尝试次数。 |
|
|
最长队列时间(以秒为单位)
|
maxQueueTimeInSeconds | integer |
定义 Nimbus 尝试解决任务的时间,直到任务被视为“达到限制”。 |
|
|
RONA 超时(以秒为单位)
|
ronaTimeoutInSeconds | integer |
定义 Nimbus 尝试访问用户的时间,直到该任务被视为 RONA,并将选择一个新用户。 |
|
|
Name
|
name | True | string |
自定义上下文参数的名称。 |
|
价值
|
value | string |
自定义上下文参数的值。 |
|
|
客户名字
|
firstName | string |
客户的名字。 |
|
|
客户姓氏
|
lastName | string |
客户的姓氏。 |
|
|
客户显示名称
|
displayName | string |
客户的显示名称。 |
|
|
客户公司
|
company | string |
客户的公司。 |
|
|
客户职务
|
jobTitle | string |
客户的职务。 |
|
|
客户部门
|
department | string |
客户的部门。 |
|
|
客户街道地址
|
streetAddress | string |
客户的街道地址。 |
|
|
客户邮政编码
|
postCode | string |
客户的邮政编码。 |
|
|
客户城市
|
city | string |
客户所在城市。 |
|
|
客户省/自治区/直辖市
|
state | string |
客户的状态。 |
|
|
客户国家/地区
|
country | string |
客户的国家/地区。 |
|
|
客户主电话号码
|
primaryTelNumber | string |
客户的主要电话号码。 |
|
|
Name
|
name | True | string |
指定电话号码。 |
|
价值
|
value | string |
电话号码的值。 |
|
|
客户 UPN
|
UPN | string |
客户的 UPN。 |
|
|
客户 IM 地址
|
imAddress | string |
客户的 IM 地址。 |
|
|
客户电子邮件
|
string |
客户的电子邮件。 |
||
|
Name
|
name | True | string |
指定自定义域。 |
|
价值
|
value | string |
自定义域的值。 |
返回
触发器
| 任务更改状态时 |
每当匹配筛选条件的任务更改其状态时引发。 |
| 虚拟用户助手有更新时 |
当虚拟用户助手有新的更新时,将触发此事件。 |
| 计划程序条目更改状态时 |
每当与筛选器条件匹配的计划程序条目更改其状态时引发。 |
任务更改状态时
每当匹配筛选条件的任务更改其状态时引发。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
Services
|
services | True | array of string |
服务的 UPN,应为其提取任务的事件。 |
|
任务事件
|
taskEvents | True | array of string |
应为其引发此触发器的任务的事件。 |
|
方式
|
modalities | array of string |
指定任务的初始形式。 |
|
|
方向
|
directions | array of string |
指定任务的方向。 |
返回
- Body
- TaskEventData
虚拟用户助手有更新时
当虚拟用户助手有新的更新时,将触发此事件。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
Services
|
services | True | array of string |
服务的 UPN,应为其提取任务的事件。 |
|
虚拟用户助手事件
|
virtualUserAssistantEvents | True | array of string |
应为其引发此触发器的虚拟用户助手的事件。 |
返回
计划程序条目更改状态时
每当与筛选器条件匹配的计划程序条目更改其状态时引发。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
Services
|
services | True | array of string |
服务的 UPN,应为其提取任务的事件。 |
|
计划程序条目事件
|
schedulerEntryEvents | True | array of string |
计划程序条目的事件,应为其引发此触发器。 |
返回
定义
TaskEventData
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
任务 ID
|
taskId | string |
任务的 Nimbus 特定 ID。 |
|
服务会话 ID
|
serviceSessionId | string |
服务会话的 ID |
|
用户会话 ID
|
userSessionId | string |
用户会话的 ID |
|
用户会话从传输开始
|
userSessionStartedWithTransfer | boolean |
指示是否由于传输而启动用户会话。 |
|
呼叫链 ID
|
callChainId | string |
任务的Microsoft调用链 ID。 |
|
事件 / 活动
|
event | string |
任务在 Nimbus 中发生的事件。 |
|
方向
|
direction | string |
在 Nimbus 中正在进行的任务方向(入站/出站/无)。 |
|
Modality
|
modality | string |
Nimbus 中任务的初始形式。 |
|
已创建
|
created | string |
创建任务时的时间戳。 |
|
已终止
|
terminated | string |
时间戳,任务已终止时。 |
|
原因
|
reason | string |
终止原因。 |
|
上次连接用户的 ID
|
lastConnectedUserId | string |
任务上一个已连接用户的对象 ID (AAD)。 |
|
上次连接的用户的 UPN
|
LastConnectedUserUPN | string |
任务的上一个已连接用户的 UPN。 |
|
上次连接用户的电子邮件
|
LastConnectedUserEmail | string |
任务上一个已连接用户的电子邮件。 |
|
Microsoft来电显示
|
microsoftCallerId | string |
调用方的对象 ID (AAD)。 |
|
引用 ID
|
referenceId | string |
第三方系统传递的引用的 ID。 |
|
来电显示
|
callerId | string |
Nimbus 中调用方的内部 ID。 如果调用方已知,则对象 ID (AAD)。 |
|
呼叫方电话号码
|
callerTelNumber | string |
呼叫者的电话号码(E.164)。 仅针对具有 modality=Audio 的任务进行设置。 |
|
调用方 UPN
|
callerUPN | string |
客户的 UPN。 |
|
Microsoft目标 ID
|
microsoftDestinationId | string |
出站任务中被调用方的对象 ID (AAD)。 |
|
目标 ID
|
destinationId | string |
Nimbus 中目标(出站)的内部 ID。 如果调用方已知,则对象 ID (AAD)。 |
|
目标电话号码
|
destinationTelNumber | string |
目的地的电话号码(E.164)。 |
|
目标 UPN
|
destinationUPN | string |
目标 UPN(出站)。 |
|
ACS ID
|
acsId | string |
调用方 Azure 通信 ID。 |
|
是匿名的
|
isAnonymous | boolean |
当调用方为匿名时,标志设置为 true。 |
|
客户标识符
|
customerIdentifier | string |
所有任务类型中的客户的标识符。 |
|
初始消息
|
initialMessage | string |
首先向 IM 客户发送消息。 |
|
服务编号
|
serviceId | string |
Nimbus 服务的内部 ID。 |
|
服务名称
|
serviceName | string |
Nimbus 服务的名称。 |
|
服务说明
|
serviceDescription | string |
Nimbus 服务的说明(继承自 Microsoft Teams)。 |
|
服务显示名称
|
serviceDisplayName | string |
Nimbus 服务的显示名称。 |
|
服务 UPN
|
serviceUPN | string |
Nimbus 服务的 UPN。 |
|
服务电话号码
|
serviceTelNumber | string |
尼布斯服务的电话号码(E.164)。 |
|
电子邮件主题
|
emailSubject | string |
电子邮件的主题。 |
|
电子邮件正文唯一格式文本
|
emailBodyUniqueRichText | string |
电子邮件正文,格式文本。 |
|
电子邮件正文唯一纯文本
|
emailBodyUniquePlainText | string |
电子邮件正文,纯文本。 |
|
电子邮件服务邮箱 UPN
|
emailServiceMailboxUPN | string |
分配给服务的邮箱的 UPN。 |
|
出站尝试
|
outboundAttempt | integer |
到达出站目标的尝试次数。 |
|
更新了参数名称
|
updatedParameterName | string |
已更新的最后一个参数的名称。 |
|
更新了参数值
|
updatedParameterValue | string |
已更新的最后一个参数的值。 |
|
任务信息
|
taskInformation | TaskInformation |
包含有关客户、自定义上下文参数和首选用户的信息。 |
TaskInformation
包含有关客户、自定义上下文参数和首选用户的信息。
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
顾客
|
customer | Customer |
包含客户的所有信息的对象。 |
|
自定义上下文参数
|
customContextParameters | array of CustomContextParameter |
自定义上下文参数列表(Key-Value)。 |
|
首选用户
|
preferredUsers | array of PreferredUser |
任务的首选用户列表(UPN-Priority)。 |
客户
包含客户的所有信息的对象。
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
客户名字
|
firstName | string |
客户的名字。 |
|
客户姓氏
|
lastName | string |
客户的姓氏。 |
|
客户显示名称
|
displayName | string |
客户的显示名称。 |
|
客户公司
|
company | string |
客户的公司。 |
|
客户职务
|
jobTitle | string |
客户的职务。 |
|
客户部门
|
department | string |
客户的部门。 |
|
客户街道地址
|
streetAddress | string |
客户的街道地址。 |
|
客户邮政编码
|
postCode | string |
客户的邮政编码。 |
|
客户城市
|
city | string |
客户所在城市。 |
|
客户省/自治区/直辖市
|
state | string |
客户的状态。 |
|
客户国家/地区
|
country | string |
客户的国家/地区。 |
|
客户主电话号码
|
primaryTelNumber | string |
客户的主要电话号码。 |
|
电话号码
|
telNumbers | array of TelNumber |
客户的其他电话号码列表。 |
|
客户 UPN
|
UPN | string |
客户的 UPN。 |
|
客户 IM 地址
|
imAddress | string |
客户的 IM 地址。 |
|
客户电子邮件
|
string |
客户的电子邮件。 |
|
|
自定义字段
|
customFields | array of CustomField |
客户的自定义字段列表。 |
TelNumber
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
Name
|
name | string |
指定电话号码。 |
|
价值
|
value | string |
电话号码的值。 |
CustomField
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
Name
|
name | string |
指定自定义域。 |
|
价值
|
value | string |
自定义域的值。 |
CustomContextParameter
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
Name
|
name | string |
自定义上下文参数的名称。 |
|
价值
|
value | string |
自定义上下文参数的值。 |
PreferredUser
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
UPN
|
upn | string |
首选用户的 UPN。 |
|
Priority
|
priority | integer |
优先级。 1 高到 99 低。 |
ContactReadDto
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
联系外部 ID
|
externalId | string |
外部系统提供的联系人的 ID。 |
|
联系人名字
|
firstName | string |
联系人的名字。 |
|
联系人姓氏
|
lastName | string |
联系人的姓氏。 |
|
联系人显示名称
|
displayName | string |
联系人的显示名称。 |
|
联系人缩写
|
initials | string |
联系人的缩写。 |
|
联系公司
|
company | string |
联系人的公司。 |
|
联系部门
|
department | string |
联系人部门。 |
|
联系职务
|
jobTitle | string |
联系人的职务。 |
|
联系用户主体名称
|
userPrincipalName | string |
联系人的用户主体名称。 |
|
联系 IM 地址
|
imAddresses | array of string |
IM 地址列表。 |
|
联系人电子邮件地址
|
emailAddresses | array of string |
电子邮件地址列表。 |
|
联系商务电话
|
businessPhones | array of string |
商务电话列表。 |
|
联系移动电话
|
mobilePhones | array of string |
移动电话列表。 |
|
联系家庭电话
|
homePhones | array of string |
家庭电话列表。 |
|
地址
|
addresses | array of Address |
地址列表。 |
|
customFields
|
customFields | array of CustomField |
联系人的自定义字段列表。 |
地址
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
地址街
|
street | string |
地址的街道和编号。 |
|
地址城市
|
city | string |
地址所在的城市。 |
|
地址国家/地区
|
country | string |
地址的国家/地区。 |
|
地址状态
|
state | string |
地址的状态。 |
|
地址邮政编码
|
postalCode | string |
地址的邮政编码。 |
SchedulerEntryEventData
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
计划程序条目 ID
|
schedulerEntryId | string |
计划程序条目的 Nimbus 特定 ID。 |
|
ConversationType
|
conversationType | string |
计划程序条目的对话类型。 |
|
事件 / 活动
|
event | string |
在 Nimbus 中为计划任务发生的事件。 |
|
方向
|
direction | string |
在 Nimbus 中正在进行的任务方向(入站/出站/无)。 |
|
Modality
|
modality | string |
Nimbus 中任务的初始形式。 |
|
引用 ID
|
ReferenceId | string |
第三方系统传递的引用的 ID。 |
|
统一对话 ID
|
unifiedConversationId | string |
统一对话 ID。 |
|
完成原因
|
completionReason | string |
终止时计划程序条目的结果。 |
|
目的地
|
destination | string |
具有“出站”方向的计划程序条目的目标。 |
|
分发优先级
|
distributionPriority | string |
应在 Nimbus 中处理任务的优先级。 |
|
截止日期时间(UTC)
|
dueDateTimeUtc | date-time |
UTC 中的截止日期和时间:示例:“2020-03-23T11:00:00Z”。 |
|
服务 UPN
|
serviceUpn | string |
为其计划条目的服务的 UPN。 |
|
最大尝试次数
|
maxAttempts | integer |
达到目标的最大尝试次数。 |
|
尝试超时(以秒为单位)
|
attemptTimeoutInSeconds | integer |
连接重试之间的超时(间隔),直到达到最大尝试次数。 |
|
最长队列时间(以秒为单位)
|
maxQueueTimeInSeconds | integer |
定义 Nimbus 尝试解决任务的时间,直到任务被视为“达到限制”。 |
|
RONA 超时(以秒为单位)
|
ronaTimeoutInSeconds | integer |
定义 Nimbus 尝试访问用户的时间,直到该任务被视为 RONA,并将选择一个新用户。 |
|
自定义上下文参数
|
customCallContextParameters | array of CustomContextParameter |
自定义上下文参数列表(Key-Value)。 |
|
顾客
|
customer | Customer |
包含客户的所有信息的对象。 |
OutboundCallWithWorkflowSchedulerEntryEventData
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
计划程序条目 ID
|
schedulerEntryId | string |
计划程序条目的 Nimbus 特定 ID。 |
|
ConversationType
|
conversationType | string |
计划程序条目的对话类型。 |
|
事件 / 活动
|
event | string |
在 Nimbus 中为计划任务发生的事件。 |
|
方向
|
direction | string |
在 Nimbus 中正在进行的任务方向(入站/出站/无)。 |
|
Modality
|
modality | string |
Nimbus 中任务的初始形式。 |
|
引用 ID
|
ReferenceId | string |
第三方系统传递的引用的 ID。 |
|
统一对话 ID
|
unifiedConversationId | string |
统一对话 ID。 |
|
完成原因
|
completionReason | string |
终止时计划程序条目的结果。 |
|
目的地
|
destination | string |
具有“出站”方向的计划程序条目的目标。 |
|
分发优先级
|
distributionPriority | string |
应在 Nimbus 中处理任务的优先级。 |
|
截止日期时间(UTC)
|
dueDateTimeUtc | date-time |
UTC 中的截止日期和时间:示例:“2020-03-23T11:00:00Z”。 |
|
服务 UPN
|
serviceUpn | string |
为其计划条目的服务的 UPN。 |
|
最大尝试次数
|
maxAttempts | integer |
达到目标的最大尝试次数。 |
|
尝试超时(以秒为单位)
|
attemptTimeoutInSeconds | integer |
定义 Nimbus 在尝试停止之前尝试到达目标的时间。 |
|
自定义上下文参数
|
customCallContextParameters | array of CustomContextParameter |
自定义上下文参数列表(Key-Value)。 |
|
顾客
|
customer | Customer |
包含客户的所有信息的对象。 |
VirtualUserAssistantEventData
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
统一会话 ID
|
unifiedSessionId | string |
相关 Nimbus 统一会话的 ID。 |
|
服务会话 ID
|
serviceSessionId | string |
相关 Nimbus 服务会话的 ID。 |
|
用户会话 ID
|
userSessionId | string |
相关 Nimbus 用户会话的 ID。 |
|
服务 UPN
|
serviceUpn | string |
发生事件的服务的 UPN。 |
|
服务编号
|
serviceId | string |
发生事件的服务的 ID。 |
|
服务名称
|
serviceName | string |
发生事件的服务的名称。 |
|
事件 / 活动
|
event | string |
在 Nimbus 中发生的虚拟用户助手事件。 |
|
用户会话从传输开始
|
userSessionStartedWithTransfer | boolean |
指示是否由于传输而启动用户会话。 |
ExternalTaskWriteResult
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
外部任务 ID
|
id | string |
已添加的外部任务的 ID。 |
|
Modality
|
modality | Modality |
任务的形式。 |
|
已创建
|
created | string |
时间戳,创建外部任务时。 |
|
类型
|
type | string |
外部任务的类型。 |
|
是匿名的
|
isAnonymous | boolean |
当调用方为匿名时,标志设置为 true。 |
|
服务编号
|
serviceId | string |
Nimbus 服务的内部 ID。 |
|
服务名称
|
serviceName | string |
Nimbus 服务的名称。 |
|
服务说明
|
serviceDescription | string |
Nimbus 服务的说明(继承自 Microsoft Teams)。 |
|
服务显示名称
|
serviceDisplayName | string |
服务的显示名称。 |
|
服务 UPN
|
serviceUPN | string |
服务的 UPN。 |
|
服务 Tel 号码
|
serviceTelNumber | string |
服务的电话号码。 |
|
首选用户
|
preferredUsers | array of PreferredUser |
任务的首选用户列表(UPN-Priority)。 |