{ "opencollection": "1.0.0", "info": { "name": "Webex Admin Address Book Contact Number API", "version": "1.0.0" }, "items": [ { "info": { "name": "Contact Number", "type": "folder" }, "items": [ { "info": { "name": "Create a new Contact Number", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/organization/:orgid/contact-number", "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 Contact Number in a given organization." }, { "info": { "name": "List all contact numbers(property - number)", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/contact-number/all-numbers", "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." } ] }, "docs": "Retrieve a list of only contact numbers(property - number) from Contact Number(s) without pagination in a given organization." }, { "info": { "name": "Bulk save Contact Number(s)", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/organization/:orgid/contact-number/bulk", "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, Update or delete Contact Number(s) in bulk in a given organization." }, { "info": { "name": "Bulk export Contact Number(s)", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/contact-number/bulk-export", "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": "page", "value": "", "type": "query", "description": "Defines the number of displayed page. The page number starts from 0." }, { "name": "pageSize", "value": "", "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." } ] }, "docs": "Export all Contact Number(s) in a given organization." }, { "info": { "name": "Get specific Contact Number by ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/contact-number/: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", "type": "path", "description": "Resource ID of the Contact Number." } ] }, "docs": "Retrieve an existing Contact Number by ID in a given organization." }, { "info": { "name": "Update specific Contact Number by ID", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/organization/:orgid/contact-number/: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", "type": "path", "description": "Resource ID of the Contact Number." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an existing Contact Number by ID in a given organization." }, { "info": { "name": "Delete specific Contact Number by ID", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/organization/:orgid/contact-number/: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", "type": "path", "description": "Resource ID of the Contact Number." } ] }, "docs": "Delete an existing Contact Number by ID in a given organization." }, { "info": { "name": "List Contact Number(s)", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/v2/contact-number", "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. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \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 space, and if so kindly bound it with quotes to apply filter.\n" }, { "name": "attributes", "value": "id", "type": "query", "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported" }, { "name": "search", "value": "contact center", "type": "query", "description": "Filter data based on the search keyword." }, { "name": "page", "value": "", "type": "query", "description": "Defines the number of displayed page. The page number starts from 0." }, { "name": "pageSize", "value": "", "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." } ] }, "docs": "Retrieve a list of Contact Number(s) in a given organization." } ] } ], "bundled": true }