Detalles técnicos de la API de Messages

Messages API permite enviar y, en algunos casos, recibir mensajes a través de SMS, MMS, RCS, Facebook Messenger, Viber y WhatsApp. Es posible que en el futuro se admitan más canales.

El siguiente diagrama ilustra cómo Messages API de Vonage te permite enviar mensajes para el caso de uso que elijas a través de múltiples canales desde un único punto final; por ejemplo, podrías enviar mensajes de notificación a través de WhatsApp y SMS:

Funciones compatibles

También se presta un apoyo limitado a objetos personalizados:

Llave:

• = Compatible.
• = Compatible con el canal, pero no con Vonage.
• n/a = No soportado por el canal.

Notas:

1. Para RCS, el custom está obsoleto. Los mensajes de botón y ubicación se admiten como Sugerencia Fichas en text, cardy carousel mensajes de tipo

Autenticación

La API de Messages admite o bien Autenticación básica o JWT (JSON Web Token), pero hay algunas diferencias importantes entre los dos a tener en cuenta:

• La autenticación básica utiliza un código Clave y secreto de la APIy autentifica en el Account nivel.
• La autenticación JWT utiliza un Token web JSON generados mediante una clave privada y un identificador de aplicación. Los JWT admiten funciones avanzadas como las ACL y autentican en el aplicación lo que significa que puedes acceder a la configuración de tu aplicación de Vonage, como la aplicación webhooks y Medios de entrada seguros.

Le recomendamos que utilice Autenticación JWT en producción para la mayoría de los casos de uso. La autenticación básica puede ser suficiente cuando se prueba la API, como cuando se utiliza el Sandbox de Mensajes, o para algunos casos de uso básico (por ejemplo, cuando no se requieren webhooks).

Si utiliza nuestro SDK de servidor para interactuar con la Messages API, estos pueden crear automáticamente JWTs para usted.

Límites de tarifa

El límite predeterminado de solicitudes a la API de Messages es de 75 solicitudes por segundo y por clave de API. Este límite puede aumentarse caso por caso. Por favor, hable con su gestor de Account o representante de ventas para aumentar su límite de velocidad.

API de cuentas externas

En API de cuentas externas se utiliza para gestionar sus cuentas de Viber Business Messages, Facebook Messenger y WhatsApp cuando utiliza esos canales con las API de Messages y Dispatch.

Cómo empezar

En este ejemplo tendrá que sustituir las siguientes variables por valores reales utilizando cualquier método conveniente:

El siguiente código muestra cómo enviar un mensaje SMS utilizando el Messages API:

curl -X POST https://api.nexmo.com/v1/messages \
	-u "${VONAGE_API_KEY}:${VONAGE_API_SECRET}" \
	-H 'Content-Type: application/json' \
	-H 'Accept: application/json' \
	-d $'{
		"to": "'${MESSAGES_TO_NUMBER}'",
		"from": "'${SMS_SENDER_ID}'",
		"channel": "sms",
		"message_type": "text",
		"text": "This is an SMS sent using the Vonage Messages API."
	}'

npm install @vonage/server-sdk @vonage/messages

const { Vonage } = require('@vonage/server-sdk');
const { Channels } = require('@vonage/messages');

/**
 * By leaving out the applicationId and privateKey parameters, the Vonage
 * SDK will use basic authentication to authenticate with the Messages API.
 *
 * @link https://developer.vonage.com/en/messages/technical-details#authentication
 */
const vonage = new Vonage(
  {
    apiKey: VONAGE_API_KEY,
    apiSecret: VONAGE_API_SECRET,
  },
  {
    ...(MESSAGES_API_URL ? {apiHost: MESSAGES_API_URL} : {}),
  },
);

vonage.messages.send({
  messageType: 'sms',
  channel: Channels.SMS,
  text: 'This is an SMS text message sent using the Messages API',
  to: MESSAGES_TO_NUMBER,
  from: SMS_SENDER_ID,
})
  .then(({ messageUUID }) => console.log(messageUUID))
  .catch((error) => console.error(error));

Referencia

• Referencia de la API Messages
• Referencia API de cuentas externas