Approvisionnement et envoi d'autocollants WhatsApp avec les API de Vonage

Les autocollants sont une fonctionnalité très populaire des chats WhatsApp depuis des années. Dans ce billet, nous allons vous expliquer ce qu'ils sont et comment les utiliser dans vos communications WhatsApp, via les API Messages de Vonage.

Les autocollants sont des artefacts visuels qui peuvent être utilisés dans un chat WhatsApp. Ils sont similaires aux emojis, mais avec des images plus grandes. Cet articledu portail de documentation officiel de WhatsApp, explique comment les utilisateurs de WhatsApp peuvent télécharger et utiliser les autocollants.

Cute WhatsApp dragon sticker

De nombreux packs d'autocollants sont déjà disponibles auprès de WhatsApp et de développeurs tiers. L'un des grands avantages des autocollants est que tout le monde peut créer et publier des packs d'autocollants tiers personnalisés. Les autocollants personnalisés conçus autour de votre marque peuvent être un moyen original et amusant d'accroître la notoriété de votre marque et l'engagement de vos clients !

Création d'un paquet d'autocollants

Pour publier un pack d'autocollants personnalisé, vous devez créer une application d'autocollants et la publier sur le Google Play store et/ou l'Apple App store. Nous n'entrerons pas dans les détails de la création d'une application d'autocollants dans cet article, mais vous pouvez commencer par consulter ce guide de l'utilisateur dans la documentation de WhatsApp. L'équipe WhatsApp a également fourni un exemple d'application que vous pouvez adapter à votre propre usage.

Les autocollants doivent répondre à certaines exigences en termes de taille, de format, etc. Android pour le repo et iOS dans le référentiel de l'application exemple.

Approvisionnement des autocollants WhatsApp en vue de leur utilisation

Une fois l'application d'autocollants créée et publiée, vos clients peuvent l'installer et télécharger votre pack d'autocollants pour l'utiliser dans leurs discussions WhatsApp. Si vous souhaitez utiliser les autocollants vous-même (par exemple dans les messages WhatsApp que vous envoyez à vos clients via l'API Messages), vous devez d'abord provisionner le pack d'autocollants pour qu'il puisse être utilisé par votre WhatsApp Business Account.

Le provisionnement est effectué par l'intermédiaire de l'API de provisionnement de WhatsApp de Vonage WhatsApp Provisioning API.

Si vous ne l'avez pas encore fait, la première étape consiste à mettre en place un déploiement WhatsApp. Pour ce faire, envoyez une requête POST au point de terminaison suivant /whatsapp-manager/deployments, comme indiqué dans la spécification de l'API:

https://api.nexmo.com/v0.1/whatsapp-manager/deployments

De plus amples informations sur le provisionnement des déploiements WhatsApp sont disponibles dans ce document.

Le provisionnement d'un déploiement WhatsApp vous fournira un identifiant de déploiement, que vous pourrez ensuite utiliser pour divers aspects de la gestion de ce déploiement, notamment le provisionnement de packs d'autocollants personnalisés destinés à être utilisés par votre compte WhatsApp Business. Le provisionnement du pack d'autocollants nécessite une requête POST vers le point de terminaison API suivant :

https://api.nexmo.com/v0.1/whatsapp-manager/deployments/:deployment_id/stickerpacks

Remarque : :deployment_id dans le chemin d'accès est remplacé par l'ID de déploiement de votre déploiement WhatsApp.

Le corps de la demande ressemblerait à ceci :

{
  "publisher": "your-publisher-name",
  "name": "your-sticker-pack-name",
  "ios_app_store_link": "https://itunes.apple.com/app/id3133333",
  "android_app_store_link": "https://play.google.com/store/apps/details?id=com.example"
}

Si la réponse est positive, l'identifiant du paquet d'autocollants déployé est indiqué.

{
  "stickerpacks": [
    {
      "id": "sticker-pack-id1"
    }
  ]
}

Pour plus de détails sur les requêtes adressées à ce point d'accès, voir la spécification de l'API.

Envoi d'un autocollant (à l'aide de l'API Messages)

Une fois votre pack d'autocollants approvisionné, vous pouvez utiliser les autocollants dans une discussion WhatsApp. Pour ce faire, vous aurez besoin de l'identifiant de l'autocollant que vous souhaitez envoyer. Il y a plusieurs étapes à suivre pour obtenir cet identifiant :

1. Obtenir l'index des autocollants. Cette opération s'effectue par le biais d'une GET à un point d'accès qui contient les éléments deployment_id et le stickerpack_idet est détaillée dans cette spécification de l'API. La réponse renvoie un objet avec une propriété index dont la valeur est l'indice de l'autocollant requis pour l'étape suivante.

2. Obtenir l'identifiant d'un autocollant. Cela nécessite une autre GET vers un autre point d'accès, cette fois-ci en combinant les éléments deployment_id et stickerpack_id avec l'identifiant sticker_index obtenu à l'étape précédente. Cette requête renverra un tableau d'objets autocollants, chacun avec une propriété id propriété. Ce point d'accès est détaillé dans spécification de l'API.

Une fois que vous avez l'image de l'autocollant, vous pouvez l'envoyer dans un message WhatsApp. id de l'autocollant, vous pouvez l'envoyer dans un message WhatsApp, en utilisant l'API Vonage Messages API.

L'envoi d'un autocollant implique une requête POST au point de terminaison suivant : https://api.nexmo.com/v1/messages.

La charge utile JSON du corps de la demande peut ressembler à ceci :

{
   "from":"447700900000",
   "to":"447700900001",
   "channel":"whatsapp",
   "message_type":"custom",
   "custom":{
      "type":"sticker",
      "sticker":{
         "id":"13aaecab-2485-4255-a0a7-97a2be6906b9"
      }
   }
}

Notez que le channel est réglé sur whatsapp et le message_type de custom, ainsi que l'objet custom ayant une valeur de type de stickeret un objet sticker qui contient l'identifiant de l'autocollant obtenu précédemment.

Pour plus d'informations sur l'utilisation de l'API Messages et sur l'envoi de messages WhatsApp, veuillez consulter les ressources suivantes :

• Spécification de l'API Messages

• Comprendre la messagerie WhatsApp

• Objets personnalisés