Retrieve the list of Translation Patterns
Retrieve a list of translation patterns for a given organization.
A translation pattern lets you manipulate dialed digits before routing a call and applies to outbound calls only. See this article for details about the translation pattern syntax.
Requires a full or read-only administrator auth token with a scope of spark-admin:telephony_config_read.
Query Parameters
ID of the organization containing the translation patterns.
When a location ID is passed, then return only the corresponding location level translation patterns.
When set to be true, then return only the organization-level translation patterns.
Limit the number of objects returned to this maximum count.
Start at the zero-based offset in the list of matching objects.
Sort the list of translation patterns according to translation pattern name, ascending or descending.
Only return translation patterns with the matching name.
Only return translation patterns with the matching matchingPattern.
Response Properties
List of translation pattern information.
Unique identifier for a translation pattern.
Name given to a translation pattern for an organization.
Matching pattern given to a translation pattern for an organization.
Replacement pattern given to a translation pattern for an organization.
Level at which the translation pattern is created. The level can either be Organization or Location.
Location details for the translation pattern when the level is Location.
Unique identifier for the location.
A unique name for the location.
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
- ID of the organization containing the translation patterns.
- When a location ID is passed, then return only the corresponding location level translation patterns.
- When set to be `true`, then return only the organization-level translation patterns.
- Limit the number of objects returned to this maximum count.
- Start at the zero-based offset in the list of matching objects.
- Sort the list of translation patterns according to translation pattern name, ascending or descending.
- Only return translation patterns with the matching `name`.
- Only return translation patterns with the matching `matchingPattern`.
{
"translationPatterns": [
{
"id":"Y2lzY29zcGFyazovL3VzL1NDSEVEVUxFL1FWVlVUMEZVVkVWT1JFRk9WQzFDVlZOSlRrVlRVeTFJVDFWU1V3",
"name":"TranslationPattern1",
"matchingPattern":"781",
"replacementPattern":"+91348781",
"level": "Organization"
},
{
"id":"Y2lzY29zcGFyazovL3VzL1NDSEVEVUxFL1FWVlVUMEZVVkVWT1JFRk9WQzFDVlZOSlRrVlRVeTFJVDFWU1V5",
"name":"TranslationPattern2",
"matchingPattern":"2XXX",
"replacementPattern":"2013",
"level": "Location",
"location": {
"name": "CHN11",
"id": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzc4YzU5NDE2LTQ5YWQtNDVlMy04NmIyLTFkZjU5M2IyZDdhYQ"
}
}
]
}