Modify Device Layout by Device ID
Modify the layout of a device by device ID in an organization.
Device layout customizes a user’s programmable line keys (PLK) on the phone and any attached Key Expansion Modules (KEM) with the existing configured line members and the user’s monitoring list.
This API requires a full or location administrator auth token with a scope of spark-admin:telephony_config_write.
URI Parameters
Modify device layout for this device ID.
Query Parameters
Modify a device layout for the device in this organization.
Body Parameters
Defines the layout mode of the device, i.e. DEFAULT or CUSTOM.
Default layout mode when a new device is added.
Enables a device to have its custom layout.
If true, user customization is enabled.
Contains a mapping of Line Keys and their corresponding actions.
An index representing a Line Key. Index starts from 1 representing the first key on the left side of the phone.
The action that would be performed when the Line Key is pressed.
PRIMARY_LINE is the user's primary extension. This is the default assignment for Line Key Index 1 and cannot be modified.
Shows the appearance of other users on the owner's phone.
Enables User and Call Park monitoring.
Enables the configure layout feature in Control Hub to set call park extension implicitly.
Allows users to reach a telephone number, extension or a SIP URI.
An open key will automatically take the configuration of a monitor button starting with the first open key. These buttons are also usable by the user to configure speed dial numbers on these keys.
Button not usable but reserved for future features.
This is applicable only when the lineKeyType is SPEED_DIAL.
This is applicable only when the lineKeyType is SPEED_DIAL and the value must be a valid Telephone Number, Ext, or SIP URI (format: user@host using A-Z,a-z,0-9,-_ .+ for user and host).
Type of KEM module.
Extension module has 14 line keys that can be configured.
Extension module has 18 line keys that can be configured.
Extension module has 20 line keys that can be configured.
Contains a mapping of KEM Keys and their corresponding actions.
An index representing a KEM Module. The Index starts from 1 representing the first KEM Module.
An index representing a KEM Key. The Index starts from 1 representing the first key on the left side of the phone.
The action that would be performed when the KEM Key is pressed.
PRIMARY_LINE is the user's primary extension. This is the default assignment for Line Key Index 1 and cannot be modified.
Shows the appearance of other users on the owner's phone.
Enables User and Call Park monitoring.
Enables the configure layout feature in Control Hub to set call park extension implicitly.
Allows users to reach a telephone number, extension or a SIP URI.
An open key will automatically take the configuration of a monitor button starting with the first open key. These buttons are also usable by the user to configure speed dial numbers on these keys.
Button not usable but reserved for future features.
Applicable only when the kemKeyType is SPEED_DIAL.
Applicable only when the kemKeyType is SPEED_DIAL. Value must be a valid Telephone Number, Ext, or SIP URI (format: user@host limited to A-Z,a-z,0-9,-_ .+ for user and host).
Response Codes
The list below describes the common success and error responses you should expect from the API.
| Code | Status | Description |
|---|---|---|
| 200 | OK | Successful request with body content. |
| 201 | Created | The request has succeeded and has led to the creation of a resource. |
| 202 | Accepted | The request has been accepted for processing. |
| 204 | No Content | Successful request without body content. |
| 400 | Bad Request | The request was invalid or cannot be otherwise served. An accompanying error message will explain further. |
| 401 | Unauthorized | Authentication credentials were missing or incorrect. |
| 403 | Forbidden | The request is understood, but it has been refused or access is not allowed. |
| 404 | Not Found | The 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. |
| 405 | Method Not Allowed | The request was made to a resource using an HTTP request method that is not supported. |
| 409 | Conflict | The 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. |
| 410 | Gone | The requested resource is no longer available. |
| 415 | Unsupported Media Type | The request was made to a resource without specifying a media type or used a media type that is not supported. |
| 423 | Locked | The 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. |
| 428 | Precondition Required | File(s) cannot be scanned for malware and need to be force downloaded. |
| 429 | Too Many Requests | Too 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. |
| 500 | Internal Server Error | Something went wrong on the server. If the issue persists, feel free to contact the Webex Developer Support team. |
| 502 | Bad Gateway | The server received an invalid response from an upstream server while processing the request. Try again later. |
| 503 | Service Unavailable | Server is overloaded with requests. Try again later. |
| 504 | Gateway Timeout | An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it. |
Header
Query Parameters
- Modify a device layout for the device in this organization.
Body
- Defines the layout mode of the device, i.e. DEFAULT or CUSTOM.
- If `true`, user customization is enabled.
- Contains a mapping of Line Keys and their corresponding actions.
- Type of KEM module.
- Contains a mapping of KEM Keys and their corresponding actions.
{
"layoutMode": "CUSTOM",
"userReorderEnabled": "true",
"lineKeys": [
{
"lineKeyIndex": 1,
"lineKeyType": "PRIMARY_LINE"
},
{
"lineKeyIndex": 2,
"lineKeyType": "SPEED_DIAL",
"lineKeyLabel": "Home",
"lineKeyValue": "213456"
}
],
"kemModuleType": "KEM_14_KEYS",
"kemKeys": [
{
"kemModuleIndex": 1,
"kemKeyIndex": 1,
"kemKeyType": "CLOSED"
},
{
"kemModuleIndex": 1,
"kemKeyIndex": 2,
"kemKeyType": "SPEED_DIAL",
"kemKeyLabel": "Office",
"kemKeyValue": "213457"
}
]
}