在广告账户中创建欢迎消息

您可以使用本接口在广告账户中创建欢迎消息。

欢迎消息将保存在广告账户的消息库中，可在 TikTok 私信广告中使用。

请求

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

方法 POST

Header

|字段{30%}|类型{15%}|描述{55%}|
|---|---|---|
|Access-Token {必填}|string|授权访问令牌。<br>可以通过[获取访问令牌](1738373164380162.html)接口获取。|
|Content-Type {必填}|string|请求信息类型。<br>允许格式：`application/json`。|

参数

|字段{30%}|类型{15%}|描述{55%}|
|---|---|---|
| advertiser_id {必填} | string | 广告主 ID。 |
| auto_message_type {必填} | string | 当用户与您开启对话时，问候他们的自动消息类型。<br><br>枚举值：<ul><li>`WELCOME_MESSAGE`: 欢迎消息。 欢迎消息是在用户点击您的广告后自动发送的消息，用于欢迎用户加入对话。</li></ul>|
| welcome_message {+条件必填} | object | `auto_message_type` 为 `WELCOME_MESSAGE` 时必填。<br><br> 有关欢迎消息的信息。 |
#| title {+条件必填} | string | 传入 `welcome_message` 时必填。<br><br>欢迎消息的名称<br> 您可以指定一个唯一的名称，以区分广告账户的消息库中不同的欢迎消息。 |
#| content {+条件必填} | string | 传入 `welcome_message` 时必填。<br><br> 欢迎消息中的欢迎语。<br><br> 长度限制：200 个字符。<br><br>示例： `Hi, thanks for contacting us. How can we help you?` |
#| suggested_questions {+条件必填} | object[] | 传入 `welcome_message` 时必填。 <br><br> 供客户点击的推荐问题列表。 <br>推荐问题是在聊天开始时显示的常见问题。用户选择推荐问题后，将自动收到相应的预设回答。<br><br> 数量范围：1-3。 |
##| question {+条件必填} | string | 传入 `welcome_message` 时必填。<br><br> 帮助用户开启对话的常见问题。 <br><br> 长度限制：70 个字符。 |
##| answer {+条件必填} | string | 传入 `welcome_message` 时必填。 <br><br>用户选择此问题后将自动收到的预设回答。 <br><br>长度限制：500 个字符。 |

示例

(code curl http)
curl --location --request POST 'https://business-api.tiktok.com/open_api/v1.3/creative/auto_message/create/' \
--header 'Access-Token: {{Access-Token}}' \
--header 'Content-Type: application/json' \
--data '{
    "advertiser_id":"{{advertiser_id}}",
    "auto_message_type":"WELCOME_MESSAGE", 
    "welcome_message": {
        "title": "{{title}}",
        "content": "{{content}}",
        "suggested_questions": [
            {
                "question": "{{question}}",
                "answer": "{{answer}}"

            },
            {
                "question": "{{question}}",
                "answer": "{{answer}}"

            },
            {
                "question": "{{question}}",
                "answer": "{{answer}}"
            }
        ]             
    }
}'
(/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| 返回数据。 |
#| auto_message_id | string | 自动消息 ID。 |

示例

(code Success-Response http)
HTTPS/1.1 200 OK
{
    "code": 0,
    "message": "OK",
    "request_id": "{{request_id}}",
    "data": {
        "auto_message_id": "{{auto_message_id}}"
    }
}
(/code)