GET /api/channels/availability Returns the availability of each channel type for the current app, including the maximum allowed count and how many have been created.

​
Headers

​
appid
string
required
Your CometChat App ID.
​
apikey
string
required
Your CometChat API Key.

​
Example request

curl https://{appId}.api-{region}.cometchat.io/v3/business-messaging/api/channels/availability \
  -H "appid: YOUR_APP_ID" \
  -H "apikey: YOUR_API_KEY"

​
Example response

[
  { "type": "in_app", "limit": -1, "used": 3 },
  { "type": "push", "limit": 1, "used": 1 },
  { "type": "sms", "limit": 0, "used": 0 },
  { "type": "email", "limit": 0, "used": 0 },
  { "type": "whatsapp", "limit": 0, "used": 0 },
  { "type": "custom", "limit": 0, "used": 0 }
]

​
Response fields

​
type
string
Channel type: in_app, push, sms, email, whatsapp, or custom.
​
limit
integer
Maximum number of channels allowed for this type. -1 means unlimited.
​
used
integer
Number of channels of this type already created.
Check availability before creating a channel to avoid hitting type limits. A limit of 0 means the channel type requires a sales-provisioned plan.