How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
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 193 APIs that Webex publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 24 operations across 23 paths, and defines 39 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

24 operations 23 paths 39 schemas 1 GET1 PATCH22 POST

Metadata

The identity and technical contract details declared by the specification.

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

Authentication & Security 5

Webex Tasks API declares 5 security schemes for authenticating requests. It supports OAuth 2.0 (oauth2) using the authorizationCode flow. It accepts HTTP bearer tokens (JWT) (bearer-key). It accepts HTTP bearer tokens (BEARER_TOKEN_FROM_CI). It accepts HTTP bearer tokens (JWT) (Bearer). It accepts HTTP bearer tokens (JWT) (bearerAuth).

  • bearer-key — e.g. Bearer YOURAUTHORIZATIONTOKEN
  • Bearer — e.g. Bearer YOURAUTHORIZATIONTOKEN
  • bearerAuth — JWT bearer token authentication. Obtain your token from the Webex Developer Portal.

Paths & Operations 24

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

Tasks 24
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
POST
/v2/tasks
Create Task
createTaskRouteV2 1 param body → 201400401403500503
POST
/v2/tasks/{taskId}/messages
Append Task Message
appendTaskMessageV2 2 params body → 202400401403429500

Schemas 39

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

WorkItemAppendTaskRequest
object
Request body to append an inbound workItem message to an existing task.
2 properties 2 required
TelephonyParams
object
Telephony channel parameters.
5 properties 3 required
CreateTaskRequestV2
Request body for creating a task.
Telephony
object
Request body to create an outbound telephony task routed through a configured entry point. entryPointId is required. When callback is provided, its type must b…
7 properties 4 required
TaskApiResponse
object
API response for a task.
2 properties 2 required
CallbackDetails
object
Details for a callback task.
2 properties 2 required
TextWithAttachment
object
Message payload with optional text and one or more file attachments for customMessaging tasks. Used when channelParams.type is text-with-attachments. Either te…
4 properties 3 required
CreateTaskResponse
object
Response body after successfully requesting a task creation.
2 properties 2 required
WrapUpResourceRequest
object
Request body for wrapping up a task.
2 properties 2 required
ConsultTransferResourceRequest
object
Request body for a consult transfer.
2 properties 2 required
ResumeRecordingResourceRequest
object
Request body for resuming a recording.
1 property 1 required
Attachment
object
File attachment for a customMessaging message.
3 properties 3 required
TaskMessageRequest
Request body to append an inbound message to an existing workItem or customMessaging task.
EndConsultRequest
object
Request body for ending a consult.
1 property
PatchTaskRequest
object
Request body for patching a task.
1 property 1 required
TaskQueue
object
The queue where the task belongs.
2 properties 2 required
Meta
object
Response metadata.
1 property
CallbackParams
object
Callback parameters for telephony tasks.
3 properties 2 required
CustomMessaging
object
Request body to create an inbound customMessaging task via a configured custom messaging channel. The channel must reference an active configured custom messag…
7 properties 5 required
ConsultResourceRequest
object
Request body for a consult.
3 properties 2 required
TaskMessageResponse
object
Response body after successfully requesting a task message append.
2 properties 2 required
WorkItemForm
object
Work item message payload.
3 properties 3 required
CustomMessageAppendTaskRequest
object
Request body to append an inbound customMessaging message to an existing task. Custom Messaging must be enabled for the organization. The API returns 403 if th…
2 properties 2 required
MediaResourceRequest
object
Request body for media resource.
1 property 1 required
ErrorDetails
object
Details of an error.
2 properties
TextMessage
object
Text-only message payload for customMessaging tasks. Used when channelParams.type is text. The attachments field is not supported for this type — sending attac…
3 properties 3 required
TransferResourceRequest
object
Request body for transferring a task.
2 properties 2 required
Task
object
List of tasks retrieved according to query parameters.
2 properties 2 required
WorkItem
object
Request body to create an inbound workItem task via a configured workItem channel. The channel must reference an active configured workItem channel in the orga…
7 properties 5 required
FlowSettings
object
Schema-free data map to pass specific data to the externalized flow settings. Supports a maximum of 15 tuples. Each tuple can have a key up to 200 bytes and a…
ConferenceResourceRequest
object
Request body for a conference.
3 properties 1 required
CreateTaskRequest
object
Request body for creating a task.
8 properties 3 required
TaskAttributes
object
Attributes of the task.
11 properties 6 required
TaskOwner
object
The owner of the task.
2 properties 2 required
ApiErrorResponse
object
Response body for an API error.
2 properties
CustomMessagingParams
object
Custom messaging channel parameters. The type field is a discriminator that determines the shape of message. Use text for a plain text message, or text-with-at…
2 properties 2 required
WorkItemParams
object
Work item channel parameters.
2 properties 2 required
GlobalVariables
object
Schema-free data map to pass specific data depending on the outbound type. Values are validated against the global variables configured in the organization. Su…
OperationError
object
An error message providing details about the operation failure.
1 property

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
Where this information came from

This is an independent, third-party profile of Webex Tasks API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.