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 Tasks API

The Tasks API from Webex — 21 operation(s) for tasks.

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

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

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

22 operations 21 paths 21 schemas 1 GET1 PATCH20 POST

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 Tasks 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 22

Across 21 paths, the API surfaces 22 operations — 1 GET, 1 PATCH, 20 POST. Each is listed below with its method, path, parameters, and response codes.

Tasks 22
POST
/v1/tasks
Create Task
CreateTaskRoute body → 201400401403500503
GET
/v1/tasks
Get Tasks
searchTasks 6 params → 200400401403413422500503
PATCH
/v1/tasks/{taskId}
Update Task
PatchTaskRoute 1 param body → 202400401403500503
POST
/v1/tasks/{taskId}/accept
Accept Task
acceptTaskRoute 1 param → 202401403500503
POST
/v1/tasks/{taskId}/end
End Task
endTaskRoute 1 param → 202401403500503
POST
/v1/tasks/{taskId}/wrapup
Wrap Up Task
agentWrapUpRoute 1 param body → 202400401403500503
POST
/v1/tasks/{taskId}/hold
Hold Task
agentHoldRoute 1 param body → 202400401403500503
POST
/v1/tasks/{taskId}/unhold
Resume Task
agentUnHoldRoute 1 param body → 202400401403500503
POST
/v1/tasks/{taskId}/reject
Reject Task
rejectTaskRoute 1 param body → 202400401403500503
POST
/v1/tasks/{taskId}/record/pause
Pause Recording Task
pauseRecordingRoute 1 param → 202401403500503
POST
/v1/tasks/{taskId}/record/resume
Resume Recording Task
resumeRecordingRoute 1 param body → 202400401403500503
POST
/v1/tasks/{taskId}/transfer
Transfer Task
transferTaskRoute 1 param body → 202400401403500503
POST
/v1/tasks/{taskId}/consult
Consult Task
consultRoute 1 param body → 202400401403500503
POST
/v1/tasks/{taskId}/consult/conference
Consult Conference Task
consultConferenceRoute 1 param body → 202400401403500503
POST
/v1/tasks/{taskId}/consult/transfer
Consult Transfer Task
consultTransferRoute 1 param body → 202400401403500503
POST
/v1/tasks/{taskId}/consult/accept
Consult Accept Task
acceptConsultRoute 1 param → 202401403500503
POST
/v1/tasks/{taskId}/assign
Assign Task
assignRoute 1 param → 202401403500503
POST
/v1/tasks/{taskId}/consult/end
Consult End Task
endConsultRoute 1 param body → 202400401403500503
POST
/v1/tasks/{taskId}/conference/exit
Exit Conference Task
exitConferenceRoute 1 param → 202401402403500503
POST
/v1/dialer/campaign/{campaignId}/preview-task/{taskId}/accept
Accept Preview Task
acceptPreviewCampaignTaskRoute 2 params → 202400401403500503
POST
/v1/dialer/campaign/{campaignId}/preview-task/{taskId}/skip
Skip Preview Task
skipPreviewCampaignTaskRoute 2 params → 202400401403500503
POST
/v1/dialer/campaign/{campaignId}/preview-task/{taskId}/remove
Remove Preview Task
removePreviewCampaignTaskRoute 2 params → 202400401403500503

Schemas 21

The contract defines 21 schemas that model the data the API accepts and returns. The most detailed are TaskAttributes (11 properties), CreateTaskRequest (8 properties), ConferenceResourceRequest (3 properties), ConsultResourceRequest (3 properties). Each schema is shown below with its type and property counts.

TransferResourceRequest
object
Request body for transferring a task.
2 properties 2 required
EndConsultRequest
object
Request body for ending a consult.
1 property
ResumeRecordingResourceRequest
object
Request body for resuming a recording.
1 property 1 required
ApiErrorResponse
object
Response body for an API error.
2 properties
TaskOwner
object
The owner of the task.
2 properties 2 required
Meta
object
Response metadata.
1 property
ConferenceResourceRequest
object
Request body for a conference.
3 properties 1 required
WrapUpResourceRequest
object
Request body for wrapping up a task.
2 properties 2 required
Task
object
List of tasks retrieved according to query parameters.
2 properties 2 required
OperationError
object
An error message providing details about the operation failure.
1 property
CreateTaskRequest
object
Request body for creating a task.
8 properties 3 required
PatchTaskRequest
object
Request body for patching a task.
1 property 1 required
ConsultResourceRequest
object
Request body for a consult.
3 properties 2 required
ErrorDetails
object
Details of an error.
2 properties
MediaResourceRequest
object
Request body for media resource.
1 property 1 required
TaskApiResponse
object
API response for a task.
2 properties 2 required
ConsultTransferResourceRequest
object
Request body for a consult transfer.
2 properties 2 required
TaskQueue
object
The queue where the task belongs.
2 properties 2 required
CallbackDetails
object
Details for a callback task.
2 properties 2 required
TaskAttributes
object
Attributes of the task.
11 properties 6 required
CreateTaskResponse
object
Response body after successfully requesting a task creation.
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

webex-tasks-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 Agents 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