Nexmo
Nexmo, платформа API Vonage, позволяет добавлять обмен данными в контексте приложений, включая SMS, голосовую связь и чат. Зарегистрируйтесь для учетной записи Nexmo здесь: https://www.nexmo.com/
Этот соединитель доступен в следующих продуктах и регионах:
| Услуга | 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) |
| Метаданные соединителя | |
|---|---|
| Publisher | Microsoft |
Создание подключения
Соединитель поддерживает следующие типы проверки подлинности:
| По умолчанию | Параметры для создания подключения. | Все регионы | Недоступен для совместного использования |
По умолчанию
Применимо: все регионы
Параметры для создания подключения.
Это недоступно для общего доступа. Если приложение power предоставляется другому пользователю, пользователю будет предложено явно создать новое подключение.
| Имя | Тип | Description | Обязательно |
|---|---|---|---|
| Ключ API | струна | Ключ API | True |
| Секрет API | securestring | Секрет API | True |
Ограничения регулирования
| Имя | Вызовы | Период обновления |
|---|---|---|
| Вызовы API для каждого подключения | 100 | 60 секунд |
Действия
| Вывод списка входящих номеров |
Эта операция используется для получения всех входящих чисел, которые находятся в разных странах. |
| Обновление приложения |
Эта операция используется для изменения существующего приложения в учетной записи. |
| Отправка SMS |
Эта операция используется для отправки SMS. |
| Отправка файла речи |
Эта операция используется для отправки синтезированного речи или записанного звукового файла на номер телефона. |
| Получение приложения по идентификатору |
Эта операция используется для получения сведений об одном приложении, учитывая его идентификатор. |
| Создание нового приложения |
Эта операция используется для создания нового приложения в учетной записи. |
| Список приложений |
Извлекает список всех приложений, связанных с вашей учетной записью. |
| Список принадлежащих номеров |
Эта операция извлекает все номера, связанные с вашей учетной записью. |
| Удаление приложения |
Эта операция используется для удаления существующего приложения в учетной записи. |
Вывод списка входящих номеров
Эта операция используется для получения всех входящих чисел, которые находятся в разных странах.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Страна
|
country | True | string |
Код в формате ISO 3166-1 alpha-2. |
|
Шаблон поиска
|
Search Pattern | string |
Выберите шаблон. |
|
|
Рисунок
|
pattern | number |
Шаблон чисел для поиска. |
|
|
Доступные функции
|
features | string |
SMS или VOICE |
|
|
Число результатов
|
size | number |
Значение по умолчанию 10. |
|
|
Индекс страницы
|
index | number |
Индекс в ответе. |
Возвращаемое значение
- Тело
- ListNumbersResponse
Обновление приложения
Эта операция используется для изменения существующего приложения в учетной записи.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор приложения
|
application_id | True | string |
Уникальный идентификатор приложения. |
|
Имя
|
name | True | string |
Имя приложения. |
|
Тип
|
type | True | string |
Тип приложения. |
|
URL-адрес ответа
|
answer_url | True | string |
Где веб-перехватчик предоставляет объект управления вызовами Nexmo. |
|
URL-адрес событий
|
event_url | True | string |
Запуск, звон или завершение |
|
Метод ответов
|
answer_method | string |
Метод HTTP (DEFAULT GET). |
|
|
Метод события
|
event_method | string |
Метод HTTP (Default POST). |
Возвращаемое значение
- Тело
- applicationResponse
Отправка SMS
Эта операция используется для отправки SMS.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор отправителя
|
from | True | string |
Буквенно-цифровые строки. |
|
Номер телефона
|
to | True | string |
Международный формат E.164. |
|
Текст
|
text | True | string |
Текст SMS. |
|
Тип
|
type | string |
По умолчанию используется текст. |
|
|
Квитанции о доставке
|
status-report-req | number |
Установите значение 1, чтобы включить. |
|
|
Справочник по клиенту
|
client-ref | string |
Для внутренних отчетов. |
|
|
Визитная карточка
|
vcard | string |
Формат vCard. |
|
|
Событие календаря
|
vcal | string |
Формат vCal. |
|
|
Срок жизни SMS
|
ttl | number |
В миллисекундах. |
|
|
URL-адрес обратного вызова
|
callback | url |
Конечная точка квитанции о доставке. |
|
|
Класс message
|
message-class | number |
Выберите класс. |
|
|
Заголовок данных пользователя
|
udh | string |
Шестнадцатеричный кодированный UDH. |
|
|
Протокол более высокого уровня
|
protocol-id | string |
Идентификатор протокола. |
|
|
Текст (если тип является двоичным.)
|
body | string |
Шестнадцатеричные двоичные данные. |
|
|
Название
|
title | string |
Если тип является wappush. |
|
|
URL-адрес
|
url | url |
URL-адрес веб-сайта (если тип — wappush.). |
|
|
Доступность (если тип wappush.)
|
validity | string |
В миллисекундах. |
Возвращаемое значение
- Тело
- smsResponse
Отправка файла речи
Эта операция используется для отправки синтезированного речи или записанного звукового файла на номер телефона.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Номер телефона
|
to | True | string |
Международный формат E.164. |
|
Номер телефона
|
from | string |
Номер Nexmo с поддержкой голосовой связи. |
|
|
Message
|
text | True | string |
Текст речи. |
|
Language
|
lg | string |
Синтезирование сообщения в. |
|
|
Gender
|
voice | string |
Мужчина или женщина. |
|
|
Число повторов
|
repeat | number |
До 10 раз. |
|
|
Разрешить обнаружение компьютеров
|
machine_detection | string |
True или зависание. |
|
|
Время ожидания компьютера
|
machine_timeout | number |
400 мс до 10000 мс. |
|
|
URL-адрес обратного вызова
|
callback | url |
URL-адрес обратного вызова. |
|
|
Метод обратного вызова
|
callback_method | string |
GET или POST. |
Возвращаемое значение
- Тело
- ttsResponse
Получение приложения по идентификатору
Эта операция используется для получения сведений об одном приложении, учитывая его идентификатор.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор приложения
|
application_id | True | string |
Уникальный идентификатор приложения. |
Возвращаемое значение
- Тело
- applicationResponse
Создание нового приложения
Эта операция используется для создания нового приложения в учетной записи.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Имя
|
name | True | string |
Имя приложения. |
|
Тип
|
type | True | string |
Тип приложения. |
|
URL-адрес ответа
|
answer_url | True | string |
Где веб-перехватчик предоставляет объект управления вызовами Nexmo. |
|
URL-адрес событий
|
event_url | True | string |
Запуск, звон или завершение |
|
Метод ответов
|
answer_method | string |
Метод HTTP (DEFAULT GET). |
|
|
Метод события
|
event_method | string |
Метод HTTP (Default POST). |
Возвращаемое значение
- Тело
- applicationResponse
Список приложений
Извлекает список всех приложений, связанных с вашей учетной записью.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Число результатов
|
page_size | number |
Элементы, возвращаемые при каждом вызове (по умолчанию 10). |
|
|
Индекс страницы
|
page_index | number |
Смещение от первой страницы (по умолчанию 0). |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Приложения
|
_embedded.applications | array of applicationResponse |
Список принадлежащих номеров
Эта операция извлекает все номера, связанные с вашей учетной записью.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Шаблон поиска
|
Search Pattern | string |
Выберите шаблон. |
|
|
Индекс страницы
|
index | number |
Индекс в ответе. |
|
|
Число результатов
|
size | number |
По умолчанию 10 макс. 100. |
|
|
Рисунок
|
pattern | number |
Шаблон чисел для поиска. |
Возвращаемое значение
- Тело
- ListNumbersResponse
Удаление приложения
Эта операция используется для удаления существующего приложения в учетной записи.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор приложения
|
application_id | True | string |
Уникальный идентификатор приложения. |
Возвращаемое значение
- Тело
- common
Определения
smsResponse
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Число сообщений
|
message-count | string |
Количество частей сообщения было разделено на. |
|
Массив сообщений
|
messages | array of object |
Содержит каждую часть сообщения. |
|
Состояние
|
messages.status | string |
Показывает, как выполняется обработка SMS-отправки. |
|
Идентификатор сообщения
|
messages.message-id | string |
Идентификатор отправленного SMS -сообщения (от 8 до 16 символов). |
|
Номер телефона
|
messages.to | string |
Номер запроса был отправлен. |
|
Справочник по клиенту
|
messages.client-ref | string |
Ссылка на клиент, заданная в запросе. |
|
Остаток
|
messages.remaining-balance | string |
Баланс в вашей учетной записи. Значение в EUR. |
|
Цена сообщения
|
messages.message-price | string |
Сумма, оплачиваемая за запрос. Значение в EUR. |
|
Сеть
|
messages.network | string |
Код мобильной сети (MCCMNC) для оператора, который будет зарегистрирован. |
|
Текст ошибки
|
messages.error-text | string |
Если произошла ошибка, это объясняет, что произошло. |
ListNumbersResponse
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Численность
|
count | integer |
Число результатов. |
|
Массив чисел
|
numbers | array of object |
Список всех чисел. |
|
Себестоимость
|
numbers.cost | string |
Стоимость номера. |
|
Страна
|
numbers.country | string |
Формат ISO 3166-1 alpha-2. |
|
Входящий номер
|
numbers.msisdn | string |
Входящий виртуальный номер. |
|
Тип
|
numbers.type | string |
Тип числа. |
ttsResponse
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор вызова
|
call_id | string |
Уникальный буквенно-цифровой идентификатор 32 символа для этого вызова. |
|
Номер телефона
|
to | string |
Номер пользователя, на который вы отправили запрос TTS или TTS. |
|
Состояние
|
status | string |
Код ответа для этого запроса TTS или TTS. |
|
Текст ошибки
|
error_text | string |
Если произошла ошибка, это объясняет, что произошло. |
applicationResponse
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
id | string |
Идентификатор приложения Nexmo. |
|
Имя
|
name | string |
Имя приложения. |
|
Keys
|
keys.public_key | string |
Открытый ключ, используемый для проверки jwt в объекте https://en.wikipedia.org/wiki/JSON_Web_Token. |
общий
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Ответ
|
type | string |
Читаемое человеком сообщение. |
|
Текст ошибки
|
error_title | string |
Заголовок ошибки возвращается при сбое. |