Онлайн-чат
LiveChat — это онлайн-программное обеспечение службы клиентов с динамической поддержкой, программным обеспечением службы поддержки и возможностями веб-аналитики.
Этот соединитель доступен в следующих продуктах и регионах:
| Услуга | 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) |
| Контакт | |
|---|---|
| Имя | Microsoft |
| URL | https://www.livechat.com/ |
| Метаданные соединителя | |
|---|---|
| Publisher | Microsoft |
| Веб-сайт | https://www.livechat.com/ |
| Политика конфиденциальности | https://www.livechat.com/legal/privacy-policy/ |
| Categories | Коммуникация |
Создание подключения
Соединитель поддерживает следующие типы проверки подлинности:
| По умолчанию | Параметры для создания подключения. | Все регионы | Недоступен для совместного использования |
По умолчанию
Применимо: все регионы
Параметры для создания подключения.
Это недоступно для общего доступа. Если приложение power предоставляется другому пользователю, пользователю будет предложено явно создать новое подключение.
| Имя | Тип | Description | Обязательно |
|---|---|---|---|
| Устаревший идентификатор сущности (не рекомендуется) | струна | Идентификатор сущности (адрес электронной почты), используемый только нерекомендуемыми операциями API LiveChat версии 2. | |
| Идентификатор учетной записи | струна | Идентификатор учетной записи (GUID), показанный на странице "Личные маркеры доступа LiveChat". Новые операции соединителя версии 2 используют это значение с API LiveChat версии 3.6. | True |
| Персональный токен доступа | securestring | Полный некодированный личный маркер доступа для этой учетной записи. | True |
Ограничения регулирования
| Имя | Вызовы | Период обновления |
|---|---|---|
| Вызовы API для каждого подключения | 100 | 60 секунд |
Действия
| Обновление билета (не рекомендуется) [DEPRECATED] |
Эта нерекомендуемая операция использует устаревший API LiveChat Tickets. |
| Получение билета (не рекомендуется) [DEPRECATED] |
Эта нерекомендуемая операция использует устаревший API LiveChat Tickets. |
| Создание агента (версия 2) |
Создает агент с помощью API LiveChat версии 3.6. Агент может требовать утверждения в зависимости от областей личного доступа и подписки LiveChat. |
| Создание нового агента (не рекомендуется) [DEPRECATED] |
Эта нерекомендуемая операция создает агент с помощью API LiveChat версии 2. Вместо этого используйте новый агент (V2). |
| Создание нового билета (не рекомендуется) [DEPRECATED] |
Эта нерекомендуемая операция использует устаревший API LiveChat Tickets. |
| Список агентов (версия 2) |
Возвращает все агенты в лицензии LiveChat с помощью API LiveChat версии 3.6. Для личного маркера доступа требуется область agent-all:ro. |
| Список агентов (не рекомендуется) [DEPRECATED] |
Эта нерекомендуемая операция возвращает агенты с помощью API LiveChat версии 2. Вместо этого используйте агенты списка (версия 2). |
| Список билетов (не рекомендуется) [DEPRECATED] |
Эта нерекомендуемая операция использует устаревший API LiveChat Tickets. |
| Удаление агента (версия 2) |
Удаляет агент с помощью API LiveChat версии 3.6. Для удаления другого агента требуются области agent-all:rw и accounts-all:rw. |
| Удаление агента (не рекомендуется) [DEPRECATED] |
Эта нерекомендуемая операция удаляет агент с помощью API LiveChat версии 2. Вместо этого используйте команду "Удалить агент" (версия 2). |
Обновление билета (не рекомендуется) [DEPRECATED]
Эта нерекомендуемая операция использует устаревший API LiveChat Tickets.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор билета
|
ticketId | True | string |
Идентификатор билета |
|
Message
|
message | string | ||
|
Электронная почта запрашивающего
|
True | string | ||
|
Имя запрашивающего пользователя
|
name | string | ||
|
Тема
|
subject | string | ||
|
Идентификатор назначаемого пользователя
|
id | string |
Выберите назначаемого. |
|
|
Тип источника
|
type | string |
Выберите источник. |
|
|
URL-адрес источника
|
url | string |
Если тип источника является окном чата. |
Возвращаемое значение
- Тело
- TicketResponse
Получение билета (не рекомендуется) [DEPRECATED]
Эта нерекомендуемая операция использует устаревший API LiveChat Tickets.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор билета
|
ticketId | True | string |
Идентификатор билета |
Возвращаемое значение
- Тело
- TicketResponse
Создание агента (версия 2)
Создает агент с помощью API LiveChat версии 3.6. Агент может требовать утверждения в зависимости от областей личного доступа и подписки LiveChat.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
ID агента
|
id | True | string |
Идентификатор агента, как правило, адрес электронной почты агента. |
|
Имя
|
name | True | string |
Имя агента. |
|
Роль
|
role | string |
Для создания роли выше, чем обычно, требуется область accounts.role.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 |
Создание нового агента (не рекомендуется) [DEPRECATED]
Эта нерекомендуемая операция создает агент с помощью API LiveChat версии 2. Вместо этого используйте новый агент (V2).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Адрес электронной почты
|
login | True | string | |
|
Имя
|
name | True | string | |
|
Состояние входа
|
login_status | string | ||
|
Название
|
job_title | string |
По умолчанию: агент поддержки. |
|
|
Разрешение
|
permission | string | ||
|
Пароль
|
password | string |
Минимальная длина 5. |
|
|
Максимальное количество чатов
|
max_chats_count | string |
Ограничение одновременных чатов. |
Возвращаемое значение
- Тело
- CreateAgent_Response
Создание нового билета (не рекомендуется) [DEPRECATED]
Эта нерекомендуемая операция использует устаревший API LiveChat Tickets.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Message
|
message | True | string | |
|
Электронная почта запрашивающего
|
True | string | ||
|
Имя запрашивающего пользователя
|
name | string | ||
|
Тема
|
subject | string | ||
|
Идентификатор назначаемого пользователя
|
id | string | ||
|
Тип источника
|
type | string |
Выбор источника |
|
|
URL-адрес источника
|
url | string |
Если тип источника является окном чата. |
Возвращаемое значение
- Тело
- TicketResponse
Список агентов (версия 2)
Возвращает все агенты в лицензии LiveChat с помощью API LiveChat версии 3.6. Для личного маркера доступа требуется область agent-all:ro.
Возвращаемое значение
Агенты в лицензии LiveChat.
- Товары
- ListAgentsV2_Response
Список агентов (не рекомендуется) [DEPRECATED]
Эта нерекомендуемая операция возвращает агенты с помощью API LiveChat версии 2. Вместо этого используйте агенты списка (версия 2).
Возвращаемое значение
Список всех агентов со своими сведениями.
- Товары
- ListAgents_Response
Список билетов (не рекомендуется) [DEPRECATED]
Эта нерекомендуемая операция использует устаревший API LiveChat Tickets.
Возвращаемое значение
- Товары
- ListTicketsResponse
Удаление агента (версия 2)
Удаляет агент с помощью API LiveChat версии 3.6. Для удаления другого агента требуются области agent-all:rw и accounts-all:rw.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
ID агента
|
id | True | string |
Идентификатор удаляемого агента. |
Удаление агента (не рекомендуется) [DEPRECATED]
Эта нерекомендуемая операция удаляет агент с помощью API LiveChat версии 2. Вместо этого используйте команду "Удалить агент" (версия 2).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Адрес электронной почты
|
login | True | string |
Сообщение электронной почты агента. |
Возвращаемое значение
- Тело
- DeleteAgent_Response
Триггеры
| Когда чат заканчивается (не рекомендуется) [DEPRECATED] |
Эта нерекомендуемая операция использует API LiveChat версии 2. |
| При запуске чата (не рекомендуется) [DEPRECATED] |
Эта нерекомендуемая операция использует API LiveChat версии 2. |
| При создании билета (не рекомендуется) [DEPRECATED] |
Эта нерекомендуемая операция использует устаревший API LiveChat Tickets. |
Когда чат заканчивается (не рекомендуется) [DEPRECATED]
Эта нерекомендуемая операция использует API LiveChat версии 2.
Возвращаемое значение
- Тело
- WebhookChatResponse
При запуске чата (не рекомендуется) [DEPRECATED]
Эта нерекомендуемая операция использует API LiveChat версии 2.
Возвращаемое значение
- Тело
- WebhookChatResponse
При создании билета (не рекомендуется) [DEPRECATED]
Эта нерекомендуемая операция использует устаревший API LiveChat Tickets.
Возвращаемое значение
Определения
WebhookChatResponse
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
agents
|
chat.agents | array of object |
agents |
|
Электронная почта агента
|
chat.agents.login | string |
Адрес электронной почты агента. |
|
Имя агента
|
chat.agents.name | string |
Имя агента. |
|
Метка времени окончания
|
chat.ended_timestamp | string |
гггг-ММ-ддTHH:мм:ss.fffZ |
|
events
|
chat.events | array of object |
Массив событий. |
|
Текст события
|
chat.events.text | string |
Сообщение, связанное с событием. |
|
Date-Time события
|
chat.events.timestamp | string |
гггг-ММ-ддTHH:мм:ss.fffZ |
|
Тип события
|
chat.events.type | string |
Тип события. |
|
Тип пользователя события
|
chat.events.user_type | string |
Тип пользователя. |
|
groups
|
chat.groups | array of integer | |
|
Идентификатор группы
|
chat.id | string |
Уникальный идентификатор группы. |
|
Message
|
chat.messages | array of object |
Массив сообщений. |
|
Идентификатор агента
|
chat.messages.agent_id | string |
Уникальный идентификатор агента, связанного с сообщением. |
|
Имя автора
|
chat.messages.author_name | string |
Имя автора сообщения.. |
|
Текст
|
chat.messages.text | string |
Текст сообщения. |
|
Отправленные Date-Time
|
chat.messages.timestamp | string |
гггг-ММ-ддTHH:мм:ss.fffZ |
|
Тип пользователя
|
chat.messages.user_type | string |
Тип пользователя, отправляющего сообщение. |
|
Начало Date-Time
|
chat.started_timestamp | string |
гггг-ММ-ддTHH:мм:ss.fffZ |
|
tags
|
chat.tags | array of string | |
|
URL
|
chat.url | string |
URL-адрес веб-сайта, на котором запущен чат. |
|
Идентификатор события
|
event_unique_id | string |
Уникальный идентификатор события, связанного с чатом. |
|
Предварительный опрос чата
|
pre_chat_survey | array of object |
Массив ответов предварительного опроса чата. |
|
Ответ
|
pre_chat_survey.answer | string |
Ответ на опрос. |
|
Идентификатор опроса
|
pre_chat_survey.id | string |
Предварительный идентификатор опроса чата. |
|
Question
|
pre_chat_survey.label | string |
Вопрос опроса. |
|
Адрес электронной почты
|
visitor.email | string |
Адрес электронной почты посетителя. |
|
Идентификатор
|
visitor.id | string |
Уникальный идентификатор посетителя. |
|
Language
|
visitor.language | string |
Язык, связанный с учетной записью посетителя. |
|
Имя
|
visitor.name | string |
Имя посетителя. |
|
Страница
|
visitor.page_current | string |
Веб-страница, из которой произошел чат. |
WebhookTicketResponse
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
ticket.assignee.id | string |
Уникальный идентификатор пользователя. |
|
Имя
|
ticket.assignee.name | string |
Имя назначаемого. |
|
events
|
ticket.events | array of object | |
|
Идентификатор
|
ticket.events.author.id | string |
Уникальный идентификатор пользователя. |
|
Имя
|
ticket.events.author.name | string |
Имя автора. |
|
Тип
|
ticket.events.author.type | string |
Агент или клиент. |
|
Date-Time события
|
ticket.events.date | date-time |
гггг-ММ-ддTHH:мм:ss.fffZ |
|
Является частным
|
ticket.events.is_private | boolean |
Значение True, если событие является частным. |
|
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 |
Сведения о связанной группе. |
|
Идентификатор
|
ticket.groups.id | integer |
Уникальный идентификатор группы. |
|
Имя
|
ticket.groups.name | string |
Имя группы. |
|
Идентификатор билета
|
ticket.id | string |
Уникальный идентификатор билета. |
|
IP
|
ticket.requester.ip | string |
IP-адрес запрашивающего средства. |
|
Адрес электронной почты
|
ticket.requester.mail | string |
Адрес электронной почты запрашивающего средства. |
|
Имя
|
ticket.requester.name | string |
Имя запрашивающего объекта. |
|
Идентификатор
|
ticket.source.id | string |
Уникальный идентификатор источника. |
|
Тип
|
ticket.source.type | string |
Lc2, mail, facebook, agent-app-manual или chat-window. |
|
URL
|
ticket.source.url | string |
URL-адрес веб-сайта, на котором был создан билет. |
|
Состояние
|
ticket.status | string |
Открытие, ожидание, решение или спам. |
|
Тема
|
ticket.subject | string |
Краткое описание билета. |
|
tags
|
ticket.tags | array of string |
ListTicketsResponse
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Создан Date-Time
|
date | date-time |
гггг-ММ-ддTHH:мм:ss.fffZ |
|
Идентификатор билета
|
id | string |
Уникальный идентификатор билета. |
|
Изменены Date-Time
|
modified | date-time |
гггг-ММ-ддTHH:мм:ss.fffZ |
|
IP
|
requester.ip | string |
IP-адрес запрашивающего средства. |
|
Адрес электронной почты
|
requester.mail | string |
Адрес электронной почты запрашивающего средства. |
|
Имя
|
requester.name | string |
Полное имя запрашивающего средства. |
|
Идентификатор
|
source.id | string |
Уникальный идентификатор источника. |
|
Тип
|
source.type | string |
Из чата, почты или lc2. |
|
URL
|
source.url | string |
Веб-страница, на которой был создан билет. |
|
Состояние
|
status | string |
Открытие, ожидание, решение или спам. |
|
Тема
|
subject | string |
Описание источника билета. |
TicketResponse
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
currentGroup.id | integer |
Уникальный идентификатор группы. |
|
Имя
|
currentGroup.name | string |
Имя группы. |
|
Создан Date-Time
|
date | date-time |
гггг-ММ-ддTHH:мм:ss.fffZ |
|
events
|
events | array of object | |
|
Идентификатор
|
events.author.id | string |
Уникальный идентификатор пользователя. |
|
Имя
|
events.author.name | string |
Имя автора. |
|
Тип
|
events.author.type | string |
Агент или клиент. |
|
Date-Time события
|
events.date | date-time |
гггг-ММ-ддTHH:мм:ss.fffZ |
|
Является частным
|
events.is_private | boolean |
Значение True, если событие является частным. |
|
Message
|
events.message | string |
Описание события. |
|
Тип
|
events.source.type | string |
Окно чата, почта или lc2. |
|
URL
|
events.source.url | string |
URL-адрес веб-сайта, из который был отправлен билет. |
|
Тип события
|
events.type | string |
Тип события, создающего билет. |
|
Группа
|
groups | array of object |
Сведения о связанной группе. |
|
Идентификатор
|
groups.id | integer |
Уникальный идентификатор группы. |
|
Имя
|
groups.name | string |
Имя группы. |
|
Идентификатор билета
|
id | string |
Уникальный идентификатор билета. |
|
IP
|
requester.ip | string |
IP-адрес запрашивающего средства. |
|
Адрес электронной почты
|
requester.mail | string |
Адрес электронной почты запрашивающего средства. |
|
Имя
|
requester.name | string |
Имя запрашивающего объекта. |
|
Идентификатор
|
source.id | string |
Уникальный идентификатор источника. |
|
Тип
|
source.type | string |
Lc2, mail, facebook, agent-app-manual или chat-window. |
|
URL
|
source.url | string |
URL-адрес веб-сайта, на котором был создан билет. |
|
Состояние
|
status | string |
Открытие, ожидание, решение или спам. |
|
Тема
|
subject | string |
Краткое описание билета. |
|
tags
|
tags | array of string |
ListAgentsV2_Response
Агенты в лицензии LiveChat.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Товары
|
AgentV2 |
AgentV2
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
ID агента
|
id | string |
Идентификатор агента, как правило, адрес электронной почты агента. |
|
Имя
|
name | string |
Имя агента. |
|
Аватар
|
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 | string |
Путь к изображению в Amazon s3. |
|
Адрес электронной почты для входа
|
login | string |
Адрес электронной почты агента. |
|
Имя
|
name | string |
Имя агента. |
|
Разрешение
|
permission | string |
Владелец, администратор или обычный. |
CreateAgent_Response
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Аватар
|
avatar | string |
Путь к изображению в Amazon s3. |
|
Массив групп
|
groups | array of object |
Список всех групп агент является частью. |
|
Идентификатор группы
|
groups.id | integer |
Уникальный идентификатор группы. |
|
Имя группы
|
groups.name | string |
Имя группы. |
|
Должность
|
job_title | string |
Агент поддержки по умолчанию. |
|
Адрес электронной почты
|
login | string |
Адрес электронной почты агента. |
|
Состояние входа
|
login_status | string |
Прием чатов или не прием чатов. |
|
Максимальное количество чатов
|
max_chats_count | integer |
Ограничение одновременных чатов. |
|
Имя
|
name | string |
Имя агента. |
|
Разрешение
|
permission | string |
Владелец, администратор или обычный |
|
Состояние
|
status | string |
Прием чатов, а не прием чатов или автономных. |