Guide de migration de WhatsApp v0.1 à v1

Il existe actuellement deux versions de l'API Messages : v0.1 et v1. Bien que la version 1 prenne en charge toutes les fonctionnalités de la version 0.1, il existe des différences significatives entre les deux versions, qu'il convient de garder à l'esprit si vous utilisez déjà la version 0.1 de l'API et que vous envisagez de migrer vers la version 1.

Structure JSON

L'une des différences les plus importantes entre les deux versions est la structure utilisée pour les données JSON dans les demandes adressées à l'API et pour les données des webhooks entrants ; la v1 fournit une structure simplifiée et plus plate. Pour que votre application fonctionne avec la v1, il sera nécessaire de modifier tout code qui génère ou fait référence aux données JSON.

Voici quelques-unes des différences entre les deux structures :

• to et from sont des nœuds à valeur unique au lieu d'un objet
• La messagerie channel ne doit être spécifié qu'une seule fois au lieu d'être spécifié en tant que type en to et from
• Les message a été remplacé par un objet message_typeet un seul nœud de valeur avec le type de contenu impliqué par l'étiquette, par exemple "text": "this is a text"

Exemples

Texte WhatsApp sortant V0.1

{
  "to": {
    "type": "whatsapp",
    "number": "447700900000"
  },
  "from": {
    "type": "whatsapp",
    "number": "447700900001"
  },
  "message": {
    "content": {
      "type": "text",
      "text": "Hello From Vonage!"
    }
  }
}

Texte WhatsApp sortant V1

{
  "message_type": "text",
  "text": "Hello From Vonage!",
  "to": "447700900000",
  "from": "447700900001",
  "channel": "whatsapp"
}

Webhook du texte WhatsApp entrant v0.1

{
  "message_uuid": "aaaaaaaa-bbbb-cccc-dddd-0123456789ab",
  "timestamp": "2020-01-01T14:00:00.000Z",
  "to": {
    "type": "whatsapp",
    "number": "447700900000"
  },
  "from": {
    "type": "whatsapp",
    "number": "447700900001"
  },
  "message": {
    "content": {
      "type": "text",
      "text": "Hello From Vonage!"
    }
  }
}

Texte WhatsApp entrant webhook v1

{
  "channel": "whatsapp",
  "message_uuid": "aaaaaaaa-bbbb-cccc-dddd-0123456789ab",
  "to": "447700900000",
  "from": "447700900001",
  "timestamp": "2020-01-01 14:00:00 UTC",
  "message_type": "text",
  "text": "Nexmo Verification code: 12345. Valid for 10 minutes.",
  "profile": {
    "name": "Jane Smith"
  },
  "context": {
    "message_uuid": "aaaaaaaa-bbbb-cccc-dddd-0123456789ab",
    "message_from": "447700900000"
  }
}

Les exemples ci-dessus en sont quelques-uns. Vérifier les spécification pour obtenir un ensemble complet de champs pour les différents types de messages et de webhooks.

Utilisation des Applications Vonage pour les Webhooks

Si vous utilisez webhooksPour la v1, ils doivent être configurés dans le cadre d'une Applications Vonage. En outre, l'Application doit être configurée pour utiliser la version v1.

Un flux de travail de base pour la mise en place de ce système via l'outil Tableau de bord serait la suivante :

1. Créez une nouvelle application sous Vos applications (en lui donnant un nom approprié, etc.)
2. Sous Capacités, activer Messages
3. L'activation de Messages devrait exposer les champs pour les webhooks de réception et d'état. Définissez le webhook entrant à l'URL où vous souhaitez recevoir les rappels pour les messages interactifs de WhatsApp.
4. Réglez la version de l'API Messages sur v1 à l'aide du menu déroulant.
5. Cliquer sur Générer une nouvelle application

Utilisation de JWTs pour l'authentification en cas d'utilisation d'une application Vonage

Si vous mettez en place une application Vonage, il est important de savoir que les applications Vonage imposent l'utilisation de JWT (JSON Web Tokens) pour authentifier les demandes à l'API. En d'autres termes, l'authentification HTTP Basic n'est pas une option dans cette situation. En savoir plus sur les JWT.

Relier les Numbers et les canaux sociaux à une application Vonage

Si vous souhaitez mettre certains numéros et canaux sociaux à la disposition d'une Application Vonage, vous devez lier ces numéros et canaux sociaux à l'application. Cela peut être fait via l'option Tableau de bord. De la Page ApplicationsVous pouvez lier des numéros à l'application sous l'onglet "Lier des numéros" et lier des canaux sociaux sous l'onglet "Lier des canaux sociaux".

Caractéristiques supplémentaires

L'une des raisons pour lesquelles vous pourriez souhaiter migrer vers la version 1, si vous utilisez actuellement la version 1, est de tirer parti de certains des avantages suivants caractéristiques supplémentaires que propose la v1, par exemple Messages interactifs WhatsApp.