1、美圣融云平台接口文档（1.3V）2015-12-01江苏美圣信息技术有限公司 2 / 18目录一、使用指南 .41.接入流程 .42.短信测试 .53.创建模板 .5二、接口开发 .61 接口说明 .62 鉴权说明 .63 账号接口 .74 模板接口 .85 模板短信接口 .116 状态接口 .127 上行接口 .148 检测黑名单 .159 检测敏感词 .16三、响应报文说明 .171.公共报文格式 .172.常见返回码 .17江苏美圣信息技术有限公司 3 / 18四、开发示例 .18Java 示例 .18C#示例 .18PHP 示例 .18其他语言 .18江苏美圣信息技术有限公司 4 /
2、18一、使用指南1.接入流程江苏美圣信息技术有限公司 5 / 182.短信测试3.创建模板江苏美圣信息技术有限公司 6 / 18二、接口开发1 接口说明所有接口采用 REST 架构风格设计，其核心面向资源，REST 对网络应用设计和开发方式，以降低开发的复杂性，提高系统的可伸缩性。返回报文统一使用 JSON，编码为 UTF-8。请会员用户登录到平台，在短信账号/ 签名查看指定账号 apikey请求地址: http:/IP:Port/rcsapi/rest服务器地址: IP端口:Port2 鉴权说明融云平台基于安全考虑，开发者调用融云平台接口采用签名认证进行鉴权。各接口统一请求 URL 地址如下
3、：http:/IP:Port/rcsapi/rest/xx/xxx.json?sid=sid&sign=sign参数：sid:账号sign:签名江苏美圣信息技术有限公司 7 / 18签名算法采用 md5 32 位算法，接口签名的具体要求请查看接口详细描述。3 账号接口请求地址: http:/IP:Port/rcsapi/rest/user/get.json?sid=sid&sign=sign请求方式：GET请求参数说明:响应参数说明:响应成功 Json 报文示例:“code“: “0“,“msg”: “成功”,“detail“: “,参数名 类型 约束 描述sid 字符型 必填 账号sign
4、字符型 必填 签名认证Md5(sid+apikey)参数名 名称 说明code 返回码 参见常见返回码msg 消息detail 详细描述userusername 账号balance 余额unit 计量单位warnBalance 预警余额 isActive 是否可用 True-可用，false-禁用apikey 接入 apikey 为了账号安全,暂时不开放，为空ip 报备 ipsignature 短信签名 如:【江苏美圣】remark 备注speed 速率subcode 扩展码江苏美圣信息技术有限公司 8 / 18“user“: “username“: “ZH00000017“,“balance
5、“: “3487“,“unit“: “条“,“warnBalance“: “56“,“isActive“: true,“apikey“: “83a4943c-6739-4556-9ac4-08528082eefb“,“ip“: “,“signature“: “【江苏美圣】“,“remark“: “租赁“,“speed“: “10“,“subcode“: “260425“响应失败 Json 报文示例：“code“: “1005“,“msg“: “请求认证失败“,“detail“: “请求认证失败“4 模板接口4.1.查询账号所有模板请求地址:http:/IP:Port/rcsapi/rest/t
6、pl/gets.json?sid=sid&sign=sign&pageindex=pageindex&pagesize=pagesize请求方式:GET请求参数说明:成功响应参数:参数名 类型 约束 描述sid 字符型 必填 账号sign 字符型 必填 签名认证md5(sid+apikey)pageindex 数字型 可选 默认：0pagesize 数字型 可选 默认:100，取值范围：0100参数名 名称 说明code 返回码江苏美圣信息技术有限公司 9 / 18响应成功 json 报文示例“code“: “0“,“msg”: “成功”,“detail“: “,“count“: “3“,“t
7、pls“: “id“: “b6d46de1c9c94c0eaa2bba74213feea5“,“name“: “注册验证码“,“content“: “您好，欢迎注册，您的短信验证码是：1， 请尽快完成注册。“,“remark“: “,“state“: “1“,“isActive“: true,“id“: “6e173b50a5a34b1989a02e31f05deb0e“,“name“: “注册模板“,“content“: “您好1, 欢迎使用2 ，后续咨询请关注3.“,“remark“: “,“state“: “1“,“isActive“: true,“id“: “f74b9c6ec4344
8、da3878e80e17c9ac927“,“name“: “OA 提醒 “,“content“: “1你好，系统中有新问题需处理，请及时查收并处理。“,“remark“: “,“state“: “1“,“isActive“: truemsg 消息detail 详细描述count 模板数量tplsid 模板 idname 模板名称content 模板内容remark 备注state 审核状态 0-退回 1-通过 2-审核isActive 是否可用 True-可用，false-禁用江苏美圣信息技术有限公司 10 / 18响应失败 Json 报文示例：“code“: “1005“,“msg“: “请
9、求认证失败“,“detail“: “请求认证失败“4.2.查询单个模板请求地址: /tpl/get.json? sid=sid&sign=sign& tplid=tplid请求方式:GET请求参数说明:响应参数说明:响应成功 Json 报文示例:“code“: “0“,“msg”: “成功”,“detail“: “,“tpl“: “id“: “6e173b50a5a34b1989a02e31f05deb0e“,“name“: “注册模板“,参数名 类型 约束 描述sid 字符型 必填 账号sign 字符型 必填 签名认证Md5(sid+apikey+tplid)tplid 字符型 必填 模板 id参数名 名称 说明code 返回码msg 消息detail 详细描述tplId 模板 idName 模板名称content 模板内容remark 备注state 审核状态 0-退回 1-通过 2-审核isActive 是否可用 True-可用，false-禁用
