Exceeding limitation on tariff#
Incoming webhook of this type contain data about exceeding chat limitations in received webhooks on the Developer tariff.
Webhook#
Webhook parameters#
| Parameter | Type | Description |
|---|---|---|
typeWebhook | string | Incoming webhook type. For webhooks of this type the parameter takes on the value quotaExceeded |
instanceData | object | Account data |
timestamp | integer | Event timestamp in UNIX format |
stateInstance | object | Data about exceeding limitations |
instanceData object parameters
| Parameter | Type | Description |
|---|---|---|
idInstance | integer | Account Id |
wid | string | Account Id in WhatsApp format |
typeInstance | string | Account messenger type |
quotaData object parameters
| Parameter | Type | Description |
|---|---|---|
method | string | Method or limitation name. By default, it takes the value correspondents |
used | string | Number of chats used in a month |
total | string | Total number of chats that can be used in a month. By default, it takes the value 3 |
status | string | Limitation status |
description | string | Description of the limitation exceedance |
Webhook body example#
{
"typeWebhook": "quotaExceeded",
"instanceData": {
"idInstance": 1000100010,
"wid": "10001234560@c.us",
"typeInstance": "whatsapp"
},
"quotaData": {
"method": "correspondents", // chat limitations
"used": 3,
"total": 3,
"status": "CORRESPONDENTS_QUOTA_EXCEEDED", // The number of chats limit has been exceeded
"description": "Monthly quota has been exceeded. You can only send or receive messages from following chats: 10001234560@c.us, 10001234561@c.us, 10001234562@c.us. Please go to your personal account and change the tariff to business https://console.green-api.com"
}
}