提交小程序页面路径
收藏接口说明
开发者通过接口向平台提交小程序 sitemap 文件，即小程序页面路径，标记哪些页面内容支持被抖音搜索索引。
基本信息
| 名称 | 描述 |
|---|---|
| HTTP URL | https://open.douyin.com/api/apps/v1/search/upload_sitemap/ |
| HTTP Method | POST |
| Scope | ma.search |
请求参数
请求头
access-token必填String
示例：clt.943da17996fb5cebfbc70c044c3fc25a57T54DcjT6HNKGqnUdxzy1KcxFnZ
content-type必填String
示例：application/json
固定值"application/json"
Body展开全部子属性
app_id必填String
示例：tt5daf2b12c285xxxx
小程序id
page_paths必填List
示例：["pages/index/1?t=1","pages/index/2?t=2","pages/index/3?t=3"]
页面路径列表。单路径长度需要小于200；总数需要小于10万；请求体需要小于5MB。路径中如果包含非英文、数字等ascii码格式的，请进行urlencode编码并替换后，再进行提交，不然会判定格式有误不予收录。详细信息参考url标准的path和query定义。
展开子属性
请求示例
curl --location 'https://open.douyin.com/api/apps/v1/search/upload_sitemap/' \ --header 'access-token: clt.78743ab256619da1fde8efabfb7c50da1jJz6mjqx0xwukNHcIdhIKWaAbOU_lq' \ --header 'Content-Type: application/json' \ --data '{ "app_id": "tt5daf2b12c285xxxx", "page_paths": [ "pages/index/1?t=1", "pages/index/2?t=2", "pages/index/3?t=3" ] }'
响应参数
Body
err_msg必填String
示例：success
错误信息
err_no必填Int32
示例：0
错误码
log_id必填String
示例：20240515223931DF96BE0F06804B27F36D
日志ID，用于向内部开发人员进行反馈
响应示例
正常响应示例异常响应示例
{ "err_no": 0, "err_msg": "success", "log_id": "20240515223931DF96BE0F06804B27F36D" }
错误码
| HTTP 状态码 | 错误码 | 错误码描述 | 排查建议 |
|---|---|---|---|
| 200 | 28001003 | access-token无效 | 重新获取access-token；或检查请求头拼写"access-token" |
| 200 | 28005007 | 参数校验异常；日提交数超过上限，当前上限为：XXX； | 检查入参非空字段是否正确填写； 超限提示：日提交数超 过上限，当前上限为：XXX，详细信息于小程序控制台Web化管理页面看。 |
| 200 | 29003003 | 系统异常 | 重试 |
| 200 | 28001007 | 参数类型校验异常 | 根据err_msg返回内容修改 |
