查询授权主动私信用户
收藏接口说明
该接口用于查询授权服务账号主动私信的所有 C 端用户列表，会返回调用应用对应的 OpenID
使用限制
关于分页方式的说明
- 分页方式一
使用 page_num x page_size 参数进行分页，返回结果将根据授权更新时间，由近至远排序返回
page_num x page_size 最多能获取 5w 条数据
- 分页方式二
使用 cursor x limit 方式进行分页，返回结果将根据首次授权时间，由远至近排序返回
cursor x limit 无获取数据限制
基本信息
| 名称 | 描述 |
|---|---|
| HTTP URL | https://open.douyin.com/im/authorize/user_list/ |
| HTTP Method | POST |
| Scope | im.direct_message |
| 权限要求 | 需要申请权限 需要用户授权 |
请求参数
请求头
access-token必填String
示例：act.943da17996fb5cebfbc70c044c3fc25a57T54DcjT6HNKGqnUdxzy1KcxFnZ
content-type必填String
示例：application/json
固定值"application/json"
Query
open_id必填String
示例：ba253642-0590-40bc-9bdf-9a1334b94059
通过/oauth/access_token/获取，调用接口B 端用户的open_id
Body
cursorString
分页方式二必传
游标，初次查询传 0 即可，后续查询使用 resp 中的 next_cursor 参数
limitInt64
分页方式二必传
每次查询数量，不能大于 100
page_numInt64
示例：1
分页方式一必传
页码，page_size * page_num 需小于 50000
page_sizeInt64
示例：10
分页方式一必传
每页数量，不能大于 50
请求示例
curl -X POST 'https://open.douyin.com/im/authorize/user_list/?open_id=aa-aa-aa' -H 'Content-Type:application/json' \ --data '{ "page_size":10, "page_num":2 }' \
响应参数
Body展开全部子属性
err_msg必填String
err_no必填Int32
log_id必填String
dataStruct
展开子属性
响应示例
正常响应示例异常响应示例
{ "data": { "auth_user_list": [ { "auth_user_source_app_id": "ttfa3965001", "target_open_id": "_000FnVpk1_9MMOGOTvzFqPoQCxmyooIfgaC", "data_im_extra": "micro_app", "query": "cptName=button", "path": "page/componentTpl/componentTpl" }, { "target_open_id": "_000LMpVKP67ggHu4Y0OO5JwQKAqkC6j0_li", "auth_user_source_app_id": "ttfa3965001", "data_im_extra": "micro_app", "query": "cptName=button", "path": "page/componentTpl/componentTpl" }, { "auth_user_source_app_id": "ttfa3965001", "target_open_id": "_0002cdMxHCrp1JcWzRtI3GDb5J-Ins4JnCS", "data_im_extra": "micro_app", "query": "cptName=button", "path": "page/componentTpl/componentTpl" } ], "has_more": true }, "err_msg": "", "err_no": 0, "log_id": "02169835083298800000000000000000000ffff0a9c251a9d7709" }
切换单列布局错误码
| HTTP 状态码 | 错误码 | 错误码描述 | 排查建议 |
|---|---|---|---|
| 200 | 28001005 | 系统内部错误，请重试 | 请求重试，若依然无解请向平台提交反馈 |
| 200 | 28001003 | access_token无效 | 重新请求生成access_token |
| 200 | 28001008 | access_token过期,请刷新或重新授权 | 重新请求生成access_token |
| 200 | 28001016 | 当前应用已被封禁或下线 | clientKey被封禁或者下线 |
| 200 | 28001006 | 网络调用错误，请重试 | 重试即可 |
| 200 | 28001014 | 应用未授权任何能力 | 确认应用是否授权能力 |
| 200 | 28001018 | 应用未获得该能力 | 开通相关能力 |
| 200 | 28003017 | quota已用完 | 联系平台处理 |
| 200 | 28001019 | 应用该能力已被封禁 | 该能力被封禁，联系平台处理 |
| 200 | 28001007 | 参数不合法 | 根据错误信息检查请求参数是否填写正常 |
