List hosting order numbers

Request

Lists the numbers belonging to the specified hosting order.

Security

Basic or OAuth2.0

Path

projectIdstringrequired

Found on your Sinch Customer Dashboard. Settings > Projects.

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

hostingOrderIdstringrequired

Found on your Sinch Customer Dashboard. Settings > Projects.

Example:01arz3ndektsv4rrffq69g5fav

Query

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.

pageTokenstring

The next page token value returned from a previous listing.

Example:pageToken=C2VNYXJrEg4KDCsxMjAxMjI2MzUyOQ==

pageSizeinteger

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

Example:pageSize=20

osrUpdateStatestring(State)

Filter the results by the state of the OSR update.

Enum Value	Description
DONE	The operation was completed successfully.
FAILED	The operation has failed.
IN_PROGRESS	The operation is currently in progress.
WAITING	The operation is pending and has not yet started.
STATE_UNSPECIFIED	The state is unspecified.

Example:osrUpdateState=DONE

campaignProvisioningStatestring(State)

Filter the results by the state of the campaign provisioning.

Enum Value	Description
DONE	The operation was completed successfully.
FAILED	The operation has failed.
IN_PROGRESS	The operation is currently in progress.
WAITING	The operation is pending and has not yet started.
STATE_UNSPECIFIED	The state is unspecified.

Example:campaignProvisioningState=DONE

platformProvisioningStatestring(State)

Filter the results by the state of the platform provisioning.

Enum Value	Description
DONE	The operation was completed successfully.
FAILED	The operation has failed.
IN_PROGRESS	The operation is currently in progress.
WAITING	The operation is pending and has not yet started.
STATE_UNSPECIFIED	The state is unspecified.

Example:platformProvisioningState=DONE

curl -i -X GET \
  -u '<username>:<password>' \
  'https://imported.numbers.api.sinch.com/v1/projects/d1923022-5199-4bb3-a513-c47b3a656bc5/hostingOrders/01arz3ndektsv4rrffq69g5fav/numbers?orderBy=createdTime&pageToken=C2VNYXJrEg4KDCsxMjAxMjI2MzUyOQ%3D%3D&pageSize=20&osrUpdateState=DONE&campaignProvisioningState=DONE&platformProvisioningState=DONE'

Responses

OK

Bodyapplication/json

numbersArray of objects(HostingOrderNumber)

nextPageTokenstring

totalSizeinteger, (int32)

Response

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

We'd love to hear from you!