Bulk Job API

Bulk jobs are a fast and efficient way to enter data at initial setup and to incorporate large-scale changes, such as changing agent skill groups between shifts and hiring multiple new agents.

You can use the Bulk Job API to list the bulk jobs currently defined in the database, define new bulk jobs, and view or delete records of existing bulk jobs.

Note

Avoid performing a bulk job transaction during a maintainence window.

Note

Limit the bulk job import to 1000 records at any given instance.

URL

https://<server>/unifiedconfig/config/bulkjob

Operations

  • create: Creates one bulk job.

  • delete: Permanently deletes one bulk job.

  • get: Returns one bulk job using the URL https://<server>/unifiedconfig/config/bulkjob/<id>.

  • get (template): Returns a sample CSV template for the given bulk job type. The response contains the CSV template as a file attachment. The form of the request is https://<server>/unifiedconfig/config/bulkjob/templates/<jobType>, where <jobType> can be one of the following:

    • dialednumber

    • agent

    • calltype

    • skillgroup

    • inventory (for lab mode inventory)

    • CVP file transfer

    • ssomigration

      This template returns records for agent and supervisor accounts that are not enabled for single sign-on. You can use the template to migrate these user accounts to SSO.

      Non-SSO users can be filtered by peripheralId, agentTeamId, or both.

      To filter by peripheralId, use the following URL:

      https://<server>/unifiedconfig/config/bulkjob/templates/ssomigration?q=peripheralId:<peripheralId>.

      To filter by agentTeamId, use the following URL:

      https://<server>/unifiedconfig/config/bulkjob/templates/ssomigration?q=agentTeamId:<agentTeamId>.

      To filter by both peripheralId and agentTeamId, use the following URL:

      https://<server>/unifiedconfig/config/bulkjob/templates/ssomigration?q=peripheralId:<peripheralId>agentTeamId:<agentTeamId>.

    • agentservice_association

      The sample CSV template returns the list of agents and the associated service types.

  • list: Retrieves a list of bulk jobs.

Parameters

  • refURL: The refURL of the bulk job. See Shared Parameters.

  • description: See Shared Parameters.

  • fileContent: The content of the bulk CSV file. The size of the file must not exceed 3MB. For information about the CSV file data, see the Manage Bulk Jobs section of the Cisco Packaged Contact Center Enterprise Administration and Configuration Guide at https://www.cisco.com/c/en/us/support/customer-collaboration/packaged-contact-center-enterprise/products-maintenance-guides-list.html.

  • createDateTime: The time the bulk job was submitted. It indicates the time in milliseconds elapsed from the zero epoch value of January 1, 1970, 00:00:00 GMT. Read-only.

  • jobHostName: The Windows computer name of the AW that initiated the bulk job. Read-only.

  • startDateTime: The time the bulk job began. Read-only.

  • endDateTime: The time the bulk job completed or failed. Read-only.

  • jobState: The current state of the job. Read-only.

    • 1: Queued

    • 2: Processing

    • 3: Succeeded

    • 4: Failed

    • 5: Cancelled

    • 6: Partially succeeded

  • jobType: The job type. Optional. If this parameter is not provided, the value is determined automatically based on the header in the bulk job file. If the parameter is provided, the header must match the job type specified.

    • 1: Dialed Number

    • 2: Agent

    • 3: Call Type

    • 4: Skill Group

    • 5: SSO Migration

    • 5: SSO Migration

    • 6: IVR Applications

    • 102: Inventory

    • 104: Contact Center AI service association

      You can create a bulk job and update the existing agent to enable or disable Contact Center AI services, using the agentservice_association jobType. This jobType is available for administrators only when Cloud Connect is added in the inventory.

  • logFile: A URL to download the log file for the bulk job. Read-only.

  • csvFile: A URL to download the CSV file that was originally uploaded in the fileContent parameter. Read-only.

Search and Sort Values

The following table shows the parameters that are searched and the parameters that are sortable.

Search parameters Sort parameters

  • description

  • description

  • jobType

  • jobState

  • jobHostName

  • createDateTime

  • startDateTime

  • endDateTime

See Search and Sort.

Example Create Request

Example create request for enabling Agent Answers service for the agents:

Code Snippet
Copy<bulkJob>
<jobType>104</jobType>
<fileContent>agentId,userName,agentServices
1111,Agent1,AgentAnswers
2222,Agent2,AgentAnswers
</fileContent>
</bulkJob>

Example create request for enabling Agent Answers, VAV Transcript, and Transcript services for the agents:

Code Snippet
Copy<bulkJob>
<jobType>104</jobType>
<fileContent>agentId,userName,agentServices
1111,Agent1,AgentAnswers;Transcript;VAVTranscript
2222,Agent2,AgentAnswers;Transcript;VAVTranscript
</fileContent>
</bulkJob>

Example Get Response

Example response for a dialed number create job that completed successfully:

Code Snippet
Copy<bulkJob>
  <changeStamp>0</changeStamp>
  <refURL>/unifiedconfig/config/bulkjob/(id)</refURL>
  <jobHostName>CCE-AW-1</jobHostName>
  <createDateTime>1330441858360</createDateTime>
  <startDateTime>1330441858361</startDateTime>
  <endDateTime>1330441858368</endDateTime>
  <jobState>3</jobState>
  <jobType>1</jobType>
  <description>dn create bulk job</description>
  <logFile><refURL>/unifiedconfig/config/bulkjob/(id)/log</refURL></logFile>
  <csvFile><refURL>/unifiedconfig/config/bulkjob/(id)/csv</refURL></csvFile>
</bulkJob>