TOOL API

ctm_message_event_set_get

Retrieves message event sets in an ad account that can be used to create TikTok Instant Messaging Ads. Before using this endpoint, make sure the ad account already has message event sets; if not, create them in TikTok Events Manager. The endpoint can also filter by messaging app account and returns the event set associated with the specified `messaging_app_account_id` when applicable. For Instant Messaging Ads usage details, see https://business-api.tiktok.com/portal/docs?id=1774482999036930.

ecommerceOAuth1 credits

Call information

Tool slug: tiktok-ads.ctm_message_event_set_get
Provider: TikTok for Business
Average response: 0 ms
Calls in 7 days: 0

Input parameters

advertiser_idrequired

Advertiser ID.

message_event_name

Filter results by message event set name. Exact match only.

message_event_set_ids

Filter results by message event set IDs. Maximum 10 IDs.

messaging_app_account_idrequired

ID of the instant messaging app account. Its required value depends on `messaging_app_type`: if `messaging_app_type` is `MESSENGER`, provide a Facebook Page ID containing numbers only; if `WHATSAPP`, provide the WhatsApp phone number as region calling code plus phone number with no special symbols (for example, `15555551234`); if `ZALO`, provide the Zalo Official Account ID.

messaging_app_typerequired

Type of instant messaging app. Valid values: `MESSENGER` for Messenger, `WHATSAPP` for WhatsApp, and `ZALO` for Zalo. This field determines the required format and source of `messaging_app_account_id`.