Vonage APIでWhatsAppステッカーのプロビジョニングと送信

ステッカーはWhatsAppチャットの人気機能です。この記事ではステッカーとは何か、またVonageメッセージAPIを通じてWhatsAppコミュニケーションで使用する方法についてご説明します。

ステッカーはWhatsAppチャットで使用可能なビジュアルアーティファクトです。 この記事WhatsApp公式ドキュメントポータルより、ステッカーのダウンロードと使用方法についてご説明します。

Cute WhatsApp dragon sticker

WhatsAppやサードパーティ開発者により、既に数多くのステッカーパックが提供されています。ステッカーの優れた点は、誰でもサードパーティのカスタムステッカーパックを作成・公開できることです。ブランド認知度や顧客エンゲージメントを高める斬新で楽しい方法です！

ステッカーパックの作成

カスタムステッカーパックを公開するには、ステッカーアプリを作成し、Google PlayストアやApple Appストアで公開する必要があります。この記事ではステッカーアプリの作成方法の詳細には触れませんが、手始めにこの ユーザーガイドをご覧ください。WhatsAppチームは サンプルアプリを提供しています。

ステッカーには、サイズやフォーマットなど、一定の要件があります。 アンドロイドレポと iOSREADMEドキュメントに記載されています。

WhatsAppステッカーのプロビジョニング

ステッカーアプリがリリースされると、お客様はアプリをインストールしてステッカーパックをダウンロードし、WhatsAppチャットで使用することができます。お客様ご自身でステッカーを使用する場合（Messages API経由でお客様に送信するWhatsAppメッセージなど）、まずWhatsAppビジネスアカウントでステッカーパックを使用できるように設定する必要があります。

プロビジョニングは Vonage WhatsApp プロビジョニングAPI.

まだWhatsAppデプロイメントを行っていない場合、まずWhatsAppデプロイメントをプロビジョニングします。これは/whatsapp-manager/deploymentsエンドポイントにPOSTリクエストを送信することで実行できます。 API仕様:

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

WhatsAppのプロビジョニングに関する詳細は以下をご参照ください。 このドキュメント.

WhatsApp デプロイメントをプロビジョニングするとデプロイメント ID が発行され、WhatsApp Business Account で使用するカスタムステッカーパックのプロビジョニングなど、デプロイメントの様々な管理に使用できます。ステッカーパックのプロビジョニングには以下の API エンドポイントへの POST リクエストが必要です：

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

注意: パスの :deployment_id は WhatsApp デプロイメントのデプロイメント ID に置き換えられます。

リクエスト・ボディは次のようになる：

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

成功したレスポンスには、配備されたステッカーパックのIDが含まれる。

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

このエンドポイントへのリクエストに関する詳細は API仕様.

ステッカーの送信（Messages APIを使用）

ステッカーパックが完成すると、WhatsAppチャットでステッカーを使用できます。そのためには、送信するステッカーのIDが必要です。ステッカーIDを取得するにはいくつかの手順が必要です：

1. ステッカー・インデックス.これは GETを含むエンドポイントへのリクエストによって行われます。 deployment_idと stickerpack_idを含むエンドポイントへのリクエストによって行われます。 このAPI仕様.レスポンスは indexプロパティを持つオブジェクトを返す。

2. ステッカーのIDを取得する.これには別の GET別のエンドポイントへのリクエストが必要です。 deployment_idと stickerpack_idと sticker_indexを一緒に指定する必要がある。このリクエストはステッカーオブジェクトの配列を返します。 idプロパティを持つステッカーオブジェクトの配列を返します。このエンドポイントの詳細は このAPI仕様.

ステッカー idステッカーが手に入ったら、WhatsAppメッセージで送信できます。 Vonage メッセージAPI.

ステッカーを送るには、次のエンドポイントへのPOSTリクエストが必要です：https://api.nexmo.com/v1/messages.

リクエストボディのJSONペイロードは以下のようになる：

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

が設定されていることに注意。 channelが whatsappと message_typeに設定されていることと、カスタム・オブジェクトに typeの stickerを持つカスタム・オブジェクトと、先に取得したステッカーIDを含むステッカー・オブジェクトに注目してほしい。

Messages APIの使用方法、WhatsAppメッセージの送信方法に関する詳細は下記をご参照下さい：

• Messages API 仕様

• WhatsAppメッセージングについて

• カスタムオブジェクト