Nexmo
Nexmo, a Vonage API Platform, permite que você adicione comunicações dentro do contexto de seus aplicativos, incluindo SMS, voz e bate-papo. Inscreva-se para uma conta Nexmo aqui - https://www.nexmo.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) |
| Metadados do conector | |
|---|---|
| Editora | Microsoft |
A criar uma ligação
O conector suporta os seguintes tipos de autenticação:
| Predefinição | Parâmetros para criar conexão. | Todas as regiões | Não compartilhável |
Padrão
Aplicável: Todas as regiões
Parâmetros para criar conexão.
Esta conexão não é compartilhável. Se o aplicativo avançado for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.
| Nome | Tipo | Description | Obrigatório |
|---|---|---|---|
| Chave de API | cadeia (de caracteres) | A chave da API | Verdade |
| Segredo da API | securestring | O segredo da API | Verdade |
Limites de Limitação
| Name | Chamadas | Período de Renovação |
|---|---|---|
| Chamadas de API por conexão | 100 | 60 segundos |
Ações
| Atualizar um aplicativo |
Esta operação é utilizada para modificar uma aplicação existente na sua conta. |
| Criar novo aplicativo |
Esta operação é utilizada para criar uma nova aplicação na sua conta. |
| Enviar um ficheiro de voz |
Esta operação é usada para enviar uma fala sintetizada ou arquivo de som gravado para um número de telefone. |
| Enviar um SMS |
Esta operação é usada para enviar um SMS. |
| Excluir um aplicativo |
Esta operação é utilizada para eliminar uma aplicação existente na sua conta. |
| Listar aplicações |
Recupera uma lista de todos os aplicativos associados à sua conta. |
| Listar números de entrada |
Esta operação é usada para recuperar todos os números de entrada que são avialable para um determinado país. |
| Listar números de propriedade |
Esta operação recupera todos os números associados à sua conta. |
| Obter aplicação por Id |
Esta operação é usada para recuperar informações sobre um único aplicativo, dada a sua id. |
Atualizar um aplicativo
Esta operação é utilizada para modificar uma aplicação existente na sua conta.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do aplicativo
|
application_id | True | string |
Identificador exclusivo do aplicativo. |
|
Nome
|
name | True | string |
Nome do pedido. |
|
Tipo
|
type | True | string |
Tipo de aplicação. |
|
url de resposta
|
answer_url | True | string |
Onde seu webhook fornece o objeto de controle de chamada Nexmo. |
|
Eventos Url
|
event_url | True | string |
Iniciado, tocando ou concluído |
|
Método de resposta
|
answer_method | string |
Método HTTP (Default GET). |
|
|
Método do evento
|
event_method | string |
Método HTTP (POST PADRÃO). |
Devoluções
- Body
- applicationResponse
Criar novo aplicativo
Esta operação é utilizada para criar uma nova aplicação na sua conta.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Nome
|
name | True | string |
Nome do pedido. |
|
Tipo
|
type | True | string |
Tipo de aplicação. |
|
url de resposta
|
answer_url | True | string |
Onde seu webhook fornece o objeto de controle de chamada Nexmo. |
|
Eventos Url
|
event_url | True | string |
Iniciado, tocando ou concluído |
|
Método de resposta
|
answer_method | string |
Método HTTP (Default GET). |
|
|
Método do evento
|
event_method | string |
Método HTTP (POST PADRÃO). |
Devoluções
- Body
- applicationResponse
Enviar um ficheiro de voz
Esta operação é usada para enviar uma fala sintetizada ou arquivo de som gravado para um número de telefone.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Para o número de telefone
|
to | True | string |
Formato internacional E.164. |
|
Do número de telefone
|
from | string |
Número Nexmo habilitado para voz. |
|
|
Message
|
text | True | string |
Texto de fala. |
|
Linguagem
|
lg | string |
Para sintetizar a mensagem em. |
|
|
Sexo
|
voice | string |
Masculino ou feminino. |
|
|
Número de repetições
|
repeat | number |
Até 10 vezes. |
|
|
Permitir deteção de máquina
|
machine_detection | string |
Verdadeiro ou desligar. |
|
|
Tempo limite da máquina
|
machine_timeout | number |
400ms a 10000ms. |
|
|
URL de retorno de chamada
|
callback | url |
Url para retorno de chamada. |
|
|
Método de retorno de chamada
|
callback_method | string |
OBTER ou PUBLICAR. |
Devoluções
- Body
- ttsResponse
Enviar um SMS
Esta operação é usada para enviar um SMS.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do remetente
|
from | True | string |
Uma cadeia alfanumérica. |
|
Para o número de telefone
|
to | True | string |
Formato internacional E.164. |
|
Texto
|
text | True | string |
Corpo do SMS. |
|
Tipo
|
type | string |
O padrão é texto. |
|
|
Recibos de Entrega
|
status-report-req | number |
Defina como 1 para ativar. |
|
|
Referência do cliente
|
client-ref | string |
Para relatórios internos. |
|
|
Cartão de visita
|
vcard | string |
Formato vCard. |
|
|
Calendário de Eventos
|
vcal | string |
Formato vCal. |
|
|
Tempo de vida útil do SMS
|
ttl | number |
Em milissegundos. |
|
|
URL de retorno de chamada
|
callback | url |
Ponto de extremidade do recibo de entrega. |
|
|
Classe de mensagem
|
message-class | number |
Escolha uma classe. |
|
|
Cabeçalho de dados do usuário
|
udh | string |
UDH codificado hexadecimal. |
|
|
Protocolo de Nível Superior
|
protocol-id | string |
Id do protocolo. |
|
|
Corpo (Se o tipo for binário.)
|
body | string |
Dados binários codificados em hexadecimal. |
|
|
Title
|
title | string |
Se type é wappush. |
|
|
Endereço URL
|
url | url |
URL do site (Se o tipo for wappush.). |
|
|
Disponibilidade (Se o tipo for wappush.)
|
validity | string |
Em milissegundos. |
Devoluções
- Body
- smsResponse
Excluir um aplicativo
Esta operação é utilizada para eliminar uma aplicação existente na sua conta.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do aplicativo
|
application_id | True | string |
Identificador exclusivo do aplicativo. |
Devoluções
- Body
- common
Listar aplicações
Recupera uma lista de todos os aplicativos associados à sua conta.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Contagem de resultados
|
page_size | number |
Itens retornados em cada chamada (Padrão 10). |
|
|
Índice da página
|
page_index | number |
Deslocamento da primeira página (Padrão 0). |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
applications
|
_embedded.applications | array of applicationResponse |
Listar números de entrada
Esta operação é usada para recuperar todos os números de entrada que são avialable para um determinado país.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Country
|
country | True | string |
Código no formato ISO 3166-1 alpha-2. |
|
Padrão de pesquisa
|
Search Pattern | string |
Escolha um padrão. |
|
|
Padrão
|
pattern | number |
Padrão numérico para pesquisar. |
|
|
Funcionalidades Disponíveis
|
features | string |
SMS ou VOZ |
|
|
Contagem de resultados
|
size | number |
Padrão 10. |
|
|
Índice da página
|
index | number |
Índice na resposta. |
Devoluções
- Body
- ListNumbersResponse
Listar números de propriedade
Esta operação recupera todos os números associados à sua conta.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Padrão de pesquisa
|
Search Pattern | string |
Escolha um padrão. |
|
|
Índice da página
|
index | number |
Índice na resposta. |
|
|
Contagem de resultados
|
size | number |
Padrão 10 Max 100. |
|
|
Padrão
|
pattern | number |
Padrão numérico para pesquisar. |
Devoluções
- Body
- ListNumbersResponse
Obter aplicação por Id
Esta operação é usada para recuperar informações sobre um único aplicativo, dada a sua id.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do aplicativo
|
application_id | True | string |
Identificador exclusivo do aplicativo. |
Devoluções
- Body
- applicationResponse
Definições
smsResponse
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Contagem de mensagens
|
message-count | string |
Número de partes em que a mensagem foi dividida. |
|
Matriz de mensagens
|
messages | array of object |
Contém cada parte da mensagem. |
|
Situação
|
messages.status | string |
Mostra como o envio de SMS está processando. |
|
ID da mensagem
|
messages.message-id | string |
Id do SMS enviado (8 a 16 caracteres). |
|
Para o número de telefone
|
messages.to | string |
Número para o qual o seu pedido foi enviado. |
|
Referência do cliente
|
messages.client-ref | string |
O client-ref que você definiu na solicitação. |
|
Saldo Remanescente
|
messages.remaining-balance | string |
Saldo na sua conta. O valor é em EUR. |
|
Preço da mensagem
|
messages.message-price | string |
Valor cobrado pelo seu pedido. O valor é em EUR. |
|
Rede
|
messages.network | string |
Mobile Country Code Mobile Network Code (MCCMNC) para a operadora na qual está registada. |
|
Texto de erro
|
messages.error-text | string |
Se ocorreu um erro, isso explica o que aconteceu. |
ListNumbersResponse
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Contar
|
count | integer |
Contagem de resultados. |
|
Matriz de números
|
numbers | array of object |
Lista de todos os números. |
|
Custo
|
numbers.cost | string |
Custo numérico. |
|
Country
|
numbers.country | string |
Formato ISO 3166-1 alpha-2. |
|
Número de entrada
|
numbers.msisdn | string |
Número virtual de entrada. |
|
Tipo
|
numbers.type | string |
Tipo de número. |
ttsResposta
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID da chamada
|
call_id | string |
ID alfanumérico exclusivo de 32 caracteres para esta chamada. |
|
Para o número de telefone
|
to | string |
Número do usuário para o qual você enviou o TTS ou TTS Prompt. |
|
Situação
|
status | string |
Código de resposta para este prompt TTS ou TTS. |
|
Texto de erro
|
error_text | string |
Se ocorreu um erro, isso explica o que aconteceu. |
applicationResponse
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Id
|
id | string |
ID do aplicativo Nexmo. |
|
Nome
|
name | string |
Nome do aplicativo. |
|
Keys
|
keys.public_key | string |
A chave pública usada para validar o jwt em um https://en.wikipedia.org/wiki/JSON_Web_Tokenarquivo . |
frequentes
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Resposta
|
type | string |
Mensagem legível por humanos. |
|
Texto de erro
|
error_title | string |
Título do erro retornado se falhar. |