Zvanu Parvaldnieks (предварительная версия)
Zvanu Parvaldnieks — это мобильная виртуальная УАТС для мобильных подписчиков LMT. Этот соединитель позволяет пользователям легко отправлять все данные и события о звонках, голосовых сообщениях, контактах и конфигурации в другие службы.
Этот соединитель доступен в следующих продуктах и регионах:
| Услуга | 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) |
| Контакт | |
|---|---|
| Имя | Latvijas Mobilais Telefons |
| URL | https://zvanuparvaldnieks.lmt.lv |
| Адрес электронной почты | tehn.atbalsts@lmt.lv |
| Метаданные соединителя | |
|---|---|
| Publisher | Latvijas Mobilais Telefons |
| Веб-сайт | https://zvanuparvaldnieks.lmt.lv |
| Политика конфиденциальности | https://www.lmt.lv/en/data-processing |
| Категории | Обмен данными; ИТ-операции |
Zvanu Parvaldnieks — это мобильная виртуальная УАТС для мобильных подписчиков LMT. Этот соединитель позволяет пользователям легко отправлять все данные и события о звонках, голосовых сообщениях, контактах и конфигурации в другие службы.
Предпосылки
Для продолжения вам потребуется следующее:
- Номер телефона с подпиской LMT Zvanu parvaldnieks
- Ключ API, который можно создать в https://zvanuparvaldnieks.lmt.lv/integration
Получение учетных данных
Используйте ключ API, созданный в https://zvanuparvaldnieks.lmt.lv/integration качестве маркера носителя:
Bearer OnYSrLTH3i2qiyb873au2LNdAajXjf5I
Начало работы с соединителем
- Создание нового ключа API
- Добавление ACL IP-адресов в качестве
0.0.0.0/0IP-адреса может измениться - Добавьте все необходимые методы API, которые вы будете использовать с Microsoft Power Automate
Известные проблемы и ограничения
- В то же время может быть не более 20 веб-перехватчиков, поэтому при возникновении проблем с триггерами проверьте, сколько веб-перехватчиков находятся на панели API -> WEB HOOKS на панели Zvanu parvaldnieks
- Элементы не собираются с
Get <anything>триггерами. Обратите внимание, что только созданные элементы собираются с триггерами. - Все проблемы с проверкой подлинности— обязательно настройте ключ API в следующем формате:
Bearer <api_key>
Распространенные ошибки и средства устранения неполадок
Достигнуто ограничение веб-перехватчика 403
В то же время может быть не более 20 веб-перехватчиков, поэтому при возникновении проблем с триггерами проверьте, сколько веб-перехватчиков находятся на панели API -> WEB HOOKS на панели Zvanu parvaldnieks
404 Нет найденных элементов
На основе запроса не найдены элементы. Убедитесь, что элементы существуют и проверяют поля фильтра, если они заполнены правильно.
422 Необработаемая сущность
Проверьте правильность заполнения значений фильтра.
Часто задаваемые вопросы
Каковы преимущества использования этого соединителя?
В отличие от обычного сценария, в котором вы будете разрабатывать решение, которое собирает данные из API, этот соединитель уже предоставляет промежуточный шаг между источником (api Zvanu parvaldnieks) и назначением, где отправляются данные. Например, настраивая поток с CallConnected триггером, мы можем отправлять сведения обо всех ответных вызовах непосредственно на лист Excel OneDrive.
Каковы требования, необходимые для начала использования этого соединителя?
Вам нужно быть подписчиком оператора LMT, а также подписчиком службы Zvanu parvaldnieks.
Какова разница между обратными вызовами веб-перехватчика и регулярными Get операциями?
Get операции поддерживают список определенных типов элементов, например вызовы и Get call History каждый раз собирает только новые созданные элементы журнала вызовов. Однако обратные вызовы веб-перехватчика активируются автоматически из стороны службы Zvanu parvaldnieks при получении нового события. Например, когда осталось новое сообщение голосовой почты, Zvanu parvaldnieks отправляет событие в соединитель с данными о новом сообщении голосовой почты.
Создание подключения
Соединитель поддерживает следующие типы проверки подлинности:
| По умолчанию | Параметры для создания подключения. | Все регионы | Недоступен для совместного использования |
По умолчанию
Применимо: все регионы
Параметры для создания подключения.
Это недоступно для общего доступа. Если приложение power предоставляется другому пользователю, пользователю будет предложено явно создать новое подключение.
| Имя | Тип | Description | Обязательно |
|---|---|---|---|
| Ключ API | securestring | Ключ API для этого API | True |
Ограничения регулирования
| Имя | Вызовы | Период обновления |
|---|---|---|
| Вызовы API для каждого подключения | 100 | 60 секунд |
Действия
| Звонить |
Запросить начало нового вызова, отправив запрос на устройство. |
| Получение голосовой почты по идентификатору |
Получение одного объекта голосовой почты путем предоставления идентификатора. |
| Получение записи звонков по идентификатору |
Получение записи одного вызова путем предоставления идентификатора. |
| Получение звукового запроса по идентификатору |
Получение одного объекта запроса звука путем предоставления идентификатора. |
| Получение идентификатора группы по идентификатору |
Получение одного объекта группы сотрудников путем предоставления идентификатора. |
| Получение конечной точки VoIP по идентификатору |
Получение одного объекта конечной точки VoIP путем предоставления идентификатора. |
| Получение контактов по идентификатору |
Получение одного объекта сотрудника путем предоставления идентификатора. |
| Получение поля голосовой почты по идентификатору |
Получение одного объекта голосовой почты путем предоставления идентификатора. |
| Получение потерянных вызовов |
Получение всех потерянных записей вызовов из журнала звонков, которые не были ответы, были вызваны или вызывающий не достиг сотрудника в ходе повторных попыток в течение одного дня. |
| Получение элемента журнала вызовов по идентификатору |
Получение одной записи журнала вызовов путем предоставления идентификатора. |
Звонить
Запросить начало нового вызова, отправив запрос на устройство.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Место назначения
|
destination | True | string |
Номер назначения. |
|
Идентификатор контакта
|
contactID | True | integer |
Уникальный идентификатор сотрудника |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
version
|
version | string |
version |
|
статус
|
status | string |
статус |
|
код состояния
|
statusCode | integer |
код состояния |
|
сообщение
|
message | string |
сообщение |
Получение голосовой почты по идентификатору
Получение одного объекта голосовой почты путем предоставления идентификатора.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор голосовой почты
|
voicemail_id | True | integer |
Уникальный идентификатор голосовой почты. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
version
|
version | string |
version |
|
статус
|
status | string |
статус |
|
код состояния
|
statusCode | integer |
код состояния |
|
сообщение
|
message | string |
сообщение |
|
sender
|
data.sender | string |
sender |
|
voicemailID
|
data.voicemailID | integer |
voicemailID |
|
length
|
data.length | integer |
length |
|
callStarted
|
data.callStarted | string |
callStarted |
|
voicemailBoxID
|
data.voicemailBoxID | integer |
voicemailBoxID |
|
voicemailBoxName
|
data.voicemailBoxName | string |
voicemailBoxName |
|
messageURL
|
data.messageURL | string |
messageURL |
Получение записи звонков по идентификатору
Получение записи одного вызова путем предоставления идентификатора.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Код записи
|
record_id | True | integer |
Уникальный идентификатор записи. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
version
|
version | string |
version |
|
статус
|
status | string |
статус |
|
код состояния
|
statusCode | integer |
код состояния |
|
сообщение
|
message | string |
сообщение |
|
идентификатор записи
|
data.recordingID | integer |
идентификатор записи |
|
callID
|
data.callID | integer |
callID |
|
посетитель
|
data.caller | string |
посетитель |
|
destination
|
data.destination | string |
destination |
|
направление
|
data.direction | string |
направление |
|
статус
|
data.status | integer |
статус |
|
callStarted
|
data.callStarted | string |
callStarted |
|
callConnected
|
data.callConnected | string |
callConnected |
|
callEnded
|
data.callEnded | string |
callEnded |
|
contactID
|
data.contactID | integer |
contactID |
|
записьURL
|
data.recordingURL | string |
записьURL |
Получение звукового запроса по идентификатору
Получение одного объекта запроса звука путем предоставления идентификатора.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор звукового запроса
|
prompt_id | True | integer |
Уникальный идентификатор звукового запроса. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
version
|
version | string |
version |
|
статус
|
status | string |
статус |
|
код состояния
|
statusCode | integer |
код состояния |
|
сообщение
|
message | string |
сообщение |
|
id
|
data.id | integer |
id |
|
имя
|
data.name | string |
имя |
|
type
|
data.type | integer |
type |
Получение идентификатора группы по идентификатору
Получение одного объекта группы сотрудников путем предоставления идентификатора.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор группы
|
group_id | True | integer |
Уникальный идентификатор группы сотрудников. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
version
|
version | string |
version |
|
статус
|
status | string |
статус |
|
код состояния
|
statusCode | integer |
код состояния |
|
сообщение
|
message | string |
сообщение |
|
Создано
|
data.created | date-time |
создано |
|
groupID
|
data.groupID | integer |
groupID |
|
type
|
data.type | integer |
type |
|
имя
|
data.name | string |
имя |
|
члены
|
data.members | array of object |
члены |
|
contactID
|
data.members.contactID | integer |
contactID |
Получение конечной точки VoIP по идентификатору
Получение одного объекта конечной точки VoIP путем предоставления идентификатора.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор конечной точки VoIP
|
endpoint_id | True | integer |
Уникальный идентификатор конечной точки VoIP. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
version
|
version | string |
version |
|
статус
|
status | string |
статус |
|
код состояния
|
statusCode | integer |
код состояния |
|
сообщение
|
message | string |
сообщение |
|
id
|
data.id | integer |
id |
|
имя
|
data.name | string |
имя |
|
employee_id
|
data.employee_id | integer |
employee_id |
Получение контактов по идентификатору
Получение одного объекта сотрудника путем предоставления идентификатора.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Код контактного лица
|
contact_id | True | integer |
Уникальный идентификатор сотрудника. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
version
|
version | string |
version |
|
статус
|
status | string |
статус |
|
код состояния
|
statusCode | integer |
код состояния |
|
сообщение
|
message | string |
сообщение |
|
current_callerid
|
data.current_callerid | string |
current_callerid |
|
Архив
|
data.archived | integer |
Архив |
|
имя
|
data.firstname | string |
имя |
|
фамилия
|
data.lastname | string |
фамилия |
|
создано
|
data.created | string |
создано |
|
число/номер
|
data.number | string |
число/номер |
|
contactID
|
data.contactID | integer |
contactID |
|
group_membership
|
data.group_membership | array of object |
group_membership |
|
создано
|
data.group_membership.created | string |
создано |
|
groupID
|
data.group_membership.groupID | integer |
groupID |
|
type
|
data.group_membership.type | integer |
type |
|
имя
|
data.group_membership.name | string |
имя |
|
члены
|
data.group_membership.members | array of object |
члены |
|
contactID
|
data.group_membership.members.contactID | integer |
contactID |
|
аватар
|
data.avatar | string |
аватар |
Получение поля голосовой почты по идентификатору
Получение одного объекта голосовой почты путем предоставления идентификатора.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор поля голосовой почты
|
box_id | True | integer |
Уникальный идентификатор поля голосовой почты. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
version
|
version | string |
version |
|
статус
|
status | string |
статус |
|
код состояния
|
statusCode | integer |
код состояния |
|
сообщение
|
message | string |
сообщение |
|
clientID
|
data.clientID | integer |
clientID |
|
boxName
|
data.boxName | string |
boxName |
|
создано
|
data.created | string |
создано |
|
voicemailBoxID
|
data.voicemailBoxID | integer |
voicemailBoxID |
Получение потерянных вызовов
Получение всех потерянных записей вызовов из журнала звонков, которые не были ответы, были вызваны или вызывающий не достиг сотрудника в ходе повторных попыток в течение одного дня.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Лимит
|
limit | integer |
Ограничение количества полученных результатов. |
|
|
Смещение
|
offset | integer |
Используется для указания результата, из которого мы хотим получить данные. |
|
|
Место назначения
|
destination | string |
Номер, на который был помещен звонок. |
|
|
Дата из
|
date_from | date-time |
Дата начала в отфильтрованном диапазоне дат. |
|
|
Дата до
|
date_to | date-time |
Дата окончания в отфильтрованном диапазоне дат. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
version
|
version | string |
version |
|
статус
|
status | string |
статус |
|
код состояния
|
statusCode | integer |
код состояния |
|
сообщение
|
message | string |
сообщение |
|
данные
|
data | array of object |
данные |
|
contact_name
|
data.contact_name | string |
contact_name |
|
destination
|
data.destination | string |
destination |
|
Попыток
|
data.attempts | integer |
Попыток |
|
callerid
|
data.callerid | string |
callerid |
|
Последний контакт
|
data.last_contact | date-time |
last_contact |
Получение элемента журнала вызовов по идентификатору
Получение одной записи журнала вызовов путем предоставления идентификатора.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор звонка
|
call_id | True | integer |
Уникальный идентификатор вызова. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
version
|
version | string |
version |
|
статус
|
status | string |
статус |
|
код состояния
|
statusCode | integer |
код состояния |
|
сообщение
|
message | string |
сообщение |
|
callID
|
data.callID | integer |
callID |
|
посетитель
|
data.caller | string |
посетитель |
|
destination
|
data.destination | string |
destination |
|
направление
|
data.direction | string |
направление |
|
статус
|
data.status | integer |
статус |
|
callStarted
|
data.callStarted | string |
callStarted |
|
callConnected
|
data.callConnected | string |
callConnected |
|
callEnded
|
data.callEnded | string |
callEnded |
|
connectionTime
|
data.connectionTime | integer |
connectionTime |
|
contactID
|
data.contactID | integer |
contactID |
|
идентификатор записи
|
data.recordingID | integer |
идентификатор записи |
Триггеры
|
Обратный вызов call |
Предоставляет событие с полезными данными о вызове при получении события CallConnectedEvent в момент ответа на вызов. |
|
Обратный вызов webhook Lost |
Предоставляет событие с полезными данными о вызове, когда событие события LostCallerDeleted получено в течение момента, когда потерянный вызов возвращается от сотрудника или получает ответ позже при повторном вызове из того же вызывающего средства. |
|
Обратный вызов веб-перехватчика Call |
Предоставляет событие с полезными данными о вызове при получении события CallCompletedEvent в момент завершения вызова. |
|
Обратный вызов веб-перехватчика Call |
Предоставляет событие с полезными данными о вызове при получении события CallRecorded в момент создания записи звонка. |
|
Обратный вызов веб-перехватчика Call |
Предоставляет событие с полезными данными о вызове при получении события CallStarted во время начала вызова. |
|
Обратный вызов веб-перехватчика Call |
Предоставляет событие с полезными данными о вызове, когда событие CallTransfered получено в течение определенного момента, когда звонок передается стороннему участнику, либо путем слепой передачи участников передачи. |
|
Обратный вызов веб-перехватчика Lost |
Предоставляет событие с данными полезных данных о вызове, когда событие LostCallerCreated получается в момент, когда вызов не получает ответа и регистрируется как потерянный. |
|
Обратный вызов веб-перехватчика Lost |
Предоставляет событие с полезными данными о вызове, когда событие LostCallerUpdated получается в момент, когда другая неудачная попытка вызова получена из того же числа, поэтому потерянные попытки записи звонков и last_contact поля обновляются с новым номером и меткой времени. |
|
Обратный вызов веб-перехватчика voicemail |
Предоставляет событие с полезными данными о голосовой почте при получении события VoicemailDeleted в момент удаления сообщения голосовой почты. |
|
Обратный вызов голосового перехватчика Voicemail |
Предоставляет событие с полезными данными о голосовой почте при получении события VoicemailCreated в момент, когда вызывающий объект оставил голосовую почту. |
| Получение голосовых сообщений |
Получение сообщений голосовой почты. Кроме того, потребитель API может фильтровать возвращаемые записи на основе contact_id, источника, box_id или date_range, чтобы ограничить результат только теми сообщениями, которые оставлены для конкретного сотрудника, голосовой почты, из определенного числа или в диапазоне запрошенных дат. |
| Получение групп |
Получение данных групп сотрудников. Кроме того, потребитель API может фильтровать возвращаемые записи на основе contact_id, чтобы ограничить результат только теми группами, у которых есть конкретный сотрудник в качестве члена. |
| Получение журнала вызовов |
Получение записей журнала вызовов. Кроме того, потребитель API может фильтровать возвращаемые записи на основе определенного числа или сотрудника, участвующих в вызове (источник, назначение или contact_id), а также направление фильтрации только входящих или исходящих вызовов или только вызовов, выполненных в указанном диапазоне дат (date_range). |
| Получение записей звонков |
Получение записей вызовов. Кроме того, потребитель API может фильтровать возвращаемые записи на основе определенного числа или сотрудника, участвующих в вызове (источник, назначение или contact_id), а также направление фильтрации только входящих или исходящих вызовов или только вызовов, выполненных в указанном диапазоне дат (date_range). |
| Получение звуковых запросов |
Получение записей звукового запроса. |
| Получение конечных точек VoIP |
Получение записей конечной точки VoIP. |
| Получение контактов |
Триггеры при создании нового сотрудника |
| Получение полей голосовой почты |
Получите список созданных полей голосовой почты. |
Обратный вызов callConnected webhook
Предоставляет событие с полезными данными о вызове при получении события CallConnectedEvent в момент ответа на вызов.
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
type
|
type | string |
type |
|
version
|
version | string |
version |
|
eventType
|
eventType | string |
eventType |
|
callID
|
data.callID | integer |
callID |
|
посетитель
|
data.caller | string |
посетитель |
|
destination
|
data.destination | string |
destination |
|
направление
|
data.direction | string |
направление |
|
статус
|
data.status | integer |
статус |
|
callStarted
|
data.callStarted | string |
callStarted |
|
callConnected
|
data.callConnected | string |
callConnected |
|
contactID
|
data.contactID | integer |
contactID |
Обратный вызов webhook LostCallerRemoved
Предоставляет событие с полезными данными о вызове, когда событие события LostCallerDeleted получено в течение момента, когда потерянный вызов возвращается от сотрудника или получает ответ позже при повторном вызове из того же вызывающего средства.
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
type
|
type | string |
type |
|
version
|
version | string |
version |
|
eventType
|
eventType | string |
eventType |
|
destination
|
data.destination | string |
destination |
|
callerid
|
data.callerid | string |
callerid |
Обратный вызов веб-перехватчика CallCompleted
Предоставляет событие с полезными данными о вызове при получении события CallCompletedEvent в момент завершения вызова.
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
type
|
type | string |
type |
|
version
|
version | string |
version |
|
eventType
|
eventType | string |
eventType |
|
callID
|
data.callID | integer |
callID |
|
посетитель
|
data.caller | string |
посетитель |
|
destination
|
data.destination | string |
destination |
|
направление
|
data.direction | string |
направление |
|
статус
|
data.status | integer |
статус |
|
callStarted
|
data.callStarted | string |
callStarted |
|
callConnected
|
data.callConnected | string |
callConnected |
|
connectionTime
|
data.connectionTime | integer |
connectionTime |
|
contactID
|
data.contactID | integer |
contactID |
|
previous_contactID
|
data.previous_contactID | integer |
previous_contactID |
Обратный вызов веб-перехватчика CallRecorded
Предоставляет событие с полезными данными о вызове при получении события CallRecorded в момент создания записи звонка.
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
type
|
type | string |
type |
|
version
|
version | string |
version |
|
eventType
|
eventType | string |
eventType |
|
идентификатор записи
|
data.recordingID | integer |
идентификатор записи |
|
callID
|
data.callID | integer |
callID |
|
callStarted
|
data.callStarted | string |
callStarted |
|
записьURL
|
data.recordingURL | string |
записьURL |
|
направление
|
data.direction | string |
направление |
|
connectionTime
|
data.connectionTime | integer |
connectionTime |
Обратный вызов веб-перехватчика CallStarted
Предоставляет событие с полезными данными о вызове при получении события CallStarted во время начала вызова.
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
type
|
type | string |
type |
|
version
|
version | string |
version |
|
eventType
|
eventType | string |
eventType |
|
callID
|
data.callID | integer |
callID |
|
посетитель
|
data.caller | string |
посетитель |
|
destination
|
data.destination | string |
destination |
|
направление
|
data.direction | string |
направление |
|
статус
|
data.status | integer |
статус |
|
callStarted
|
data.callStarted | string |
callStarted |
|
contactID
|
data.contactID | integer |
contactID |
Обратный вызов веб-перехватчика CallTransfered
Предоставляет событие с полезными данными о вызове, когда событие CallTransfered получено в течение определенного момента, когда звонок передается стороннему участнику, либо путем слепой передачи участников передачи.
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
type
|
type | string |
type |
|
version
|
version | string |
version |
|
eventType
|
eventType | string |
eventType |
|
callID
|
data.callID | integer |
callID |
|
посетитель
|
data.caller | string |
посетитель |
|
destination
|
data.destination | string |
destination |
|
статус
|
data.status | integer |
статус |
|
callStarted
|
data.callStarted | string |
callStarted |
|
callConnected
|
data.callConnected | string |
callConnected |
|
connectionTime
|
data.connectionTime | integer |
connectionTime |
|
contactID
|
data.contactID | integer |
contactID |
|
previous_contactID
|
data.previous_contactID | integer |
previous_contactID |
|
направление
|
data.direction | string |
направление |
Обратный вызов веб-перехватчика LostCallerAdded
Предоставляет событие с данными полезных данных о вызове, когда событие LostCallerCreated получается в момент, когда вызов не получает ответа и регистрируется как потерянный.
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
type
|
type | string |
type |
|
version
|
version | string |
version |
|
eventType
|
eventType | string |
eventType |
|
contact_name
|
data.contact_name | string |
contact_name |
|
destination
|
data.destination | string |
destination |
|
Попыток
|
data.attempts | integer |
Попыток |
|
callerid
|
data.callerid | string |
callerid |
|
last_contact
|
data.last_contact | string |
last_contact |
Обратный вызов веб-перехватчика LostCallerUpdated
Предоставляет событие с полезными данными о вызове, когда событие LostCallerUpdated получается в момент, когда другая неудачная попытка вызова получена из того же числа, поэтому потерянные попытки записи звонков и last_contact поля обновляются с новым номером и меткой времени.
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
type
|
type | string |
type |
|
version
|
version | string |
version |
|
eventType
|
eventType | string |
eventType |
|
contact_name
|
data.contact_name | string |
contact_name |
|
destination
|
data.destination | string |
destination |
|
Попыток
|
data.attempts | integer |
Попыток |
|
callerid
|
data.callerid | string |
callerid |
|
last_contact
|
data.last_contact | string |
last_contact |
Обратный вызов веб-перехватчика voicemailDeleted
Предоставляет событие с полезными данными о голосовой почте при получении события VoicemailDeleted в момент удаления сообщения голосовой почты.
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
type
|
type | string |
type |
|
version
|
version | string |
version |
|
eventType
|
eventType | string |
eventType |
|
sender
|
data.sender | string |
sender |
|
voicemailID
|
data.voicemailID | integer |
voicemailID |
Обратный вызов голосового перехватчика VoicemailCreated
Предоставляет событие с полезными данными о голосовой почте при получении события VoicemailCreated в момент, когда вызывающий объект оставил голосовую почту.
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
type
|
type | string |
type |
|
version
|
version | string |
version |
|
eventType
|
eventType | string |
eventType |
|
sender
|
data.sender | string |
sender |
|
voicemailID
|
data.voicemailID | integer |
voicemailID |
|
length
|
data.length | integer |
length |
|
callStarted
|
data.callStarted | string |
callStarted |
|
voicemailBoxID
|
data.voicemailBoxID | integer |
voicemailBoxID |
|
voicemailBoxName
|
data.voicemailBoxName | string |
voicemailBoxName |
|
messageURL
|
data.messageURL | string |
messageURL |
Получение голосовых сообщений
Получение сообщений голосовой почты. Кроме того, потребитель API может фильтровать возвращаемые записи на основе contact_id, источника, box_id или date_range, чтобы ограничить результат только теми сообщениями, которые оставлены для конкретного сотрудника, голосовой почты, из определенного числа или в диапазоне запрошенных дат.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор голосовой почты
|
voicemail_id | integer |
Уникальный идентификатор сообщения голосовой почты. |
|
|
Лимит
|
limit | integer |
Ограничение количества полученных результатов. |
|
|
Смещение
|
offset | integer |
Используется для указания результата, из которого мы хотим получить данные. |
|
|
Исходный номер
|
source | string |
Номер вызывающей стороны. |
|
|
Код контактного лица
|
contact_id | integer |
Уникальный идентификатор сотрудника. |
|
|
Идентификатор поля голосовой почты
|
box_id | integer |
Уникальный идентификатор поля голосовой почты. |
|
|
Дата из
|
date_from | date-time |
Дата начала в отфильтрованном диапазоне дат. |
|
|
Дата до
|
date_to | date-time |
Дата окончания в отфильтрованном диапазоне дат. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
version
|
version | string |
version |
|
статус
|
status | string |
статус |
|
код состояния
|
statusCode | integer |
код состояния |
|
сообщение
|
message | string |
сообщение |
|
данные
|
data | array of object |
данные |
|
sender
|
data.sender | string |
sender |
|
voicemailID
|
data.voicemailID | integer |
voicemailID |
|
length
|
data.length | integer |
length |
|
callStarted
|
data.callStarted | string |
callStarted |
|
voicemailBoxID
|
data.voicemailBoxID | integer |
voicemailBoxID |
|
voicemailBoxName
|
data.voicemailBoxName | string |
voicemailBoxName |
|
messageURL
|
data.messageURL | string |
messageURL |
Получение групп
Получение данных групп сотрудников. Кроме того, потребитель API может фильтровать возвращаемые записи на основе contact_id, чтобы ограничить результат только теми группами, у которых есть конкретный сотрудник в качестве члена.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор группы
|
group_id | integer |
Уникальный идентификатор группы. |
|
|
Код контактного лица
|
contact_id | integer |
Уникальный идентификатор сотрудника. |
|
|
Лимит
|
limit | integer |
Ограничение количества полученных результатов. |
|
|
Смещение
|
offset | integer |
Используется для указания результата, из которого мы хотим получить данные. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
version
|
version | string |
version |
|
статус
|
status | string |
статус |
|
код состояния
|
statusCode | integer |
код состояния |
|
сообщение
|
message | string |
сообщение |
|
данные
|
data | array of object |
данные |
|
создано
|
data.created | string |
создано |
|
groupID
|
data.groupID | integer |
groupID |
|
type
|
data.type | integer |
type |
|
имя
|
data.name | string |
имя |
|
члены
|
data.members | array of object |
члены |
|
contactID
|
data.members.contactID | integer |
contactID |
Получение журнала вызовов
Получение записей журнала вызовов. Кроме того, потребитель API может фильтровать возвращаемые записи на основе определенного числа или сотрудника, участвующих в вызове (источник, назначение или contact_id), а также направление фильтрации только входящих или исходящих вызовов или только вызовов, выполненных в указанном диапазоне дат (date_range).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор звонка
|
call_id | integer |
Уникальный идентификатор вызова. |
|
|
Лимит
|
limit | integer |
Ограничение количества полученных результатов. |
|
|
Смещение
|
offset | integer |
Используется для указания результата, из которого мы хотим получить данные. |
|
|
Номер назначения
|
destination | string |
Номер, на который был помещен звонок. |
|
|
Исходный номер
|
source | string |
Номер вызывающей стороны. |
|
|
Направление
|
direction | string |
"in" или "out", чтобы указать, был ли звонок входящий или исходящий. |
|
|
Код контактного лица
|
contact_id | integer |
Уникальный идентификатор сотрудника, участвующий в вызове. |
|
|
Дата из
|
date_from | date-time |
Дата начала в отфильтрованном диапазоне дат. |
|
|
Дата до
|
date_to | date-time |
Дата окончания в отфильтрованном диапазоне дат. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
version
|
version | string |
version |
|
статус
|
status | string |
статус |
|
код состояния
|
statusCode | integer |
код состояния |
|
сообщение
|
message | string |
сообщение |
|
данные
|
data | array of object |
данные |
|
callID
|
data.callID | integer |
callID |
|
посетитель
|
data.caller | string |
посетитель |
|
destination
|
data.destination | string |
destination |
|
направление
|
data.direction | string |
направление |
|
статус
|
data.status | integer |
статус |
|
callStarted
|
data.callStarted | string |
callStarted |
|
callConnected
|
data.callConnected | string |
callConnected |
|
callEnded
|
data.callEnded | string |
callEnded |
|
connectionTime
|
data.connectionTime | integer |
connectionTime |
|
contactID
|
data.contactID | integer |
contactID |
|
идентификатор записи
|
data.recordingID | integer |
идентификатор записи |
Получение записей звонков
Получение записей вызовов. Кроме того, потребитель API может фильтровать возвращаемые записи на основе определенного числа или сотрудника, участвующих в вызове (источник, назначение или contact_id), а также направление фильтрации только входящих или исходящих вызовов или только вызовов, выполненных в указанном диапазоне дат (date_range).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Код записи
|
record_id | integer |
Уникальный идентификатор записи. |
|
|
Лимит
|
limit | integer |
Ограничение количества полученных результатов. |
|
|
Смещение
|
offset | integer |
Используется для указания результата, из которого мы хотим получить данные. |
|
|
Номер назначения
|
destination | string |
Номер, на который был помещен звонок. |
|
|
Исходный номер
|
source | string |
Номер вызывающей стороны. |
|
|
Направление
|
direction | string |
"in" или "out", чтобы указать, был ли звонок входящий или исходящий. |
|
|
Код контактного лица
|
contact_id | integer |
Уникальный идентификатор сотрудника, участвующий в вызове. |
|
|
Дата из
|
date_from | date-time |
Дата начала в отфильтрованном диапазоне дат. |
|
|
Дата до
|
date_to | date-time |
Дата окончания в отфильтрованном диапазоне дат. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
version
|
version | string |
version |
|
статус
|
status | string |
статус |
|
код состояния
|
statusCode | integer |
код состояния |
|
сообщение
|
message | string |
сообщение |
|
данные
|
data | array of object |
данные |
|
идентификатор записи
|
data.recordingID | integer |
идентификатор записи |
|
callID
|
data.callID | integer |
callID |
|
посетитель
|
data.caller | string |
посетитель |
|
destination
|
data.destination | string |
destination |
|
направление
|
data.direction | string |
направление |
|
статус
|
data.status | integer |
статус |
|
callStarted
|
data.callStarted | string |
callStarted |
|
callConnected
|
data.callConnected | string |
callConnected |
|
callEnded
|
data.callEnded | string |
callEnded |
|
contactID
|
data.contactID | integer |
contactID |
|
записьURL
|
data.recordingURL | string |
записьURL |
Получение звуковых запросов
Получение записей звукового запроса.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор звукового запроса
|
prompt_id | integer |
Уникальный идентификатор звукового запроса. |
|
|
Лимит
|
limit | integer |
Ограничение количества полученных результатов. |
|
|
Смещение
|
offset | integer |
Используется для указания результата, из которого мы хотим получить данные. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
version
|
version | string |
version |
|
статус
|
status | string |
статус |
|
код состояния
|
statusCode | integer |
код состояния |
|
сообщение
|
message | string |
сообщение |
|
данные
|
data | array of object |
данные |
|
id
|
data.id | integer |
id |
|
имя
|
data.name | string |
имя |
|
type
|
data.type | integer |
type |
Получение конечных точек VoIP
Получение записей конечной точки VoIP.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор конечной точки VoIP
|
endpoint_id | integer |
Уникальный идентификатор конечной точки VoIP. |
|
|
Лимит
|
limit | integer |
Ограничение количества полученных результатов. |
|
|
Смещение
|
offset | integer |
Используется для указания результата, из которого мы хотим получить данные. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
version
|
version | string |
version |
|
статус
|
status | string |
статус |
|
код состояния
|
statusCode | integer |
код состояния |
|
сообщение
|
message | string |
сообщение |
|
данные
|
data | array of object |
данные |
|
id
|
data.id | integer |
id |
|
имя
|
data.name | string |
имя |
|
employee_id
|
data.employee_id | integer |
employee_id |
Получение контактов
Триггеры при создании нового сотрудника
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Лимит
|
limit | integer |
Ограничение количества полученных результатов. |
|
|
Смещение
|
offset | integer |
Используется для указания результата, из которого мы хотим получить данные. |
|
|
Код контактного лица
|
contact_id | integer |
Уникальный идентификатор сотрудника. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
version
|
version | string |
version |
|
статус
|
status | string |
статус |
|
код состояния
|
statusCode | integer |
код состояния |
|
сообщение
|
message | string |
сообщение |
|
данные
|
data | array of object |
данные |
|
current_callerid
|
data.current_callerid | string |
current_callerid |
|
Архив
|
data.archived | integer |
Архив |
|
имя
|
data.firstname | string |
имя |
|
фамилия
|
data.lastname | string |
фамилия |
|
создано
|
data.created | string |
создано |
|
число/номер
|
data.number | string |
число/номер |
|
contactID
|
data.contactID | integer |
contactID |
|
group_membership
|
data.group_membership | array of object |
group_membership |
|
создано
|
data.group_membership.created | string |
создано |
|
groupID
|
data.group_membership.groupID | integer |
groupID |
|
type
|
data.group_membership.type | integer |
type |
|
имя
|
data.group_membership.name | string |
имя |
|
члены
|
data.group_membership.members | array of object |
члены |
|
contactID
|
data.group_membership.members.contactID | integer |
contactID |
|
аватар
|
data.avatar | string |
аватар |
Получение полей голосовой почты
Получите список созданных полей голосовой почты.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор поля голосовой почты
|
box_id | integer |
Уникальный идентификатор поля голосовой почты. |
|
|
Лимит
|
limit | integer |
Ограничение количества полученных результатов. |
|
|
Смещение
|
offset | integer |
Используется для указания результата, из которого мы хотим получить данные. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
version
|
version | string |
version |
|
статус
|
status | string |
статус |
|
код состояния
|
statusCode | integer |
код состояния |
|
сообщение
|
message | string |
сообщение |
|
данные
|
data | array of object |
данные |
|
clientID
|
data.clientID | integer |
clientID |
|
boxName
|
data.boxName | string |
boxName |
|
создано
|
data.created | string |
создано |
|
voicemailBoxID
|
data.voicemailBoxID | integer |
voicemailBoxID |