生成access_token
API 地址
api.yun.vhall.com/api/v1/base/create-access-token
描述
用于SDK权限校验,access_token 即权限,调用接口生成access_token 将传入SDK,SDK在请求时会附带access_token , SDK将按您赋予的权限进行相关的权限验证,如果您同时集成多个服务,可在入参时传入相应服务的权限值
名词解释
第三方用户ID(third_party_user_id)是什么?
第三方用户ID(third_party_user_id)是开发者自有用户系统里用户的唯一标识,如果开发者无自有用户系统,则随机生成一个唯一标识字符串即可。例如:md5(时间戳+随机数) 第三方用户ID(third_party_user_id)在微吼云提供sdk事件中可能会包含此id,通过这种形式,开发者可以将此用户和自有系统中的用户对应起来。类似的,在数据接口,服务器回调,也有类似应用。 约束条件:第三方用户ID(third_party_user_id)长度不能超过100个字符,字符范围不限制,任意字符都可以支持。但推荐使用数组和字母组合。
入参
关于公共请求参数详细内容,请参考 公共请求参数。
参数 | 类型 | 是否必选 | 含义 |
---|---|---|---|
third_party_user_id | string | 是 | 第三方用户ID是开发者自有用户系统里用户的唯一标识,详见参考第三方用户ID(third_party_user_id)是什么? |
expire_time | string | 否 | 过期时间 默认为一天,最大为1天,最小为1秒 格式为: 2017/01/01 00:00:00 |
publish_stream | string | 否 | 在使用直播推流SDK获取access_token时必须传入此参数,参数对应的值为直播房间ID(room_id) (通过直播API下创建直播房间接口获得) |
chat | string | 否 | 在使用聊天SDK获取access_token时必须传入此参数,参数对应的值为聊天频道ID(channel_id)(通过消息API下创建频道接口获得) |
operate_document | string | 否 | 在使用文档演示SDK获取access_token时必须传入此参数,参数对应的为值聊天频道ID(channel_id) (通过消息API下创建频道接口获得) |
kick_inav | string | 否 | 在使用互动SDK 踢出互动房间/取消踢出互动房间 时需要传入此参数,参数值对应的为互动房间ID(ivav_id) |
publish_inav_stream | string | 否 | 在使用互动SDK 推流 时需要传入此参数,参数值对应的为互动房间ID(ivav_id) |
kick_inav_stream | string | 否 | 在使用互动SDK 踢出某一路流 时传入此参数,参数值对应的为互动房间ID(ivav_id) |
askfor_inav_publish | string | 否 | 在使用互动SDK 邀请推流/取消邀请推流 时传入此参数,参数值对应的为互动房间ID(ivav_id) |
audit_inav_publish | string | 否 | 在使用互动SDK 审核申请上麦 时传入此参数,参数值对应的为互动房间ID(ivav_id) |
publish_inav_another | string | 否 | 在使用互动SDK 推旁路直播/结束推旁路直播 时传入此参数,参数值对应的为互动房间ID(ivav_id) |
apply_inav_publish | string | 否 | 在使用互动SDK 申请上麦 时传入此参数,参数值对应的为互动房间ID(ivav_id) |
data_collect_manage | string | 否 | 在使用数据收集服务SDK 允许管理问卷 时传入此参数,参数值目前只支持传入all |
data_collect_submit | string | 否 | 在使用数据收集服务SDK 允许提交问卷答卷 时传入此参数,参数值目前只支持传入all |
data_collect_view | string | 否 | 在使用数据收集服务SDK 允许浏览问卷信息 时传入此参数,参数值目前只支持传入all |
参数示例
{
third_party_user_id : "vhall_user_nelsonking", // 第三方用户ID
expire_time : 2017/01/01 00:00:00, // 过期时间
publish_stream : "lss_af793b0e,lss_b328234c", // 推流: “房间ID”
chat : "ch_af793b0e,ch_cb593b12",// 发聊天: “频道ID”
operate_document : "ch_2ca93b03,ch_eb493b22",// 演示文档操作: “频道ID”
}
// 各权限对应的值为其权限类别的资源ID
// 权限列表可有多个,无先后顺序
// 多个资源ID,请使用英文逗号分割
出参
参数 | 类型 | 是否必选 | 含义 |
---|---|---|---|
access_token | string | 是 | token 令牌 |
错误码
错误码 | 类型 | 含义 |
---|---|---|
10012 | int | 第三方用户ID不能为空 |
40004 | int | 时间类型不正确 |
40003 | int | 没有该权限类型 资源ID |
30005 | int | 不是这些房间拥有者 房间ID |
30006 | int | 不是这些频道拥有者 |
响应格式
{
"code": 200,
"msg": "",
"data": {
"access_token": ""
}
}