转发平台白名单校验

1. 接口描述

接口使用场景 客户某场直播除需要在全时直播外, 还需要在其它直播平台转播, 只有通过白名单校验的用户才可以观看

接口名称:

/eventopenapi/event/platform/forward/whitelist/check

发送方式:

POST

参数格式:

accept: application/json;content-type: application/json

2. 输入参数

参数 类型 必须 说明
token String 统一鉴权token
eventId Long 直播会议ID
email String 邮箱
phone Object 电话信息

phone 参数说明

参数 类型 必须 说明
countryCode String 国家码
areaCode String 区号
number String 电话号码

3. 输出参数

参数 类型 说明
timeStamp Long 返回时间(时间戳,单位毫秒)
requestId String 请求ID(在接口异常时, 需提供请求ID)
code Int 返回的状态码
msg String 当返回结果的状态码不为200时,包含的错误信息
data Json 返回数据

3. data参数说明

参数 类型 说明
result boolean 校验结果, true: 校验通过, false: 校验不通过

4. 示例

输入示例

{
    "token":"5d41c4ac806c",
    "eventId": 581274,
    "phone": {
        "countryCode": "86",
        "areaCode": "",
        "number": "18100000001"
    }
}

输出示例

{
    "timeStamp": 1660807364357,
    "code": 200,
    "msg": "Successfully to check the whitelist!",
    "data": {
        "result": true
    },
    "requestId": "10.255.0.106_20220818_152241_1660807361972"
}