Test Environment. You are currently using the Webex for Developers test environment. Apps created here will not be available for use with Webex Teams. Please visit Webex for Developers to manage your apps.

List Device Configurations for device

Lists all device configurations associated with the given device ID. Administrators can list configurations for all devices within an organization.

GET/v1/deviceConfigurations
Query Parameters
deviceId
stringrequired

List device configurations by device ID.

key
string

This can optionally be used to filter configurations. Keys are composed of segments. It's possible to use absolute paths, wildcards or ranges .

  • Absolute gives only one configuration as a result. Conference.MaxReceiveCallRate for example gives the Conference MaxReceiveCallRate configuration.

  • Wildcards (*) can specify multiple configurations with shared segments. Audio.Ultrasound.* for example will filter on all Audio Ultrasound configurations.

  • Range ([_number_]) can be used to filter numbered segments. FacilityService.Service[1].Name for instance only shows the first FacilityService Service Name configuration, FacilityService.Service[*].Name shows all, FacilityService.Service[1..3].Name shows the first three and FacilityService.Service[2..n].Name shows all starting at 2. Note that RFC 3986 3.2.2 does not allow square brackets in urls outside the host, so to specify range in a configuration key you will need to encode them to %5B for [ and %5D for ].

Response Properties
deviceId
string

Id of the device that the configurations are for.

items
Device Configuration
Response Codes

The list below describes the common success and error responses you should expect from the API.

CodeStatusDescription
200OKSuccessful request with body content.
204No ContentSuccessful request without body content.
400Bad RequestThe request was invalid or cannot be otherwise served. An accompanying error message will explain further.
401UnauthorizedAuthentication credentials were missing or incorrect.
403ForbiddenThe request is understood, but it has been refused or access is not allowed.
404Not FoundThe URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.
405Method Not AllowedThe request was made to a resource using an HTTP request method that is not supported.
409ConflictThe request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.
410GoneThe requested resource is no longer available.
415Unsupported Media TypeThe request was made to a resource without specifying a media type or used a media type that is not supported.
423LockedThe requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.
428Precondition RequiredFile(s) cannot be scanned for malware and need to be force downloaded.
429Too Many RequestsToo many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.
500Internal Server ErrorSomething went wrong on the server. If the issue persists, feel free to contact the Webex Developer Support team.
502Bad GatewayThe server received an invalid response from an upstream server while processing the request. Try again later.
503Service UnavailableServer is overloaded with requests. Try again later.
504Gateway TimeoutAn upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.
GET
/v1/deviceConfigurations{?deviceId,key}
Log in to try the API.
Header
Query Parameters
  • List device configurations by device ID.
  • This can optionally be used to filter configurations. Keys are composed of segments. It's possible to use absolute paths, wildcards or ranges . - **Absolute** gives only one configuration as a result. `Conference.MaxReceiveCallRate` for example gives the Conference MaxReceiveCallRate configuration. + **Wildcards** (\*) can specify multiple configurations with shared segments. `Audio.Ultrasound.*` for example will filter on all Audio Ultrasound configurations. - **Range** ([_number_]) can be used to filter numbered segments. `FacilityService.Service[1].Name` for instance only shows the first FacilityService Service Name configuration, `FacilityService.Service[*].Name` shows all, `FacilityService.Service[1..3].Name` shows the first three and `FacilityService.Service[2..n].Name` shows all starting at 2. Note that [RFC 3986 3.2.2](https://www.ietf.org/rfc/rfc3986.html#section-3.2.2) does not allow square brackets in urls outside the host, so to specify range in a configuration key you will need to encode them to %5B for [ and %5D for ].
https://webexapis.com/v1/deviceConfigurations?deviceId=Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMl9hL0RFVklDRS9hNmYwYjhkMi01ZjdkLTQzZDItODAyNi0zM2JkNDg3NjYzMTg=
200 / OK
{
    "deviceId": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMl9hL0RFVklDRS9hNmYwYjhkMi01ZjdkLTQzZDItODAyNi0zM2JkNDg3NjYzMTg=",
    "items": {
        "Audio.Ultrasound.MaxVolume": {
            "value": 70,
            "source": "default",
            "sources": {
                "default": {
                    "value": 70,
                    "editability": {
                        "editable": false,
                        "reason": "FACTORY_DEFAULT"
                    }
                },
                "configured": {
                    "value": null,
                    "editability": {
                        "editable": true
                    }
                }
            },
            "valueSpace": {
                "type": "integer",
                "maximum": 100,
                "minimum": 0
            }
        },
        "FacilityService.Service[1].Name": {
            "value": "Live Support",
            "source": "default",
            "sources": {
                "default": {
                    "value": "Live Support",
                    "editability": {
                        "editable": false,
                        "reason": "FACTORY_DEFAULT"
                    }
                },
                "configured": {
                    "value": null,
                    "editability": {
                        "editable": true
                    }
                }
            },
            "valueSpace": {
                "type": "string",
                "maxLength": 1024,
                "minLength": 0
            }
        },
        "Conference.MaxReceiveCallRate": {
            "value": 786,
            "source": "configured",
            "sources": {
                "default": {
                    "value": 6000,
                    "editability": {
                        "editable": false,
                        "reason": "FACTORY_DEFAULT"
                    }
                },
                "configured": {
                    "value": 786,
                    "editability": {
                        "editable": true
                    }
                }
            },
            "valueSpace": {
                "type": "integer",
                "maximum": 6000,
                "minimum": 64
            }
        },
        "Video.Output.Connector[2].Resolution": {
            "value": "Auto",
            "source": "default",
            "sources": {
                "default": {
                    "value": "Auto",
                    "editability": {
                        "editable": false,
                        "reason": "FACTORY_DEFAULT"
                    }
                },
                "configured": {
                    "value": null,
                    "editability": {
                        "editable": false,
                        "reason": "CONFIG_MANAGED_BY_DIFFERENT_AUTHORITY"
                    }
                }
            },
            "valueSpace": {
                "enum": [
                    "1920_1080_50",
                    "1920_1080_60",
                    "1920_1200_50",
                    "1920_1200_60",
                    "2560_1440_60",
                    "3840_2160_30",
                    "3840_2160_60",
                    "Auto"
                ],
                "type": "string"
            }
        }
    }
}