Skip to main content
GuidesAPI Reference
Version: 1

Contact Center Agent Status API

The 8x8 Contact Center Get/Set Agent Status API enables you to set an agent's status or availability in your contact center. You can set the status for a specific contact center agent or perform a bulk operation for setting the status for multiple agents. (e.g., ON_BREAK, WORK_OFFLINE). The available agent status codes and types include the following -

  • 0 UNKNOWN

  • 1 LOGGED_OUT

  • 2 LOGGED_IN

  • 3 ON_BREAK

  • 4 WAIT_TRANSACT

  • 5 WORK_OFFLINE

  • 6 TRANSACT_OFFERED

  • 7 PROCESS_TRANSACT

  • 8 POST_PROCESS

  • 9 BUSY

  • 10 DIRECT_CALL

  • 11 ON_EMAIL

The Get/Set Agent Status API enables you to:

  • Obtain the query status for an agent or agents

  • Set the status for an agent or multiple agents

The data obtained from the Get/Set Agent Status API can be filtered by agent group.

Note that pagination is currently not supported.

This API is not enabled by default. If you do not have access contact your 8x8 representative.

Authentication​

The username is the tenantId and the password is the VCC action-token. These values are used for the Agent Status API.

Security Scheme Type:

http

HTTP Authorization Scheme:

basic

Contact

VCC Engineering Team: vcc-dev@8x8.com