Nexmo
O Nexmo, a Plataforma de API vonage, permite adicionar comunicações dentro do contexto de seus aplicativos, incluindo SMS, Voz e Chat. Inscreva-se para uma conta do Nexmo aqui - https://www.nexmo.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) |
| Metadados do conector | |
|---|---|
| Publicador | Microsoft |
Criando uma conexão
O conector dá suporte aos seguintes tipos de autenticação:
| Default | 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.
Essa não é uma conexão compartilhável. Se o aplicativo de energia 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 | A chave de API | Verdade |
| Segredo da API | secureString | O segredo da API | Verdade |
Limitações
| Nome | Chamadas | Período de renovação |
|---|---|---|
| Chamadas à API por conexão | 100 | 60 segundos |
Ações
| Atualizar um aplicativo |
Essa operação é usada para modificar um aplicativo existente em sua conta. |
| Criar novo aplicativo |
Essa operação é usada para criar um novo aplicativo em sua conta. |
| Enviar um arquivo de fala |
Essa operação é usada para enviar uma fala sintetizada ou um arquivo de som gravado para um número de telefone. |
| Enviar um SMS |
Essa operação é usada para enviar um SMS. |
| Excluir um aplicativo |
Essa operação é usada para excluir um aplicativo existente em sua conta. |
| Listar aplicativos |
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 aviáveis para um determinado país. |
| Listar números de propriedade |
Essa operação recupera todos os números associados à sua conta. |
| Obter aplicativo por Id |
Essa operação é usada para recuperar informações sobre um único aplicativo, considerando sua ID. |
Atualizar um aplicativo
Essa operação é usada para modificar um aplicativo existente em sua conta.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do aplicativo
|
application_id | True | string |
Identificador exclusivo do aplicativo. |
|
Nome
|
name | True | string |
Nome do aplicativo. |
|
Tipo
|
type | True | string |
Tipo de aplicativo. |
|
URL de Resposta
|
answer_url | True | string |
Onde o webhook entrega o objeto de controle de chamada Nexmo. |
|
URL de Eventos
|
event_url | True | string |
Iniciado, tocando ou concluído |
|
Método Answer
|
answer_method | string |
Método HTTP (GET padrão). |
|
|
Método event
|
event_method | string |
Método HTTP (POST padrão). |
Retornos
- Corpo
- applicationResponse
Criar novo aplicativo
Essa operação é usada para criar um novo aplicativo em sua conta.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Nome
|
name | True | string |
Nome do aplicativo. |
|
Tipo
|
type | True | string |
Tipo de aplicativo. |
|
URL de Resposta
|
answer_url | True | string |
Onde o webhook entrega o objeto de controle de chamada Nexmo. |
|
URL de Eventos
|
event_url | True | string |
Iniciado, tocando ou concluído |
|
Método Answer
|
answer_method | string |
Método HTTP (GET padrão). |
|
|
Método event
|
event_method | string |
Método HTTP (POST padrão). |
Retornos
- Corpo
- applicationResponse
Enviar um arquivo de fala
Essa operação é usada para enviar uma fala sintetizada ou um arquivo de som gravado para um número de telefone.
Parâmetros
| Nome | Chave | Obrigató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 do Nexmo habilitado para voz. |
|
|
Message
|
text | True | string |
Texto de fala. |
|
Linguagem
|
lg | string |
Para sintetizar a mensagem. |
|
|
Gênero
|
voice | string |
Masculino ou feminino. |
|
|
Contagem repetida
|
repeat | number |
Até 10 vezes. |
|
|
Permitir detecção de computador
|
machine_detection | string |
True ou hangup. |
|
|
Tempo limite do computador
|
machine_timeout | number |
400 m a 10000ms. |
|
|
URL de retorno de chamada
|
callback | url |
URL para retorno de chamada. |
|
|
Método de retorno de chamada
|
callback_method | string |
GET ou POST. |
Retornos
- Corpo
- ttsResponse
Enviar um SMS
Essa operação é usada para enviar um SMS.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do remetente
|
from | True | string |
Uma cadeia de caracteres alfanumérica. |
|
Para o número de telefone
|
to | True | string |
Formato internacional E.164. |
|
Texto
|
text | True | string |
Corpo de SMS. |
|
Tipo
|
type | string |
O padrão é texto. |
|
|
Recibos de entrega
|
status-report-req | number |
Defina como 1 para habilitar. |
|
|
Referência do cliente
|
client-ref | string |
Para relatórios internos. |
|
|
Cartão de visita
|
vcard | string |
Formato vCard. |
|
|
Evento calendário
|
vcal | string |
Formato vCal. |
|
|
Tempo de vida do SMS
|
ttl | number |
Em milissegundos. |
|
|
URL de retorno de chamada
|
callback | url |
Ponto de extremidade de confirmação de entrega. |
|
|
Classe de mensagem
|
message-class | number |
Escolha uma classe. |
|
|
Cabeçalho de Dados do Usuário
|
udh | string |
Hex codificado UDH. |
|
|
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 Hex. |
|
|
Title
|
title | string |
Se o tipo for wappush. |
|
|
URL
|
url | url |
URL do Site (se o tipo for wappush.). |
|
|
Disponibilidade (se o tipo for wappush.)
|
validity | string |
Em milissegundos. |
Retornos
- Corpo
- smsResponse
Excluir um aplicativo
Essa operação é usada para excluir um aplicativo existente em sua conta.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do aplicativo
|
application_id | True | string |
Identificador exclusivo do aplicativo. |
Retornos
- Corpo
- common
Listar aplicativos
Recupera uma lista de todos os aplicativos associados à sua conta.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Contagem dos resultados
|
page_size | number |
Itens retornados em cada chamada (Padrão 10). |
|
|
Índice de Página
|
page_index | number |
Deslocamento da primeira página (Padrão 0). |
Retornos
| Nome | 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 aviáveis para um determinado país.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
País
|
country | True | string |
Código no formato ISO 3166-1 alfa-2. |
|
Padrão de Pesquisa
|
Search Pattern | string |
Escolha um padrão. |
|
|
Padrão
|
pattern | number |
Padrão de número a ser pesquisado. |
|
|
Recursos disponíveis
|
features | string |
SMS ou VOZ |
|
|
Contagem dos resultados
|
size | number |
Padrão 10. |
|
|
Índice de Página
|
index | number |
Indexar na resposta. |
Retornos
- Corpo
- ListNumbersResponse
Listar números de propriedade
Essa operação recupera todos os números associados à sua conta.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Padrão de Pesquisa
|
Search Pattern | string |
Escolha um padrão. |
|
|
Índice de Página
|
index | number |
Indexar na resposta. |
|
|
Contagem dos resultados
|
size | number |
Padrão 10 Max 100. |
|
|
Padrão
|
pattern | number |
Padrão de número a ser pesquisado. |
Retornos
- Corpo
- ListNumbersResponse
Obter aplicativo por Id
Essa operação é usada para recuperar informações sobre um único aplicativo, considerando sua ID.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do aplicativo
|
application_id | True | string |
Identificador exclusivo do aplicativo. |
Retornos
- Corpo
- applicationResponse
Definições
smsResponse
| Nome | 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á sendo processado. |
|
ID da mensagem
|
messages.message-id | string |
ID do SMS que foi enviado (8 a 16 caracteres). |
|
Para o número de telefone
|
messages.to | string |
Número para o qual sua solicitação foi enviada. |
|
Referência do cliente
|
messages.client-ref | string |
O cliente ref que você definiu na solicitação. |
|
Saldo Restante
|
messages.remaining-balance | string |
Balancear em sua conta. O valor está em EUR. |
|
Preço da Mensagem
|
messages.message-price | string |
Valor cobrado pela solicitação. O valor está em EUR. |
|
Rede
|
messages.network | string |
MCCMNC (Mobile Country Code Mobile Network Code) para a operadora com a qual está registrado. |
|
Texto de erro
|
messages.error-text | string |
Se ocorreu um erro, isso explica o que aconteceu. |
ListNumbersResponse
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Contagem
|
count | integer |
Contagem de resultados. |
|
Matriz de números
|
numbers | array of object |
Lista de todos os números. |
|
Custo
|
numbers.cost | string |
Custo do número. |
|
País
|
numbers.country | string |
Formato iso 3166-1 alfa-2. |
|
Número de entrada
|
numbers.msisdn | string |
Número virtual de entrada. |
|
Tipo
|
numbers.type | string |
Tipo de número. |
ttsResponse
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID da chamada
|
call_id | string |
ID exclusiva de caractere alfanumérico 32 para essa chamada. |
|
Para o número de telefone
|
to | string |
Número do usuário para o qual você enviou o prompt TTS ou TTS. |
|
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
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
ID do aplicativo Nexmo. |
|
Nome
|
name | string |
Nome do aplicativo. |
|
Teclas
|
keys.public_key | string |
A chave pública usada para validar o jwt em um https://en.wikipedia.org/wiki/JSON_Web_Token. |
comum
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Resposta
|
type | string |
Mensagem legível por humanos. |
|
Texto de erro
|
error_title | string |
Título do erro retornado se houver falha. |