Device Call Settings - Apply a Line Key Template

Apply a Line Key Template

Apply a Line Key Template or reset devices to their factory Line Key settings.

Line Keys, also known as Programmable Line Keys (PLK), are the keys found on either side of a typical desk phone display. A Line Key Template is a definition of actions that will be performed by each of the Line Keys for a particular device model. This API allows users to apply a line key template or apply factory default Line Key settings to devices in a set of locations or across all locations in the organization.

Applying a Line Key Template or resetting devices to their default Line Key configuration requires a full administrator auth token with a scope of spark-admin:telephony_config_write.

POST/v1/telephony/config/jobs/devices/applyLineKeyTemplate

Query Parameters

orgId

string

Apply Line Key Template for this organization.

Body Parameters

action

enumrequired

Line key Template action to perform.

APPLY_TEMPLATE

string

Used to apply LinekeyTemplate to devices.

APPLY_DEFAULT_TEMPLATES

string

Used to reset devices to its default Linekey Template configurations.

templateId

stringrequired

templateId is required for APPLY_TEMPLATE action.

locationIds

array[string]

Used to search for devices only in the given locations.

excludeDevicesWithCustomLayout

boolean

Indicates whether to exclude devices with custom layout.

includeDeviceTags

array[string]

Include devices only with these tags.

excludeDeviceTags

array[string]

Exclude devices with these tags.

advisoryTypes

LineKeyTemplateAdvisoryTypes

Refine search with advisories.

moreSharedAppearancesEnabled

boolean

Refine search to apply changes to devices that contain the warning "More shared/virtual line appearances than shared/virtual lines requested".

fewSharedAppearancesEnabled

boolean

Refine search to apply changes to devices that contain the warning "More shared/virtual lines requested than shared/virtual line appearances".

moreMonitorAppearancesEnabled

boolean

Refine search to apply changes to devices that contain the warning "More monitored line appearances than monitored lines in the user's monitoring list".

moreCPEAppearancesEnabled

boolean

Refine search to apply changes to devices that contain the warning "More call park extension line appearances than call park extensions in user's monitoring list".

moreModeManagementAppearancesEnabled

boolean

Refine search to apply changes to devices that contain the warning "More mode management lines configured for the device". The default value is false.

Response Properties

name

string

Job name.

string

Unique identifier of the job.

trackingId

string

Unique identifier to track the flow of HTTP requests.

sourceUserId

string

Unique identifier to identify which user has run the job.

sourceCustomerId

string

Unique identifier to identify the customer who has run the job.

targetCustomerId

string

Unique identifier to identify the customer for which the job was run.

instanceId

number

Unique identifier to identify the instance of the job.

jobExecutionStatus

array[JobExecutionStatusObject]

Displays the most recent step's execution status. Contains execution statuses of all the steps involved in the execution of the job.

number

Unique identifier that identifies each instance of the job.

startTime

string

Step execution start time in UTC format.

endTime

string

Step execution end time in UTC format.

lastUpdated

string

Last updated time (in UTC format) post one of the step execution completion.

statusMessage

string

Displays status for overall steps that are part of the job.

exitCode

string

Exit Code for a job.

createdTime

string

Job creation time in UTC format.

timeElapsed

string

Time lapsed since the job execution started.

stepExecutionStatuses

array[stepExecutionStatusesObject]

Status of each step within a job.

number

Unique identifier that identifies each step in a job.

startTime

string

Step execution start time in UTC format.

endTime

string

Step execution end time in UTC format.

lastUpdated

string

Last updated time for a step in UTC format.

statusMessage

string

Displays the status of a step.

exitCode

string

Exit Code for a step.

name

string

Name of different steps the job goes through.

timeElapsed

string

Time lapsed since the step execution started.

latestExecutionStatus

string

Indicates the most recent status (STARTING, STARTED, COMPLETED, FAILED) of the job at the time of invocation.

latestExecutionExitCode

enum

Most recent exit code of the job at the time of invocation.

UNKNOWN

string

Job is in progress.

COMPLETED

string

Job has completed successfully.

FAILED

string

Job has failed.

STOPPED

string

Job has been stopped.

COMPLETED_WITH_ERRORS

string

Job has completed with errors.

percentageComplete

string

Indicates the progress of the job.

updatedCount

string

Number of job steps completed.

advisoryCount

string

Number of job steps completed with advisories.

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.

POST

/v1/telephony/config/jobs/devices/applyLineKeyTemplate{?orgId}

Header

Content-Type
Authorization
Use personal access token
Bearer
This limited-duration personal access token is hidden for your security.

Query Parameters

orgId
string
Apply Line Key Template for this organization.

Body

action
enumRequired
Line key Template action to perform.
templateId
stringRequired
`templateId` is required for `APPLY_TEMPLATE` action.
locationIds
array
Used to search for devices only in the given locations.
excludeDevicesWithCustomLayout
boolean
Indicates whether to exclude devices with custom layout.
includeDeviceTags
array
Include devices only with these tags.
excludeDeviceTags
array
Exclude devices with these tags.
advisoryTypes
LineKeyTemplateAdvisoryTypes
Refine search with advisories.

https://webexapis.com/v1/telephony/config/jobs/devices/applyLineKeyTemplate?orgId=Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE

{
    "action": "APPLY_TEMPLATE",
    "templateId": "Y2lzY29zcGFyazovL3VzL0RFVklDRV9MSU5FX0tFWV9URU1QTEFURS81NzVhMWY3Zi03MjRkLTRmZGUtODk4NC1mNjNhNDljMzYxZmQ",
    "locationIds": [
        "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2E4Mjg5NzIyLTFiODAtNDFiNy05Njc4LTBlNzdhZThjMTA5OA"
    ],
    "excludeDevicesWithCustomLayout": "true",
    "includeDeviceTags": [
        "accounting",
        "sales"
    ],
    "excludeDeviceTags": [
        "admin"
    ],
    "advisoryTypes": {
        "moreSharedAppearancesEnabled": "true",
        "fewSharedAppearancesEnabled": "true",
        "moreMonitorAppearancesEnabled": "true",
        "moreCPEAppearancesEnabled": "true",
        "moreModeManagementAppearancesEnabled": "true"
    }
}

202 / Accepted

{
    "name": "applyphonelinekeytemplates",
    "id": "Y2lzY29zcGFyazovL3VzL0pPQl9JRC8wZTJjNmI5NC1hNDdlLTQxZGUtODE5ZS04YTcwNTZjMTc5MDk",
    "trackingId": "NA_a9ef6908-60cf-40e6-b56f-461abffd6fa3",
    "sourceUserId": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS85OThhMThhYi1kZjY5LTQ5MWYtYmViZi03MzUxMGE3ODI5N2I",
    "sourceCustomerId": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi9hNDVkNmNkYS1hZTVhLTQwYzMtYTdhZC01NjUwZmRkZGQ1M2M",
    "targetCustomerId": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi9hNDVkNmNkYS1hZTVhLTQwYzMtYTdhZC01NjUwZmRkZGQ1M2M",
    "instanceId": 0,
    "jobExecutionStatus": [
        {
            "id": 0,
            "startTime": "2023-07-05T21:36:53.749Z",
            "lastUpdated": "2023-07-05T21:37:06.714Z",
            "statusMessage": "STARTED",
            "exitCode": "UNKNOWN",
            "createdTime": "2023-07-05T21:36:53.551Z",
            "stepExecutionStatuses": [
                {
                    "id": 0,
                    "startTime": "2023-07-05T21:36:54.601Z",
                    "lastUpdated": "2023-07-05T21:37:06.078Z",
                    "statusMessage": "STARTED",
                    "exitCode": "UNKNOWN",
                    "name": "applyphonelinekeytemplatesProcess",
                    "timeElapsed": "PT11.476S"
                }
            ],
            "timeElapsed": "PT11.476S"
        }
    ],
    "latestExecutionStatus": "STARTED",
    "latestExecutionExitCode": "UNKNOWN",
    "percentageComplete": 10,
    "updatedCount": 1,
    "advisoryCount": 0
}