Détails techniques de l'API Messages

L'API Messages vous permet d'envoyer et, dans certains cas, de recevoir des messages par SMS, MMS, RCS, Facebook Messenger, Viber et WhatsApp. D'autres canaux pourront être pris en charge à l'avenir.

Le diagramme suivant illustre comment l'API Messages de Vonage vous permet d'envoyer des messages pour le cas d'utilisation de votre choix via plusieurs canaux à partir d'un seul point d'extrémité ; par exemple, vous pourriez envoyer des messages de notification via WhatsApp et SMS :

Caractéristiques prises en charge

Une aide limitée est également fournie pour objets personnalisés:

Clé :

• = pris en charge.
• = Pris en charge par le canal, mais pas par Vonage.
• n/a = Non pris en charge par le canal.

Notes :

1. Pour le RCS, le custom est obsolète. Les messages relatifs aux boutons et à l'emplacement sont pris en charge en tant que Suggestion Chips en text, cardet carousel types de messages

Authentification

L'API Messages prend en charge soit Authentification de base ou JWT (JSON Web Token), mais il existe des différences importantes entre les deux :

• L'authentification de base utilise un code Clé et secret de l'APIet s'authentifie auprès du Account niveau.
• L'authentification JWT utilise un Jeton Web JSON généré à l'aide d'une clé privée et de l'identifiant de l'application. Les JWT prennent en charge des fonctions avancées telles que les listes de contrôle d'accès et l'authentification au niveau de l'application. Applications niveau, ce qui signifie que vous pouvez accéder aux paramètres de votre application Vonage tels que l'application webhooks et Sécuriser les médias entrants.

Nous vous recommandons d'utiliser Authentification JWT en production pour la plupart des cas d'utilisation. L'authentification de base peut suffire lors de l'essai de l'API, par exemple lors de l'utilisation de Messages Sandbox, ou pour certains cas d'utilisation de base (par exemple lorsque les webhooks ne sont pas nécessaires).

Si vous utilisez notre SDK de serveur pour interagir avec l'API Messages, ces derniers peuvent créer automatiquement des JWT pour vous.

Limites de taux

La limite de débit par défaut pour les demandes adressées à l'API Messages est de 75 demandes par seconde et par clé API. Cette limite peut être augmentée au cas par cas. Veuillez vous adresser à votre Account manager ou à votre représentant commercial concernant l'augmentation de votre limite de taux.

API Comptes externes

Les API Comptes externes est utilisé pour gérer vos Account pour Viber Business Messages, Facebook Messenger et WhatsApp lorsque vous utilisez ces canaux avec les API Messages et Dispatch.

Pour commencer

Dans cet exemple, vous devrez remplacer les variables suivantes par des valeurs réelles en utilisant n'importe quelle méthode pratique :

Le code suivant montre comment envoyer un SMS à l'aide de l'API Messages :

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));

Référence

• Référence de l'API Messages
• Référence API Comptes externes