实时聊天（LiveChat）
LiveChat 是一种在线客户服务软件，提供实时支持、技术支持软件和 Web 分析功能。
此连接器在以下产品和区域中可用：
| 服务 | 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 | Microsoft |
| URL | https://www.livechat.com/ |
| 连接器元数据 | |
|---|---|
| 发布者 | Microsoft |
| 网站 | https://www.livechat.com/ |
| 隐私策略 | https://www.livechat.com/legal/privacy-policy/ |
| Categories | 通信 |
正在创建连接
连接器支持以下身份验证类型：
| 默认 | 用于创建连接的参数。 | 所有区域 | 不可共享 |
违约
适用：所有区域
用于创建连接的参数。
这是不可共享的连接。 如果 Power App 与另一个用户共享，系统会提示其他用户显式创建新连接。
| Name | 类型 | Description | 必选 |
|---|---|---|---|
| 旧实体 ID （已弃用） | 字符串 | 仅弃用的 LiveChat API v2 操作使用的实体 ID（电子邮件地址）。 | |
| 帐户标识 | 字符串 | LiveChat 个人访问令牌页上显示的帐户 ID（GUID）。 新的 （V2） 连接器操作将此值与 LiveChat API v3.6 配合使用。 | True |
| 个人访问令牌 | securestring | 此帐户的完整未编码个人访问令牌。 | True |
限制
| 名称 | 调用 | 续订期 |
|---|---|---|
| 每个连接的 API 调用数 | 100 | 60 秒 |
操作
| 列出代理 （V2） |
使用 LiveChat API v3.6 返回 LiveChat 许可证中的所有代理。 个人访问令牌需要代理--all：ro 范围。 |
| 列出代理 （已弃用） [已弃用] |
此弃用的操作使用 LiveChat API v2 返回代理。 请改用列表代理（V2）。 |
| 列出票证 （已弃用） [已弃用] |
此已弃用的操作使用已停用的 LiveChat 票证 API。 |
| 创建新代理 （V2） |
使用 LiveChat API v3.6 创建代理。 代理可能需要批准，具体取决于个人访问令牌范围和 LiveChat 订阅。 |
| 创建新的代理 （已弃用） [已弃用] |
此弃用的操作使用 LiveChat API v2 创建代理。 请改用“创建新代理”（V2）。 |
| 创建新的票证 （已弃用） [已弃用] |
此已弃用的操作使用已停用的 LiveChat 票证 API。 |
| 删除代理 （V2） |
使用 LiveChat API v3.6 删除代理。 删除另一个代理需要 agents-all：rw 和 accounts-all：rw 范围。 |
| 删除代理 （已弃用） [已弃用] |
此弃用的操作使用 LiveChat API v2 删除代理。 请改用“删除代理”（V2）。 |
| 更新票证 （已弃用） [已弃用] |
此已弃用的操作使用已停用的 LiveChat 票证 API。 |
| 获取票证 （已弃用） [已弃用] |
此已弃用的操作使用已停用的 LiveChat 票证 API。 |
列出代理 （V2）
使用 LiveChat API v3.6 返回 LiveChat 许可证中的所有代理。 个人访问令牌需要代理--all：ro 范围。
返回
LiveChat 许可证中的代理。
列出代理 （已弃用） [已弃用]
列出票证 （已弃用） [已弃用]
创建新代理 （V2）
使用 LiveChat API v3.6 创建代理。 代理可能需要批准，具体取决于个人访问令牌范围和 LiveChat 订阅。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
代理标识
|
id | True | string |
代理 ID，通常是代理电子邮件地址。 |
|
Name
|
name | True | string |
代理名称。 |
|
角色
|
role | string |
创建高于正常角色需要 accounts.roles.lc-all：rw 范围。 |
|
|
登录状态
|
login_status | string | ||
|
职务
|
job_title | string | ||
|
Mobile
|
mobile | string | ||
|
最大聊天计数
|
max_chats_count | integer | ||
|
待审批
|
awaiting_approval | boolean |
将此设置为 false 需要专用 subscription.lc：rw 范围。 |
|
|
群组标识符
|
id | True | integer | |
|
Priority
|
priority | True | string | |
|
Notifications
|
notifications | array of string | ||
|
电子邮件订阅
|
email_subscriptions | array of string | ||
|
时区
|
timezone | string |
工作日程使用的时区。 |
|
|
日
|
day | True | string | |
|
Enabled
|
enabled | True | boolean | |
|
Start
|
start | True | string | |
|
结束
|
end | True | string |
创建新的代理 （已弃用） [已弃用]
此弃用的操作使用 LiveChat API v2 创建代理。 请改用“创建新代理”（V2）。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
Email
|
login | True | string | |
|
Name
|
name | True | string | |
|
登录状态
|
login_status | string | ||
|
Title
|
job_title | string |
默认值为：支持代理。 |
|
|
许可
|
permission | string | ||
|
密码
|
password | string |
最小长度 5. |
|
|
最大聊天计数
|
max_chats_count | string |
并发聊天的限制。 |
返回
- Body
- CreateAgent_Response
创建新的票证 （已弃用） [已弃用]
此已弃用的操作使用已停用的 LiveChat 票证 API。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
Message
|
message | True | string | |
|
请求者的电子邮件
|
True | string | ||
|
请求者的姓名
|
name | string | ||
|
Subject
|
subject | string | ||
|
被分配者 ID
|
id | string | ||
|
源类型
|
type | string |
选取源 |
|
|
源 URL
|
url | string |
如果源类型为聊天窗口。 |
返回
- Body
- TicketResponse
删除代理 （V2）
使用 LiveChat API v3.6 删除代理。 删除另一个代理需要 agents-all：rw 和 accounts-all：rw 范围。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
代理标识
|
id | True | string |
要删除的代理的 ID。 |
删除代理 （已弃用） [已弃用]
此弃用的操作使用 LiveChat API v2 删除代理。 请改用“删除代理”（V2）。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
Email
|
login | True | string |
代理的电子邮件。 |
返回
- Body
- DeleteAgent_Response
更新票证 （已弃用） [已弃用]
此已弃用的操作使用已停用的 LiveChat 票证 API。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
票证 ID
|
ticketId | True | string |
票证的 ID |
|
Message
|
message | string | ||
|
请求者的电子邮件
|
True | string | ||
|
请求者的姓名
|
name | string | ||
|
Subject
|
subject | string | ||
|
被分配者 ID
|
id | string |
选取被分配者。 |
|
|
源类型
|
type | string |
选取源。 |
|
|
源 URL
|
url | string |
如果源类型为聊天窗口。 |
返回
- Body
- TicketResponse
获取票证 （已弃用） [已弃用]
此已弃用的操作使用已停用的 LiveChat 票证 API。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
票证 ID
|
ticketId | True | string |
票证的 ID |
返回
- Body
- TicketResponse
触发器
| 创建票证时（已弃用） [已弃用] |
此已弃用的操作使用已停用的 LiveChat 票证 API。 |
| 聊天启动时（已弃用） [已弃用] |
此弃用的操作使用 LiveChat API v2。 |
| 聊天结束时（已弃用） [已弃用] |
此弃用的操作使用 LiveChat API v2。 |
创建票证时（已弃用） [已弃用]
聊天启动时（已弃用） [已弃用]
聊天结束时（已弃用） [已弃用]
定义
WebhookChatResponse
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
代理
|
chat.agents | array of object |
代理 |
|
代理电子邮件
|
chat.agents.login | string |
代理的电子邮件地址。 |
|
代理名称
|
chat.agents.name | string |
代理的名称。 |
|
结束时间戳
|
chat.ended_timestamp | string |
yyyy-MM-ddTHH：mm：ss.fffZ |
|
events
|
chat.events | array of object |
事件数组。 |
|
事件文本
|
chat.events.text | string |
与事件关联的消息。 |
|
事件 Date-Time
|
chat.events.timestamp | string |
yyyy-MM-ddTHH：mm：ss.fffZ |
|
事件类型
|
chat.events.type | string |
事件类型。 |
|
事件用户类型
|
chat.events.user_type | string |
用户类型。 |
|
groups
|
chat.groups | array of integer | |
|
组 ID
|
chat.id | string |
组的唯一标识符。 |
|
Message
|
chat.messages | array of object |
消息数组。 |
|
代理 ID
|
chat.messages.agent_id | string |
与消息关联的代理的唯一 ID。 |
|
作者名称
|
chat.messages.author_name | string |
消息的 author. |
|
文本
|
chat.messages.text | string |
消息正文。 |
|
已发送 Date-Time
|
chat.messages.timestamp | string |
yyyy-MM-ddTHH：mm：ss.fffZ |
|
用户类型
|
chat.messages.user_type | string |
发送消息的用户的类型。 |
|
已启动 Date-Time
|
chat.started_timestamp | string |
yyyy-MM-ddTHH：mm：ss.fffZ |
|
tags
|
chat.tags | array of string | |
|
URL
|
chat.url | string |
聊天开始的网站 URL。 |
|
事件 ID
|
event_unique_id | string |
与聊天关联的事件的唯一 ID。 |
|
聊天前调查
|
pre_chat_survey | array of object |
聊天前调查响应的数组。 |
|
答案
|
pre_chat_survey.answer | string |
调查答案。 |
|
调查 ID
|
pre_chat_survey.id | string |
预聊天调查 ID。 |
|
问题
|
pre_chat_survey.label | string |
调查问题。 |
|
Email
|
visitor.email | string |
访问者的电子邮件地址。 |
|
Id
|
visitor.id | string |
访问者的唯一 ID。 |
|
语言
|
visitor.language | string |
与访问者帐户关联的语言。 |
|
Name
|
visitor.name | string |
访问者的名称。 |
|
页
|
visitor.page_current | string |
聊天源自的网页。 |
WebhookTicketResponse
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
Id
|
ticket.assignee.id | string |
用户的唯一标识符。 |
|
Name
|
ticket.assignee.name | string |
被分配者的名称。 |
|
events
|
ticket.events | array of object | |
|
Id
|
ticket.events.author.id | string |
用户的唯一 ID。 |
|
Name
|
ticket.events.author.name | string |
作者的名称。 |
|
类型
|
ticket.events.author.type | string |
代理或客户端。 |
|
事件 Date-Time
|
ticket.events.date | date-time |
yyyy-MM-ddTHH：mm：ss.fffZ |
|
专用
|
ticket.events.is_private | boolean |
如此 如果事件是私有的。 |
|
Message
|
ticket.events.message | string |
事件的说明。 |
|
类型
|
ticket.events.source.type | string |
聊天窗口、邮件或 lc2。 |
|
URL
|
ticket.events.source.url | string |
从中发送票证的网站 URL。 |
|
事件类型
|
ticket.events.type | string |
生成票证的事件的类型。 |
|
组
|
ticket.groups | array of object |
关联组的详细信息。 |
|
Id
|
ticket.groups.id | integer |
组的唯一 ID。 |
|
Name
|
ticket.groups.name | string |
组名称。 |
|
票证 ID
|
ticket.id | string |
票证的唯一 ID。 |
|
IP
|
ticket.requester.ip | string |
请求者的 IP 地址。 |
|
Email
|
ticket.requester.mail | string |
请求者的电子邮件地址。 |
|
Name
|
ticket.requester.name | string |
请求者的名称。 |
|
Id
|
ticket.source.id | string |
源的唯一 ID。 |
|
类型
|
ticket.source.type | string |
Lc2、mail、facebook、agent-app-manual 或 chat-window。 |
|
URL
|
ticket.source.url | string |
创建票证的网站 URL。 |
|
状态
|
ticket.status | string |
打开、挂起、已解决或垃圾邮件。 |
|
Subject
|
ticket.subject | string |
票证的简短说明。 |
|
tags
|
ticket.tags | array of string |
ListTicketsResponse
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
已创建 Date-Time
|
date | date-time |
yyyy-MM-ddTHH：mm：ss.fffZ |
|
票证 ID
|
id | string |
票证的唯一标识符。 |
|
修改后的 Date-Time
|
modified | date-time |
yyyy-MM-ddTHH：mm：ss.fffZ |
|
IP
|
requester.ip | string |
请求者的 IP 地址。 |
|
Email
|
requester.mail | string |
请求者的电子邮件地址。 |
|
Name
|
requester.name | string |
请求者的全名。 |
|
Id
|
source.id | string |
源的唯一标识符。 |
|
类型
|
source.type | string |
从聊天、邮件或 lc2。 |
|
URL
|
source.url | string |
创建票证的网页。 |
|
状态
|
status | string |
打开、挂起、已解决或垃圾邮件。 |
|
Subject
|
subject | string |
票证源的说明。 |
TicketResponse
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
Id
|
currentGroup.id | integer |
组的唯一 ID。 |
|
Name
|
currentGroup.name | string |
组名称。 |
|
已创建 Date-Time
|
date | date-time |
yyyy-MM-ddTHH：mm：ss.fffZ |
|
events
|
events | array of object | |
|
Id
|
events.author.id | string |
用户的唯一 ID。 |
|
Name
|
events.author.name | string |
作者的名称。 |
|
类型
|
events.author.type | string |
代理或客户端。 |
|
事件 Date-Time
|
events.date | date-time |
yyyy-MM-ddTHH：mm：ss.fffZ |
|
专用
|
events.is_private | boolean |
如此 如果事件是私有的。 |
|
Message
|
events.message | string |
事件的说明。 |
|
类型
|
events.source.type | string |
聊天窗口、邮件或 lc2。 |
|
URL
|
events.source.url | string |
从中发送票证的网站 URL。 |
|
事件类型
|
events.type | string |
生成票证的事件的类型。 |
|
组
|
groups | array of object |
关联组的详细信息。 |
|
Id
|
groups.id | integer |
组的唯一 ID。 |
|
Name
|
groups.name | string |
组名称。 |
|
票证 ID
|
id | string |
票证的唯一 ID。 |
|
IP
|
requester.ip | string |
请求者的 IP 地址。 |
|
Email
|
requester.mail | string |
请求者的电子邮件地址。 |
|
Name
|
requester.name | string |
请求者的名称。 |
|
Id
|
source.id | string |
源的唯一 ID。 |
|
类型
|
source.type | string |
Lc2、mail、facebook、agent-app-manual 或 chat-window。 |
|
URL
|
source.url | string |
创建票证的网站 URL。 |
|
状态
|
status | string |
打开、挂起、已解决或垃圾邮件。 |
|
Subject
|
subject | string |
票证的简短说明。 |
|
tags
|
tags | array of string |
ListAgentsV2_Response
LiveChat 许可证中的代理。
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
物品
|
AgentV2 |
AgentV2
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
代理标识
|
id | string |
代理 ID，通常是代理电子邮件地址。 |
|
Name
|
name | string |
代理名称。 |
|
Avatar
|
avatar | string |
代理头像 URL。 |
|
角色
|
role | string |
代理角色。 |
|
登录状态
|
login_status | string |
代理登录状态。 |
|
职务
|
job_title | string |
代理职务。 |
|
Mobile
|
mobile | string |
代理电话号码。 |
|
最大聊天计数
|
max_chats_count | integer |
并发聊天的最大数量。 |
|
已暂停
|
suspended | boolean |
代理是否挂起。 |
|
待审批
|
awaiting_approval | boolean |
代理是否正在等待审批。 |
|
groups
|
groups | array of AgentGroupV2 |
分配给代理的组。 |
AgentGroupV2
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
群组标识符
|
id | integer | |
|
Priority
|
priority | string |
ListAgents_Response
包含其详细信息的所有代理的列表。
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
Avatar
|
avatar | string |
Amazon s3 上图像的路径。 |
|
登录电子邮件
|
login | string |
代理的电子邮件地址。 |
|
Name
|
name | string |
代理的名称。 |
|
许可
|
permission | string |
所有者、管理员或正常。 |
CreateAgent_Response
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
Avatar
|
avatar | string |
Amazon s3 上图像的路径。 |
|
组数组
|
groups | array of object |
代理所属的所有组的列表。 |
|
组 ID
|
groups.id | integer |
组的唯一 ID。 |
|
组名称
|
groups.name | string |
组名称。 |
|
职务
|
job_title | string |
默认情况下支持代理。 |
|
Email
|
login | string |
代理的电子邮件地址。 |
|
登录状态
|
login_status | string |
接受聊天或不接受聊天。 |
|
最大聊天计数
|
max_chats_count | integer |
并发聊天的限制。 |
|
Name
|
name | string |
代理的名称。 |
|
许可
|
permission | string |
所有者、管理员或正常 |
|
状态
|
status | string |
接受聊天，不接受聊天或脱机。 |