Overview

Captures are the recorded pieces of media produced from a Task. Supported channels are Voice, Chat, Email, Work Item, Social, and Custom Messaging (as applicable for the solution). There can be one or more Captures for any given Task. Captures are accessible for both open (voice only) and closed Tasks (all channels).

For more information about when captures are available, see the Captures Availability section below.

Authentication & Authorization

This API requires a valid bearer token. The caller must satisfy the scope and role requirements for one of the following:

Service App

• Required Scope: cjp:config_read
• The orgId must be provided in the request body and must match the token's org.
• For service app setup, refer to Contact Center Service Apps.

Org Admin

• Required Scopes: Identity:SCIM and Identity:Organization
• Required Role (one of): id_full_admin, id_readonly_admin, cjp.admin, or atlas-portal.partner.provision_admin
• The user must belong to the organization being queried. If orgId is provided in the request body, it must match the token's org. If orgId is omitted, it is inferred from the token.

Partner Admin

• Required Scope: Identity:SCIM for the managed org
• Required Role: atlas-portal.partner.salesadmin
• The org ID must be included in the managed org list. This is accomplished by adding the org to the Managed customer orgs list in control hub.

Supervisor

• Required Role: cjp.supervisor
• The user must belong to the organization being queried. If orgId is provided in the request body, it must match the token's org. If orgId is omitted, it is inferred from the token.

Note: Please refer to the contact center setup documentation for the configuration details.