openapi: 3.0.0
info:
title: Webex Admin Address Book Tasks API
version: 1.0.0
description: The Webex Admin APIs provide comprehensive programmatic access to administrative functions for managing Webex organizations, users, licenses, and settings. These APIs enable automation of user provisioning, license assignment, compliance management, and audit event retrieval. Administrators can integrate with enterprise identity systems, enforce security policies, monitor usage, and streamline onboarding/offboarding processes. The APIs support granular control over organizational resources, making them ideal for large-scale deployments and custom admin tooling.
tags:
- name: Tasks
paths:
/v1/tasks:
post:
tags:
- Tasks
summary: Create Task
description: This API is to create a task for work or handling assignments. Represents both inbound tasks (originating from customer-facing channels) and outbound tasks (originating from contact center to customer-facing channel). Requires 'cjp:user' scope for authorization. For a list of possible response messages, see the Call Control API Guide.
operationId: CreateTaskRoute
parameters: []
requestBody:
description: Request body to create a task.
content:
application/json:
schema:
$ref: '#/components/schemas/CreateTaskRequest'
required: true
responses:
'201':
description: The new task was successfully requested for creation
content:
application/json:
schema:
$ref: '#/components/schemas/CreateTaskResponse'
'400':
description: Bad Request
'401':
description: Unauthorized, Token is Invalid
'403':
description: Forbidden Request
'500':
description: Internal Server Error
'503':
description: Service Unavailable
get:
tags:
- Tasks
summary: Get Tasks
description: "Retrieve open and closed tasks. Sorted by createdTime ascending. Uses offset-based pagination.\nFor this API, response compression using gzip can be enabled by including 'Accept-Encoding' header in the request with its value as 'gzip'. \nThe response will be compressed only if its size exceeds 1 MB.\nIf the header is not present in the request or if gzip is not listed as one of the encodings in the header's value (comma separated encodings), then API response will not be compressed and this can impact the latency as observed from clients."
operationId: searchTasks
parameters:
- name: channelTypes
in: query
description: Task channel type(s) permitted in response. Separate values with commas. Use lowercase. By default, there is no channelType filtering.
required: false
example:
- email
- telephony
schema:
type: array
items:
type: string
enum:
- email
- chat
- telephony
- social
- name: from
in: query
description: Filters tasks created after the given epoch timestamp (in milliseconds).
required: true
schema:
type: integer
format: int64
example: 1591702170000
- name: to
in: query
description: Filters tasks created before the given epoch timestamp (in milliseconds); queries up to the present if timestamp is not specified.
required: false
schema:
type: integer
format: int64
example: 1591802180000
- name: pageSize
in: query
description: Maximum page size in the response. Maximum allowed value is 1000. Defaults to 100 items per page.
required: false
schema:
maximum: 1000
minimum: 1
type: integer
format: int32
default: 100
example: 100
- name: orgId
in: query
description: Organization ID to use for this operation. If unspecified, inferred from token. Token must have permission to interact with this organization.
required: false
schema:
type: string
example: 97cdbf45-ebe2-4687-8341-44d5c7abf101
- name: TrackingId
in: header
description: 'Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. '
required: false
schema:
type: string
example: INTEGRATION-9bcdc696-57fa-4e91-b5aa-57a66a347c23
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/TaskApiResponse'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
'401':
description: Unauthorized Operation
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
'403':
description: Forbidden
content:
'*/*':
schema:
$ref: '#/components/schemas/ApiErrorResponse'
'413':
description: Content Too Large
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
'422':
description: Unprocessable Entity
content:
application/json: {}
'500':
description: An Unexpected Error Occurred
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
'503':
description: The service is currently unavailable to serve the requests
content:
application/json: {}
/v1/tasks/{taskId}:
patch:
tags:
- Tasks
summary: Update Task
description: This API is to update a task. Represents both inbound tasks (originating from customer-facing channels) and outbound tasks (originating from contact center to customer-facing channel). Requires one of the following scopes 'cjp:user' or 'cloud-contact-center:pod_conv' for authorization.. For a list of possible response messages, see the Call Control API Guide.
operationId: PatchTaskRoute
parameters:
- name: taskId
in: path
description: The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.
required: true
schema:
type: string
format: UUID
example: 315fbb91-2288-427c-9588-ec764cd46ea4
requestBody:
description: Request body for patching a task.
content:
application/json:
schema:
$ref: '#/components/schemas/PatchTaskRequest'
required: true
responses:
'202':
description: The request is accepted for processing
'400':
description: Bad Request
'401':
description: Unauthorized, Token is Invalid
'403':
description: Forbidden Request
'500':
description: Internal Server Error
'503':
description: Service Unavailable
/v1/tasks/{taskId}/accept:
post:
tags:
- Tasks
summary: Accept Task
description: Access this endpoint when the user has to accept either an inbound or an outbound requests. The request can be social, a chat or an email. Requires one of the following scopes 'cjp:user' or 'cloud-contact-center:pod_conv' for authorization. For a list of possible response messages, see the [Call Control API Guide](/docs/contact-control-apis).
operationId: acceptTaskRoute
parameters:
- name: taskId
in: path
description: The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.
required: true
schema:
type: string
format: UUID
example: 315fbb91-2288-427c-9588-ec764cd46ea4
responses:
'202':
description: The request is accepted for processing
'401':
description: Unauthorized, Token is Invalid
'403':
description: Forbidden Request
'500':
description: Internal Server Error
'503':
description: Service Unavailable
/v1/tasks/{taskId}/end:
post:
tags:
- Tasks
summary: End Task
description: Access this endpoint when the user has to end either an inbound or an outbound requests. Requires one of the following scopes 'cjp:user' or 'cloud-contact-center:pod_conv' for authorization. For a list of possible response messages, see the [Call Control API Guide](/docs/contact-control-apis).
operationId: endTaskRoute
parameters:
- name: taskId
in: path
description: The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.
required: true
schema:
type: string
format: UUID
example: 315fbb91-2288-427c-9588-ec764cd46ea4
responses:
'202':
description: The request is accepted for processing
'401':
description: Unauthorized, Token is Invalid
'403':
description: Forbidden Request
'500':
description: Internal Server Error
'503':
description: Service Unavailable
/v1/tasks/{taskId}/wrapup:
post:
tags:
- Tasks
summary: Wrap Up Task
description: Access this endpoint when the user has to wrap up a call. Requires one of the following scopes 'cjp:user' or 'cloud-contact-center:pod_conv' for authorization. For a list of possible response messages, see the [Call Control API Guide](/docs/contact-control-apis).
operationId: agentWrapUpRoute
parameters:
- name: taskId
in: path
description: The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.
required: true
schema:
type: string
format: UUID
example: 315fbb91-2288-427c-9588-ec764cd46ea4
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/WrapUpResourceRequest'
required: true
responses:
'202':
description: The request is accepted for processing
'400':
description: Bad Request
'401':
description: Unauthorized, Token is Invalid
'403':
description: Forbidden Request
'500':
description: Internal Server Error
'503':
description: Service Unavailable
/v1/tasks/{taskId}/hold:
post:
tags:
- Tasks
summary: Hold Task
description: Access this endpoint when the user has to hold a call. When an user is in consulting state, the task will be put on hold. It is not applicable for chats and emails. Requires one of the following scopes 'cjp:user','cloud-contact-center:pod_conv' for authorization. For a list of possible response messages, see the [Call Control API Guide](/docs/contact-control-apis).
operationId: agentHoldRoute
parameters:
- name: taskId
in: path
description: The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.
required: true
schema:
type: string
format: UUID
example: 315fbb91-2288-427c-9588-ec764cd46ea4
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/MediaResourceRequest'
required: true
responses:
'202':
description: The request is accepted for processing
'400':
description: Bad Request
'401':
description: Unauthorized, Token is Invalid
'403':
description: Forbidden Request
'500':
description: Internal Server Error
'503':
description: Service Unavailable
/v1/tasks/{taskId}/unhold:
post:
tags:
- Tasks
summary: Resume Task
description: Access this endpoint when the user has to resume a call from hold. When an user is done consulting, the previously held interaction with the customer should be resumed. It is not applicable for chats and emails. Requires one of the following scopes 'cjp:user','cloud-contact-center:pod_conv' for authorization. For a list of possible response messages, see the [Call Control API Guide](/docs/contact-control-apis).
operationId: agentUnHoldRoute
parameters:
- name: taskId
in: path
description: The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.
required: true
schema:
type: string
format: UUID
example: 315fbb91-2288-427c-9588-ec764cd46ea4
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/MediaResourceRequest'
required: true
responses:
'202':
description: The request is accepted for processing
'400':
description: Bad Request
'401':
description: Unauthorized, Token is Invalid
'403':
description: Forbidden Request
'500':
description: Internal Server Error
'503':
description: Service Unavailable
/v1/tasks/{taskId}/reject:
post:
tags:
- Tasks
summary: Reject Task
description: Access this endpoint when the user has to reject a task. Once a task is rejected, the status of the user goes to idle from available. Requires one of the following scopes 'cjp:user' or 'cloud-contact-center:pod_conv' for authorization. For a list of possible response messages, see the [Call Control API Guide](/docs/contact-control-apis).
operationId: rejectTaskRoute
parameters:
- name: taskId
in: path
description: The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.
required: true
schema:
type: string
format: UUID
example: 315fbb91-2288-427c-9588-ec764cd46ea4
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/MediaResourceRequest'
required: true
responses:
'202':
description: The request is accepted for processing
'400':
description: Bad Request
'401':
description: Unauthorized, Token is Invalid
'403':
description: Forbidden Request
'500':
description: Internal Server Error
'503':
description: Service Unavailable
/v1/tasks/{taskId}/record/pause:
post:
tags:
- Tasks
summary: Pause Recording Task
description: When configured by the administrator, telephony tasks are often being recorded for various reasons. When an user is handling sensitive customer information, he/she might want to pause the recording and later on resume recording. For a list of possible response messages, see the [Call Control API Guide](/docs/contact-control-apis). Requires OAuth scope cjp:user. The authenticated user must have a UserProfile of type Agent to access this API.
operationId: pauseRecordingRoute
parameters:
- name: taskId
in: path
description: The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.
required: true
schema:
type: string
format: UUID
example: 315fbb91-2288-427c-9588-ec764cd46ea4
responses:
'202':
description: The request is accepted for processing
'401':
description: Unauthorized, Token is Invalid
'403':
description: Forbidden Request
'500':
description: Internal Server Error
'503':
description: Service Unavailable
/v1/tasks/{taskId}/record/resume:
post:
tags:
- Tasks
summary: Resume Recording Task
description: When configured by the administrator, telephony tasks are often being recorded for various reasons. When an user is handling sensitive customer information, he/she might resume the recording after the pause. For a list of possible response messages, see the [Call Control API Guide](/docs/contact-control-apis). Requires OAuth scope cjp:user. The authenticated user must have a UserProfile of type Agent to access this API.
operationId: resumeRecordingRoute
parameters:
- name: taskId
in: path
description: The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.
required: true
schema:
type: string
format: UUID
example: 315fbb91-2288-427c-9588-ec764cd46ea4
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ResumeRecordingResourceRequest'
responses:
'202':
description: The request is accepted for processing
'400':
description: Bad Request
'401':
description: Unauthorized, Token is Invalid
'403':
description: Forbidden Request
'500':
description: Internal Server Error
'503':
description: Service Unavailable
/v1/tasks/{taskId}/transfer:
post:
tags:
- Tasks
summary: Transfer Task
description: Access this endpoint when the user has to transfer a call to another user. Requires one of the following scopes 'cjp:user' or 'cloud-contact-center:pod_conv' scope for authorization. For a list of possible response messages, see the [Call Control API Guide](/docs/contact-control-apis).
operationId: transferTaskRoute
parameters:
- name: taskId
in: path
description: The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.
required: true
schema:
type: string
format: UUID
example: 315fbb91-2288-427c-9588-ec764cd46ea4
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/TransferResourceRequest'
required: true
responses:
'202':
description: The request is accepted for processing
'400':
description: Bad Request
'401':
description: Unauthorized, Token is Invalid
'403':
description: Forbidden Request
'500':
description: Internal Server Error
'503':
description: Service Unavailable
/v1/tasks/{taskId}/consult:
post:
tags:
- Tasks
summary: Consult Task
description: Access this endpoint when the user has to consult a call to another user. Requires one of the following scopes 'cjp:user' or 'cloud-contact-center:pod_conv' for authorization. For a list of possible response messages, see the [Call Control API Guide](/docs/contact-control-apis).
operationId: consultRoute
parameters:
- name: taskId
in: path
description: The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.
required: true
schema:
type: string
format: UUID
example: 315fbb91-2288-427c-9588-ec764cd46ea4
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ConsultResourceRequest'
required: true
responses:
'202':
description: The request is accepted for processing
'400':
description: Bad Request
'401':
description: Unauthorized, Token is Invalid
'403':
description: Forbidden Request
'500':
description: Internal Server Error
'503':
description: Service Unavailable
/v1/tasks/{taskId}/consult/conference:
post:
tags:
- Tasks
summary: Consult Conference Task
description: Access this endpoint when the user has to initiate a conference with the consulting user. Requires one of the following scopes 'cjp:user' or 'cloud-contact-center:pod_conv' for authorization. For a list of possible response messages, see the [Call Control API Guide](/docs/contact-control-apis).
operationId: consultConferenceRoute
parameters:
- name: taskId
in: path
description: The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.
required: true
schema:
type: string
format: UUID
example: 315fbb91-2288-427c-9588-ec764cd46ea4
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ConferenceResourceRequest'
required: true
responses:
'202':
description: The request is accepted for processing
'400':
description: Bad Request
'401':
description: Unauthorized, Token is Invalid
'403':
description: Forbidden Request
'500':
description: Internal Server Error
'503':
description: Service Unavailable
/v1/tasks/{taskId}/consult/transfer:
post:
tags:
- Tasks
summary: Consult Transfer Task
description: Access this endpoint when the user has to transfer a call to the consulting user. Requires one of the following scopes 'cjp:user' or 'cloud-contact-center:pod_conv' for authorization. For a list of possible response messages, see the [Call Control API Guide](/docs/contact-control-apis).
operationId: consultTransferRoute
parameters:
- name: taskId
in: path
description: The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.
required: true
schema:
type: string
format: UUID
example: 315fbb91-2288-427c-9588-ec764cd46ea4
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ConsultTransferResourceRequest'
required: true
responses:
'202':
description: The request is accepted for processing
'400':
description: Bad Request
'401':
description: Unauthorized, Token is Invalid
'403':
description: Forbidden Request
'500':
description: Internal Server Error
'503':
description: Service Unavailable
/v1/tasks/{taskId}/consult/accept:
post:
tags:
- Tasks
summary: Consult Accept Task
description: Access this endpoint when the user has to accept a call to the consulting user. Requires one of the following scopes 'cjp:user' or 'cloud-contact-center:pod_conv' for authorization. For a list of possible response messages, see the [Call Control API Guide](/docs/contact-control-apis).
operationId: acceptConsultRoute
parameters:
- name: taskId
in: path
description: The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.
required: true
schema:
type: string
format: UUID
example: 315fbb91-2288-427c-9588-ec764cd46ea4
responses:
'202':
description: The request is accepted for processing
'401':
description: Unauthorized, Token is Invalid
'403':
description: Forbidden Request
'500':
description: Internal Server Error
'503':
description: Service Unavailable
/v1/tasks/{taskId}/assign:
post:
tags:
- Tasks
summary: Assign Task
description: Access this endpoint when users such as administrators, supervisors, or agents with an agent license need to assign tasks to themselves. Authorization requires the `cjp:user` scope. For a list of potential response messages, refer to the [Call Control API Guide](/docs/contact-control-apis).
operationId: assignRoute
parameters:
- name: taskId
in: path
description: The unique ID represents the task that the user want to assign.
required: true
schema:
type: string
format: UUID
example: 315fbb91-2288-427c-9588-ec764cd46ea4
responses:
'202':
description: The request is accepted for processing
'401':
description: Unauthorized
'403':
description: Forbidden Request
'500':
description: Internal Server Error
'503':
description: Service Unavailable
/v1/tasks/{taskId}/consult/end:
post:
tags:
- Tasks
summary: Consult End Task
description: Access this endpoint when the user has to end a call with the consulting user. Requires one of the following scopes 'cjp:user' or 'cloud-contact-center:pod_conv' for authorization. For a list of possible response messages, see the [Call Control API Guide](/docs/contact-control-apis).
operationId: endConsultRoute
parameters:
- name: taskId
in: path
description: The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.
required: true
schema:
type: string
format: UUID
example: 315fbb91-2288-427c-9588-ec764cd46ea4
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/EndConsultRequest'
required: true
responses:
'202':
description: The request is accepted for processing
'400':
description: Bad Request
'401':
description: Unauthorized, Token is Invalid
'403':
description: Forbidden Request
'500':
description: Internal Server Error
'503':
description: Service Unavailable
/v1/tasks/{taskId}/conference/exit:
post:
tags:
- Tasks
summary: Exit Conference Task
description: Access this endpoint when the user wants to exit from a conference call. Requires one of the following scopes 'cjp:user' or 'cloud-contact-center:pod_conv' for authorization. For a list of possible response messages, see the [Call Control API Guide](/docs/contact-control-apis).
operationId: exitConferenceRoute
parameters:
- name: taskId
in: path
description: The taskId represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.
required: true
schema:
type: string
format: UUID
example: 315fbb91-2288-427c-9588-ec764cd46ea4
responses:
'202':
description: The request is accepted for processing
'401':
description: Unauthorized, Token is Invalid
'402':
description: Not Found
'403':
description: Forbidden Request
'500':
description: Internal Server Error
'503':
description: Service Unavailable
/v1/dialer/campaign/{campaignId}/preview-task/{taskId}/accept:
post:
tags:
- Tasks
summary: Accept Preview Task
description: API to accept the preview campaign task offered to the agent.
operationId: acceptPreviewCampaignTaskRoute
parameters:
- name: taskId
in: path
description: The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.
required: true
schema:
type: string
format: UUID
example: 315fbb91-2288-427c-9588-ec764cd46ea4
- name: campaignId
in: path
description: The unique ID represents the campaign that the user is currently working on.
required: true
schema:
type: string
format: UUID
example: 315fbb91-2288-427c-9588-ec764cd46ea4
responses:
'202':
description: The request is accepted for processing
'400':
description: Bad Request
'401':
description: Invalid or absent authorization header
'403':
description: Invalid OAuth 2.0 Bearer Token
'500':
description: Internal Server Error
'503':
description: Service Unavailable
/v1/dialer/campaign/{campaignId}/preview-task/{taskId}/skip:
post:
tags:
- Tasks
summary: Skip Preview Task
description: API to skip the preview campaign task offered to the agent.
operationId: skipPreviewCampaignTaskRoute
parameters:
- name: taskId
in: path
description: The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.
required: true
schema:
type: string
format: UUID
example: 315fbb91-2288-427c-9588-ec764cd46ea4
- name: campaignId
in: path
description: The unique ID represents the campaign that the user is currently working on.
required: true
schema:
type: string
format: UUID
example: 315fbb91-2288-427c-9588-ec764cd46ea4
responses:
'202':
description: The request is accepted for processing
'400':
description: Bad Request
'401':
description: Invalid or absent authorization header
'403':
description: Invalid OAuth 2.0 Bearer Token
'500':
description: Internal Server Error
'503':
description: Service Unavailable
/v1/dialer/campaign/{campaignId}/preview-task/{taskId}/remove:
post:
tags:
- Tasks
summary: Remove Preview Task
description: API to remove the preview campaign task offered to the agent
operationId: removePreviewCampaignTaskRoute
parameters:
- name: taskId
in: path
description: The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.
required: true
schema:
type: string
format: UUID
example: 315fbb91-2288-427c-9588-ec764cd46ea4
- name: campaignId
in: path
description: The unique ID represents the campaign that the user is currently working on.
required: true
schema:
type: string
format: UUID
example: 315fbb91-2288-427c-9588-ec764cd46ea4
responses:
'202':
description: The request is accepted for processing
'400':
description: Bad Request
'401':
description: Invalid or absent authorization header
'403':
description: Invalid OAuth 2.0 Bearer Token
'500':
description: Internal Server Error
'503':
description: Service Unavailable
components:
schemas:
TransferResourceRequest:
description: Request body for transferring a task.
properties:
to:
description: The user destination ID or the entry point ID to transfer, maximum length 43 characters.
type: string
example: 315fbb91-2288-427c-9588-ec764cd46ea4
destinationType:
description: The user can transfer to another user in the team(```agent```), q
# --- truncated at 32 KB (47 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/webex/refs/heads/main/openapi/webex-tasks-api-openapi.yml