{
"opencollection": "1.0.0",
"info": {
"name": "Webex Admin Address Book Agent Personal Greeting Files API",
"version": "1.0.0"
},
"items": [
{
"info": {
"name": "Agent Personal Greeting Files",
"type": "folder"
},
"items": [
{
"info": {
"name": "Create a new Greeting File",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/organization/:orgid/agent-personal-greeting",
"params": [
{
"name": "orgid",
"value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1",
"type": "path",
"description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create a new agent personal greeting File for a given organization."
},
{
"info": {
"name": "deleteReferences_1",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/organization/:orgid/agent-personal-greeting/delete-reference",
"params": [
{
"name": "orgid",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
}
},
{
"info": {
"name": "Get specific Greeting File by ID",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/organization/:orgid/agent-personal-greeting/:id",
"params": [
{
"name": "orgid",
"value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1",
"type": "path",
"description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization."
},
{
"name": "id",
"value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba2",
"type": "path",
"description": "Resource ID of the Greeting File."
},
{
"name": "includeUrl",
"value": "true",
"type": "query",
"description": "Indicates if the URL for downloading Greeting Fileshould be included in the response."
}
]
},
"docs": "Retrieve an existing Greeting File by ID in a given organization."
},
{
"info": {
"name": "Update specific Greeting File by ID",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/organization/:orgid/agent-personal-greeting/:id",
"params": [
{
"name": "orgid",
"value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1",
"type": "path",
"description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization."
},
{
"name": "id",
"value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba2",
"type": "path",
"description": "Resource ID of the Greeting File."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update specific Greeting File by ID in a given organization."
},
{
"info": {
"name": "Partially update Greeting File by ID",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "{{baseUrl}}/organization/:orgid/agent-personal-greeting/:id",
"params": [
{
"name": "orgid",
"value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1",
"type": "path",
"description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization."
},
{
"name": "id",
"value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba2",
"type": "path",
"description": "Resource ID of the Greeting File."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Partially update Greeting File by ID in a given organization."
},
{
"info": {
"name": "Delete specific Greeting File by ID",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/organization/:orgid/agent-personal-greeting/:id",
"params": [
{
"name": "orgid",
"value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1",
"type": "path",
"description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization."
},
{
"name": "id",
"value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba2",
"type": "path",
"description": "Resource ID of the Greeting File."
}
]
},
"docs": "Delete an existing Greeting File by ID for a given organization."
},
{
"info": {
"name": "getAllConfigWithMetaData",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/organization/:orgid/v2/agent-personal-greeting",
"params": [
{
"name": "orgid",
"value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1",
"type": "path",
"description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization."
},
{
"name": "filter",
"value": "id==\"2f9eecc5-0472-4549-9a83-2afdae0d4ba1\"",
"type": "query",
"description": "Specify a filter based on which the results will be fetched. Supported fields are : firstname, lastname, email, ciUserId and attribute tag \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n"
},
{
"name": "search",
"value": "contact center",
"type": "query",
"description": "Filter data based on the search keyword.Supported search columns(firstName, lastName, email, attributeTag)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"firstName\";value==\"Cisco\"\n- fields=in=(\"firstName\",\"email\");value==\"Cisco\"\n"
},
{
"name": "attributes",
"value": "id",
"type": "query",
"description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported."
},
{
"name": "page",
"value": "0",
"type": "query",
"description": "Defines the number of displayed page. The page number starts from 0."
},
{
"name": "pageSize",
"value": "100",
"type": "query",
"description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size."
},
{
"name": "includeAgentDetails",
"value": "",
"type": "query",
"description": "If includeAgentDetails is set to true then projection, filtering, searching, and sorting on agent firstName, lastName and email will be enabled."
}
]
}
},
{
"info": {
"name": "Create a new Greeting File using v2 API",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/organization/:orgid/v2/agent-personal-greeting",
"params": [
{
"name": "orgid",
"value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1",
"type": "path",
"description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create a new Greeting File using v2 API"
},
{
"info": {
"name": "Get specific Greeting File by ID using v2 API",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/organization/:orgid/v2/agent-personal-greeting/:id",
"params": [
{
"name": "orgid",
"value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1",
"type": "path",
"description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization."
},
{
"name": "id",
"value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba2",
"type": "path",
"description": "Resource ID of the Greeting File."
},
{
"name": "includeUrl",
"value": "true",
"type": "query",
"description": "Indicates if the URL for downloading Greeting Fileshould be included in the response."
}
]
},
"docs": "Retrieve an existing Greeting File by ID in a given organization."
},
{
"info": {
"name": "Update specific Greeting File by ID using v2 API",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/organization/:orgid/v2/agent-personal-greeting/:id",
"params": [
{
"name": "orgid",
"value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1",
"type": "path",
"description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization."
},
{
"name": "id",
"value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba2",
"type": "path",
"description": "Resource ID of the Greeting File."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update specific Greeting File by ID in a given organization."
},
{
"info": {
"name": "Partially update Greeting File by ID using v2 API",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "{{baseUrl}}/organization/:orgid/v2/agent-personal-greeting/:id",
"params": [
{
"name": "orgid",
"value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1",
"type": "path",
"description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization."
},
{
"name": "id",
"value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba2",
"type": "path",
"description": "Resource ID of the Greeting File."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Partially update Greeting File by ID in a given organization."
},
{
"info": {
"name": "Delete specific Greeting File by ID using v2 API",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/organization/:orgid/v2/agent-personal-greeting/:id",
"params": [
{
"name": "orgid",
"value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1",
"type": "path",
"description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization."
},
{
"name": "id",
"value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba2",
"type": "path",
"description": "Resource ID of the Greeting File."
}
]
},
"docs": "Delete an existing Greeting File by ID for a given organization."
},
{
"info": {
"name": "List Greeting File(s)",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/organization/:orgid/v3/agent-personal-greeting",
"params": [
{
"name": "orgid",
"value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1",
"type": "path",
"description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization."
},
{
"name": "filter",
"value": "id==\"2f9eecc5-0472-4549-9a83-2afdae0d4ba1\"",
"type": "query",
"description": "Specify a filter based on which the results will be fetched. Supported fields are : firstname, lastname, email, ciUserId and attribute tag \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n"
},
{
"name": "search",
"value": "contact center",
"type": "query",
"description": "Filter data based on the search keyword.Supported search columns(firstName, lastName, email, attributeTag)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"firstName\";value==\"Cisco\"\n- fields=in=(\"firstName\",\"email\");value==\"Cisco\"\n"
},
{
"name": "attributes",
"value": "id",
"type": "query",
"description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported."
},
{
"name": "page",
"value": "0",
"type": "query",
"description": "Defines the number of displayed page. The page number starts from 0."
},
{
"name": "pageSize",
"value": "100",
"type": "query",
"description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size."
},
{
"name": "includeAgentDetails",
"value": "",
"type": "query",
"description": "If includeAgentDetails is set to true then projection, filtering, searching, and sorting on agent firstName, lastName and email will be enabled."
}
]
},
"docs": "Retrieve a list of Greeting File(s) in a given organization."
}
]
}
],
"bundled": true
}