PUSHMSG DOCUMENTATION

产品概览

了解 PushMsg 的消息流程、服务入口与文档导航。

更新 2026-10-264 分钟阅读

PushMsg 将业务系统提交的信息转换为微信公众号通知。服务先保存消息,再通过持久化队列异步发送,并提供鉴权、公众号渠道权限、幂等去重、状态查询和人工处理入口。

从哪里开始

你要完成的工作 阅读入口
第一次接入,发送一条客户跟进通知 快速开始
在 CRM 中推送客户名称、来源、电话等信息 CRM 专用接口
使用其他微信模板,或发送客服文本 通用消息接口
配置公众号、模板和业务系统密钥 管理控制台
获取通知接收人的微信 OpenID OpenID 获取
安装、发布、备份或排查服务 部署说明 · 运行维护 · 故障排查

服务入口

入口 地址 用途
完整生产文档 PushMsg 文档中心 本手册、接口说明与下载资料
CRM 推送接口 https://openid.xianboss.com/api/v1/crm/push 可信 HTTPS;固定映射“新客户跟进通知”模板
CRM 在线参考 打开调用说明 生产站点上的单页 API 文档
OpenID 获取页面 在微信内打开 获取当前微信账号在“仙宝科技”公众号下的 OpenID
管理控制台 打开控制台 管理公众号、业务应用和消息记录
通用业务 API https://14.103.113.229/api/v1/messages 自行指定公众号通道、模板和字段

管理后台使用 https://pmsg.admin.xianboss.com/admin/ 的可信 HTTPS。通用业务 API 的 IP 入口使用自签名证书,客户端需要信任管理员交付的服务器证书。CRM 接口和 OpenID 页面使用域名 HTTPS。openid.xianboss.com 当前开放 CRM 接口及 OpenID 授权入口,通用消息使用 IP 入口,管理后台通过 /admin/ 访问管理接口。

生产文档站用于查阅与下载资料,入口为 https://pmsg.admin.xianboss.com。原 http://192.168.0.21:8084 保留为局域网预览入口。业务推送请求应发送到上表中的生产 API 地址。

选择接入方式

CRM 专用接口

CRM 提交业务字段:customerName、customerType、customerSource、customerPhone、markedAt。服务端负责选择 xianbao 通道和“新客户跟进通知”模板,并映射微信字段。

适合客户新增、客户分配或跟进提醒等使用同一通知模板的 CRM 事件。接收人通过 openId 指定,可对应 CRM 负责人或管理人员。

通用消息接口

调用方指定 channelId、type、templateId 和 data,适合接入其他已配置的公众号或微信模板。客服文本使用 TEXT 类型,发送资格仍受微信互动时限等条件约束。

两种接口共用业务应用鉴权、渠道权限、消息持久化和队列。相同调用方下的 requestId 是去重依据,跨接口提交同一标识也要保持映射后的消息内容一致。

一条消息如何处理

  1. 业务系统携带独立 API Key 和 API Secret 提交 JSON 请求。
  2. PushMsg 校验调用方、渠道和接收人权限及字段,保存消息后返回消息 ID。
  3. 队列调用微信接口,记录发送状态、尝试次数及微信消息 ID。
  4. 业务系统通过消息 ID 查询结果;管理员在控制台处理失败或不确定的任务。

HTTP 202 表示任务已接收;SENT 表示微信接口已接受请求,用户实际收到或阅读的情况需在微信客户端确认。UNKNOWN 表示发送结果无法确定,需要先人工核实。

下载接入资料

示例均使用占位密钥和接收人。实际 Key 和 Secret 由管理员单独交付,请保存在业务系统服务端配置中。

PushMsg 文档内容以当前部署的接口与配置为准。

输入关键词搜索全部文档。