Skip to main content

Agent chat concurrency

Returns every agent in the bot with their current live-chat load, overall concurrency limit, availability status, group membership, and profile details. Useful for determining chat-specific agent availability when agents have separate concurrency limits configured for chat vs. tickets. The agent roster and status use the same mechanism as the internal agent-availability API, so results always match what agents see in the dashboard.

Query Parameters
bot string REQUIRED

The unique ID of the bot.

Responses
200

Agent concurrency data returned.

Schema OPTIONAL
agents object[] OPTIONAL
agentId string OPTIONAL
currentChatConcurrency integer OPTIONAL

Number of live-chat tickets currently assigned to the agent (ASSIGNED/WRAP-UP status).

maxChatConcurrency integer OPTIONAL

The agent's overall concurrency limit. Not chat-specific — agents-service has no distinct chat-only limit today, so this is the same cap that applies across all ticket types.

status string OPTIONAL

Possible values: [available, dnd, away, offline]

Current availability status.

groups string[] OPTIONAL

Group codes the agent belongs to.

agentProfile object OPTIONAL
email string OPTIONAL
name string OPTIONAL
description string OPTIONAL
aliasname string OPTIONAL
languages string[] OPTIONAL
signature string OPTIONAL
400

botId is required.

Schema OPTIONAL
error string OPTIONAL

Human-readable error message.

401

Missing/invalid API key.

Schema OPTIONAL
error string OPTIONAL

Human-readable error message.

429

Rate limit exceeded.

Schema OPTIONAL
error string OPTIONAL

Human-readable error message.

500

Internal server error.

Schema OPTIONAL
error string OPTIONAL

Human-readable error message.