Qualified Numbers
List qualified numbers
Returns a list of qualified numbers for the project.
get/v1/projects/{projectId}/qualifiedNumbers
Path parameters
projectIdstring required
Example:d1923022-5199-4bb3-a513-c47b3a656bc5
Found on your Sinch Customer Dashboard. Settings > Projects.
Query parameters
regionCodestring
Example:US
Region code to filter by. ISO 3166-1 alpha-2 country code of the phone number. Currently supported are US, CA
states'GLOBAL_PROCESS_STATE_ELIGIBLE_CHECK_PENDING' | 'GLOBAL_PROCESS_STATE_ELIGIBLE' | 'GLOBAL_PROCESS_STATE_NOT_ELIGIBLE' | 'GLOBAL_PROCESS_STATE_VERIFICATION_PENDING' | 'GLOBAL_PROCESS_STATE_VERIFICATION_FAILED' | 'GLOBAL_PROCESS_STATE_VERIFICATION_BLOCKED' | 'GLOBAL_PROCESS_STATE_VERIFIED' | 'GLOBAL_PROCESS_STATE_HOSTING_IN_PROGRESS' | 'GLOBAL_PROCESS_STATE_HOSTING_DONE' | 'GLOBAL_PROCESS_STATE_HOSTING_FAILED' | 'GLOBAL_PROCESS_STATE_UNSPECIFIED' required
Example:GLOBAL_PROCESS_STATE_HOSTING_IN_PROGRESS
The qualified number states
pageSizeinteger
Example:20
The maximum number of items to return, server can enforce an upper limit and overwrite the value.
pageTokenstring
Example:C2VNYXJrEg4KDCsxMjAxMjI2MzUyOQ==
The next page token value returned from a previous listing.
orderBy'createdTime' | 'updatedTime'
Parameter used to order the returned hosting orders
Response
OK
Example response
{
"qualifiedNumbers": [
{
"phoneNumber": "+12025550134",
"projectId": "abcd12ef-ab12-ab12-bc34-abcdef123456",
"regionCode": "US",
"osrEligibility": {
"status": "DONE"
},
"ownershipVerification": {
"status": "DONE"
}
}
]
}