{ "opencollection": "1.0.0", "info": { "name": "Webex Admin Address Book Devices API", "version": "1.0.0" }, "items": [ { "info": { "name": "Devices", "type": "folder" }, "items": [ { "info": { "name": "List Devices", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/devices", "params": [ { "name": "max", "value": "100", "type": "query", "description": "Limit the maximum number of devices in the response." }, { "name": "start", "value": "", "type": "query", "description": "\nOffset. Default is 0.\n" }, { "name": "displayName", "value": "SFO12-3-PanHandle", "type": "query", "description": "\nList devices with this display name.\n" }, { "name": "personId", "value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS83MTZlOWQxYy1jYTQ0LTRmZWQtOGZjYS05ZGY0YjRmNDE3ZjU", "type": "query", "description": "\nList devices by person ID.\n" }, { "name": "workspaceId", "value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS81MTAxQjA3Qi00RjhGLTRFRjctQjU2NS1EQjE5QzdCNzIzRjc=", "type": "query", "description": "\nList devices by workspace ID.\n" }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "\nList devices in this organization. Only admin users of another organization (such as partners) may use this parameter.\n" }, { "name": "connectionStatus", "value": "", "type": "query", "description": "\nList devices with this connection status.\n" }, { "name": "product", "value": "", "type": "query", "description": "\nList devices with this product name.\n" }, { "name": "type", "value": "", "type": "query", "description": "\nList devices with this type.\n" }, { "name": "serial", "value": "", "type": "query", "description": "\nList devices with this serial number.\n" }, { "name": "tag", "value": "", "type": "query", "description": "\nList devices which have a tag. Searching for multiple tags (logical AND) can be done by comma separating the `tag` values or adding several `tag` parameters.\n" }, { "name": "software", "value": "", "type": "query", "description": "\nList devices with this software version.\n" }, { "name": "upgradeChannel", "value": "", "type": "query", "description": "\nList devices with this upgrade channel.\n" }, { "name": "errorCode", "value": "", "type": "query", "description": "\nList devices with this error code.\n" }, { "name": "capability", "value": "xapi", "type": "query", "description": "\nList devices with this capability.\n" }, { "name": "permission", "value": "", "type": "query", "description": "\nList devices with this permission.\n" }, { "name": "locationId", "value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS81MTAxQjA3Qi00RjhGLTRFRjctQjU2NS1EQjE5QzdCNzIzRjc=", "type": "query", "description": "\nList devices by location ID.\n" }, { "name": "workspaceLocationId", "value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS81MTAxQjA3Qi00RjhGLTRFRjctQjU2NS1EQjE5QzdCNzIzRjc=", "type": "query", "description": "\nList devices by workspace location ID. Deprecated, prefer `locationId`.\n" }, { "name": "mac", "value": "", "type": "query", "description": "\nList devices with this MAC address.\n" }, { "name": "devicePlatform", "value": "cisco", "type": "query", "description": "\nList devices with this device platform.\n" }, { "name": "plannedMaintenance", "value": "off", "type": "query", "description": "\nList devices with this planned maintenance.\n" } ] }, "docs": "Lists all active Webex devices associated with the authenticated user, such as devices activated in personal mode. This requires the `spark:devices_read` scope. Administrators can list all devices within their organization. This requires an administrator auth token with the `spark-admin:devices_read` scope." }, { "info": { "name": "Create a Device by MAC Address", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/devices", "params": [ { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLXdlc3QtMl9yL09SR0FOSVpBVElPTi9mN2I3MzYwYy1lMDcxLTQwN2EtYTU1Ny04NDI4YmIyMjhlODQ", "type": "query", "description": "The organization associated with the device. If left empty, the organization associated with the caller will be used." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a phone by its MAC address in a specific workspace or for a person.\n\nSpecify the `mac`, `model` and either `workspaceId` or `personId`.\n\n* You can get the `model` from the [supported devices](/docs/api/v1/device-call-settings/read-the-list-of-supported-devices) API.\n\n* Either `workspaceId` or `personId` should be provided. If both are supplied, the request will be invalid.\n\n* The `password` field is only required for third party devices. You can obtain the required third party phone confi" }, { "info": { "name": "Get Device Details", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/devices/:deviceId", "params": [ { "name": "deviceId", "value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9ERVZJQ0UvNTEwMUIwN0ItNEY4Ri00RUY3LUI1NjUtREIxOUM3QjcyM0Y3", "type": "path", "description": "\nA unique identifier for the device.\n" }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLXdlc3QtMl9yL09SR0FOSVpBVElPTi9mN2I3MzYwYy1lMDcxLTQwN2EtYTU1Ny04NDI4YmIyMjhlODQ", "type": "query", "description": "The organization associated with the device. If left empty, the organization associated with the caller will be used." } ] }, "docs": "Shows details for a device, by ID. This requires an auth token with the `spark:devices_read` scope to see your own device, or `spark-admin:devices_read` to see any other device in your organization.\n\nSpecify the device ID in the `deviceId` parameter in the URI." }, { "info": { "name": "Modify Device Tags", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/devices/:deviceId", "params": [ { "name": "deviceId", "value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9ERVZJQ0UvNTEwMUIwN0ItNEY4Ri00RUY3LUI1NjUtREIxOUM3QjcyM0Y3", "type": "path", "description": "Unique identifier for the device." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLXdlc3QtMl9yL09SR0FOSVpBVElPTi9mN2I3MzYwYy1lMDcxLTQwN2EtYTU1Ny04NDI4YmIyMjhlODQ", "type": "query", "description": "The organization associated with the device. If left empty, the organization associated with the caller will be used." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create, delete or update tags on a device. For your own device, this requires an auth token with the `spark:devices_write` scope. An auth token with the `spark-admin:devices_write` scope is required to operate on other devices within the organization.\n\nSpecify the device ID in the `deviceId` parameter in the URI.\n\nInclude only the tag array in the request body, no other device attributes can be changed. This action will overwrite any previous tags. A common approach is to first [GET the devices'" }, { "info": { "name": "Delete a Device", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/devices/:deviceId", "params": [ { "name": "deviceId", "value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9ERVZJQ0UvNTEwMUIwN0ItNEY4Ri00RUY3LUI1NjUtREIxOUM3QjcyM0Y3", "type": "path", "description": "A unique identifier for the device." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLXdlc3QtMl9yL09SR0FOSVpBVElPTi9mN2I3MzYwYy1lMDcxLTQwN2EtYTU1Ny04NDI4YmIyMjhlODQ", "type": "query", "description": "The organization associated with the device. If left empty, the organization associated with the caller will be used." } ] }, "docs": "Deletes a device, by ID. Deleting your own device requires an auth token with the `spark:devices_write` scope. Deleting any other device in the organization will require an administrator auth token with the `spark-admin:devices_write` scope.\n\nSpecify the device ID in the `deviceId` parameter in the URI.\n\n
Deleting a device from a person with a Webex Calling Standard license will enable Webex Calling across their Webex mobile, tablet, desktop, and browser applications." }, { "info": { "name": "Create a Device Activation Code", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/devices/activationCode", "params": [ { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLXdlc3QtMl9yL09SR0FOSVpBVElPTi9mN2I3MzYwYy1lMDcxLTQwN2EtYTU1Ny04NDI4YmIyMjhlODQ", "type": "query", "description": "The organization associated with the activation code generated. If left empty, the organization associated with the caller will be used." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Generate an activation code for a device in a specific workspace by `workspaceId` or for a person by `personId`. This requires an auth token with the `spark-admin:devices_write` scope, and either `identity:placeonetimepassword_create` (allows creating activation codes for workspaces only) or `identity:one_time_password` (allows creating activation codes for workspaces or persons).\n\n* Adding a device to a workspace with calling type `none` or `thirdPartySipCalling` will reset the workspace callin" } ] } ], "bundled": true }