Cómo aprovisionar y enviar stickers de WhatsApp con las API de Vonage

Los stickers son una característica muy popular de los chats de WhatsApp desde hace años. En este post te explicaremos qué son y cómo usarlos en tus comunicaciones de WhatsApp, a través de las Messages API de Vonage.

Los stickers son artefactos visuales que se pueden utilizar en un chat de WhatsApp, similares a los emojis, pero con imágenes más grandes. Este artículodel portal de documentación oficial de WhatsApp, explica cómo los usuarios de WhatsApp pueden descargar y utilizar los stickers.

Cute WhatsApp dragon sticker

Existen numerosos paquetes de stickers disponibles por WhatsApp y desarrolladores externos. Una de las grandes ventajas de los stickers es que cualquiera puede crear y publicar paquetes personalizados de terceros. Los stickers personalizados diseñados en torno a su marca pueden ser una forma novedosa y divertida de dar a conocer su marca y atraer a los clientes.

Crear un paquete de adhesivos

Para publicar un paquete de pegatinas personalizado, tendrás que crear una aplicación de pegatinas y publicarla en Google Play Store y/o Apple App Store. No vamos a entrar en los detalles de cómo crear una aplicación de stickers en este post, pero un buen lugar para empezar es esta guía del usuario en la documentación de WhatsApp. El equipo de WhatsApp también ha proporcionado una aplicación de ejemplo que puedes adaptar para tu propio uso.

Existen ciertos requisitos para las pegatinas, en cuanto a tamaño, formato, etc., que se enumeran en el Android para el repo y en iOS en el repositorio de la aplicación de ejemplo.

Aprovisionamiento de pegatinas de WhatsApp para su uso

Una vez creada y publicada la aplicación de stickers, tus clientes podrán instalarla y descargar tu paquete de stickers para utilizarlo en sus chats de WhatsApp. Sin embargo, si desea utilizar los stickers usted mismo (por ejemplo, en los mensajes de WhatsApp que envíe a sus clientes a través de Messages API), primero deberá aprovisionar el paquete de stickers para que pueda utilizarlo su WhatsApp Business Account.

El aprovisionamiento se realiza a través de la API de aprovisionamiento de WhatsApp de Vonage.

Si aún no lo ha hecho, el primer paso es aprovisionar un despliegue de WhatsApp. Para ello, envíe una solicitud POST al siguiente punto final /whatsapp-manager/deployments, tal y como se detalla en la especificación de la API especificación de la API:

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

Encontrará más información sobre el aprovisionamiento de implementaciones de WhatsApp en este documento.

El aprovisionamiento de una implementación de WhatsApp le proporcionará un ID de implementación, que podrá utilizar para diversos aspectos de la gestión de dicha implementación, incluido el aprovisionamiento de paquetes de adhesivos personalizados para su uso por parte de su WhatsApp Business Account. El aprovisionamiento del paquete de adhesivos requiere una solicitud POST al siguiente punto final de la API:

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

Nota: :deployment_id en la ruta se sustituye por el ID de despliegue de su despliegue de WhatsApp.

El cuerpo de la solicitud sería algo parecido a esto

{
  "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"
}

Una respuesta correcta incluiría el ID del paquete de pegatinas desplegado.

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

Encontrará más información sobre cómo realizar solicitudes a este punto final en la especificación de la API especificación API.

Envío de una pegatina (mediante la Messages API)

Una vez aprovisionado el paquete de stickers, puede utilizarlos en un chat de WhatsApp. Para ello, necesitarás el identificador de cada uno de los stickers que quieras enviar. Hay un par de pasos necesarios para conseguirlo:

1. Obtener el índice de adhesivos. Esto se hace mediante una GET a un endpoint que contiene el deployment_id y el stickerpack_idy se detalla en esta especificación de la API. La respuesta devuelve un objeto con una propiedad index cuyo valor es el índice de pegatina necesario para el siguiente paso.

2. Obtener la identificación para una pegatina. Esto requiere otra GET a un punto final diferente, esta vez con las etiquetas deployment_id y stickerpack_id junto con el sticker_index obtenidos en el paso anterior. Esta petición devolverá un array de objetos sticker, cada uno con una propiedad id propiedad. Este endpoint se detalla en esta especificación de la API.

Una vez que tengas el id del sticker, puedes enviarlo en un mensaje de WhatsApp, utilizando la API de Messages de Vonage.

El envío de una pegatina implica una solicitud POST al siguiente punto final: https://api.nexmo.com/v1/messages.

La carga útil JSON para el cuerpo de la solicitud podría tener este aspecto:

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

Tenga en cuenta que channel en whatsapp y el message_type de custom, así como que el objeto custom tiene un type de stickery un objeto sticker que contiene el id de sticker obtenido anteriormente.

Para obtener más información sobre el uso de Messages API y el envío de mensajes de WhatsApp, consulte los siguientes recursos:

• Especificación de la API de Messages

• Entender la mensajería de WhatsApp

• Objetos personalizados