\n\n
This API is only supported for non-integrated PSTN connection types "
},
{
"info": {
"name": "Validate phone numbers",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/telephony/config/actions/validateNumbers/invoke",
"params": [
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Organization of the Route Group."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Validate the list of phone numbers in an organization. Each phone number's availability is indicated in the response.\n\nEach location has a set of phone numbers that can be assigned to people, workspaces, or features. Phone numbers must follow the E.164 format for all countries, except for the United States, which can also follow the National format. Active phone numbers are in service.\n\nValidating a phone number in an organization requires a full administrator or location administrator auth toke"
},
{
"info": {
"name": "Get Phone Numbers for an Organization with Given Criteria",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/numbers",
"params": [
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "List numbers for this organization."
},
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzEyMzQ1",
"type": "query",
"description": "Return the list of phone numbers for this location within the given organization. The maximum length is 36."
},
{
"name": "max",
"value": "5",
"type": "query",
"description": "Limit the number of phone numbers returned to this maximum count. The default is 2000."
},
{
"name": "start",
"value": "0",
"type": "query",
"description": "Start at the zero-based offset in the list of matching phone numbers. The default is 0."
},
{
"name": "phoneNumber",
"value": "+12056852221",
"type": "query",
"description": "Search for this `phoneNumber`."
},
{
"name": "available",
"value": "true",
"type": "query",
"description": "Search among the available phone numbers. This parameter cannot be used along with `ownerType` parameter when set to `true`."
},
{
"name": "order",
"value": "lastName-asc",
"type": "query",
"description": "Sort the list of phone numbers based on the following:`lastName`,`dn`,`extension`. Sorted by number and extension in ascending order."
},
{
"name": "ownerName",
"value": "Mark",
"type": "query",
"description": "Return the list of phone numbers that are owned by the given `ownerName`. Maximum length is 255."
},
{
"name": "ownerId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS80M2QzYjY4ZC04MjkwLTRmMzctOTM2NS03MmNhMTcxMzRiODM",
"type": "query",
"description": "Returns only the matched number/extension entries assigned to the feature with the specified UUID or `broadsoftId`."
},
{
"name": "ownerType",
"value": "PEOPLE",
"type": "query",
"description": "Returns the list of phone numbers of the given `ownerType`. Possible input values:"
},
{
"name": "extension",
"value": "000",
"type": "query",
"description": "Returns the list of phone numbers with the given extension."
},
{
"name": "numberType",
"value": "NUMBER",
"type": "query",
"description": "Returns the filtered list of phone numbers that contain a given type of number. `available` or `state` query parameters cannot be used when `numberType=EXTENSION`. Possible input values:"
},
{
"name": "phoneNumberType",
"value": "PRIMARY",
"type": "query",
"description": "Returns the filtered list of phone numbers of the given `phoneNumberType`. Response excludes any extensions without numbers. Possible input values:"
},
{
"name": "state",
"value": "ACTIVE",
"type": "query",
"description": "Returns the list of phone numbers with the matching state. Response excludes any extensions without numbers. Possible input values:"
},
{
"name": "details",
"value": "true",
"type": "query",
"description": "Returns the overall count of the phone numbers along with other details for a given organization."
},
{
"name": "tollFreeNumbers",
"value": "true",
"type": "query",
"description": "Returns the list of toll-free phone numbers."
},
{
"name": "restrictedNonGeoNumbers",
"value": "true",
"type": "query",
"description": "Returns the list of restricted non-geographical numbers."
},
{
"name": "includedTelephonyTypes",
"value": "PSTN_NUMBER",
"type": "query",
"description": "Returns the list of phone numbers that are of given `includedTelephonyTypes`. By default, if this query parameter is not provided, it will list both PSTN and Mobile Numbers. Possible input values are PSTN_NUMBER or MOBILE_NUMBER."
},
{
"name": "serviceNumber",
"value": "true",
"type": "query",
"description": "Returns the list of service phone numbers."
}
]
},
"docs": "List all the phone numbers for the given organization along with the status and owner (if any).\n\nNumbers can be standard, service, or mobile. Both standard and service numbers are PSTN numbers.\nService numbers are considered high-utilization or high-concurrency phone numbers and can be assigned to features like auto-attendants, call queues, and hunt groups.\nPhone numbers can be linked to a specific location, be active or inactive, and be assigned or unassigned.\nThe owner of a number is the perso"
},
{
"info": {
"name": "List Manage Numbers Jobs",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/jobs/numbers/manageNumbers",
"params": [
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi80YTViYjVhOC1hZDAwLTQ0ZGEtODg2NC0wYjExNTE0NDQyYzk",
"type": "query",
"description": "Retrieve list of Manage Number jobs for this organization."
},
{
"name": "start",
"value": "0",
"type": "query",
"description": "Start at the zero-based offset in the list of jobs. Default is 0."
},
{
"name": "max",
"value": "2000",
"type": "query",
"description": "Limit the number of jobs returned to this maximum count. Default is 2000."
}
]
},
"docs": "Lists all Manage Numbers jobs for the given organization in order of most recent one to oldest one irrespective of its status.\n\nThe public API only supports initiating jobs which move numbers between locations.\n\nVia Control Hub they can initiate both the move and delete, so this listing can show both.\n\nThis API requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`."
},
{
"info": {
"name": "Initiate Number Jobs",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/telephony/config/jobs/numbers/manageNumbers",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Starts the execution of an operation on a set of numbers. Supported operations are: `MOVE`, `NUMBER_USAGE_CHANGE`.\n\nUp to 1000 numbers can be given in `MOVE` operation type and `NUMBER_USAGE_CHANGE` operation type per request.\nIf another move number job request is initiated while a move job is in progress, the API call will receive a `409` HTTP status code.\n\nIn order to move a number the following is required:\n\n* The number must be unassigned.\n\n* Both locations must have the same PSTN Connection"
},
{
"info": {
"name": "Get Manage Numbers Job Status",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/jobs/numbers/manageNumbers/:jobId",
"params": [
{
"name": "jobId",
"value": "Y2lzY29zcGFyazovL3VzL0pPQl9JRC83ZWUyMjAzMS0xM2Q5LTRmYTctODQ0NS1lNDMzNjE3MmVjYmU",
"type": "path",
"description": "Retrieve job details for this `jobId`."
}
]
},
"docs": "Returns the status and other details of the job.\n\nThis API requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`."
},
{
"info": {
"name": "Pause the Manage Numbers Job",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/telephony/config/jobs/numbers/manageNumbers/:jobId/actions/pause/invoke",
"params": [
{
"name": "jobId",
"value": "Y2lzY29zcGFyazovL3VzL0pPQl9JRC83ZWUyMjAzMS0xM2Q5LTRmYTctODQ0NS1lNDMzNjE3MmVjYmU",
"type": "path",
"description": "Pause the Manage Numbers job for this `jobId`."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi80YTViYjVhOC1hZDAwLTQ0ZGEtODg2NC0wYjExNTE0NDQyYzk",
"type": "query",
"description": "Pause the Manage Numbers job for this organization."
}
]
},
"docs": "Pause the running Manage Numbers Job. A paused job can be resumed.\n\nThis API requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`."
},
{
"info": {
"name": "Resume the Manage Numbers Job",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/telephony/config/jobs/numbers/manageNumbers/:jobId/actions/resume/invoke",
"params": [
{
"name": "jobId",
"value": "Y2lzY29zcGFyazovL3VzL0pPQl9JRC83ZWUyMjAzMS0xM2Q5LTRmYTctODQ0NS1lNDMzNjE3MmVjYmU",
"type": "path",
"description": "Resume the Manage Numbers job for this `jobId`."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi80YTViYjVhOC1hZDAwLTQ0ZGEtODg2NC0wYjExNTE0NDQyYzk",
"type": "query",
"description": "Resume the Manage Numbers job for this organization."
}
]
},
"docs": "Resume the paused Manage Numbers Job. A paused job can be resumed.\n\nThis API requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`."
},
{
"info": {
"name": "List Manage Numbers Job errors",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/jobs/numbers/manageNumbers/:jobId/errors",
"params": [
{
"name": "jobId",
"value": "Y2lzY29zcGFyazovL3VzL0pPQl9JRC84YTI0ZjM5NC1lMTdjLTRiMTYtOTU3Ni0zNzA3YjY5YmU3Mzc",
"type": "path",
"description": "Retrieve the error details for this `jobId`."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85MTE1NDM1Ny1iZWQxLTQ1ZDUtYWE4Zi00ZTUwYzBkZWNmMzM",
"type": "query",
"description": "Retrieve list of jobs for this organization."
},
{
"name": "start",
"value": "0",
"type": "query",
"description": "Specifies the error offset from the first result that you want to fetch."
},
{
"name": "max",
"value": "100",
"type": "query",
"description": "Specifies the maximum number of records that you want to fetch."
}
]
},
"docs": "Lists all error details of Manage Numbers job. This will not list any errors if `exitCode` is `COMPLETED`. If the status is `COMPLETED_WITH_ERRORS` then this lists the cause of failures.\n\nList of possible Errors:\n\n+ BATCH-1017021 - Failed to move because it is an inactive number.\n\n+ BATCH-1017022 - Failed to move because the source location and target location have different CCP providers.\n\n+ BATCH-1017023 - Failed because it is not an unassigned number.\n\n+ BATCH-1017024 - Failed because it is a"
}
]
}
],
"bundled": true
}