Zalo webhook

消息回调服务

对提供的webhook地址，进行Zalo业务相关的推送信息（目前支持推送消息回执）

消息回执

下发Zalo消息后，对消息状态进行回执推送

• URL：dr_webhook
• Method：POST
• Content-Type：application/json

回执参数

• body 参数：

参数名	类型	说明
status	String	回执状态（success,failed,delivered,journey_acknowledged,journey_time_out）
requestId	String	消息发送请求标识
code	Number	状态码（状态码说明）
message	String	状态码信息
sendTime	String	发送时间
cost	Object	费用信息（success,delivered,journey_acknowledged,journey_time_out显示）
ext	String	透传字段，该字段为发送接口中的非必填字段，填写后在回执success,failed,delivered,journey_acknowledged中会原样返回

• cost json obj:

参数名	类型	说明
currency	String	币种
originalPrice	Number	原币价格

回执示例

success

{
    "status": "success",
    "requestId": "zalomid.a941ccf8dd374dafxxxxxxacbe7a6ea5",
    "code": 0,
    "message": "Successfully sent.",
    "sendTime": "2024-05-01 10:12:39",
    "ext": "ext info",
    "cost": {
        "currency": "USD",
        "originalPrice": 4.1234
    },
    "zaloRes": {
        "sysMsg": "Successfully sent.",
        "cusMsg": "Successfully sent.",
        "error": 0,
        "message": "Success",
        "data": {
            "sent_time": "1714529559833",
            "sending_mode": "1",
            "msg_id": "5c4ee6axxxxxx9692026",
            "quota": {
                "remainingQuota": "4999",
                "dailyQuota": "5000"
            }
        }
    }
}

failed

{
    "status": "failed",
    "requestId": "zalomid.68d9cc28ba9546f797exxxxxx9333e23",
    "code": 17004,
    "message": "Zalo send error(Zalo account not existed)",
    "sendTime": "2024-10-30 10:34:40",
    "ext": "ext info",
    "zaloRes": {
        "sysMsg": "Zalo send error(Zalo account not existed)",
        "cusMsg": "Zalo send error(Zalo account not existed)",
        "error": -118,
        "message": "Zalo account not existed",
        "data": null
    }
}

delivered

{
    "status": "delivered",
    "requestId": "zalomid.a941ccf8dd374dafxxxxxxacbe7a6ea5",
    "code": 17003,
    "message": "Zalo message has delivered",
    "sendTime": "2023-07-13 15:12:11",
    "ext": "ext info"
}

journey_acknowledged

{
  "status": "journey_acknowledged",
  "requestId": "zalomid.a941ccf8dd374dafxxxxxxacbe7a6ea5",
  "code": 17006,
  "message": "The journey begins to be charged",
  "oaId": "30418xxxxxx05770721",
  "journeyId": "126052xxxx58967296",
  "appId": "33101xxxx80048",
  "timestamp": "1720602861913",
  "ext": "ext info",
  "cost": {
    "currency": "EUR",
    "originalPrice": 130
  }
}

journey_time_out

{
    "status": "journey_time_out",
    "code": 17007,
    "message": "Journey expires and has never been used",
    "journeyId": "126051xxxxxx4045952",
    "appId": "33101xxxxxx45180048",
    "oaId": "30418xxxxxx05770721",
    "timestamp": "1721206920581"
}

状态码说明

code	message	解决办法
0	Successfully sent.	消息提交成功提交zalo
1100	Customer does not exist / Status is unavailable	账号状态异常，联系业务人员处理账号问题
1102	Insufficient balance	账号余额不足，请联系业务人员充值
9000	Request parameter error	参数缺失，请检查必须的参数
9001	System business error	系统业务错误，请联系技术人员排除问题
9002	Phone number error	非法号码，请检查号码正确性
9003	Customer APP does not exist / Status is unavailable	应用状态异常，联系业务人员处理云平台应用创建/禁用问题
9004	Customer APP does not have quotation	应用报价缺失，联系业务人员处理应用报价问题
9005	Missing customer APP routes	应用路由缺失，请联系技术人员排查路由
9999	Unknown error	请联系技术人员排除问题
17003	Zalo message has delivered	消息已送达
17004	Zalo send error	Zalo官方发送失败错误信息
17005	Zalo engine api timeout	Zalo发送超时
17006	The journey begins to be charged	Zalo Journey Token 计费确认