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

是

贴图多媒体素材编号

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

否

贴图多媒体素材编号

emojis

否

贴图包中的一组表情符号

响应

成功的响应会显示 200 OK，以及 null 或 {}。

null or {}

删除第三方贴图

请求

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

响应

成功的响应会显示 200 OK，以及 null 或 {}。

null or {}