模拟webhook事件
收藏我的收藏
接口说明
用于模拟 Webhook 事件发送。
目前支持的事件类型:
- 1.create_video
- 2.authorize
- 3.receive_msg
- 4.enter_im
- 5.dial_phone
- 6.dial_phone
- 7.website_contact
- 8.personal_tab_contact
- 9.verify_webhook
使用限制
不需要用户授权。
申请路径:抖音开放平台控制台->能力管理->抖音业务能力->开放平台->Webhook OpenAPI 管理能力
基本信息
名称 | 描述 |
HTTP URL | |
HTTP Method | POST |
Scope | aweme.webhook |
权限要求 | •需要申请权限 ◦移动网站应用:抖音开放平台控制台->能力管理->抖音业务能力->开放平台->Webhook OpenAPI 管理能力 •不需要用户授权 |
请求头
参数名称 | 类型 | 参数描述 | 参数示例 | 是否必填 |
Content-Type | string | 固定值:application/json | application/json | 是 |
access-token | string | clt.943da17996fb5cebfbc70c044c3fc25a57T54DcjT6HNKGqnUdxzy1KcxFnZ | 是 |
请求参数
Body
参数名称 | 参数类型 | 参数描述 | 参数示例 | 是否必填 |
event_type | string | 需要mock的事件类型, 开放平台会通过webhook发送一条mock数据给你 | create_video | true |
请求示例
curl --location --request GET 'https://open.douyin.com/sandbox/webhook/event/send/' \ --header 'access-token: clt.943da17996fb5cebfbc70c044c3fc25a57T54DcjT6HNKGqnUdxzy1KcxFnZ' \ --header 'Content-Type: application/json' \ --data '{ "event_type": "create_video" }'
响应参数
参数名称 | 参数类型 | 参数描述 | 参数示例 |
extra | struct | | |
now | i64 | 毫秒级时间戳 | 1597213176393 |
error_code | i32 | 错误码 | 0 |
description | string | 错误码描述 | |
sub_error_code | i32 | 子错误码 | 0 |
sub_description | string | 子错误码描述 | |
logid | string | 标识请求的唯一id | 202008121419360101980821035705926A |
响应示例
正常示例
{ "extra": { "logid": "202008121419360101980821035705926A", "now": 1597213176393, "error_code": 0, "description": "", "sub_error_code": 0, "sub_description": "" } }
异常示例
{ "data": { "error_code": 2100005, "description": "Parameter error" }, "extra": { "error_code": 2100005, "description": "Parameter error", "sub_error_code": 0, "sub_description": "", "now": 1594015876138, "log_id": "2020070614111601022506808001045D59" } }
错误码
HTTP 状态码 | 错误码 | 描述 | 排查建议 |
200 | 2100004 | "系统繁忙,此时请开发者稍后再试" | 检查参数或重试 |
200 | 2190004 | “无权访问” | 申请该应用权限 |
200 | 2190005 | "ticket已过期" | ticket有效时间7200s,在获取ticket前必须生成ticket |
200 | 16388 | “签名不正确” | 确认获取的ticket与校验的ticket是否一致 |