添加白名单 | API文档

# 添加白名单

# 接口说明

项	值
URL	`/openapi/v1/live/whiteList/add.json`
描述	添加白名单
请求方式	POST
需要登录	是
注意事项	无
其他	无

# 请求参数说明

字段名	字段类型	说明	是否必传
skuId	string	商品id	是
whiteList	array	白名单对象列表	是
bizNum	string	子商户number。多商户模式下可指定查询具体子商户下的数据	否

# 白名单对象

字段名	字段类型	说明	是否必传
mobile	string	手机号	否。与unionId和openId不能同时为空
unionId	string	微信unionId	否。与mobile和openId不能同时为空
openId	string	微信openId	否。与mobile和unionId不能同时为空
name	string	客户昵称	否
avatar	string	客户头像地址	否
bizNum	string	子商户number。多商户模式下可指定查询具体子商户下的数据	否

# 请求数据

{
    "skuId": "10293776126212",
    "whiteList":[
      {
        "mobile": "18812341234",
        "unionId": "",
        "openId": "",
        "name": "xxx",
        "avatar": "http://xxxx"
      },
      {
        "mobile": "",
        "unionId": "xxxxx",
        "openId": "",
        "name": "xxx",
        "avatar": "http://xxxx"
      },
      {
        "mobile": "",
        "unionId": "",
        "openId": "xxx",
        "name": "xxx",
        "avatar": "http://xxxx"
      }
    ]
}

# 返回数据

{
    "code" : 200,
    "msg" : "",
    "data" : null
}

# 删除白名单

# 接口说明

项	值
URL	`/openapi/v1/live/whiteList/delete.json`
描述	删除白名单
请求方式	POST
需要登录	是
注意事项	无
其他	无

# 请求参数说明

字段名	字段类型	说明	是否必传
skuId	string	商品id	是
whiteList	array	白名单对象列表	是

# 白名单对象

字段名	字段类型	说明	是否必传
mobile	string	手机号	否。与unionId和openId不能同时为空
unionId	string	微信unionId	否。与mobile和openId不能同时为空
openId	string	微信openId	否。与mobile和unionId不能同时为空
name	string	客户昵称	否
avatar	string	客户头像地址	否

# 请求数据

{
    "skuId": "10293776126212",
    "whiteList":[
      {
        "mobile": "18812341234",
        "unionId": "",
        "openId": "",
        "name": "xxx",
        "avatar": "http://xxxx"
      },
      {
        "mobile": "",
        "unionId": "xxxxx",
        "openId": "",
        "name": "xxx",
        "avatar": "http://xxxx"
      },
      {
        "mobile": "",
        "unionId": "",
        "openId": "xxx",
        "name": "xxx",
        "avatar": "http://xxxx"
      }
    ]
}

# 返回数据

{
    "code" : 200,
    "msg" : "",
    "data" : null
}

# 通过roomId添加白名单

# 接口说明

项	值
URL	`/openapi/v1/live/whiteList/addByRoomId.json`
描述	通过roomId添加白名单
请求方式	POST
需要登录	是
注意事项	无
其他	无

# 请求参数说明

字段名	字段类型	说明	是否必传
roomIds	array	直播间id列表	是
whiteList	array	白名单对象列表	是
bizNum	string	子商户number。多商户模式下可指定查询具体子商户下的数据	否

# 白名单对象

字段名	字段类型	说明	是否必传
mobile	string	手机号	否。与unionId和openId不能同时为空
unionId	string	微信unionId	否。与mobile和openId不能同时为空
openId	string	微信openId	否。与mobile和unionId不能同时为空
name	string	客户昵称	否
avatar	string	客户头像地址	否
bizNum	string	子商户number。多商户模式下可指定查询具体子商户下的数据	否

# 请求数据

{
    "roomIds": ["25072294098021"],
    "whiteList":[
      {
        "mobile": "18812341234",
        "unionId": "",
        "openId": "",
        "name": "xxx",
        "avatar": "http://xxxx"
      },
      {
        "mobile": "",
        "unionId": "xxxxx",
        "openId": "",
        "name": "xxx",
        "avatar": "http://xxxx"
      },
      {
        "mobile": "",
        "unionId": "",
        "openId": "xxx",
        "name": "xxx",
        "avatar": "http://xxxx"
      }
    ]
}

# 返回数据

{
    "code" : 200,
    "msg" : "",
    "data" : null
}

# 通过roomId删除白名单

# 接口说明

项	值
URL	`/openapi/v1/live/whiteList/deleteByRoomId.json`
描述	通过roomId删除白名单
请求方式	POST
需要登录	是
注意事项	无
其他	无

# 请求参数说明

字段名	字段类型	说明	是否必传
roomIds	array	直播间id列表	是
whiteList	array	白名单对象列表	是

# 白名单对象

字段名	字段类型	说明	是否必传
mobile	string	手机号	否。与unionId和openId不能同时为空
unionId	string	微信unionId	否。与mobile和openId不能同时为空
openId	string	微信openId	否。与mobile和unionId不能同时为空
name	string	客户昵称	否
avatar	string	客户头像地址	否

# 请求数据

{
    "roomIds": ["25072294098021"],
    "whiteList":[
      {
        "mobile": "18812341234",
        "unionId": "",
        "openId": "",
        "name": "xxx",
        "avatar": "http://xxxx"
      },
      {
        "mobile": "",
        "unionId": "xxxxx",
        "openId": "",
        "name": "xxx",
        "avatar": "http://xxxx"
      },
      {
        "mobile": "",
        "unionId": "",
        "openId": "xxx",
        "name": "xxx",
        "avatar": "http://xxxx"
      }
    ]
}

# 返回数据

{
    "code" : 200,
    "msg" : "",
    "data" : null
}

# 添加全局白名单

# 接口说明

项	值
URL	`/openapi/v1/live/whiteList/addGlobal.json`
描述	添加全局白名单
请求方式	POST
需要登录	是
注意事项	无
其他	无

# 请求参数说明

字段名	字段类型	说明	是否必传
whiteList	array	白名单对象列表	是

# 白名单对象

字段名	字段类型	说明	是否必传
mobile	string	手机号	否。与unionId和openId不能同时为空
unionId	string	微信unionId	否。与mobile和openId不能同时为空
openId	string	微信openId	否。与mobile和unionId不能同时为空

# 请求数据

{
    "whiteList":[
      {
        "mobile": "18812341234",
        "unionId": "",
        "openId": ""
      },
      {
        "mobile": "",
        "unionId": "xxxxx",
        "openId": ""
      },
      {
        "mobile": "",
        "unionId": "",
        "openId": "xxx"
      }
    ]
}

# 返回数据

{
    "code" : 200,
    "msg" : "",
    "data" : null
}

# 删除全局白名单

# 接口说明

项	值
URL	`/openapi/v1/live/whiteList/deleteGlobal.json`
描述	删除全局白名单
请求方式	POST
需要登录	是
注意事项	无
其他	无

# 请求参数说明

字段名	字段类型	说明	是否必传
whiteList	array	白名单对象列表	是

# 白名单对象

字段名	字段类型	说明	是否必传
mobile	string	手机号	否。与unionId和openId不能同时为空
unionId	string	微信unionId	否。与mobile和openId不能同时为空
openId	string	微信openId	否。与mobile和unionId不能同时为空

# 请求数据

{
    "whiteList":[
      {
        "mobile": "18812341234",
        "unionId": "",
        "openId": ""
      },
      {
        "mobile": "",
        "unionId": "xxxxx",
        "openId": ""
      },
      {
        "mobile": "",
        "unionId": "",
        "openId": "xxx"
      }
    ]
}

# 返回数据

{
    "code" : 200,
    "msg" : "",
    "data" : null
}

# 全局白名单检测

# 接口说明

项	值
URL	`/openapi/v1/live/whiteList/checkInGlobal.json`
描述	全局白名单检测
请求方式	POST
需要登录	是
注意事项	无
其他	无

# 请求参数说明

字段名	字段类型	说明	是否必传
roomId	string	直播间ID	否
mobile	string	手机号	否。与unionId和openId不能同时为空
unionId	string	微信unionId	否。与mobile和openId不能同时为空
openId	string	微信openId	否。与mobile和unionId不能同时为空

# 请求数据

{
    "mobile": "18812341234",
    "unionId": "xxxxx",
    "openId": "xxx",
    "roomId": "xxxxxx"
}

# 返回数据

{
    "code" : 200,
    "msg" : "",
    "data" : {
        false | true
    }
}

← 商品直播预约 →