获取用于广告创建的消息事件集列表

您可以使用本接口获取可用于创建 TikTok 即时通讯广告的消息事件集列表。

使用前需知

您需确保您的广告账户已有消息事件集。若您的广告账户无消息事件集，需在事件管理平台创建消息事件集。

请求

地址 https://business-api.tiktok.com/open_api/v1.3/ctm/message_event_set/get/

方法 GET

Header

|字段{30%}|类型{15%}|描述{55%}|
|---|---|---|
|Access-Token {必填}|string|授权访问令牌。可以通过[获取访问令牌](1738373164380162.html)接口获取。|

参数

|字段{30%}|类型{15%}|描述{55%}|
|---|---|---|
| advertiser_id {必填} | string | 广告主 ID。 |
| messaging_app_type {必填} | string | 即时通讯应用类型。 <br><br>枚举值： <ul><li>`MESSENGER`：Messenger。</li><li>`WHATSAPP`：WhatsApp。</li><li>`ZALO`：Zalo。</li></ul>|
| messaging_app_account_id {必填} | string | 即时通讯应用账号 ID。 <br><br><ul><li>若 `messaging_app_type` 为 `MESSENGER`，需指定 Facebook 公共主页编号。合法的 Facebook 公共主页编号只包含数字。 <ul><li>若要查找您的 Facebook 公共主页编号，请前往您的 Facebook 公共主页，点击封面照片下方的<b>简介</b>（About），然后点击<b>公共主页信息公示</b>（Page transparency）。</li></ul></li><li>若 `messaging_app_type` 为 `WHATSAPP`，需按以下格式指定 WhatsApp 电话号码：电话号码的区号 + 电话号码，且去除特殊符号。例如，若区号为 +1 且电话号码为 (555) 555-1234，需将本字段设置为 `15555551234`。</li><li>若 `messaging_app_type` 为 `ZALO`，需指定 Zalo 官方账号 ID。</li></ul>|
| message_event_name | string | 用于筛选结果的消息事件集名称。 <br><br>仅支持精确搜索。 |
| message_event_set_ids | string[] | 用于筛选结果的消息事件集 ID 列表。  <br><br>最大数量：10。 |

示例

(code curl http)
curl --location --request GET 'https://business-api.tiktok.com/open_api/v1.3/ctm/message_event_set/get/?advertiser_id={{advertiser_id}}&messaging_app_type=WHATSAPP&messaging_app_account_id={{essaging_app_account_id}}' \
--header 'Access-Token: {{Access-Token}}'
(/code)

|字段{30%}|类型{15%}|描述{55%}|
|---|---|---|
|code |number| 返回码。完整返回码列表及描述，参见 [附录 - 返回码](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097)。|
|message |string| 返回信息。更多信息参见 [附录 - 返回码](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097)。 |
|request_id |string| 请求的日志ID，唯一标识一个请求。 |
|data |object| 返回数据。 |
#| message_event_set_list | object[] | 该广告账户中已绑定的消息事件集列表。 |
##| message_event_set_id | string | 消息事件集 ID。 |
##| message_event_name | string | 消息事件集名称。 |
##| create_time | string | 消息事件集的创建时间，格式为`YYYY-MM-DD HH:MM:SS`。 <br><br> 示例：`2024-01-01 00:00:01`。 |
#| matched_event_set | object | 与即时通讯应用账号（`messaging_app_account_id`）绑定的唯一消息事件集的有有关信息。
##| message_event_set_id | string | 消息事件集 ID。 |
##| message_event_name | string | 消息事件集名称。 |
##| create_time | string | 消息事件集的创建时间，格式为`YYYY-MM-DD HH:MM:SS`。<br><br>示例：`2024-01-01 00:00:01`。 |

示例

(code Success-Response http)
HTTPS/1.1 200 OK
{
    "code": 0,
    "message": "OK",
    "request_id": "{{request_id}}",
    "data": {
        "message_event_set_list": [
            {
                "message_event_set_id": "{{message_event_set_id}}",
                "create_time": "2024-04-18 14:25:28",
                "message_event_name": "{{message_event_name}}"
            },
            {
                "message_event_set_id": "{{message_event_set_id}}",
                "create_time": "2024-10-25 09:42:04",
                "message_event_name": "{{message_event_name}}"
            }
        ],
        "matched_event_set": {
            "message_event_set_id": "{{message_event_set_id}}",
            "create_time": "2024-10-25 09:42:04",
            "message_event_name": "{{message_event_name}}"
        }
    }
}
(/code)