Bereitstellen und Versenden von WhatsApp Stickern mit Vonage APIs

Sticker sind schon seit Jahren eine sehr beliebte Funktion in WhatsApp-Chats. In diesem Beitrag erklären wir, was sie sind und wie Sie sie in Ihrer WhatsApp-Kommunikation über die Vonage Messages APIs verwenden können.

Sticker sind visuelle Artefakte, die in einem WhatsApp-Chat verwendet werden können, ähnlich wie Emojis, aber mit größeren Bildern. Dieser Artikelaus dem offiziellen WhatsApp-Dokumentationsportal erklärt, wie WhatsApp-Nutzer Sticker herunterladen und verwenden können.

Cute WhatsApp dragon sticker

Es gibt bereits zahlreiche Sticker-Pakete, die von WhatsApp und Drittanbietern zur Verfügung gestellt werden. Das Tolle an Aufklebern ist, dass jeder benutzerdefinierte Aufkleberpakete von Drittanbietern erstellen und veröffentlichen kann. Benutzerdefinierte Sticker, die auf Ihre Marke zugeschnitten sind, können eine neuartige und unterhaltsame Möglichkeit sein, die Markenbekanntheit und die Kundenbindung zu steigern!

Erstellen eines Sticker-Packs

Um ein benutzerdefiniertes Stickerpaket zu veröffentlichen, müssen Sie eine Sticker-App erstellen und diese dann im Google Play Store und/oder im Apple App Store veröffentlichen. Wir werden in diesem Beitrag nicht näher darauf eingehen, wie man eine Sticker-App erstellt, aber ein guter Ausgangspunkt ist diese Benutzerhandbuch in der WhatsApp-Dokumentation. Das WhatsApp-Team hat auch eine Beispiel-App zur Verfügung gestellt, die Sie für Ihren eigenen Gebrauch anpassen können.

Es gibt bestimmte Anforderungen für Sticker in Bezug auf Größe, Format usw., die in der Android für das Repo und iOS README-Dokumenten im Repository der Beispielanwendung aufgeführt sind.

Bereitstellung von WhatsApp-Stickern für die Verwendung

Sobald die Sticker-App erstellt und freigegeben wurde, können Ihre Kunden die App installieren und Ihr Sticker-Paket zur Verwendung in ihren WhatsApp-Chats herunterladen. Wenn Sie die Sticker jedoch selbst verwenden möchten (z. B. in WhatsApp-Nachrichten, die Sie über die Messages API an Kunden senden), müssen Sie das Sticker-Paket zunächst für die Verwendung durch Ihren WhatsApp Business Account bereitstellen.

Die Provisionierung erfolgt über die Vonage WhatsApp-Bereitstellungs-API.

Wenn Sie dies noch nicht getan haben, müssen Sie zunächst eine WhatsApp-Bereitstellung einrichten. Dies kann durch Senden einer POST-Anfrage an den folgenden Endpunkt /whatsapp-manager/deployments erfolgen, wie in der API-Spezifikation:

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

Weitere Informationen zur Bereitstellung von WhatsApp-Bereitstellungen finden Sie in diesem Dokument.

Durch die Bereitstellung eines WhatsApp-Einsatzes erhalten Sie eine Einsatz-ID, die Sie dann für verschiedene Aspekte der Verwaltung dieses Einsatzes verwenden können, einschließlich der Bereitstellung von benutzerdefinierten Sticker-Packs für die Verwendung durch Ihren WhatsApp Business Account. Die Bereitstellung des Sticker-Packs erfordert eine POST-Anfrage an den folgenden API-Endpunkt:

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

Hinweis: :deployment_id im Pfad wird durch die Deployment-ID Ihrer WhatsApp-Bereitstellung ersetzt.

Der Anfragetext würde etwa so aussehen:

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

Eine erfolgreiche Antwort würde die ID des verteilten Aufkleberpakets enthalten.

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

Weitere Einzelheiten zu Anfragen an diesen Endpunkt finden Sie in der API-Spezifikation.

Versenden eines Aufklebers (mit der Messages API)

Sobald Ihr Sticker-Paket bereitgestellt ist, können Sie die Sticker in einem WhatsApp-Chat verwenden. Dazu benötigen Sie die Sticker-ID für den einzelnen Sticker, den Sie versenden möchten. Um diese zu erhalten, sind ein paar Schritte erforderlich:

1. Holen Sie sich den Aufkleber-Index. Dies geschieht über eine GET Anfrage an einen Endpunkt, der die deployment_id und den stickerpack_identhält, und ist detailliert in dieser API-Spezifikation. Die Antwort gibt ein Objekt mit einer index zurück, dessen Wert der für den nächsten Schritt erforderliche Aufkleberindex ist.

2. Holen Sie sich den Ausweis für einen Aufkleber. Dies erfordert eine weitere GET Anfrage an einen anderen Endpunkt, dieses Mal mit den Parametern deployment_id und stickerpack_id zusammen mit der sticker_index aus dem vorherigen Schritt. Diese Anfrage gibt ein Array von Aufkleberobjekten zurück, jedes mit einer id Eigenschaft. Dieser Endpunkt wird detailliert beschrieben in dieser API-Spezifikation.

Sobald Sie den id des Aufklebers haben, können Sie ihn in einer WhatsApp-Nachricht versenden, indem Sie die Vonage Messages API.

Das Versenden eines Aufklebers erfordert eine POST-Anfrage an den folgenden Endpunkt: https://api.nexmo.com/v1/messages.

Der JSON-Payload für den Request Body könnte etwa so aussehen:

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

Beachten Sie die channel wird auf whatsapp und die message_type von custom, sowie das custom-Objekt mit einem type von stickerund ein Aufkleber-Objekt, das die zuvor erhaltene Aufkleber-ID enthält.

Weitere Informationen zur Verwendung der Messages API und zum Senden von WhatsApp-Nachrichten finden Sie in den folgenden Ressourcen:

• Messages API-Spezifikation

• Verstehen von WhatsApp-Nachrichten

• Benutzerdefinierte Objekte