获取广告账户中的欢迎消息

您可以使用本接口获取广告账户消息库中的欢迎消息列表。

请求

地址 https://business-api.tiktok.com/open_api/v1.3/creative/auto_message/get/

方法 GET

Header

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

参数

|字段{30%}|类型{15%}|描述{55%}|
|---|---|---|
| advertiser_id {必填} | string | 广告主 ID。 |
| auto_message_type {必填} | string | 当用户与您开启对话时，问候他们的自动消息类型。<br><br>枚举值：<ul><li>`WELCOME_MESSAGE`: 欢迎消息。 欢迎消息是在用户点击您的广告后自动发送的消息，用于欢迎用户加入对话。</li></ul>|
| auto_message_id | string | 自动消息的 ID。 <br><br>当 `auto_message_type` 为 `WELCOME_MESSAGE` 时，您可以通过此字段指定欢迎消息的 ID 以筛选结果。<br><br>若未传入本字段，则将返回所指定的自动消息类型的所有消息。 |
| page | number | 当前页数。 <br><br> 取值范围：≥ 1。<br> 默认值：1。 |
| page_size| number | 每页大小。<br><br>取值范围：1-100。<br>默认值：10。 |

示例

(code curl http)
curl --location --request GET 'https://business-api.tiktok.com/open_api/v1.3/creative/auto_message/get/?advertiser_id={{advertiser_id}}&auto_message_type=WELCOME_MESSAGE&page=1&page_size=100' \
--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| 返回数据。 |
#| list | object[] | 广告账户中的欢迎消息列表。 |
##| auto_message_id | string | 自动消息的 ID。 |
##| auto_message_type | string | 当用户与您开启对话时，问候他们的自动消息类型。<br><br>枚举值：<ul><li>`WELCOME_MESSAGE`: 欢迎消息。 欢迎消息是在用户点击您的广告后自动发送的消息，用于欢迎用户加入对话。</li></ul>|
##| welcome_message | string | 有关欢迎消息的信息。 |
###| title | string | 欢迎消息的名称。 您可以使用名称区分广告账户的消息库中不同的欢迎消息。 |
###| content | string | 欢迎消息中的欢迎语。<br><br>示例：`Hi, thanks for contacting us. How can we help you?` |
###| suggested_questions | object[] | 供客户点击的推荐问题列表。<br>推荐问题是在聊天开始时显示的常见问题。用户选择推荐问题后，将自动收到相应的预设回答。 |
####| question | string | 帮助用户开启对话的常见问题。 |
####| answer | string | 用户选择此问题后将自动收到的预设回答。 |
##| audit_status | string | 自动消息的审核状态。<br><br>枚举值：<ul><li>`AUDITING`: 自动消息正在等待审核。 </li><li>`PASS`: 自动消息已通过审核。</li><li> `REJECTED`: 自动消息已被拒审。</li></ul>|
##| create_time | string | 自动消息创建时间，格式为 `YYYY-MM-DD HH:MM:SS`（UTC+0）。<br><br> 示例：`2025-01-01 00:00:01`。 |
#| page_info | object | 分页信息。 <br><br><p><span style="color:darkred"><b>注意</b></span>：若请求中指定了 `auto_message_id`，则不会返回 `page_info`。 |
##| page | number | 当前页数。 |
##| page_size | number | 分页大小。 |
##| total_number | number | 总结果数。 |
##| total_page | number | 总页数。 |

示例

(code Success-Response http)
HTTPS/1.1 200 OK
{
    "code": 0,
    "message": "OK",
    "request_id": "{{request_id}}",
    "data": {
        "auto_message_list": [
            {
                "audit_status": "PASS",
                "auto_message_id": "{{auto_message_id}}",
                "auto_message_type": "WELCOME_MESSAGE",
                "create_time": "{{create_time}}",
                "welcome_message": {
                    "content": "{{content}}",
                    "suggested_questions": [
                        {
                            "answer": "{{answer}}",
                            "question": "{{question}}"
                        },
                        {
                            "answer": "{{answer}}",
                            "question": "{{question}}"
                        },
                        {
                            "answer": "{{answer}}",
                            "question": "{{question}}"
                        }
                    ],
                    "title": "{{title}}"
                }
            }
        ]
    }
}
(/code)