Update a Virtual Line
Update the designated Virtual Line.
Virtual line is a capability in Webex Calling that allows administrators to configure multiple lines to Webex Calling users.
Updating a virtual line requires a full or user or location administrator auth token with a scope of spark-admin:telephony_config_write.
URI Parameters
Update settings for a virtual line with the matching ID.
Query Parameters
Update virtual line settings from this organization.
Body Parameters
First name defined for a virtual line. Minimum length is 1. Maximum length is 64.
Last name defined for a virtual line. Minimum length is 1. Maximum length is 64.
Display name defined for a virtual line.
Phone number of a virtual line. Minimum length is 1. Maximum length is 23. Either phoneNumber or extension is mandatory.
Extension of a virtual line. Minimum length is 2. Maximum length is 10. Either phoneNumber or extension is mandatory.
Virtual Line's announcement language.
Last name used in the Calling Line ID and for dial-by-name functions. Minimum length is 1. Maximum length is 64.
First name used in the Calling Line ID and for dial-by-name functions. Minimum length is 1. Maximum length is 128.
Phone number to appear as the CLID for all calls. Minimum length is 1. Maximum length is 23.
Time zone defined for the virtual line.
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
- Update virtual line settings from this organization.
Body
- First name defined for a virtual line. Minimum length is 1. Maximum length is 64.
- Last name defined for a virtual line. Minimum length is 1. Maximum length is 64.
- Display name defined for a virtual line.
- Phone number of a virtual line. Minimum length is 1. Maximum length is 23. Either `phoneNumber` or `extension` is mandatory.
- Extension of a virtual line. Minimum length is 2. Maximum length is 10. Either `phoneNumber` or `extension` is mandatory.
- Virtual Line's announcement language.
- Last name used in the Calling Line ID and for dial-by-name functions. Minimum length is 1. Maximum length is 64.
- First name used in the Calling Line ID and for dial-by-name functions. Minimum length is 1. Maximum length is 128.
- Phone number to appear as the CLID for all calls. Minimum length is 1. Maximum length is 23.
- Time zone defined for the virtual line.
{
"firstName": "Bob",
"lastName": "Smith",
"displayName": "Bob Smith",
"phoneNumber": "+15558675309",
"extension": "5309",
"announcementLanguage": "French",
"callerIdFirstName": "Bob",
"callerIdLastName": "Smith",
"callerIdNumber": "+15558675309",
"timeZone": "Africa/Algiers"
}