推送通道 API

推送模块提供推送发送、推送日志、按天/按次统计以及推送备注名的设置、查询与删除。

模块概览​

项目值
接口数量7
幂等接口1
路径前缀/im/v2
请求方法POST（JSON 请求体）
鉴权方式App-Key / Nonce / Timestamp / Signature（见 鉴权与签名）
响应信封{ code, msg?, data?, requestId? }

接口列表​

接口方法路径说明幂等
发送推送通知POST/im/v2/push/send发送推送通知（scope=all|tag|package|user|users；不落地，按应用推送配置的 webhook 投递并记录推送日志）。否
查询推送日志POST/im/v2/push/log/list查询推送日志（覆盖融云 /message/push/detail/history）。否
推送聚合统计POST/im/v2/push/stats/day推送聚合统计（按天；覆盖融云 /stat/getDayPushData）。否
单次推送统计POST/im/v2/push/stats/by-id单次推送统计（覆盖融云 /stat/getPushIdData）。否
设置推送备注名POST/im/v2/push/remark/set设置推送备注名（scope=user|group；覆盖融云 /user/remarks/* 与 /group/remarks/*）。是
查询推送备注名POST/im/v2/push/remark/get查询推送备注名。否
删除推送备注名POST/im/v2/push/remark/remove删除推送备注名。否

接口约定​

  • 完整请求地址 = 部署域名 + /im/v2 + 接口路径；所有接口使用 POST。
  • 请求头必须携带 App-Key / Nonce / Timestamp / Signature；签名规则见鉴权与签名。
  • 响应统一为 { code, msg?, data?, requestId? }；code = 0 表示成功。
  • 列表类接口使用 limit 分页，单页上限见限频与限制。

相关说明​