主动推送消息

向指定访客列表主动推送文本、图片或富文本消息，接口会校验企业推送权限与消息内容格式。

请求参数

名称	类型	必填	描述
appKey	string	是	企业 AppKey。
time	int64	是	当前 UTC 时间戳，从 1970 年 1 月 1 日 0 点 0 分 0 秒开始到现在的秒数。
checksum	string	是	请求签名，签名规则参考通用说明的数据校验。
checksumAlgorithm	int32	否	签名算法版本，默认 0。

请求体

名称	类型	必填	描述	示例值
userlist	string[]	是	访客外部账号列表，单次最多 25 个	["visitor_001","visitor_002"]
msgtype	string	是	消息类型，详见消息类型说明。支持 text、picture、richText	text
content	string \| object	是	消息内容。text 类型传文本；picture、richText 类型传对应 JSON 对象。	您好，这是一条主动推送消息
bid	string	否	平台电商店铺编号，不传时默认 -1	shop_001
fromType	string	否	来源类型	open
action	object	否	消息按钮配置
└url	string	是	按钮跳转地址	https://example.com/order/10001
└label	string	是	按钮文案	查看详情
senderInfo	object	否	发送方展示信息，字段以客户端展示协议为准

返回参数

名称	类型	描述	示例值
code	int32	业务状态码，200 表示成功。	200
message	string	JSON 字符串；key 为处理结果分类，value 为对应访客外部账号列表。	{"success":["visitor_001"]}

错误码

状态码	描述
400	请求参数格式错误、缺少必要字段或请求体不是合法 JSON。
401	鉴权失败、签名错误、AppKey 不存在或 time 超出允许范围。
500	服务端处理异常。
8002	业务错误码，HTTP 状态码仍为 200：参数错误，常见于请求体 JSON 不合法、缺少必填字段或字段格式不合法。
8003	业务错误码，HTTP 状态码仍为 200：业务状态错误，例如质检任务状态错误或任务类型不匹配。
14001	业务错误码，HTTP 状态码仍为 200：AppKey 不存在或无效。
14002	业务错误码，HTTP 状态码仍为 200：checksum 签名校验失败。
14003	业务错误码，HTTP 状态码仍为 200：time 与服务器时间相差超过允许范围，或时间参数为空。
14004	业务错误码，HTTP 状态码仍为 200：请求内容错误，例如请求体格式错误、缺少必填字段或字段值不合法。
14005	业务错误码，HTTP 状态码仍为 200：无客服在线。
14006	业务错误码，HTTP 状态码仍为 200：访客正在排队。
14008	业务错误码，HTTP 状态码仍为 200：IP 白名单限制或 IP 被拦截。
14009	业务错误码，HTTP 状态码仍为 200：请求过于频繁。
14010	业务错误码，HTTP 状态码仍为 200：留言功能关闭。
14011	业务错误码，HTTP 状态码仍为 200：接口未开放或被停用。
14012	业务错误码，HTTP 状态码仍为 200：企业未开启主动推送消息。
14014	业务错误码，HTTP 状态码仍为 200：访客处于挂起状态。
14015	业务错误码，HTTP 状态码仍为 200：访客正在分流中。
14500	业务错误码，HTTP 状态码仍为 200：系统内部错误。

postEndpoint

/openapi/push/msg

curl -X POST "https://qiyukf.com/openapi/push/msg?appKey=string&time=0&checksum=string" \  -H "Content-Type: application/json" \  -d '{    "userlist": [      "visitor_001",      "visitor_002"    ],    "msgtype": "text",    "content": "您好，这是一条主动推送消息"  }'

{
  "code": 200,
  "message": "{\"success\":[\"visitor_001\"]}"
}

空

{
  "code": 8002,
  "message": "参数错误，常见于请求体 JSON 不合法、缺少必填字段或字段格式不合法。"
}

{
  "code": 8003,
  "message": "业务状态错误，例如质检任务状态错误或任务类型不匹配。"
}

{
  "code": 14001,
  "message": "AppKey 不存在或无效。"
}

{
  "code": 14002,
  "message": "checksum 签名校验失败。"
}

{
  "code": 14003,
  "message": "time 与服务器时间相差超过允许范围，或时间参数为空。"
}

{
  "code": 14004,
  "message": "请求内容错误，例如请求体格式错误、缺少必填字段或字段值不合法。"
}

{
  "code": 14005,
  "message": "无客服在线。"
}

{
  "code": 14006,
  "message": "访客正在排队。"
}

{
  "code": 14008,
  "message": "IP 白名单限制或 IP 被拦截。"
}

{
  "code": 14009,
  "message": "请求过于频繁。"
}

{
  "code": 14010,
  "message": "留言功能关闭。"
}

{
  "code": 14011,
  "message": "接口未开放或被停用。"
}

{
  "code": 14012,
  "message": "企业未开启主动推送消息。"
}

{
  "code": 14014,
  "message": "访客处于挂起状态。"
}

{
  "code": 14015,
  "message": "访客正在分流中。"
}

{
  "code": 14500,
  "message": "系统内部错误。"
}