{
  "opencollection": "1.0.0",
  "info": {
    "name": "Webex Admin Address Book Callbacks API",
    "version": "1.0.0"
  },
  "items": [
    {
      "info": {
        "name": "Callbacks",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get scheduled callbacks",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/v1/callbacks/organization/:orgId/scheduled-callback",
            "params": [
              {
                "name": "orgId",
                "value": "123e4567-e89b-12d3-a456-426614174000",
                "type": "path",
                "description": "The organization ID for which the callback is being scheduled. This should be a valid UUID."
              },
              {
                "name": "callbackNumber",
                "value": "+1234567890",
                "type": "query",
                "description": "The callback customer number to filter the scheduled callbacks. Only an exact match will yield the result. Allows an optional country code followed by digits (0-9) and the special characters: space, hyphen -, parentheses ( and ), and period ., ensuring the total length is between 7 and 15 characters."
              },
              {
                "name": "assigneeAgent",
                "value": "123e4567-e89b-12d3-a456-426614174001",
                "type": "query",
                "description": "The unique identifier of the agent assigned to handle the callback. Must be in UUID format. This parameter is optional, but at least one of assigneeAgent or callbackNumber must be provided."
              },
              {
                "name": "page",
                "value": "1",
                "type": "query",
                "description": "The page number to retrieve."
              },
              {
                "name": "pageSize",
                "value": "10",
                "type": "query",
                "description": "The number of items per page."
              },
              {
                "name": "sortBy",
                "value": "scheduledTime",
                "type": "query",
                "description": "The field to sort the results by. If `sortBy` is set to `assignedTime`, the `assigneeAgent` parameter must also be provided."
              },
              {
                "name": "sortOrder",
                "value": "asc",
                "type": "query",
                "description": "The order to sort the results in."
              }
            ]
          },
          "docs": "Allows the user to list scheduled callbacks for a given customer number or assignee agent, excluding those whose scheduled trigger time has already passed. Requires 'cjp:user' scope for authorization."
        },
        {
          "info": {
            "name": "Schedule a Callback",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/v1/callbacks/organization/:orgId/scheduled-callback",
            "params": [
              {
                "name": "orgId",
                "value": "123e4567-e89b-12d3-a456-426614174000",
                "type": "path",
                "description": "The organization ID for which the callback is being scheduled. This should be a valid UUID."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a new callback request for a customer. Authorization requires the cjp:user scope. The callback default endpoint (EP) and default ANI must be configured as mandatory settings to successfully make API calls."
        },
        {
          "info": {
            "name": "Get scheduled callback by Id",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/v1/callbacks/organization/:orgId/scheduled-callback/:id",
            "params": [
              {
                "name": "orgId",
                "value": "123e4567-e89b-12d3-a456-426614174000",
                "type": "path",
                "description": "The organization ID for which the callback is being scheduled. This should be a valid UUID."
              },
              {
                "name": "id",
                "value": "5C3E69AC-3695-4D51-899B-4B4CC3ED8ECF",
                "type": "path",
                "description": "The id with which the Scheduled Callback has been created."
              }
            ]
          },
          "docs": "Retrieve an existing scheduled callback by Id, excluding those whose scheduled trigger time has already passed. Requires 'cjp:user' scope for authorization."
        },
        {
          "info": {
            "name": "Update scheduled callback by Id",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "{{baseUrl}}/v1/callbacks/organization/:orgId/scheduled-callback/:id",
            "params": [
              {
                "name": "orgId",
                "value": "123e4567-e89b-12d3-a456-426614174000",
                "type": "path",
                "description": "The organization ID for which the callback is being scheduled. This should be a valid UUID."
              },
              {
                "name": "id",
                "value": "5C3E69AC-3695-4D51-899B-4B4CC3ED8ECF",
                "type": "path",
                "description": "The id with which the Scheduled Callback has been created."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update an existing scheduled callback by Id,those whose scheduled trigger time has already passed cannot be updated. Requires 'cjp:user' scope for authorization."
        },
        {
          "info": {
            "name": "Delete scheduled callback by Id",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{{baseUrl}}/v1/callbacks/organization/:orgId/scheduled-callback/:id",
            "params": [
              {
                "name": "orgId",
                "value": "123e4567-e89b-12d3-a456-426614174000",
                "type": "path",
                "description": "The organization ID for which the callback is being scheduled. This should be a valid UUID."
              },
              {
                "name": "id",
                "value": "5C3E69AC-3695-4D51-899B-4B4CC3ED8ECF",
                "type": "path",
                "description": "The id with which the Scheduled Callback has been created."
              }
            ]
          },
          "docs": "Delete an existing scheduled callback by Id, those whose scheduled trigger time has already passed cannot be deleted. Requires 'cjp:user' scope for authorization."
        }
      ]
    }
  ],
  "bundled": true
}