CeMIAP EAS与AppServer编程接口参考手册.pdf

1 目录 1 接口整体说明 ........................................................................................................................... 1 1.1 输入格式 ....................................................................................................................... 1 1.2 输出格式 ....................................................................................................................... 1 1.3 术语及约定 ................................................................................................................... 2 2 EAServer 提供给业务服务器的接口 ....................................................................................... 2 2.1 Push 消息 ...................................................................................................................... 2 2.2 用户状态查询 ............................................................................................................... 4 3 业务服务器提供给 EAServer 的接口 ...................................................................................... 5 3.1 认证 ............................................................................................................................... 6 3.2 业务代理 ....................................................................................................................... 6 3.3 下载 ............................................................................................................................... 8 3.4 上传 ............................................................................................................................. 10 3.5 用户状态通知 ............................................................................................................. 11 4 JSSE 提供给业务服务器的接口 ............................................................................................. 13 4.1 Push 消息 .................................................................................................................... 13 1 修订记录 时间 修订人 修订内容 2012.8.6 wangfg 创建 V0.1 1 接口整体说明 所有接口均采用 HTTP/HTTPS 协议， URL 中 包括服务器 IP 和端口，格式为：http://IP:PORT/mobile 。

输入参数以 POST 方式提交，接口的输入 /输出采用 JSON 格式，编码格式为 UTF-8，基于流的接口（如上传、下载）的输出值格式将会在具体章节中详细的说明 1.1 输入格式 1. Post 方式，参数放在 HTTP Body 中 1.2 输出格式 本节对通用输出值格式做出具体描述 对于输出内容的数据类型，包括：  布尔型 (Boolean)：例如 isNew:true|false，没有 null 值  数字型 (Number)：例如 number:3.1415，没有 null 值  字符串型 (String)：例如 name:’张三 ’，没有 null 值， null 需要转化为 ’’(空串 ) 2  对象类型 (Object)： null 表示空对象， {…}表示非空对象【 只有 Object 有 null 值 】，对象的属性可以是 Boolean,Number,String,Object,Array.  数组类型 (Array)：则 []表示空数组没有 null 值， null 需要转换为 []，数组的元素可以是 Boolean,Number,String,Object,Array。

通用输出值的格式为 JSON 格式，具体如下 { success:true|false, //是否成功， boolean error:’’, //错误信息，如果 success=false，携带此信息， String errorCode:0, //错误代码，用于错误的分类， int data: //返回值， Object } 对于返回的结果，有以下几种情况： 1） success=true：成功，此时 error=null， errorCode=0，代表没有错误其中 data 为返回的数据对象 data 只可能是 Object 或 Array 类型 2） success=false：失败，进一步查看 errorCode 确定错误的分类以确定下一步操作对于每个接口来说， errorCode 的情况可能都不一样，具体说明见各个接口其中errorCode=2 是统一的，标识 session 失效，需要重新登录 1.3 术语及约定 日期格式： YYYY-MM-DD 时间格式： YYYY-MM-DD HH24:mi:SS 2 EAServer 提供给业务服务器的接口 本节详细描述了 EAServer 提供给业务服务器的接口说明。

EAServer 提 供给业务服务器的所有接口是一个地址，不同的接口通过 commandId 区分 接口的格式为 JSON 2.1 Push 消息 URL： http://ip:port/uc 3 输入： { commandId:’push’, //命令 ID，对于 Push 来时，固定为 push sequenceId:string //请求的序列号，可不填 (如果请求方是异步请求时有用 ) params:{ //push 请求的参数 appCode:string //应用代码 userList:string[] //接收通知的用户数组，元素为用户在该应用的登录账号 offlinePolicy:{ send:int //离线发送规则 //0:如果用户离线，消息丢弃 //1:如果用户离线， EAServer 保存离线在消息表， // 并通知用户，通知方式见下 inform:int //离线消息通知规则 //0:不通知 //1:转发到邮箱通知 //2:转发到短信通知 }, mode:int //消息类型 //1：提示框并确认后将应用拉起 //2：冒泡提示 //3：即时消息 //4：应用图标数字提示 //5：用户消息 format:int //消息内容格式。

//0:二进制格式，以 base64 编码； //1:文本格式 title:string //消息标题 content:string //消息内容 } } 4 输出： { success:true|false, //是否成功 sequenceId:int //请求时序列号，原样返回 error:’’, //错误信息，如果 success=false，需要携带此信息 errorCode:int //错误代码 data:无 } 说明： errorCode 错误码定义 101：其他错误 301: 用户不存在 401：应用不存在 402 : 应用代码错误 405: 应用账号不存在 406: 应用不可访问 407：用户无权访问应用 409：应用状态错误 701: 无效的消息 702: 不可识别的消息 703: 消息协议字段错误 2.2 用户状态查询 如果应用想查询一批用户的状态，可通过这个接口向 EAServer 发起请求，然后将结果本地保存备用 一般的使用方法：在业务服务器启动时，获取所有用户状态保存，然后接收 EAServer的用户状态通知。

保证本地的用户状态和 EAServer 的用户状态时同步的当然也可以损失一些性能，本地不保存，每次需要时再到 EAServer 查询） URL： http://ip:port/uc 输入： { 5 commandId:’userstate’, //命令 ID，对于状态查询来时，固定为 userstate sequenceId:string //请求的序列号，可不填 (如果请求方是异步请求时有用 ) params:{ //接口参数 appCode:string //应用代码 userList:string[] //查询的用户账号列表，数组 } } 输出： { success:true|false, //是否成功 sequenceId:int //请求时序列号，原样返回 error:’’, //错误信息，如果 success=false，需要携带此信息 errorCode:int //错误代码 data:{ stateList:int[] //用户状态数组，和请求时的用户账号数组一一对应取值范围 //-1:用户不存在 //0: 离线 //1: } } 说明： 此处的用户账号是业务系统的应用账号，不是 CeMIAP 的账号。

errorCode 错误码定义： 101：其他错误 401：应用不存在 3 业务服务器提供给 EAServer 的接口 本节详细描述了业务服务器需要提供给 EAServer 的接口 6 3.1 认证 URL： 取决于配置 输入： { user:string //用户账号 password:string //用户密码 } 输出： {。