获取 CRM 事件组列表

您可以使用本接口获取广告账户中的 CRM （客户关系管理）事件组列表。支持使用 CRM 事件组的 ID 或名称为筛选条件。

重要提示
使用事件 API 接口代表您同意遵守TikTok 商业产品（数据）条款，并且不会与 TikTok 分享敏感数据。

使用前需知

确保您的广告账户下已创建 CRM 事件组。若您尚未创建 CRM 事件组，但想要使用此功能，请联系您的 TikTok 销售代表。

请求

地址 https://business-api.tiktok.com/open_api/v1.3/crm/list/

方法 GET

Header

|字段{30%}|类型{15%}|描述{55%}|
|---|---|---|
|Access-Token {必填}|string|授权访问令牌。可以通过[获取访问令牌](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)接口获取。|

参数

|字段{30%}|类型{15%}|描述{55%}|
|---|---|---|
| advertiser_id {必填} | string | 广告主ID。 |
| name | string | 用于筛选结果的 CRM 事件组名称。<br><br>长度限制：1-40 字符。 <br><br> 仅支持精确匹配。<ul><li>若未传入本字段，将返回广告账户中的所有 CRM 事件组。</li><li>若您传入的名称没有匹配结果，返回结果将为空。</li></ul> |
| event_set_ids| string[] | 用于筛选结果的 CRM 事件组 ID 列表。<br><br>最大数量：50。 <br><br>仅支持精确匹配。 <br><br><ul><li>若未传入本字段，将返回广告账户中的所有 CRM 事件组。</li><li>仅返回与您在该字段指定的 ID 匹配的 CRM 事件组，无匹配结果的 ID 将不会返回对应的 CRM 事件组。</li><li>若您同时传入`event_set_ids`和`name`，则将在匹配到使用所指定的名称，且该事件组的 ID 在指定的 CRM 事件组 ID 列表中时，获取一条结果，或未匹配到 CRM 事件组时，获取0条结果。</li></ul><br><p><span style="color:darkred"><b>注意</b></span>：单个广告账户中允许的 CRM 事件组最大数量为 50。 |

示例

(code curl http)
curl --location --request GET "https://business-api.tiktok.com/open_api/v1.3/crm/list/?advertiser_id={{advertiser_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| 返回数据。 |
#| crm_event_sets| object[] | 广告账户中匹配到的 CRM 事件组列表。 |
##| event_set_id | string | CRM 事件组 ID。 |
##| name | string | CRM 事件组名称。 |
##| create_time | string | 该 CRM 事件组的创建时间，以[ISO 8601](https://zh.wikipedia.org/wiki/ISO_8601)格式表示。 <br><br>示例：`”2023-04-15T00:23:38Z”`。 |

示例

(code Success-Response http)
HTTPS/1.1 200 OK
{
    "code": 0,
    "message": "OK",
    "request_id": "{{request_id}}",
    "data": {
        "crm_event_sets": [
            {
                "event_set_id": "{{event_set_id}}",
                "name": "{{name}}",
                "create_time": "2023-10-06T08:42:36Z"
            },
            {
                "event_set_id": "{{event_set_id}}",
                "name": "{{name}}",
                "create_time": "2023-12-07T14:45:07Z"
            }
        ]
    }
}
(/code)