WhatsApp BusinessプラットフォームオンプレミスAPI

スタンプパックの管理

/v1/stickerpacks

stickerpacksノードは、ファーストパーティとサードパーティの両方のスタンプパックおよびスタンプを管理するために使用します。

このドキュメントでは、以下について説明します。

ファーストパーティスタンプパック

ファーストパーティスタンプパックの取得

リクエスト

GET /v1/stickerpacks?namespace=whatsapp

応答

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

ファーストパーティスタンプパックの情報の取得

リクエスト

GET /v1/stickerpacks/sticker-pack-id?namespace=whatsapp

応答

{
  "stickerpacks": [
    {
      "publisher" : "sticker-pack-publisher-name",
      "name": "sticker-pack-name"
    }
  ]
}

ファーストパーティスタンプ

ファーストパーティスタンプの取得

リクエスト

GET /v1/stickerpacks/sticker-pack-id/stickers?namespace=whatsapp

応答

{
  "stickers": [
    {"index": "sticker-index1"},
    {"index": "sticker-index2"}
  ]
}

ファーストパーティスタンプの情報の取得

リクエスト

GET /v1/stickerpacks/sticker-pack-id/stickers/sticker-index?namespace=whatsapp

応答

{
  "stickers": [
    {
      "id": "sticker-media-id" # ex: b942a4d1-4e1d-4c56-8cfa-a848b8222061
      "emojis": ["🐥", "😃"],
    }
  ]
}

サードパーティスタンプパック

サードパーティスタンプパックの作成

リクエスト

POST /v1/stickerpacks
{
  "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",
}

パラメーター

名前必須かどうか説明

publisher

必須

サードパーティスタンプパックのパブリッシャーの名前

name

必須

スタンプパックの名前

ios_app_store_link

任意

Apple iOS App Storeのスタンプパックへのリンク
リンクの形式はhttps://itunes.apple.com/app/idXXXXXXXXX
App Storeのリンクの取得については、https://stackoverflow.com/questions/4137426/get-itunes-link-for-app-before-submittingにある手順を参照

android_app_store_link

任意

Google Playストアのスタンプパックへのリンク
リンクの形式はhttps://play.google.com/store/apps/details?id=com.example (com.exampleはアプリのパッケージ名)

応答

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

サードパーティスタンプパックの取得

リクエスト

GET /v1/stickerpacks

応答

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

サードパーティスタンプパックの情報の取得

リクエスト

GET /v1/stickerpacks/your-sticker-pack-id

応答

{
  "stickerpacks": [
    {
      "publisher" : "sticker-pack-publisher-name",
      "name": "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",
    }
  ]
}

サードパーティスタンプパックの更新

リクエスト

PATCH /v1/stickerpacks/your-sticker-pack-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",
}

パラメーター

名前必須かどうか説明

publisher

任意

サードパーティスタンプパックのパブリッシャーの名前

name

任意

スタンプパックの名前

ios_app_store_link

任意

Apple iOS App Storeのスタンプパックへのリンク
リンクの形式はhttps://itunes.apple.com/app/idXXXXXXXXX
App Storeのリンクの取得については、https://stackoverflow.com/questions/4137426/get-itunes-link-for-app-before-submittingにある手順を参照

android_app_store_link

任意

Google Playストアのスタンプパックへのリンク
リンクの形式はhttps://play.google.com/store/apps/details?id=com.example (com.exampleはアプリのパッケージ名)

応答

成功すると、応答に200 OKと、nullまたは{}のいずれかが示されます。

null or {}

サードパーティスタンプパックの削除

リクエスト

DELETE /v1/stickerpacks/your-sticker-pack-id

応答

成功すると、応答に200 OKと、nullまたは{}のいずれかが示されます。

null or {}

サードパーティスタンプ

サードパーティスタンプの作成

リクエスト

POST /v1/stickerpacks/your-sticker-pack-id/stickers
{
  "image_data_id" : "your-sticker-image-media-id",
  "emojis": ["🐥", "😃"]
}

パラメーター

名前必須かどうか説明

image_data_id

必須

スタンプメディアのID

emojis

任意

スタンプパックに含まれる絵文字の配列

応答

{
  "stickers": [{
    "index": "sticker-index"
  }]
}

サードパーティスタンプの取得

リクエスト

GET /v1/stickerpacks/your-sticker-pack-id/stickers

応答

{
  "stickers": [
    {"index": "sticker-index1"},
    {"index": "sticker-index2"}
  ]
}

サードパーティスタンプの情報の取得

リクエスト

GET /v1/stickerpacks/your-sticker-pack-id/stickers/your-sticker-index

応答

{
  "stickers": [
    {
      "id": "sticker-media-id" # ex: b942a4d1-4e1d-4c56-8cfa-a848b8222061
      "emojis": ["🐥", "😃"],
      "image_data_id" : "sticker-image-media-id",
    }
  ]
}

サードパーティスタンプの更新

リクエスト

PATCH /v1/stickerpacks/your-sticker-pack-id/stickers/your-sticker-index
{
  "image_data_id" : "your-sticker-image-media-id",
  "emojis": ["🐥", "😃"],
}

パラメーター

名前必須かどうか説明

image_data_id

任意

スタンプメディアのID

emojis

任意

スタンプパックに含まれる絵文字の配列

応答

成功すると、応答に200 OKと、nullまたは{}のいずれかが示されます。

null or {}

サードパーティスタンプの削除

リクエスト

DELETE /v1/stickerpacks/your-sticker-pack-id/stickers/your-sticker-index

応答

成功すると、応答に200 OKと、nullまたは{}のいずれかが示されます。

null or {}