E EasyPush 实时消息推送平台
查看接入指南 管理控制台
API 文档

消息推送与客户端控制接口

这页整理了签名规则、统一返回结构、响应码以及常用接口， 适合业务系统在服务端完成自动化消息推送与在线状态管理。

打开控制台 查看接入指南
签名说明 返回值 响应码 关闭客户端 发送消息 在线客户端 是否在线
基础

签名说明

每个接口都必须传递 sign 参数，用于校验请求合法性。生成规则如下：

  1. 将接口中的所有参数名称按字典顺序排序。
  2. 按排序顺序依次取出各参数值，并拼接成字符串。
  3. 使用 AppKey 对应的 AppSecret 对拼接结果进行 AES 加密，算法为 AES/ECB/PKCS5Padding。
  4. 将步骤 3 生成的字符串作为 sign 参数值传递。

AppSecret 可在 管理控制台 查看。为避免签名错误，也可以使用 签名校验工具。

基础

返回值

名称 值示例 说明
code 0000 响应码，详见响应码说明。
msg success 成功时固定返回 success，失败时返回失败详情。
module 00 系统内部定义字段，通常无需使用。
data {'appName':'test'} / 123 / true 返回数据，格式随接口不同而变化。
基础

响应码

代码值 说明
0000请求成功
1001appkey参数缺失
1002appkey无效
1003应用已停用
1101sign参数缺失
1102ts参数缺失
1103签名错误
1104请求过期
1201客户端不存在
接口 1

关闭客户端

  • URL：https://ep.eastech-inc.com/api/client/close
  • Method：POST
  • Content-Type：x-www-form-urlencoded
名称是否必填值示例说明
appkey是SZpLjHJpz5S92dGGeegkVEBq4H717O6P应用的 AppKey。
clientId是user001客户端标识。
ts是1751375273907当前时间戳，单位毫秒。
sign是8abe03ef7871ede07b7241a94554b84d签名。
接口 2

发送消息

  • URL：https://ep.eastech-inc.com/api/message/publish
  • Method：POST
  • Content-Type：x-www-form-urlencoded
名称是否必填值示例说明
appkey是SZpLjHJpz5S92dGGeegkVEBq4H717O6P应用的 AppKey。
channel是channel通道名称。
content是hello消息内容。
clientId否user001为空时发送给所有订阅该通道的客户端；不为空时仅发送给指定客户端。
ts是1751375273907当前时间戳，单位毫秒。
sign是8abe03ef7871ede07b7241a94554b84d签名。
接口 3

获取所有在线客户端

  • URL：https://ep.eastech-inc.com/api/client/list
  • Method：POST
  • Content-Type：x-www-form-urlencoded
名称是否必填值示例说明
appkey是SZpLjHJpz5S92dGGeegkVEBq4H717O6P应用的 AppKey。
ts是1751375273907当前时间戳，单位毫秒。
sign是8abe03ef7871ede07b7241a94554b84d签名。

返回值 data 类型为 JSON 数组，其中每个JSON对象包含字段如下：

名称类型值示例说明
uuid字符串d679eca7-9369-4551-85c0-f38a87317961客户端连接 ID。
clientId字符串user001客户端标识。
createTime字符串2025-07-20 15:54:20客户端连接创建时间。
subscribeInfos对象{ "channel": "channel1", "createTime":"2025-07-20T07:54:20.612+00:00" }客户端订阅通道信息，包含通道名称和订阅时间。
userAgent字符串Mozilla/5.0 (...)客户端浏览器 UA。
clientIp字符串172.23.15.4客户端 IP 地址。
接口 4

判断客户端是否在线

  • URL：https://ep.eastech-inc.com/api/client/online
  • Method：POST
  • Content-Type：x-www-form-urlencoded
名称是否必填值示例说明
clientId是user001客户端标识。
appkey是SZpLjHJpz5S92dGGeegkVEBq4H717O6P应用的 AppKey。
ts是1751375273907当前时间戳，单位毫秒。
sign是8abe03ef7871ede07b7241a94554b84d签名。
返回值 data 类型为 boolean，true 表示在线，false 表示不在线。
接口 5

获取客户端详情

  • URL：https://ep.eastech-inc.com/api/client/get
  • Method：POST
  • Content-Type：x-www-form-urlencoded
名称是否必填值示例说明
appkey是SZpLjHJpz5S92dGGeegkVEBq4H717O6P应用的 AppKey。
clientId是user001客户端标识。
ts是1751375273907当前时间戳，单位毫秒。
sign是8abe03ef7871ede07b7241a94554b84d签名。

返回值 data 类型为 JSON 对象，字段明细详见获取在线客户端