概述

网易云信官网API适用于业务服务器调用，为满足业务服务器的终端用户上传视频以及点播加密等需求，云信提供了移动端终端用户的管理API，方便企业管理其终端用户使用云信的服务。

功能逻辑

以移动端上传为例：移动端上传适用于 andriod 端和 ios 端上传视频内容的场景，其使用方式是终端直接上传视频，上传完成后回调业务服务器，由业务服务器通知终端上传成功。

交互过程如图：

• 终端用户登录，注册终端信息至用户业务服务器；
• 用户业务服务器注册终端用户信息至网易云信API服务器；
• 业务服务器返回accid和token给终端用户;
• 终端用户使用accid和token调用API上传文件等。

API

以下API的调用方式和请求头参数均和官网一致。

创建终端用户

接口描述

域名：vcloud.163.com

接口名：/app/vod/thirdpart/user/create

用于业务服务器向网易云信注册其终端用户信息。

输入参数

参数	类型	必须	说明
accid	String	是	网易云信视频用户创建的其子用户id，最大长度32字符，必须保证唯一
name	String	否	网易云信视频用户创建的其子用户名称，最大长度256字符
type	int	是	网易云信视频用户创建其子用户的方式，1表示由网易云信视频生成token， 2表示由网易云信视频用户传入token
props	String	否	json属性，第三方可选填，最大长度256字符
token	String	否	网易云信视频用户可以指定其子用户登录token值，最大长度128字符， 并更新，如果未指定，会自动生成token， 并在创建成功后返回，如果type = 2,则必填

输出参数

参数	类型	说明
code	Int	响应码
accid	String	网易云信视频用户创建的其子用户id
name	String	网易云信视频用户创建的其子用户名称
token	String	网易云信视频用户子用户的token
props	String	json属性，第三方可选填，最大长度256字符
msg	String	错误信息

响应状态码

HTTP状态码	含义
200	操作成功
400	请求报文格式错误，报文构造不正确或者没有完整发送
700	服务器内部出现错误，请稍后重试或者将完整错误信息发送给客服人员帮忙解决
710	权限认证失败，请参考文档中的接口鉴权部分
720	访问失败，余额不足。
721	服务未开通，请前往开通页面申请服务开通
722	服务开通审核中，请联系客服人员开通服务
723	请求的次数超过了配额限制

示例代码

输入1

curl -X POST -H "Content-Type: application/json;charset=utf-8" -H "AppKey: 027338bf****9d6af80b3" -H "Nonce: 1" -H "CurTime: 1465723418" -H "CheckSum: 61bbfd88c5102****e65a2abe7ae13" -d '{"accid":"227","name":"网易云信视频","type":1,"props":"test"}' https://vcloud.163.com/app/vod/thirdpart/user/create

输出1

"Content-Type": "application/json; charset=utf-8"
{
  "ret": {      
    "accid":"227",
    "name":"网易云信视频",
    "token": "ioapfhoa****juopa",
    "props":"test",     
  },
  "code": 200
}

更新终端用户

接口描述

域名：vcloud.163.com

接口名：/app/vod/thirdpart/user/update

用于业务服务器向网易云信更新其终端用户信息。

输入参数

参数	类型	必须	说明
accid	String	是	网易云信视频用户其子用户id，最大长度32字符，必须保证唯一
name	String	否	网易云信视频用户其子用户名称
props	String	否	json属性，第三方可选填，最大长度256字符
token	String	否	网易云信视频用户可以指定其子用户登录token值，最大长度128字符

输出参数

参数	类型	说明
code	Int	响应码
accid	String	网易云信视频用户创建的其子用户id
name	String	网易云信视频用户创建的其子用户名称，最大长度256字
token	String	网易云信视频用户子用户的token
props	String	json属性，第三方可选填，最大长度256字符
isUsed	Int	该子用户是否被禁用，0表示未被禁用，1表示被禁用
msg	String	错误信息

响应状态码

HTTP状态码	含义
200	操作成功
400	请求报文格式错误，报文构造不正确或者没有完整发送
700	服务器内部出现错误，请稍后重试或者将完整错误信息发送给客服人员帮忙解决
710	权限认证失败，请参考文档中的接口鉴权部分
720	访问失败，余额不足。
721	服务未开通，请前往开通页面申请服务开通
722	服务开通审核中，请联系客服人员开通服务
723	请求的次数超过了配额限制

示例代码

输入1

curl -X POST -H "Content-Type: application/json;charset=utf-8" -H "AppKey: 027338bf****9d6af80b3" -H "Nonce: 1" -H "CurTime: 1465723418" -H "CheckSum: 61bbfd88c5102****e65a2abe7ae13" -d '{"accid":227, "name":"娱乐"}' https://vcloud.163.com/app/vod/thirdpart/user/update

输出1

"Content-Type": "application/json; charset=utf-8"
{
  "ret": {
    "token": "ioapfho*****afijuopa",
    "accid":"227",
    "name":"娱乐",
    "props":"test", 
    "isUsed":1,    
  },
  "code": 200
}

删除终端用户

接口描述

域名：vcloud.163.com

接口名：/app/vod/thirdpart/user/userDelete

用于业务服务器向网易云信删除其终端用户信息。

输入参数

参数	类型	必须	说明
accid	String	是	网易云信视频用户其子用户id，最大长度32字符，必须保证唯一

输出参数

参数	类型	说明
code	Int	响应码
msg	String	错误信息

响应状态码

HTTP状态码	含义
200	操作成功
400	请求报文格式错误，报文构造不正确或者没有完整发送
700	服务器内部出现错误，请稍后重试或者将完整错误信息发送给客服人员帮忙解决
710	权限认证失败，请参考文档中的接口鉴权部分
720	访问失败，余额不足。
721	服务未开通，请前往开通页面申请服务开通
722	服务开通审核中，请联系客服人员开通服务
723	请求的次数超过了配额限制

示例代码

输入1

curl -X POST -H "Content-Type: application/json;charset=utf-8" -H "AppKey: 027338bf****9d6af80b3" -H "Nonce: 1" -H "CurTime: 1465723418" -H "CheckSum: 61bbfd88c5102****e65a2abe7ae13" -d '{"accid":227}' https://vcloud.163.com/app/vod/thirdpart/user/userDelete

输出1

"Content-Type": "application/json; charset=utf-8"
{
  "ret": {},
  "code": 200
}

屏蔽终端用户

接口描述

域名：vcloud.163.com

接口名：/app/vod/thirdpart/user/userDisable

用于业务服务器向网易云信屏蔽其终端用户信息。

输入参数

参数	类型	必须	说明
accid	String	是	网易云信视频用户其子用户id，最大长度32字符，必须保证唯一

输出参数

参数	类型	说明
code	Int	响应码
msg	String	错误信息

响应状态码

HTTP状态码	含义
200	操作成功
400	请求报文格式错误，报文构造不正确或者没有完整发送
700	服务器内部出现错误，请稍后重试或者将完整错误信息发送给客服人员帮忙解决
710	权限认证失败，请参考文档中的接口鉴权部分
720	访问失败，余额不足。
721	服务未开通，请前往开通页面申请服务开通
722	服务开通审核中，请联系客服人员开通服务
723	请求的次数超过了配额限制

示例代码

输入1

curl -X POST -H "Content-Type: application/json;charset=utf-8" -H "AppKey: 027338bf****9d6af80b3" -H "Nonce: 1" -H "CurTime: 1465723418" -H "CheckSum: 61bbfd88c5102****e65a2abe7ae13" -d '{"accid":227}' https://vcloud.163.com/app/vod/thirdpart/user/userDisable

输出1

"Content-Type": "application/json; charset=utf-8"
{
  "ret": {},
  "code": 200
}

恢复终端用户

接口描述

域名：vcloud.163.com

接口名：/app/vod/thirdpart/user/userRecover

用于业务服务器向网易云信恢复其终端用户信息。

输入参数

参数	类型	必须	说明
accid	String	是	网易云信视频用户其子用户id，最大长度32字符，必须保证唯一

输出参数

参数	类型	说明
code	Int	响应码
msg	String	错误信息

响应状态码

HTTP状态码	含义
200	操作成功
400	请求报文格式错误，报文构造不正确或者没有完整发送
700	服务器内部出现错误，请稍后重试或者将完整错误信息发送给客服人员帮忙解决
710	权限认证失败，请参考文档中的接口鉴权部分
720	访问失败，余额不足。
721	服务未开通，请前往开通页面申请服务开通
722	服务开通审核中，请联系客服人员开通服务
723	请求的次数超过了配额限制

示例代码

输入1

curl -X POST -H "Content-Type: application/json;charset=utf-8" -H "AppKey: 027338bf****9d6af80b3" -H "Nonce: 1" -H "CurTime: 1465723418" -H "CheckSum: 61bbfd88c5102****e65a2abe7ae13" -d '{"accid":227}' https://vcloud.163.com/app/vod/thirdpart/user/userRecover

输出1

"Content-Type": "application/json; charset=utf-8"
{
  "ret": {},
  "code": 200
}

**目前网易云信支持使用 Accid 和 Token 和 AppKey 值作为 API 的请求头，替代 Nonce、CheckSum、CurTime、AppKey。