{ "opencollection": "1.0.0", "info": { "name": "Webex Admin Address Book Tasks API", "version": "1.0.0" }, "items": [ { "info": { "name": "Tasks", "type": "folder" }, "items": [ { "info": { "name": "Get Tasks", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/tasks", "headers": [ { "name": "TrackingId", "value": "INTEGRATION-9bcdc696-57fa-4e91-b5aa-57a66a347c23" } ], "params": [ { "name": "channelTypes", "value": "email,telephony", "type": "query", "description": "Task channel type(s) permitted in response. Separate values with commas. Use lowercase. By default, there is no channelType filtering." }, { "name": "from", "value": "1591702170000", "type": "query", "description": "Filters tasks created after the given epoch timestamp (in milliseconds)." }, { "name": "to", "value": "1591802180000", "type": "query", "description": "Filters tasks created before the given epoch timestamp (in milliseconds); queries up to the present if timestamp is not specified." }, { "name": "pageSize", "value": "100", "type": "query", "description": "Maximum page size in the response. Maximum allowed value is 1000. Defaults to 100 items per page." }, { "name": "orgId", "value": "97cdbf45-ebe2-4687-8341-44d5c7abf101", "type": "query", "description": "Organization ID to use for this operation. If unspecified, inferred from token. Token must have permission to interact with this organization." } ] }, "docs": "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 im" }, { "info": { "name": "Create Task", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/tasks", "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "Update Task", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/v1/tasks/:taskId", "params": [ { "name": "taskId", "value": "315fbb91-2288-427c-9588-ec764cd46ea4", "type": "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." } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "Accept Task", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/tasks/:taskId/accept", "params": [ { "name": "taskId", "value": "315fbb91-2288-427c-9588-ec764cd46ea4", "type": "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." } ] }, "docs": "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)." }, { "info": { "name": "End Task", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/tasks/:taskId/end", "params": [ { "name": "taskId", "value": "315fbb91-2288-427c-9588-ec764cd46ea4", "type": "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." } ] }, "docs": "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)." }, { "info": { "name": "Wrap Up Task", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/tasks/:taskId/wrapup", "params": [ { "name": "taskId", "value": "315fbb91-2288-427c-9588-ec764cd46ea4", "type": "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." } ], "body": { "type": "json", "data": "{}" } }, "docs": "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)." }, { "info": { "name": "Hold Task", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/tasks/:taskId/hold", "params": [ { "name": "taskId", "value": "315fbb91-2288-427c-9588-ec764cd46ea4", "type": "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." } ], "body": { "type": "json", "data": "{}" } }, "docs": "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)." }, { "info": { "name": "Resume Task", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/tasks/:taskId/unhold", "params": [ { "name": "taskId", "value": "315fbb91-2288-427c-9588-ec764cd46ea4", "type": "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." } ], "body": { "type": "json", "data": "{}" } }, "docs": "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)." }, { "info": { "name": "Reject Task", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/tasks/:taskId/reject", "params": [ { "name": "taskId", "value": "315fbb91-2288-427c-9588-ec764cd46ea4", "type": "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." } ], "body": { "type": "json", "data": "{}" } }, "docs": "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)." }, { "info": { "name": "Pause Recording Task", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/tasks/:taskId/record/pause", "params": [ { "name": "taskId", "value": "315fbb91-2288-427c-9588-ec764cd46ea4", "type": "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." } ] }, "docs": "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." }, { "info": { "name": "Resume Recording Task", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/tasks/:taskId/record/resume", "params": [ { "name": "taskId", "value": "315fbb91-2288-427c-9588-ec764cd46ea4", "type": "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." } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "Transfer Task", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/tasks/:taskId/transfer", "params": [ { "name": "taskId", "value": "315fbb91-2288-427c-9588-ec764cd46ea4", "type": "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." } ], "body": { "type": "json", "data": "{}" } }, "docs": "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)." }, { "info": { "name": "Consult Task", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/tasks/:taskId/consult", "params": [ { "name": "taskId", "value": "315fbb91-2288-427c-9588-ec764cd46ea4", "type": "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." } ], "body": { "type": "json", "data": "{}" } }, "docs": "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)." }, { "info": { "name": "Consult Conference Task", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/tasks/:taskId/consult/conference", "params": [ { "name": "taskId", "value": "315fbb91-2288-427c-9588-ec764cd46ea4", "type": "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." } ], "body": { "type": "json", "data": "{}" } }, "docs": "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)." }, { "info": { "name": "Consult Transfer Task", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/tasks/:taskId/consult/transfer", "params": [ { "name": "taskId", "value": "315fbb91-2288-427c-9588-ec764cd46ea4", "type": "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." } ], "body": { "type": "json", "data": "{}" } }, "docs": "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)." }, { "info": { "name": "Consult Accept Task", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/tasks/:taskId/consult/accept", "params": [ { "name": "taskId", "value": "315fbb91-2288-427c-9588-ec764cd46ea4", "type": "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." } ] }, "docs": "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)." }, { "info": { "name": "Assign Task", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/tasks/:taskId/assign", "params": [ { "name": "taskId", "value": "315fbb91-2288-427c-9588-ec764cd46ea4", "type": "path", "description": "The unique ID represents the task that the user want to assign." } ] }, "docs": "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)." }, { "info": { "name": "Consult End Task", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/tasks/:taskId/consult/end", "params": [ { "name": "taskId", "value": "315fbb91-2288-427c-9588-ec764cd46ea4", "type": "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." } ], "body": { "type": "json", "data": "{}" } }, "docs": "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)." }, { "info": { "name": "Exit Conference Task", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/tasks/:taskId/conference/exit", "params": [ { "name": "taskId", "value": "315fbb91-2288-427c-9588-ec764cd46ea4", "type": "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." } ] }, "docs": "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)." }, { "info": { "name": "Accept Preview Task", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/dialer/campaign/:campaignId/preview-task/:taskId/accept", "params": [ { "name": "taskId", "value": "315fbb91-2288-427c-9588-ec764cd46ea4", "type": "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." }, { "name": "campaignId", "value": "315fbb91-2288-427c-9588-ec764cd46ea4", "type": "path", "description": "The unique ID represents the campaign that the user is currently working on." } ] }, "docs": "API to accept the preview campaign task offered to the agent." }, { "info": { "name": "Skip Preview Task", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/dialer/campaign/:campaignId/preview-task/:taskId/skip", "params": [ { "name": "taskId", "value": "315fbb91-2288-427c-9588-ec764cd46ea4", "type": "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." }, { "name": "campaignId", "value": "315fbb91-2288-427c-9588-ec764cd46ea4", "type": "path", "description": "The unique ID represents the campaign that the user is currently working on." } ] }, "docs": "API to skip the preview campaign task offered to the agent." }, { "info": { "name": "Remove Preview Task", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/dialer/campaign/:campaignId/preview-task/:taskId/remove", "params": [ { "name": "taskId", "value": "315fbb91-2288-427c-9588-ec764cd46ea4", "type": "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." }, { "name": "campaignId", "value": "315fbb91-2288-427c-9588-ec764cd46ea4", "type": "path", "description": "The unique ID represents the campaign that the user is currently working on." } ] }, "docs": "API to remove the preview campaign task offered to the agent" } ] } ], "bundled": true }