Hosting Orders
List hosting orders
Lists the hosting orders for the project.
get/v1/projects/{projectId}/hostingOrders
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'HOSTING_ORDER_STATE_UNSPECIFIED' | 'DRAFT' | 'SUBMITTED' | 'WAITING_FOR_LOA_SIGNATURE' | 'IN_PROGRESS' | 'COMPLETED' | 'REJECTED' required
The hosting order states
type'HOSTING_ORDER_TYPE_UNSPECIFIED' | 'IMPORT' | 'TYPE_TEXT_ENABLE' required
The hosting order type
servicePlanIdstring required
Example:324e4567-e89b-12d3-a456-426614174000
The hosting order servicePlanId
campaignIdstring required
Example:123e4567-e89b-12d3-a456-426614174000
The hosting order campaignId
orderBy'createdTime' | 'updatedTime'
Parameter used to order the returned hosting orders
pageTokenstring
Example:C2VNYXJrEg4KDCsxMjAxMjI2MzUyOQ==
The next page token value returned from a previous listing.
pageSizeinteger
Example:20
The maximum number of items to return, server can enforce an upper limit and overwrite the value.
Response
OK
Example response
{
"hostingOrders": [
{
"projectId": "YOUR_project_id",
"hostingOrderId": "YOUR_hosting_order_id",
"displayName": "MyHostingOrder",
"regionCode": "US",
"servicePlanId": "YOUR_service_plan_id",
"campaignId": "YOUR_campaign_id",
"textEnableInfo": {
"businessName": "Acme, Inc.",
"authorisedPerson": {
"firstName": "John",
"lastName": "Doe",
"email": "john.doe@company.com"
},
"address": {
"buildingNumber": "123",
"street": "1st",
"city": "New York",
"state": "NY",
"postalCode": "00001",
"country": "USA"
},
"currentVoiceCarrier": "TMO"
},
"callbackUrl": "https://www.your-callback-server.com/callback"
}
]
}