这里会显示出您选择的修订版和当前版本之间的差别。
两侧同时换到之前的修订记录 前一修订版 后一修订版 | 前一修订版 | ||
im_服务端开发文档 [2016/05/26 07:42] tangbing [1.2服务端SDK下载] |
im_服务端开发文档 [2017/08/23 08:44] (当前版本) |
||
---|---|---|---|
行 1: | 行 1: | ||
- | ======IM服务端API介绍及接入====== | + | ======1.IM服务端API介绍及接入====== |
---- | ---- | ||
=====1.1简介===== | =====1.1简介===== | ||
行 5: | 行 5: | ||
Rest是一套新兴的web通讯协议,访问方式和普通的http类似,平台接口分get和post方式请求。协议支持xml,json两种请求方式,采用md5加密算法的方式,通过url参数的形式发送参数。\\ | Rest是一套新兴的web通讯协议,访问方式和普通的http类似,平台接口分get和post方式请求。协议支持xml,json两种请求方式,采用md5加密算法的方式,通过url参数的形式发送参数。\\ | ||
=====1.2IM AS 开发实例===== | =====1.2IM AS 开发实例===== | ||
- | 为了方便开发者的服务端对接云之讯平台,我们提供了 Server SDK:\\ | + | 为了方便开发者的服务端对接云之讯平台,我们提供了 Server 开发实例:\\ |
- | [[https://www.ucpaas.com/UCSIMDOWNLOAD/AS/ASSDK_JAVA.zip|AS SDK(java版)]]\\ | + | [[https://www.ucpaas.com/UCSIMDOWNLOAD/AS/ASSDK_JAVA.zip|AS 开发实例(java版)]]\\ |
- | [[https://www.ucpaas.com/UCSIMDOWNLOAD/AS/ASSDK_PHP.zip|AS SDK(php版)]] | + | [[https://www.ucpaas.com/UCSIMDOWNLOAD/AS/ASSDK_PHP.zip|AS 开发实例(php版)]] |
=====1.3接入方式===== | =====1.3接入方式===== | ||
---- | ---- | ||
行 101: | 行 101: | ||
^属性 ^类型 ^约束 ^说明 | | ^属性 ^类型 ^约束 ^说明 | | ||
|appId |String |必选 |开发者创建的应用ID,UCpaas平台生成,固定32位长度| | |appId |String |必选 |开发者创建的应用ID,UCpaas平台生成,固定32位长度| | ||
- | |userId |String |必选 |开发者应用下注册用户的ID,数字、字母(区分大小写)组成,最长32位,应用下唯一。| | + | |userId |String |必选 |开发者应用下注册用户的ID,数字、字母(区分大小写)组成,最长31位,应用下唯一。| |
- | |friendlyName |String |可选 |开发者应用下注册用户对应的昵称,数字、字母(区分大小写)、下划线组成,最长50位| | + | |friendlyName |String |可选 |开发者应用下注册用户对应的昵称,数字、字母(区分大小写)、下划线组成,最长31位| |
|mobile |String |可选 |绑定的手机号码,同一个应用内唯一。| | |mobile |String |可选 |绑定的手机号码,同一个应用内唯一。| | ||
行 149: | 行 149: | ||
|loginToken|String |必选 |UCPaas平台用户令牌| | |loginToken|String |必选 |UCPaas平台用户令牌| | ||
|createDate|String |必选 |创建日期,格式yyyy-mm-dd hh:mm:ss| | |createDate|String |必选 |创建日期,格式yyyy-mm-dd hh:mm:ss| | ||
- | |userId |String |必选 |开发者应用下注册用户的ID,数字、字母(区分大小写)组成,最长32位,应用下唯一| | + | |userId |String |必选 |开发者应用下注册用户的ID,数字、字母(区分大小写)组成,最长31位,应用下唯一| |
**XML响应示例:** | **XML响应示例:** | ||
行 203: | 行 203: | ||
^属性 ^类型 ^约束 ^说明 | | ^属性 ^类型 ^约束 ^说明 | | ||
|appId |String |必选 |开发者创建的应用ID,UCpaas平台生成,固定32位长度| | |appId |String |必选 |开发者创建的应用ID,UCpaas平台生成,固定32位长度| | ||
- | |userId |String |必选 |开发者应用下注册用户的ID,数字、字母(区分大小写)组成,最长32位,应用下唯一| | + | |userId |String |必选 |开发者应用下注册用户的ID,数字、字母(区分大小写)组成,最长31位,应用下唯一| |
**XML请求示例:** | **XML请求示例:** | ||
行 303: | 行 303: | ||
|respCode |String |必选 |响应状态码,定长6位,取值000000(成功),具体状态码见状态码说明| | |respCode |String |必选 |响应状态码,定长6位,取值000000(成功),具体状态码见状态码说明| | ||
|client |String |必选 |client列表,节点的名称| | |client |String |必选 |client列表,节点的名称| | ||
- | |friendlyName |String |必选 |开发者应用下用户在UCPaas平台注册的昵称,数字、字母(区分大小写)、下划线组成,最长50位| | + | |friendlyName |String |必选 |开发者应用下用户在UCPaas平台注册的昵称,数字、字母(区分大小写)、下划线组成,最长31位| |
|mobile |String |可选 |用户帐号绑定的手机号| | |mobile |String |可选 |用户帐号绑定的手机号| | ||
|clientNumber |String |必选 |UCPaas平台生成的唯一用户id,定长14位数字| | |clientNumber |String |必选 |UCPaas平台生成的唯一用户id,定长14位数字| | ||
行 309: | 行 309: | ||
|createDate |String |必选 |创建日期,格式yyyy-mm-dd hh:mm:ss| | |createDate |String |必选 |创建日期,格式yyyy-mm-dd hh:mm:ss| | ||
|loginToken|String |必选 |UCPaas平台用户令牌| | |loginToken|String |必选 |UCPaas平台用户令牌| | ||
- | |userId |String |必选 |开发者应用下注册用户的ID,数字、字母(区分大小写)组成,最长32位,应用下唯一| | + | |userId |String |必选 |开发者应用下注册用户的ID,数字、字母(区分大小写)组成,最长31位,应用下唯一| |
**XML响应示例:** | **XML响应示例:** | ||
行 367: | 行 367: | ||
^属性 ^类型 ^约束 ^说明 | | ^属性 ^类型 ^约束 ^说明 | | ||
|appId |String |必选 |开发者创建的应用ID,UCpaas平台生成,固定32位长度| | |appId |String |必选 |开发者创建的应用ID,UCpaas平台生成,固定32位长度| | ||
- | |userId |String |必选 |开发者应用下注册用户的ID,数字、字母(区分大小写)组成,最长32位,应用下唯一| | + | |userId |String |必选 |开发者应用下注册用户的ID,数字、字母(区分大小写)组成,最长31位,应用下唯一| |
**XML请求示例:** | **XML请求示例:** | ||
行 391: | 行 391: | ||
|respCode |String |必选 |响应状态码,定长6位,取值000000(成功),具体状态码见状态码说明| | |respCode |String |必选 |响应状态码,定长6位,取值000000(成功),具体状态码见状态码说明| | ||
|client |String |必选 |client列表,节点的名称| | |client |String |必选 |client列表,节点的名称| | ||
- | |friendlyName |String |必选 |开发者应用下用户在UCPaas平台注册的昵称,数字、字母(区分大小写)、下划线注册,最长50位| | + | |friendlyName |String |必选 |开发者应用下用户在UCPaas平台注册的昵称,数字、字母(区分大小写)、下划线注册,最长31位| |
|mobile |String |可选 |用户帐号绑定的手机号| | |mobile |String |可选 |用户帐号绑定的手机号| | ||
|clientNumber |String |必选 |UCPaas平台生成的唯一用户id,定长14位数字| | |clientNumber |String |必选 |UCPaas平台生成的唯一用户id,定长14位数字| | ||
行 397: | 行 397: | ||
|createDate |String |必选 |创建日期,格式yyyy-mm-dd hh:mm:ss| | |createDate |String |必选 |创建日期,格式yyyy-mm-dd hh:mm:ss| | ||
|loginToken|String |必选 |UCPaas平台用户令牌| | |loginToken|String |必选 |UCPaas平台用户令牌| | ||
- | |userId |String |必选 |开发者应用下注册用户的ID,数字、字母(区分大小写)组成,最长32位| | + | |userId |String |必选 |开发者应用下注册用户的ID,数字、字母(区分大小写)组成,最长31位| |
**XML响应示例:** | **XML响应示例:** | ||
行 503: | 行 503: | ||
|memberCount|String |必选 |群组中成员个数| | |memberCount|String |必选 |群组中成员个数| | ||
|groupName|String |可选 |群组名称| | |groupName|String |可选 |群组名称| | ||
- | |userId|String |可选 |开发者应用下注册用户的ID,只能数字,最长50位| | + | |userId|String |可选 |开发者应用下注册用户的ID,只能数字,最长31位| |
行 631: | 行 631: | ||
|appId |String |必选 |开发者创建的应用ID,UCpaas平台生成,固定32位长度| | |appId |String |必选 |开发者创建的应用ID,UCpaas平台生成,固定32位长度| | ||
|groupId |String |必选 |群组ID| | |groupId |String |必选 |群组ID| | ||
- | |userId |String |必选 |多个用户userId字符串列表,用英文逗号隔开,一次最多加50个用户,userId最长不超过32| | + | |userId |String |必选 |多个用户userId字符串列表,用英文逗号隔开,一次最多加50个用户,userId最长不超过31| |
**XML请求示例:** | **XML请求示例:** | ||
行 946: | 行 946: | ||
|respCode |String |必选 |响应状态码,定长6位,取值000000(成功),具体状态码见状态码说明| | |respCode |String |必选 |响应状态码,定长6位,取值000000(成功),具体状态码见状态码说明| | ||
|memberCount|String |必选 |群组中成员个数| | |memberCount|String |必选 |群组中成员个数| | ||
- | |userId|String |可选 |开发者应用下注册用户的ID,只能数字,最长50位| | + | |userId|String |可选 |开发者应用下注册用户的ID,只能数字,最长31位| |
行 980: | 行 980: | ||
</code> | </code> | ||
- | ======4.服务端接口全局返回码====== | + | ======4.消息管理====== |
+ | ---- | ||
+ | 消息管理主要用于开发者对IM消息各种管理操作,主要包括:广播消息。 | ||
+ | |||
+ | ===== 4.1广播消息 ===== | ||
+ | 通过HTTPS POST方式提交请求,云之讯融合通讯开放平台收到请求后,发送广播消息并返回。\\ | ||
+ | |||
+ | **请求** | ||
+ | <code java> | ||
+ | /{SoftVersion}/Accounts/{accountSid}/im/broadcast/text | ||
+ | </code> | ||
+ | |||
+ | **请求包头** | ||
+ | |||
+ | 详情请查阅统一请求包头,并使用开发者账号进行验证。 | ||
+ | |||
+ | **请求包体** | ||
+ | |||
+ | ^属性 ^类型 ^约束 ^说明 | | ||
+ | |appId |String |必选 |开发者创建的应用ID,UCpaas平台生成,固定32位长度| | ||
+ | |content |String|必选 |消息内容| | ||
+ | |||
+ | **XML请求示例:** | ||
+ | <code xml> | ||
+ | POST/2015-06-30/Accounts/e03bc9106c6ed0eaebfce8c368fdcd48/im/broadcast/text?sig=3C861C9CFA64862A79B906D80EDB79BA | ||
+ | Host: api.ucpaas.com | ||
+ | Accept:application/xml | ||
+ | Content-Type:application/xml;charset=utf-8 | ||
+ | Authorization:ZTAzYmM5MTA2YzZlZDBlYWViZmNlOGMzNjhmZGNkNDg6MjAxNDA2MjMxNzE2MzI= | ||
+ | |||
+ | <?xml version="1.0" encoding="UTF-8" standalone="yes"?> | ||
+ | <imBroadcast> | ||
+ | <appId>e462aba25bc6498fa5ada7eefe1401b7</appId> | ||
+ | <content>消息内容11</content> | ||
+ | </imBroadcast> | ||
+ | </code> | ||
+ | **JSON请求示例:** | ||
+ | <code java> | ||
+ | POST/2015-06-30/Accounts/e03bc9106c6ed0eaebfce8c368fdcd48/im/broadcast/text?sig=027282406B5E0E66F4EFE2A86B7A60F7 | ||
+ | Host: api.ucpaas.com | ||
+ | Accept:application/json | ||
+ | Content-Type:application/json;charset=utf-8 | ||
+ | Authorization:ZTAzYmM5MTA2YzZlZDBlYWViZmNlOGMzNjhmZGNkNDg6MjAxNDA2MjMxNzMwMzg= | ||
+ | |||
+ | { | ||
+ | "imBroadcast" : { | ||
+ | "appId" : "e462aba25bc6498fa5ada7eefe1401b7", | ||
+ | "content" : "消息内容11" | ||
+ | } | ||
+ | } | ||
+ | </code> | ||
+ | **响应** | ||
+ | |||
+ | **响应包体** | ||
+ | ^属性 ^类型 ^约束 ^说明 | | ||
+ | |respCode |String |必选 |响应状态码,定长6位,取值000000(成功),具体状态码见状态码说明| | ||
+ | |||
+ | |||
+ | **XML响应示例:** | ||
+ | <code xml> | ||
+ | HTTP/1.1 200 OK | ||
+ | Content-Type: application/xml; charset=utf-8 | ||
+ | |||
+ | <?xml version="1.0" encoding="UTF-8" standalone="yes"?> | ||
+ | <resp> | ||
+ | <respCode>000000</respCode> | ||
+ | </resp> | ||
+ | </code> | ||
+ | |||
+ | **JSON响应示例:** | ||
+ | <code java> | ||
+ | HTTP/1.1 200 OK | ||
+ | Content-Type: application/json; charset=utf-8 | ||
+ | |||
+ | { | ||
+ | "resp": { | ||
+ | "respCode": "000000" | ||
+ | } | ||
+ | } | ||
+ | </code> | ||
+ | |||
+ | ======5.服务端接口全局返回码====== | ||
---- | ---- | ||
在调用服务端的REST接口API时,云之讯平台服务端会返回成功或失败的返回码,对每个返回码对应相应的原因说明。 | 在调用服务端的REST接口API时,云之讯平台服务端会返回成功或失败的返回码,对每个返回码对应相应的原因说明。 | ||
- | =====4.1帐号管理接口返回码===== | + | =====5.1帐号管理接口返回码===== |
^返回码 ^说明 | | ^返回码 ^说明 | | ||
|000000 |成功执行| | |000000 |成功执行| | ||
行 1048: | 行 1129: | ||
|103133 |userId不存在| | |103133 |userId不存在| | ||
|103134 |userId不合法,含非法字符 | | |103134 |userId不合法,含非法字符 | | ||
- | |103135 |userId超长,超过50个字符 | | + | |103135 |userId超长,超过31个字符 | |
|103136 |userId已处于关闭状态 | | |103136 |userId已处于关闭状态 | | ||
|103137 |调用中间件创建子账号失败 | | |103137 |调用中间件创建子账号失败 | | ||
行 1057: | 行 1138: | ||
|100500 |HTTP状态码不等于200 | | |100500 |HTTP状态码不等于200 | | ||
- | =====4.2群组管理接口返回码===== | + | =====5.2群组管理接口返回码===== |
^返回码 ^说明 | | ^返回码 ^说明 | | ||
|106000 |userId为空 | | |106000 |userId为空 | | ||
行 1089: | 行 1170: | ||
|106028 |群组批量加入成员失败(包括部分失败) | | |106028 |群组批量加入成员失败(包括部分失败) | | ||
+ | =====5.3消息管理接口返回码===== | ||
+ | ^返回码 ^说明 | | ||
+ | |106029 |消息对象不能为空 | | ||
+ | |106030 |消息内容不能为空 | | ||
+ | |106031 |消息内容长度限制500个字符 | | ||
+ | |106032 |发送次数限制:1小时内最多只能发送1次,24小时内最多只能发送3次 | |