Messaging

Get Chat Availability By Id

Check if messages could be sent to the chat. Only for WABA.

is_available will be true if it's possible to send a free-form message to the chat. This means that you 'have enough dialogs balance' AND ('have auto templates enabled' OR 'have dialog session open').

is_available will be false otherwise

To find out why the chat is not available, check the following in order:

  1. Check waba.dialogs_available. If it's false, then you must top up your dialogs balance
  2. Check waba.expires_at. If it's in the past, then the dialog session has ended. You must wait for an incoming message from the recipient or send a template message.
  3. Check waba.auto_templates_enabled. If it's false, then you must send a template message
get/companies/{company_id}/messaging/chats/{chat_id}/availability

Request

  • Base URL: https://api.radist.online/v2
  • URL: https://api.radist.online/v2/companies/{company_id}/messaging/chats/{chat_id}/availability
  • Auth: one of:
    • API key in header X-Api-Key
    • OAuth 2 (password, token URL https://auth.radist.online/auth/realms/radist/protocol/openid-connect/token)

Path parameters

company_idinteger required
chat_idinteger required

Response

Successful Response

is_availableboolean

Changes

No recorded changes to this operation across all 1 revision of this API.