Appearance
签到开关设置
| 拥有此API的权限集 |
|---|
| 直播管理-增删改 |
请求方式及url
请求方式:
POST请求头:
Content-Type:application/json接口地址:
https://api.xiaoe-tech.com/xe.alive.signin.set_conf/1.0.0频率限制:
10秒50次
接口调试
请求参数
响应结果
暂无响应数据
请求参数
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| access_token | 是 | string | 专属token |
| alive_id | 是 | string | 直播ID |
| is_sign_in_on | 是 | int | 签到开关:0-关闭, 1-开启 |
| sign_in_type | 否 | int | 签到类型:1=普通签到,2=强制签到 |
| sign_style_type | 否 | int | 签到样式: 0=默认样式,1=自定义样式 |
| sign_style_id | 否 | int | 签到样式id,默认传0,已设置过自定义样式可传该接口返回的style_id |
| sign_style_title | 否 | string | 签到标题,仅当sign_style_type=1时该参数才有效 |
| sign_style_desc | 否 | string | 签到说明,仅当sign_style_type=1时该参数才有效 |
| sign_style_txt | 否 | string | 签到按钮文字,仅当sign_style_type=1时该参数才有效 |
| sign_style_tips | 否 | string | 签到完成提示,仅当sign_style_type=1时该参数才有效 |
请求示例
json
{
"access_token": "xe_xxxxx",
"alive_id": "l_69a7dabfe4b0694c5b91ec76",
"sign_in_type": 1,
"is_sign_in_on": 1,
"sign_style_type": 1,
"sign_style_id": 0,
"sign_style_title": "签到标题",
"sign_style_desc": "签到说明",
"sign_style_txt": "签到按钮文字",
"sign_style_tips": "签到完成提示"
}返回参数
| 参数名 | 必选 | 类型 | 说明 | 备注 |
|---|---|---|---|---|
| code | 是 | int | 返回码 | 0-成功,其他值-失败 |
| msg | 是 | string | 返回信息 | code=0时为成功信息;code≠0时返回错误信息 |
| data | 是 | json对象 | 核心返回数据 | - |
| data.style_id | 是 | int | 签到样式id | 只有设置了自定义样式,才会返回大于0的style_id |
备注
code=0时,表示接口调用成功
返回示例
json
{
"code": 0,
"msg": "已开启直播间签到功能",
"data": {
"style_id": 26896
}
}