Skip to main content
GET
/
whatsapp
/
agent-usage
Get current limit and usage (business initiated conversations) for WhatsApp agent.
curl --request GET \
  --url https://1-some-client.some-server.healvi-chat/third-party/v1/whatsapp/agent-usage \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "business_initiated": {
      "current_usage": 123,
      "current_limit": 123,
      "limit_exhausted": true
    }
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.chat.voicebot.studio/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
agent_id
integer

Optional ID of target agent. If none given, the first WhatsApp agent will be used.

Response

200 - application/json

Success

​
data
object

Template submitted to WhatsApp for approval. Necessary to create business initiated conversations.