Vonage (versão prévia)
A Plataforma de API vonage permite que você adicione comunicações dentro do contexto de seus aplicativos, incluindo SMS, Voz e Chat. Inscreva-se para uma conta do Nexmo aqui - https://www.vonage.com/
Esse conector está disponível nos seguintes produtos e regiões:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Todas as regiões do Power Automate , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Aplicativos Lógicos | Standard | Todas as regiões dos Aplicativos Lógicos , exceto as seguintes: – Regiões do Azure Governamental - Regiões do Azure China - Departamento de Defesa dos EUA (DoD) |
| Power Apps | Premium | Todas as regiões do Power Apps , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Power Automate | Premium | Todas as regiões do Power Automate , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Contato | |
|---|---|
| Nome | Suporte do Vonage |
| URL | https://www.vonage.co.uk/support |
| support@vonage.com |
| Metadados do conector | |
|---|---|
| Publicador | Vonage |
| Site | https://vonage.com |
| Política de Privacidade | https://www.vonage.com/legal/privacy-policy |
| Categorias | Communication |
A Plataforma de API vonage permite que você adicione comunicações dentro do contexto de seus aplicativos, incluindo SMS, Voz e Chat.
Pré-requisitos
Você precisará do seguinte para continuar:
- Uma conta vonage, inscreva-se em https://dashboard.nexmo.com/sign-up
Como obter credenciais
Para obter credenciais, você pode se inscrever para uma conta gratuita do Vonage em https://dashboard.nexmo.com/sign-up
Problemas e limitações conhecidos
Atualmente, esse conector não expõe todos os produtos e APIs do Vonage
Limitações
| Nome | Chamadas | Período de renovação |
|---|---|---|
| Chamadas à API por conexão | 100 | 60 segundos |
Ações
| Enviar uma mensagem para o canal especificado |
Enviar uma mensagem |
| Fornece informações básicas de insights numéricos sobre um número |
Fornece informações básicas de insights numéricos sobre um número |
| Fornece informações de insight de número padrão sobre um número |
Fornece informações de insight de número padrão sobre um número |
| Solicitar uma verificação |
Use a solicitação Verificar para gerar e enviar um PIN para o usuário |
| Verificar verificação |
Confirma que o PIN recebido do usuário corresponde à solicitação Verificar |
Enviar uma mensagem para o canal especificado
Enviar uma mensagem
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Tipo de conteúdo para solicitação
|
Content-Type | True | string |
Tipo de conteúdo |
|
Tipo de data aceito
|
Accept | True | string |
Aceitar |
|
O tipo de mensagem a ser enviada. Você deve fornecer texto neste campo
|
message_type | string |
O tipo de mensagem a ser enviada. Você deve fornecer texto neste campo |
|
|
O texto da mensagem a ser enviada; limitado a 1000 caracteres
|
text | string |
O texto da mensagem a ser enviada; limitado a 1000 caracteres |
|
|
O número de telefone do destinatário da mensagem no formato E.164
|
to | string |
O número de telefone do destinatário da mensagem no formato E.164 |
|
|
O número de telefone do destinatário da mensagem no formato E.164
|
from | string |
O número de telefone do destinatário da mensagem no formato E.164 |
|
|
O canal para o qual enviar. Você deve fornecer sms neste campo
|
channel | string |
O canal para o qual enviar. Você deve fornecer sms neste campo |
|
|
Referência de cliente de até 40 caracteres
|
client_ref | string |
Referência de cliente de até 40 caracteres |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
message_uuid
|
message_uuid | string |
message_uuid |
Fornece informações básicas de insights numéricos sobre um número
Fornece informações básicas de insights numéricos sobre um número
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
O formato de resposta
|
format | True | string |
O formato de resposta |
|
Sua chave de API
|
api_key | True | string |
Sua chave de API |
|
Seu segredo de API
|
api_secret | True | string |
Seu segredo de API |
|
Um número de telefone sobre o qual você precisa de informações em formato nacional ou internacional
|
number | True | string |
Um número de telefone sobre o qual você precisa de informações em formato nacional ou internacional |
|
Código de país de dois caracteres no formato ISO 3166-1 alfa-2, por exemplo. GB ou EUA
|
country | True | string |
Código de país de dois caracteres no formato ISO 3166-1 alfa-2, por exemplo. GB ou EUA |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
status
|
status | integer | |
|
status_message
|
status_message | string | |
|
request_id
|
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 |
Fornece informações de insight de número padrão sobre um número
Fornece informações de insight de número padrão sobre um número
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
O formato de resposta
|
format | True | string |
O formato de resposta |
|
Sua chave de API
|
api_key | True | string |
Sua chave de API |
|
Seu segredo de API
|
api_secret | True | string |
Seu segredo de API |
|
Um número de telefone sobre o qual você precisa de informações em formato nacional ou internacional
|
number | True | string |
Um número de telefone sobre o qual você precisa de informações em formato nacional ou internacional |
|
Código de país de dois caracteres no formato ISO 3166-1 alfa-2, por exemplo. GB ou EUA
|
country | True | string |
Código de país de dois caracteres no formato ISO 3166-1 alfa-2, por exemplo. GB ou EUA |
|
Definir como true para receber o nome do proprietário do número de telefone na resposta
|
cnam | string |
Definir como true para receber o nome do proprietário do número de telefone na resposta |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
status
|
status | integer | |
|
status_message
|
status_message | string | |
|
request_id
|
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 | |
|
nome
|
current_carrier.name | string | |
|
country
|
current_carrier.country | string | |
|
network_type
|
current_carrier.network_type | string | |
|
network_code
|
original_carrier.network_code | string | |
|
nome
|
original_carrier.name | string | |
|
country
|
original_carrier.country | string | |
|
network_type
|
original_carrier.network_type | string | |
|
Portado
|
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 |
Solicitar uma verificação
Use a solicitação Verificar para gerar e enviar um PIN para o usuário
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
O formato de resposta
|
format | True | string |
O formato de resposta |
|
Você pode encontrar sua chave de API no painel da sua conta https://dashboard.nexmo.com
|
api_key | True | string |
Você pode encontrar sua chave de API no painel da sua conta https://dashboard.nexmo.com |
|
Você pode encontrar seu segredo de API em seu painel https://dashboard.nexmo.com
|
api_secret | True | string |
Você pode encontrar seu segredo de API em seu painel https://dashboard.nexmo.com |
|
O número de telefone móvel ou fixo a ser verificado. O número deve estar no formato E.164
|
number | True | string |
O número de telefone móvel ou fixo a ser verificado. O número deve estar no formato E.164 |
|
Especifique o código de país de dois caracteres, verifique se formatará o número
|
country | string |
Especifique o código de país de dois caracteres, verifique se formatará o número |
|
|
Uma cadeia de caracteres alfanumérica de 18 caracteres, usada para personalizar o corpo do SMS de solicitação
|
brand | True | string |
Uma cadeia de caracteres alfanumérica de 18 caracteres, usada para personalizar o corpo do SMS de solicitação |
|
Uma cadeia de caracteres alfanumérica de 11 caracteres que representa a identidade do remetente
|
sender_id | string |
Uma cadeia de caracteres alfanumérica de 11 caracteres que representa a identidade do remetente |
|
|
O comprimento do código de verificação
|
code_length | integer |
O comprimento do código de verificação |
|
|
Controlar o idioma usado para a solicitação Verificar
|
lg | string |
Controlar o idioma usado para a solicitação Verificar |
|
|
Por quanto tempo o código de verificação gerado é válido por, em segundos
|
pin_expiry | integer |
Por quanto tempo o código de verificação gerado é válido por, em segundos |
|
|
Tempo de espera em segundos entre tentativas de entregar o código de verificação
|
next_event_wait | integer |
Tempo de espera em segundos entre tentativas de entregar o código de verificação |
|
|
Sequência predefinida de ações de SMS e TTS para transmitir o PIN ao usuário
|
workflow_id | integer |
Sequência predefinida de ações de SMS e TTS para transmitir o PIN ao usuário |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
status
|
status | string | |
|
request_id
|
request_id | string |
Verificar verificação
Confirma que o PIN recebido do usuário corresponde à solicitação Verificar
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
O formato de resposta
|
format | True | string |
O formato de resposta |
|
Sua chave de API
|
api_key | True | string |
Sua chave de API |
|
Seu segredo de API
|
api_secret | True | string |
Seu segredo de API |
|
Esta é a request_id recebida na resposta à solicitação Verify
|
request_id | True | string |
Esta é a request_id recebida na resposta à solicitação Verify |
|
O código de verificação inserido pelo usuário
|
code | True | string |
O código de verificação inserido pelo usuário |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
request_id
|
request_id | string | |
|
event_id
|
event_id | string | |
|
status
|
status | string | |
|
price
|
price | string | |
|
moeda
|
currency | string | |
|
estimated_price_messages_sent
|
estimated_price_messages_sent | string |