List qualified numbers

Request

Returns a list of qualified numbers for the project.

Security

Basic or OAuth2.0

Path

projectIdstringrequired

Found on your Sinch Customer Dashboard. Settings > Projects.

Example:d1923022-5199-4bb3-a513-c47b3a656bc5

Query

regionCodestring

Region code to filter by. ISO 3166-1 alpha-2 country code of the phone number. Currently supported are US, CA

Example:regionCode=US

statesstringrequired

The qualified number states

Enum Value	Description
GLOBAL_PROCESS_STATE_UNSPECIFIED	The state is unspecified.
GLOBAL_PROCESS_STATE_ELIGIBLE_CHECK_PENDING	The check for eligibility is pending.
GLOBAL_PROCESS_STATE_ELIGIBLE	The state is eligible.
GLOBAL_PROCESS_STATE_NOT_ELIGIBLE	The state is not eligible.
GLOBAL_PROCESS_STATE_VERIFICATION_PENDING	The state verification is pending.
GLOBAL_PROCESS_STATE_VERIFICATION_FAILED	The state verification failed.
GLOBAL_PROCESS_STATE_VERIFICATION_BLOCKED	The state verification is blocked.
GLOBAL_PROCESS_STATE_VERIFIED	The state is verified.
GLOBAL_PROCESS_STATE_HOSTING_IN_PROGRESS	Hosting process is in progress.
GLOBAL_PROCESS_STATE_HOSTING_DONE	Hosting process is done.
GLOBAL_PROCESS_STATE_HOSTING_FAILED	Hosting process failed.

Example:states=GLOBAL_PROCESS_STATE_HOSTING_IN_PROGRESS

pageSizeinteger

The maximum number of items to return, server can enforce an upper limit and overwrite the value.

Example:pageSize=20

pageTokenstring

The next page token value returned from a previous listing.

Example:pageToken=C2VNYXJrEg4KDCsxMjAxMjI2MzUyOQ==

orderBystring

Parameter used to order the returned hosting orders

Enum Value	Description
createdTime	Order by the time the hosting order was created.
updatedTime	Order by the time the hosting order was last updated.

curl -i -X GET \
  -u '<username>:<password>' \
  'https://imported.numbers.api.sinch.com/v1/projects/d1923022-5199-4bb3-a513-c47b3a656bc5/qualifiedNumbers?regionCode=US&states=GLOBAL_PROCESS_STATE_HOSTING_IN_PROGRESS&pageSize=20&pageToken=C2VNYXJrEg4KDCsxMjAxMjI2MzUyOQ%3D%3D&orderBy=createdTime'

Responses

OK

Bodyapplication/json

qualifiedNumbersArray of objects(QualifiedNumber)

nextPageTokenstring

totalSizeinteger, (int32)

Response

{
  "qualifiedNumbers": [
    { … }
  ],
  "nextPageToken": "string",
  "totalSize": 0
}

We'd love to hear from you!