CHL SAAS Viber API webhook - nxtele/nxcloud-doc-en GitHub Wiki

Viber Webhook

Message Callback Service

Push Viber business events to the configured webhook URL (currently supports delivery receipts).

Delivery Receipt

After sending Viber messages, delivery status callbacks are pushed.

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

Receipt Parameters

Body Parameters

Parameter Type Description
status String Delivery status (failed, delivered, seen, expired)
requestId String Message request ID
code Number Status code (see code list)
message String Status message
sendTime String Send time
cost Object Cost info (shown for delivered)

cost object

Parameter Type Description
currency String Currency
localPrice Number Local price (CNY)
originalPrice Number Original price
rateType String Rate type

Receipt Examples

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",
    "cost": {
        "currency": "USD",
        "localPrice": 29.89465,
        "originalPrice": 4.1234,
        "rateType": "Transactional"
    }
}

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"
}