Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Webex Agents API

The Agents API from Webex — 7 operation(s) for agents.

Webex Agents API is one of 178 APIs that Webex publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Agents. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 7 operations across 7 paths, and defines 13 schemas. It is described by OpenAPI 3.0.0, at version 1.0.0.

7 operations 7 paths 13 schemas 2 GET3 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.0.0
Authentication
OAuth 2.0, HTTP Bearer, OAuth 2.0
Resource Areas
1

Authentication & Security 3

Webex Agents API declares 3 security schemes for authenticating requests. It supports OAuth 2.0 (oauth2) using the authorizationCode flow. It accepts HTTP bearer tokens (JWT) (bearer-key). It supports OAuth 2.0 (bearerAuth) using the authorizationCode flow, exposing 1 scope.

  • bearer-key — e.g. Bearer YOURAUTHORIZATIONTOKEN
  • bearerAuth — OAuth 2.0 Bearer token authentication

Paths & Operations 7

Across 7 paths, the API surfaces 7 operations — 2 GET, 3 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Agents 7
POST
/v1/agents/login
Login
loginRoute body → 202400401403500503
PUT
/v1/agents/logout
Logout
logoutRoute body → 202400401403500503
PUT
/v1/agents/session/state
State Change
stateRoute body → 202400401403500503
POST
/v1/agents/reload
Reload
reloadRoute → 202401403500503
POST
/v1/agents/buddyList
Buddy Agents List
buddyAgentsRoute body → 202400401403500503
GET
/v1/agents/activities
Get Agent Activities
getAgentActivities 9 params → 200400401403413422500503
GET
/v1/agents/statistics
Get Agent Statistics
getDocumentByQueryParam 6 params → 200400401403422500503

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are AgentActivity (25 properties), ChannelResponse (12 properties), LogInResourceRequest (6 properties), OutAgentStatistics (6 properties). Each schema is shown below with its type and property counts.

AgentActivitiesApiResponse
object
Response wrapper for agent activities.
2 properties 2 required
AgentActivity
object
List of agent activities retrieved according to query parameters.
25 properties 25 required
ApiErrorResponse
object
Response body for an API error.
2 properties
AgentApiResponse
object
Response wrapper for agent statistics.
2 properties 2 required
BuddyAgentRequest
object
Request payload to retrieve buddy agents.
3 properties 2 required
ErrorDetails
object
Details of an error.
2 properties
ChannelResponse
object
Statistics for a specific channel.
12 properties
LogOutResourceRequest
object
2 properties 1 required
StateResourceRequest
object
Request payload to update an agent state.
4 properties 2 required
OperationError
object
An error message providing details about the operation failure.
1 property
Meta
object
Response metadata.
1 property
LogInResourceRequest
object
6 properties 2 required
OutAgentStatistics
object
List of Agent Statistics records retrieved according to query parameters.
6 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

webex-agents-api-openapi.yml Raw ↑

Other APIs Webex publishes across the network.

Webex Address Book API
Webex Admin Audit Events API
Webex Agent Personal Greeting Files API
Webex Agent Summaries API
Webex Agent Wellbeing API
Webex AI Feature API
Webex API - Domain Management API
Webex Archive Users API
Webex Attachment Actions API
Webex Audio Files API
Webex Authorizations API
Webex Auto CSAT API