Viber Webhook

Message Callback Service

The provided webhook URL will receive push information related to Viber services (currently supports message delivery receipts).

Message Receipt

After sending a Viber message, a receipt will be pushed to provide the status of the message.

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

Receipt Parameters

Body Parameters:

Parameter	Type	Description
status	String	Message status (failed, delivered, seen, expired)
requestId	String	Message request identifier
code	Number	Status code (see explanation below)
message	String	Status code description
sendTime	String	Message send time
cost	Object	Cost information (displayed for delivered status)

cost JSON object:

Parameter	Type	Description
currency	String	Currency type
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"
}