【龙岩市教育数据共享服务平台】
消息推送接口
（版本号 V1.0）
文档修订记录
版本号 | 状态 | 简要说明 | 日期 | 变更人 |
V1.0 | 建立 | 中间消息推送接口 | 2022.1.26 | 童倩 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
龙岩市教育数据共享服务平台在政务信息网和政务外网、互联网区提供Restful接口，各部门业务系统通过调用该Restful接口，实现政务数据实时共享。
限制类型 | 限制说明 |
传输字符编码格式 | 平台接口采用的是UTF-8编码格式 |
传输数据格式 | 平台接口采用JSON格式 |
为了保证汇聚共享平台对外提供的统一接口安全可靠、简易兼容，接口规范应满足如下原则：
(1) 接口具有普遍的适应性；
(2) 使用简单、快捷的方式实现其他系统的接入；
(3) 接口应充分考虑省汇聚共享平台的应用扩展情况；
(4) 保证接口数据在省汇聚平台与用户系统的一致性；
(5) 接口调用能够方便的形成，并能在接入方顺利地实现；
(6) 在满足功能要求的前提下，使接口数据量最少；
(7) 接口数据传输控制策略可靠且完善；
(8) 具有可靠的接口数据出错返回机制。
所有接口调用均采用HTTP远程调用方式，客户端调用并同步返回响应。数据格式： json
1. 请求方式：get/post， 服务地址url格式为http://domain/[service]/[servicename]
其中:domain为服务域名、service为服务名称、servicename 为API名称.
2. 协议消息头包含以下属性:
Content-Type：application/json;charset=utf-8;
3. 请求header包含以下参数:
user-date： 调用日期。格式yyyyMMddHHmmssSSS。17位日期字符串，小时采用24小时格式，如：20160101160758675；
user-params：请求参数。Get请求格式为：xx=xx&xx=xx。Post请求格式为json字符串。并对参数进行URL的UTF-8编码
authorization： 鉴权码，其中，鉴权码（authorition）=dc:{apikey}:{signature}。鉴权码由三部分组成，他们之间以英文冒号隔开；（详细请参考2.2）
1. 响应报文媒体类型为application/json;charset=utf-8.
apikey | 管理人员分配 |
secretkey | 管理人员分配 |
authorization： | 第一部分：固定值为dc。 第二部分：用户申请的apikey。 第三部分：数据签名（signature）。 例如： dc:test-apikey:ODExQUJENUFCRTBDQTc5NzM4RkQ2RTUzQzE2MDQyNUY= 数据签名（signature），加密格式如下： signature= BASE64{ Hmac_sha1{ user-params + 换行符 + user-date + 换行符 } } 数据签名由hmac_sha1加密后在经base64编码。hmac_sha1密钥为用户申请的secretkey。}
|
user-date | 用日期。格式yyyyMMddHHmmssSSS。17位日期字符串，小时采用24小时格式，如：20160101160758675；
|
user-params | 请求参数。Get请求格式为：xx=xx&xx=xx。Post请求格式为json字符串。 并对参数进行URL的UTF-8编码 |
API调用示例代码：
下载Api调用示例，把代码导入开发工具，查看其中的RequestApiTest类，修改其中的 APIKEY，SECRETKEY，然后根据相应的请求方式，修改接口地址进行测试。
接口访问地址 | http://open-api.longyanedu.net/message/msgSend | |||
接口方式 | HTTP | 提交方式 | Post | |
入参 | 名称 | 必填 | 数据类型 | 说明 |
appId | 是 | string | 应用ID | |
appKey | 是 | string | 应用key | |
orgId | 是 | string | 申请开通消息服务的机构ID | |
users | 是 | string | 消息发送用户，多个逗号分隔 | |
code | 是 | string | 申请消息模板编码（默认模板编码：10000） | |
isTodo | 是 | string | 是否为待办事项 0：不是（默认） 1：是 | |
param | 否 | string | 模板中对应指定值（json字符串） | |
mobiles | 是 | string | 消息发送用户手机号，多个逗号分隔 | |
content | 是 | string | 发送消息内容 | |
出参 | 名称 | 数据类型 | 说明 | |
code | String | 结果编码,000000：成功 | ||
message | String | 结果描述 | ||
status | String | 状态，OK：成功 | ||
请求示例 | {"code":"10000","param":{"name":"名称","url":"http://www.baidu.com","status":"已处理"},"mobiles":"18050434901,18850385391","appId":"4D6689DE9A6A391399D0BDCE68F7748B","isTodo":"0","appKey":"72ff892f120149fbb9ee20f10ac09a8d","users":"664ca1fc736111ecbfd3b6bdaf5eda12","orgId":"990a51d8d3eb4df6bf5fcc6f64705cc9","content":"测试"} | |||
返回示例 | {"code":"000000","message":"发送成功","result":"","status":"OK"} | |||
接口访问地址 | http://open-api.longyanedu.net/message/platformSend | |||
接口方式 | HTTP | 提交方式 | Post | |
入参 | 名称 | 必填 | 数据类型 | 说明 |
appId | 是 | string | 应用ID | |
appKey | 是 | string | 应用key | |
orgId | 是 | string | 申请开通消息服务的机构ID | |
users | 是 | string | 消息发送用户，多个逗号分隔 | |
code | 是 | string | 申请消息模板编码（默认模板编码：10000） | |
isTodo | 是 | string | 是否为待办事项 0：不是 1：是 | |
param | 否 | Map | 模板中对应指定值 | |
出参 | 名称 | 数据类型 | 说明 | |
code | String | 结果编码,000000：成功 | ||
message | String | 结果描述 | ||
status | String | 状态，OK：成功 | ||
请求示例 | { "code": "10000", "users": "664ca1fc736111ecbfd3b6bdaf5eda12", "orgId": "990a51d8d3eb4df6bf5fcc6f64705cc9", “isTodo”:”1”, "param": {"name":"名称","url":"http://www.baidu.com","status":"已处理"} } | |||
返回示例 | {"code":"000000","message":"发送成功","result":"","status":"OK"} | |||
接口访问地址 | http://open-api.longyanedu.net/message/smsSend | |||
接口方式 | HTTP | 提交方式 | Post | |
入参 | 名称 | 必填 | 数据类型 | 说明 |
mobiles | 是 | string | 消息发送用户手机号，多个逗号分隔 | |
content | 是 | string | 发送消息内容 | |
出参 | 名称 | 数据类型 | 说明 | |
code | String | 结果编码,000000：成功 | ||
message | String | 结果描述 | ||
status | String | 状态，OK：成功 | ||
请求示例 | { "mobiles": "18050434901,18850385391", "content": "测试" } | |||
返回示例 | {"code":"000000","message":"发送成功","result":"","status":"OK"} | |||
接口访问地址 | http://open-api.longyanedu.net/message/qyWeinXinSend | |||
接口方式 | HTTP | 提交方式 | Post | |
入参 | 名称 | 必填 | 数据类型 | 说明 |
mobiles | 是 | string | 消息发送用户手机号，多个逗号分隔 | |
content | 是 | string | 发送消息内容 | |
出参 | 名称 | 数据类型 | 说明 | |
code | String | 结果编码,000000：成功 | ||
message | String | 结果描述 | ||
status | String | 状态，OK：成功 | ||
请求示例 | { "mobiles": "18050434901,18850385391", "content": "测试" } | |||
返回示例 | {"code":"000000","message":"发送成功","result":"","status":"OK"} | |||
评论
还能输入140字
用户评论
经过核实，本空间由于存在敏感词或非法违规信息或不安全代码或被其他用户举报，
已被管理员（或客服）锁定。
本空间现无法正常访问，也无法进行任何操作。
如需解锁请联系当地教育技术部门，由当地教育技术部门联系锁定人处理。
当前机构空间已被管理员（或客服）封锁。
目前机构空间无法正常访问，也无法进行任何操作。
如需重新开放，请联系当地教育技术部门，由当地教育技术部门联系管理员（或客服）处理。
龙岩市教育公共服务平台