Vonage (предварительная версия)
Платформа API Vonage позволяет добавлять обмен данными в контексте приложений, включая SMS, голосовую связь и чат. Зарегистрируйтесь для учетной записи Nexmo здесь: https://www.vonage.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) |
| Контакт | |
|---|---|
| Имя | Поддержка Vonage |
| URL | https://www.vonage.co.uk/support |
| Адрес электронной почты | support@vonage.com |
| Метаданные соединителя | |
|---|---|
| Publisher | Vonage |
| Веб-сайт | https://vonage.com |
| Privacy Policy (Политика конфиденциальности) | https://www.vonage.com/legal/privacy-policy |
| Категории | Communication |
Платформа API Vonage позволяет добавлять обмен данными в контексте приложений, включая SMS, голосовую связь и чат.
Предпосылки
Для продолжения вам потребуется следующее:
- Учетная запись Vonage, зарегистрируйтесь по адресу https://dashboard.nexmo.com/sign-up
Получение учетных данных
Чтобы получить учетные данные, вы можете зарегистрироваться для бесплатной учетной записи Vonage по адресу https://dashboard.nexmo.com/sign-up
Известные проблемы и ограничения
В настоящее время этот соединитель не предоставляет все продукты и API Vonage
Ограничения регулирования
| Имя | Вызовы | Период обновления |
|---|---|---|
| Вызовы API для каждого подключения | 100 | 60 секунд |
Действия
| Запрос проверки |
Использование запроса проверки для создания и отправки ПИН-кода пользователю |
| Отправка сообщения в указанный канал |
Отправка сообщения |
| Предоставляет базовые сведения о количестве |
Предоставляет базовые сведения о количестве |
| Предоставляет сведения о стандартном анализе чисел о числе |
Предоставляет сведения о стандартном анализе чисел о числе |
| Проверка проверки |
Подтверждает пин-код, полученный от пользователя, соответствует запросу "Проверить" |
Запрос проверки
Использование запроса проверки для создания и отправки ПИН-кода пользователю
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Формат ответа
|
format | True | string |
Формат ответа |
|
Ключ API можно найти на панели мониторинга учетной записи https://dashboard.nexmo.com
|
api_key | True | string |
Ключ API можно найти на панели мониторинга учетной записи https://dashboard.nexmo.com |
|
Секрет API можно найти на панели мониторинга https://dashboard.nexmo.com
|
api_secret | True | string |
Секрет API можно найти на панели мониторинга https://dashboard.nexmo.com |
|
Номер мобильного или телефонного телефона для проверки. Число должно быть в формате E.164
|
number | True | string |
Номер мобильного или телефонного телефона для проверки. Число должно быть в формате E.164 |
|
Укажите код страны с двумя символами, убедитесь, что отформатируйте номер
|
country | string |
Укажите код страны с двумя символами, убедитесь, что отформатируйте номер |
|
|
Буквенно-цифровая строка с 18 символами, используемая для персонализации текста SMS запроса.
|
brand | True | string |
Буквенно-цифровая строка с 18 символами, используемая для персонализации текста SMS запроса. |
|
Буквенно-цифровая строка с 11 символами, представляющая удостоверение отправителя
|
sender_id | string |
Буквенно-цифровая строка с 11 символами, представляющая удостоверение отправителя |
|
|
Длина кода проверки
|
code_length | integer |
Длина кода проверки |
|
|
Управление языком, используемым для запроса проверки
|
lg | string |
Управление языком, используемым для запроса проверки |
|
|
Срок действия созданного кода проверки в секундах
|
pin_expiry | integer |
Срок действия созданного кода проверки в секундах |
|
|
Время ожидания в секундах между попытками доставки кода проверки
|
next_event_wait | integer |
Время ожидания в секундах между попытками доставки кода проверки |
|
|
Предопределенная последовательность действий SMS и TTS для передачи ПИН-кода пользователю
|
workflow_id | integer |
Предопределенная последовательность действий SMS и TTS для передачи ПИН-кода пользователю |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
статус
|
status | string | |
|
идентификатор запроса
|
request_id | string |
Отправка сообщения в указанный канал
Отправка сообщения
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Тип контента для запроса
|
Content-Type | True | string |
Тип контента |
|
Тип принятой даты
|
Accept | True | string |
Принять |
|
Тип отправленного сообщения. Необходимо указать текст в этом поле
|
message_type | string |
Тип отправленного сообщения. Необходимо указать текст в этом поле |
|
|
Текст сообщения для отправки; ограничено 1000 символами
|
text | string |
Текст сообщения для отправки; ограничено 1000 символами |
|
|
Номер телефона получателя сообщения в формате E.164
|
to | string |
Номер телефона получателя сообщения в формате E.164 |
|
|
Номер телефона получателя сообщения в формате E.164
|
from | string |
Номер телефона получателя сообщения в формате E.164 |
|
|
Канал для отправки. В этом поле необходимо указать sms
|
channel | string |
Канал для отправки. В этом поле необходимо указать sms |
|
|
Ссылка на клиент до 40 символов
|
client_ref | string |
Ссылка на клиент до 40 символов |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
message_uuid
|
message_uuid | string |
message_uuid |
Предоставляет базовые сведения о количестве
Предоставляет базовые сведения о количестве
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Формат ответа
|
format | True | string |
Формат ответа |
|
Ключ API
|
api_key | True | string |
Ключ API |
|
Секрет API
|
api_secret | True | string |
Секрет API |
|
Номер телефона, который требуется получить представление о национальном или международном формате
|
number | True | string |
Номер телефона, который требуется получить представление о национальном или международном формате |
|
Код страны с двумя символами в формате ISO 3166-1 alpha-2, например. ГБ или США
|
country | True | string |
Код страны с двумя символами в формате ISO 3166-1 alpha-2, например. ГБ или США |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
статус
|
status | integer | |
|
status_message
|
status_message | string | |
|
идентификатор запроса
|
request_id | string | |
|
international_format_number
|
international_format_number | string | |
|
national_format_number
|
national_format_number | string | |
|
country_code
|
country_code | string | |
|
country_code_iso3
|
country_code_iso3 | string | |
|
country_name
|
country_name | string | |
|
country_prefix
|
country_prefix | string |
Предоставляет сведения о стандартном анализе чисел о числе
Предоставляет сведения о стандартном анализе чисел о числе
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Формат ответа
|
format | True | string |
Формат ответа |
|
Ключ API
|
api_key | True | string |
Ключ API |
|
Секрет API
|
api_secret | True | string |
Секрет API |
|
Номер телефона, который требуется получить представление о национальном или международном формате
|
number | True | string |
Номер телефона, который требуется получить представление о национальном или международном формате |
|
Код страны с двумя символами в формате ISO 3166-1 alpha-2, например. ГБ или США
|
country | True | string |
Код страны с двумя символами в формате ISO 3166-1 alpha-2, например. ГБ или США |
|
Задайте значение true для получения имени владельца номера телефона в ответе
|
cnam | string |
Задайте значение true для получения имени владельца номера телефона в ответе |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
статус
|
status | integer | |
|
status_message
|
status_message | string | |
|
идентификатор запроса
|
request_id | string | |
|
international_format_number
|
international_format_number | string | |
|
national_format_number
|
national_format_number | string | |
|
country_code
|
country_code | string | |
|
country_code_iso3
|
country_code_iso3 | string | |
|
country_name
|
country_name | string | |
|
country_prefix
|
country_prefix | string | |
|
request_price
|
request_price | string | |
|
refund_price
|
refund_price | string | |
|
remaining_balance
|
remaining_balance | string | |
|
network_code
|
current_carrier.network_code | string | |
|
имя
|
current_carrier.name | string | |
|
country
|
current_carrier.country | string | |
|
network_type
|
current_carrier.network_type | string | |
|
network_code
|
original_carrier.network_code | string | |
|
имя
|
original_carrier.name | string | |
|
country
|
original_carrier.country | string | |
|
network_type
|
original_carrier.network_type | string | |
|
Портирована
|
ported | string | |
|
caller_type
|
caller_identity.caller_type | string | |
|
caller_name
|
caller_identity.caller_name | string | |
|
first_name
|
caller_identity.first_name | string | |
|
last_name
|
caller_identity.last_name | string | |
|
caller_name
|
caller_name | string | |
|
last_name
|
last_name | string | |
|
first_name
|
first_name | string | |
|
caller_type
|
caller_type | string |
Проверка проверки
Подтверждает пин-код, полученный от пользователя, соответствует запросу "Проверить"
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Формат ответа
|
format | True | string |
Формат ответа |
|
Ключ API
|
api_key | True | string |
Ключ API |
|
Секрет API
|
api_secret | True | string |
Секрет API |
|
Это request_id, полученное в ответе на запрос проверки
|
request_id | True | string |
Это request_id, полученное в ответе на запрос проверки |
|
Код проверки, введенный пользователем
|
code | True | string |
Код проверки, введенный пользователем |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
идентификатор запроса
|
request_id | string | |
|
event_id
|
event_id | string | |
|
статус
|
status | string | |
|
цена
|
price | string | |
|
currency
|
currency | string | |
|
estimated_price_messages_sent
|
estimated_price_messages_sent | string |