Vonage (Pré-visualização)
A Vonage API Platform permite-lhe adicionar comunicações dentro do contexto das suas aplicações, incluindo SMS, Voz e Chat. Inscreva-se para uma conta Nexmo aqui - https://www.vonage.com/
Este conector está disponível nos seguintes produtos e regiões:
| Serviço | Class | Regiões |
|---|---|---|
| Estúdio Copiloto | Premium | Todas as regiões do Power Automatic , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Aplicações Lógicas | Standard | Todas as regiões do Logic Apps , exceto as seguintes: - Regiões do Azure Government - Regiões do Azure China - Departamento de Defesa dos EUA (DoD) |
| Aplicações Power | Premium | Todas as regiões do Power Apps , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Automatize o poder | Premium | Todas as regiões do Power Automatic , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Contato | |
|---|---|
| Nome | Suporte Vonage |
| URL | https://www.vonage.co.uk/support |
| support@vonage.com |
| Metadados do conector | |
|---|---|
| Editora | Vonage |
| Sítio Web | https://vonage.com |
| Política de Privacidade | https://www.vonage.com/legal/privacy-policy |
| Categorias | Communication |
A Vonage API Platform permite-lhe adicionar comunicações dentro do contexto das suas aplicações, incluindo SMS, Voz e Chat.
Pré-requisitos
Você precisará do seguinte para prosseguir:
- 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 Vonage gratuita em https://dashboard.nexmo.com/sign-up
Problemas conhecidos e limitações
Atualmente, esse conector não expõe todos os produtos e APIs da Vonage
Limites de Limitação
| Name | Chamadas | Período de Renovação |
|---|---|---|
| Chamadas de API por conexão | 100 | 60 segundos |
Ações
| Enviar uma mensagem para o canal fornecido |
Enviar uma mensagem |
| Fornece informações básicas de insight numérico sobre um número |
Fornece informações básicas de insight numérico 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 |
| Solicite uma verificação |
Use a solicitação Verificar para gerar e enviar um PIN para seu usuário |
| Verificar verificação |
Confirma que o PIN recebido do usuário corresponde à solicitação Verificar |
Enviar uma mensagem para o canal fornecido
Enviar uma mensagem
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Tipo de conteúdo para solicitação
|
Content-Type | True | string |
Tipo de conteúdo |
|
Tipo de data aceite
|
Accept | True | string |
Aceitar |
|
O tipo de mensagem a enviar. Deve fornecer texto neste campo
|
message_type | string |
O tipo de mensagem a enviar. Deve fornecer texto neste campo |
|
|
O texto da mensagem a enviar; limitado a 1000 caracteres
|
text | string |
O texto da mensagem a enviar; 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 |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
message_uuid
|
message_uuid | string |
message_uuid |
Fornece informações básicas de insight numérico sobre um número
Fornece informações básicas de insight numérico sobre um número
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
O formato da resposta
|
format | True | string |
O formato da resposta |
|
A sua chave API
|
api_key | True | string |
A sua chave API |
|
O segredo da sua API
|
api_secret | True | string |
O segredo da sua API |
|
Um número de telefone sobre o qual precisa de informações em formato nacional ou internacional
|
number | True | string |
Um número de telefone sobre o qual precisa de informações em formato nacional ou internacional |
|
Código de país de dois caracteres no formato ISO 3166-1 alpha-2, por exemplo. GB ou EUA
|
country | True | string |
Código de país de dois caracteres no formato ISO 3166-1 alpha-2, por exemplo. GB ou EUA |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
estado
|
status | integer | |
|
status_message
|
status_message | string | |
|
id_de_pedido
|
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
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
O formato da resposta
|
format | True | string |
O formato da resposta |
|
A sua chave API
|
api_key | True | string |
A sua chave API |
|
O segredo da sua API
|
api_secret | True | string |
O segredo da sua API |
|
Um número de telefone sobre o qual precisa de informações em formato nacional ou internacional
|
number | True | string |
Um número de telefone sobre o qual precisa de informações em formato nacional ou internacional |
|
Código de país de dois caracteres no formato ISO 3166-1 alpha-2, por exemplo. GB ou EUA
|
country | True | string |
Código de país de dois caracteres no formato ISO 3166-1 alpha-2, por exemplo. GB ou EUA |
|
Definido como true para receber o nome do proprietário do número de telefone na resposta
|
cnam | string |
Definido como true para receber o nome do proprietário do número de telefone na resposta |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
estado
|
status | integer | |
|
status_message
|
status_message | string | |
|
id_de_pedido
|
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 |
Solicite uma verificação
Use a solicitação Verificar para gerar e enviar um PIN para seu usuário
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
O formato da resposta
|
format | True | string |
O formato da 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 verificar. O número deve estar no formato E.164
|
number | True | string |
O número de telefone móvel ou fixo a verificar. 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 alfanumérica de 18 caracteres, usada para personalizar o corpo do SMS da solicitação
|
brand | True | string |
Uma cadeia alfanumérica de 18 caracteres, usada para personalizar o corpo do SMS da solicitação |
|
Uma cadeia alfanumérica de 11 caracteres que representa a identidade do remetente
|
sender_id | string |
Uma cadeia 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, em segundos
|
pin_expiry | integer |
Por quanto tempo o código de verificação gerado é válido, em segundos |
|
|
Tempo de espera em segundos entre as tentativas de entrega do código de verificação
|
next_event_wait | integer |
Tempo de espera em segundos entre as tentativas de entrega do código de verificação |
|
|
Sequência predefinida de ações SMS e TTS para transmitir o PIN ao seu utilizador
|
workflow_id | integer |
Sequência predefinida de ações SMS e TTS para transmitir o PIN ao seu utilizador |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
estado
|
status | string | |
|
id_de_pedido
|
request_id | string |
Verificar verificação
Confirma que o PIN recebido do usuário corresponde à solicitação Verificar
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
O formato da resposta
|
format | True | string |
O formato da 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 |
|
Este é o request_id que você recebeu na resposta à solicitação Verificar
|
request_id | True | string |
Este é o request_id que você recebeu na resposta à solicitação Verificar |
|
O código de verificação introduzido pelo utilizador
|
code | True | string |
O código de verificação introduzido pelo utilizador |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
id_de_pedido
|
request_id | string | |
|
event_id
|
event_id | string | |
|
estado
|
status | string | |
|
Preço
|
price | string | |
|
moeda
|
currency | string | |
|
estimated_price_messages_sent
|
estimated_price_messages_sent | string |