• Hosted in the EU
  • GDPR Compliant
  • No Downloads Required

Chat Group Availability API

Chat Group Availability API

The Live Chat group availability API makes it possible to check if agents are online for the group. For more information on when a chat button is available, see: Livechat Button Availability. The number of logged on agents will be returned, as well as the number of available open chat lines.

API Endpoints:

/api/account_groups/availability

Returns the availability of all groups belonging to the account of the logged on user.

Example:

$ curl --basic -u user1:****** https://channel.me/api/account_groups/availability
{"sales": {"online_agents": 2, "open_lines": 3}, "support": {"online_agents": 5, "open_lines": 5}, "billing": {"online_agents": 0, "open_lines": 0}}

/api/account_groups/availability?groups=<name1>[,<name2>]

Returns the availability information of the groups with specified names.

Example:

$ curl --basic -u user1:****** \
    https://channel.me/api/account_groups/availability?groups=sales,billing
{"sales": {"online_agents": 2, "open_lines": 3}, "billing": {"online_agents": 0, "open_lines": 0}}