Nexmo
Nexmo, la plataforma de API vonage, le permite agregar comunicaciones dentro del contexto de las aplicaciones, incluidos SMS, Voz y Chat. Regístrese aquí para obtener una cuenta de Nexmo: https://www.nexmo.com/
Este conector está disponible en los siguientes productos y regiones:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Todas las regiones de Power Automate excepto las siguientes: - Gobierno de EE. UU. (GCC) - Gobierno de EE. UU. (GCC High) - China Cloud operado por 21Vianet - Departamento de Defensa de EE. UU. (DoD) |
| Aplicaciones lógicas | Estándar | Todas las regiones de Logic Apps excepto las siguientes: - Regiones de Azure Government - Regiones de Azure China - Departamento de Defensa de EE. UU. (DoD) |
| Power Apps | Premium | Todas las regiones de Power Apps excepto las siguientes: - Gobierno de EE. UU. (GCC) - Gobierno de EE. UU. (GCC High) - China Cloud operado por 21Vianet - Departamento de Defensa de EE. UU. (DoD) |
| Power Automate | Premium | Todas las regiones de Power Automate excepto las siguientes: - Gobierno de EE. UU. (GCC) - Gobierno de EE. UU. (GCC High) - China Cloud operado por 21Vianet - Departamento de Defensa de EE. UU. (DoD) |
| Metadatos del conector | |
|---|---|
| Publicador | Microsoft |
Creación de una conexión
El conector admite los siguientes tipos de autenticación:
| Predeterminado | Parámetros para crear una conexión. | Todas las regiones | No se puede compartir |
Predeterminado
Aplicable: Todas las regiones
Parámetros para crear una conexión.
Esta conexión no se puede compartir. Si la aplicación de energía se comparte con otro usuario, se pedirá a otro usuario que cree explícitamente una nueva conexión.
| Nombre | Tipo | Description | Obligatorio |
|---|---|---|---|
| Clave de API | cuerda / cadena | La clave de API | Cierto |
| Secreto de API | securestring | Secreto de API | Cierto |
Limitaciones
| Nombre | Llamadas | Período de renovación |
|---|---|---|
| Llamadas API por conexión | 100 | 60 segundos |
Acciones
| Actualización de una aplicación |
Esta operación se usa para modificar una aplicación existente en la cuenta. |
| Creación de una aplicación |
Esta operación se usa para crear una nueva aplicación en la cuenta. |
| Eliminación de una aplicación |
Esta operación se usa para eliminar una aplicación existente en la cuenta. |
| Enumerar aplicaciones |
Recupera una lista de todas las aplicaciones asociadas a su cuenta. |
| Enumerar números de entrada |
Esta operación se usa para recuperar todos los números de entrada que son avialbles para un país determinado. |
| Enumerar números de propiedad |
Esta operación recupera todos los números asociados a su cuenta. |
| Enviar un SMS |
Esta operación se usa para enviar un SMS. |
| Envío de un archivo de voz |
Esta operación se usa para enviar un archivo de sonido sintetizado o voz grabado a un número de teléfono. |
| Obtención de la aplicación por identificador |
Esta operación se usa para recuperar información sobre una sola aplicación, dado su identificador. |
Actualización de una aplicación
Esta operación se usa para modificar una aplicación existente en la cuenta.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de aplicación
|
application_id | True | string |
Identificador único de la aplicación. |
|
Nombre
|
name | True | string |
Nombre de la aplicación. |
|
Tipo
|
type | True | string |
Tipo de aplicación. |
|
Url de respuesta
|
answer_url | True | string |
Donde el webhook entrega el objeto de control de llamadas de Nexmo. |
|
Dirección URL de eventos
|
event_url | True | string |
Iniciado, timbre o completo |
|
Answer (método)
|
answer_method | string |
Método HTTP (GET predeterminado). |
|
|
Event (método)
|
event_method | string |
Método HTTP (Post predeterminado). |
Devoluciones
- Body
- applicationResponse
Creación de una aplicación
Esta operación se usa para crear una nueva aplicación en la cuenta.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Nombre
|
name | True | string |
Nombre de la aplicación. |
|
Tipo
|
type | True | string |
Tipo de aplicación. |
|
Url de respuesta
|
answer_url | True | string |
Donde el webhook entrega el objeto de control de llamadas de Nexmo. |
|
Dirección URL de eventos
|
event_url | True | string |
Iniciado, timbre o completo |
|
Answer (método)
|
answer_method | string |
Método HTTP (GET predeterminado). |
|
|
Event (método)
|
event_method | string |
Método HTTP (Post predeterminado). |
Devoluciones
- Body
- applicationResponse
Eliminación de una aplicación
Esta operación se usa para eliminar una aplicación existente en la cuenta.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de aplicación
|
application_id | True | string |
Identificador único de la aplicación. |
Devoluciones
- Body
- common
Enumerar aplicaciones
Recupera una lista de todas las aplicaciones asociadas a su cuenta.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Número de resultados
|
page_size | number |
Elementos devueltos en cada llamada (valor predeterminado 10). |
|
|
Índice de página
|
page_index | number |
Desplazamiento desde la primera página (valor predeterminado 0). |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
aplicaciones
|
_embedded.applications | array of applicationResponse |
Enumerar números de entrada
Esta operación se usa para recuperar todos los números de entrada que son avialbles para un país determinado.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
País
|
country | True | string |
Código en formato alfa-2 ISO 3166-1. |
|
Patrón de búsqueda
|
Search Pattern | string |
Elija un patrón. |
|
|
Modelo
|
pattern | number |
Patrón de número que se va a buscar. |
|
|
Características disponibles
|
features | string |
SMS o VOICE |
|
|
Número de resultados
|
size | number |
El valor predeterminado es 10. |
|
|
Índice de página
|
index | number |
Índice en la respuesta. |
Devoluciones
- Body
- ListNumbersResponse
Enumerar números de propiedad
Esta operación recupera todos los números asociados a su cuenta.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Patrón de búsqueda
|
Search Pattern | string |
Elija un patrón. |
|
|
Índice de página
|
index | number |
Índice en la respuesta. |
|
|
Número de resultados
|
size | number |
Valor predeterminado 10 max 100. |
|
|
Modelo
|
pattern | number |
Patrón de número que se va a buscar. |
Devoluciones
- Body
- ListNumbersResponse
Enviar un SMS
Esta operación se usa para enviar un SMS.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. del remitente
|
from | True | string |
Cadena alfanumérica. |
|
Número de teléfono
|
to | True | string |
Formato internacional E.164. |
|
Mensaje de texto
|
text | True | string |
Cuerpo de SMS. |
|
Tipo
|
type | string |
El valor predeterminado es texto. |
|
|
Recibos de entrega
|
status-report-req | number |
Establézcalo en 1 para habilitarlo. |
|
|
Referencia de cliente
|
client-ref | string |
Para los informes internos. |
|
|
Tarjeta de visita
|
vcard | string |
Formato vCard. |
|
|
Evento de calendario
|
vcal | string |
Formato vCal. |
|
|
Duración de SMS
|
ttl | number |
En milisegundos. |
|
|
Dirección URL de devolución de llamadas
|
callback | url |
Punto de conexión de recibo de entrega. |
|
|
Clase Message
|
message-class | number |
Elija una clase. |
|
|
Encabezado de datos de usuario
|
udh | string |
UDH codificado hexadecimal. |
|
|
Protocolo de nivel superior
|
protocol-id | string |
Id. de protocolo. |
|
|
Cuerpo (si el tipo es binario).
|
body | string |
Datos binarios codificados hexadecimales. |
|
|
Title
|
title | string |
Si el tipo es wappush. |
|
|
URL
|
url | url |
Dirección URL del sitio web (si el tipo es wappush.). |
|
|
Disponibilidad (si el tipo es wappush).
|
validity | string |
En milisegundos. |
Devoluciones
- Body
- smsResponse
Envío de un archivo de voz
Esta operación se usa para enviar un archivo de sonido sintetizado o voz grabado a un número de teléfono.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Número de teléfono
|
to | True | string |
Formato internacional E.164. |
|
Número de teléfono
|
from | string |
Número de Nexmo habilitado para voz. |
|
|
Message
|
text | True | string |
Texto de voz. |
|
Language
|
lg | string |
Para sintetizar el mensaje en. |
|
|
Gender
|
voice | string |
Macho o hembra. |
|
|
Número de repeticiones
|
repeat | number |
Hasta 10 veces. |
|
|
Permitir detección de máquinas
|
machine_detection | string |
True o hangup. |
|
|
Tiempo de espera de la máquina
|
machine_timeout | number |
400 ms a 10000 ms. |
|
|
Dirección URL de devolución de llamadas
|
callback | url |
Dirección URL de devolución de llamada. |
|
|
Callback (método)
|
callback_method | string |
GET o POST. |
Devoluciones
- Body
- ttsResponse
Obtención de la aplicación por identificador
Esta operación se usa para recuperar información sobre una sola aplicación, dado su identificador.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de aplicación
|
application_id | True | string |
Identificador único de la aplicación. |
Devoluciones
- Body
- applicationResponse
Definiciones
smsResponse
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Recuento de mensajes
|
message-count | string |
Número de partes en las que se dividió el mensaje. |
|
Matriz de mensajes
|
messages | array of object |
Contiene cada parte del mensaje. |
|
Estado
|
messages.status | string |
Muestra cómo se procesa el envío de SMS. |
|
Id. de mensaje
|
messages.message-id | string |
Identificador del SMS que se envió (de 8 a 16 caracteres). |
|
Número de teléfono
|
messages.to | string |
Número al que se envió la solicitud. |
|
Referencia de cliente
|
messages.client-ref | string |
La referencia de cliente que estableció en la solicitud. |
|
Saldo restante
|
messages.remaining-balance | string |
Saldo en su cuenta. El valor está en EUR. |
|
Precio del mensaje
|
messages.message-price | string |
Importe cargado por la solicitud. El valor está en EUR. |
|
Network
|
messages.network | string |
Código de país móvil Código de red móvil (MCCMNC) para el operador con el que está registrado. |
|
Texto de error
|
messages.error-text | string |
Si se produjo un error, esto explica lo que sucedió. |
ListNumbersResponse
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Contar
|
count | integer |
Recuento de resultados. |
|
Matriz de números
|
numbers | array of object |
Lista de todos los números. |
|
Cost
|
numbers.cost | string |
Costo del número. |
|
País
|
numbers.country | string |
Formato alfa-2 ISO 3166-1. |
|
Número de entrada
|
numbers.msisdn | string |
Número virtual de entrada. |
|
Tipo
|
numbers.type | string |
Tipo de número. |
ttsResponse
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Identificador de llamada
|
call_id | string |
Identificador de carácter alfanumérico único de 32 para esta llamada. |
|
Número de teléfono
|
to | string |
Número del usuario al que envió el mensaje de TTS o TTS. |
|
Estado
|
status | string |
Código de respuesta para este mensaje de TTS o TTS. |
|
Texto de error
|
error_text | string |
Si se produjo un error, esto explica lo que sucedió. |
applicationResponse
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Id
|
id | string |
Identificador de aplicación de Nexmo. |
|
Nombre
|
name | string |
Nombre de la aplicación. |
|
Keys
|
keys.public_key | string |
Clave pública que se usa para validar el jwt en .https://en.wikipedia.org/wiki/JSON_Web_Token |
común
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Respuesta
|
type | string |
Mensaje legible humano. |
|
Texto de error
|
error_title | string |
Título del error devuelto si se produjo un error. |