小程序直播挂载黑白名单管理能力
收藏
该接口提供直播场景下挂载小程序的黑白名单管理能力，开发者可以决定哪些用户直播时可以挂载他们的小程序(白名单)，哪些用户直播时不可以挂载他们的小程序(黑名单)。
使用限制
- 只有开通了直播通用挂载能力的小程序才能设置黑白名单。
- 当前只有增删能力，暂无查询能力，开发者需要自己维护黑白名单数据。
接口说明
- 小程序设置了白名单后，只有白名单内的用户才能够挂载小程序，其他用户均不可挂载。
- 小程序设置了黑名单后，黑名单内的用户不可以挂载小程序，其他用户均可以进行挂载。
- 如果小程序黑白名单都没有设置，那么默认所有用户都可以进行挂载小程序。
- 如果小程序同时设置了黑白名单，以白名单为准，只有白名单内的用户才可以挂载小程序。
请求地址
POST https://developer.toutiao.com/api/apps/v1/live/set_black_white_list
请求头
参数 | 类型 | 是否必填 | 描述 |
|---|---|---|---|
| string | 是 | 固定值 "application/json" |
| string | 是 | 授权验证, 详见: 验证授权 示例: "0801************************************************3d3d" |
请求参数
名称 | 类型 | 是否必填 | 描述 |
|---|---|---|---|
| string | 是 | 小程序的appID |
| string | 是 | 用户抖音号 |
| int | 是 | 操作类型
|
请求示例
curl --location --request POST 'https://developer.toutiao.com/api/apps/v1/live/set_black_white_list' \ --header 'content-type: application/json' \ --header 'access-token: 080112184***************************************47673d3d' \ --data-raw '{ "app_id": "ttc19ab7275ea4a7****", "uniq_id": "douyinhao", "type": 1 }'
响应参数
名称 | 类型 | 是否必填 | 描述 | 示例值 |
|---|---|---|---|---|
| int | 是 | 0表示成功，非0时表示错误，错误码对应错误类型加下表。 | 0 |
| string | 是 | err_no非0时对应的错误信息文案提示，成功时为空字符串 | "" |
| string | 是 | 返回log_id, 方便排查问题时，问题定位 | 2020**************************926A |
| string | 否 | 成功时，返回"success" | "success" |
响应示例
正常示例
// 正常示例 { "data": "success", "err_no": 0, "err_msg": "", "log_id": "2020**************************926A" }
异常示例
// 异常示例，不返回data字段 { "err_no": -1, "err_msg": "system error", "log_id": "2020**************************926A }
错误码
当请求失败时，会返回非 0 的err_no，错误信息会携带在 err_msg 中，错误码含义如下：
错误号 | 描述 | 排查建议 |
|---|---|---|
-1 | 系统错误 | 重试即可 |
10001 | 传入 app_id 为空 | 请传入有效的appid |
10010 | 传入抖音号为空 | 请传入有效的抖音号 |
10011 | 传入access-token为空 | 请传入有效的access-token |
11016 | access-token 校验不通过 | 检查access-token是否已失效，检查access-token是否为对应app_id的token，检查app_id是否正确 |
11017 | 无效的uniq_id | 抖音号不正确，请传入有效的抖音号 |
11018 | 无效的操作行为类型 | 操作类型仅限1, 2, 3, 4, 请输入正确操作类型 |
11019 | 小程序未开通通用挂载能力 | 小程序未开通直播通用挂载能力，开通该能力后才可设置黑白名单 |
