Viber webhook

消息回调服务

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

消息回执

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

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

回执参数

• body 参数：

参数名	类型	说明
status	String	回执状态（success，failed，delivered，seen，expired）
requestId	String	消息发送请求标识
code	Number	状态码（状态码说明）
message	String	状态码信息
sendTime	String	发送时间
cost	Object	费用信息（delivered显示）

• cost json obj:

参数名	类型	说明
currency	String	币种
localPrice	Number	本币价格（CNY）
originalPrice	Number	原币价格
rateType	String	费率类型

回执示例

success

{
    "status": "success",
    "requestId": "f6a7d49946094857ae02812969a83056",
    "code": 0,
    "message": "Successfully sent.",
    "sendTime": "2023-07-13 15:12:11",
    "cost": {
        "currency": "USD",
        "localPrice": 29.89465,
        "originalPrice": 4.1234,
        "rateType": "Transactional"
    }
}

failed

{
    "status": "failed",
    "requestId": "f6a7d49946094857ae02812969a83056",
    "code": 11000,
    "message": "Viber send error",
    "sendTime": "2023-07-13 15:12:11"
}

delivered

{
    "status": "delivered",
    "requestId": "f6a7d49946094857ae02812969a83056",
    "code": 11001,
    "message": "Viber message has delivered",
    "sendTime": "2023-07-13 15:12:11"
}

seen

{
    "status": "seen",
    "requestId": "f6a7d49946094857ae02812969a83056",
    "code": 11002,
    "message": "Viber message has seen",
    "sendTime": "2023-07-13 15:12:11"
}

expired

{
    "status": "expired",
    "requestId": "f6a7d49946094857ae02812969a83056",
    "code": 11003,
    "message": "Viber message has expired",
    "sendTime": "2023-07-13 15:12:11"
}

消息回复

终端用户回应客户下发消息，对终端用户回复消息内容进行推送（目前只支持用户对下发消息回复）

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

回复参数

• body 参数：

参数名	类型	说明
phone	String	viber用户号码，带国码
appkey	String	客户应用appkey
traceRequestId	String	消息回复，对应客户的消息请求标识
message	JsonObject	消息体内容
sendTime	String	发送时间

• message 参数:

参数名	类型	说明
text	String	文本消息
media	String	媒体消息内容
fileName	String	媒体名称

消息回复示例

文本消息

{
    "phone":"791xxxxx30",
    "appkey":"TexxxP6",
    "traceRequestId":"ae2c8ff7a4ee408398cf220e3fc1c199",
    "message":{
        "text":"text test"
    },
    "sendTime":"2023-07-17 14:40:50"
}

媒体消息

{
    "phone":"791xxxxx30",
    "appkey":"TexxxP6",
    "traceRequestId":"ae2c8ff7a4ee408398cf220e3fc1c199",
    "message":{
        "media":"https:media-link",
        "fileName":"xxxx.jpeg"
    },
    "sendTime":"2023-07-17 14:44:09"
}

状态码说明

code	message	解决办法
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	请联系技术人员排除问题
11000	Viber send error	Viber官方发送失败错误信息
11001	Viber message has delivered	消息已送达
11002	Viber message has seen	消息已读
11003	Viber message has expired	消息过期
11004	Viber engine api timeout	Viber发送超时