注册 登录

用户工具

您在这里: 接入建议 » 1.IM服务端API介绍及接入
im_服务端开发文档

差别

这里会显示出您选择的修订版和当前版本之间的差别。

到此差别页面的链接

两侧同时换到之前的修订记录 前一修订版
后一修订版 		前一修订版
后一修订版 两侧同时换到之后的修订记录
im_服务端开发文档 [2016/05/26 07:42]
tangbing [1.2服务端SDK下载] 		im_服务端开发文档 [2016/06/07 09:40]
liuxia
行 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接入方式=====
 ---- ----
行 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 |成功执行|
行 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次 |

页面工具