Hosting Orders

API reference

Hosting Orders

Hosted numbers provide you with an easy method to port your SMS enabled numbers to Sinch or to use SMS messaging and other products to send and receive messages, on voice-enabled numbers (including landline numbers) that you already own.

Note: The SMS enablement process is only supported in United States and Canada.

The Hosting Orders API allows you to manage all the numbers that you are hosting on the Sinch platform. This includes numbers that you have ported to Sinch and/or any non- Sinch numbers that you already own and are hosting on Sinch to enable Sinch SMS messaging and other products.

Operations

List hosting orders

Request

Lists the hosting orders 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 hosting order states

Enum Value	Description
HOSTING_ORDER_STATE_UNSPECIFIED	State is unspecified.
DRAFT	Hosting order is a draft.
SUBMITTED	Hosting order has been submitted.
WAITING_FOR_LOA_SIGNATURE	Hosting order is waiting for the LoA signature.
IN_PROGRESS	Hosting order is in progress.
COMPLETED	Hosting order is completed.
REJECTED	Hosting order is rejected.

typestringrequired

The hosting order type

Enum Value	Description
HOSTING_ORDER_TYPE_UNSPECIFIED	Type is unspecified.
IMPORT	Type is importing numbers.
TYPE_TEXT_ENABLE	Type is text enabling numbers.

servicePlanIdstringrequired

The hosting order servicePlanId

Example:servicePlanId=324e4567-e89b-12d3-a456-426614174000

campaignIdstringrequired

The hosting order campaignId

Example:campaignId=123e4567-e89b-12d3-a456-426614174000

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

curl -i -X GET \
  -u '<username>:<password>' \
  'https://imported.numbers.api.sinch.com/v1/projects/d1923022-5199-4bb3-a513-c47b3a656bc5/hostingOrders?regionCode=US&states=HOSTING_ORDER_STATE_UNSPECIFIED&type=HOSTING_ORDER_TYPE_UNSPECIFIED&servicePlanId=324e4567-e89b-12d3-a456-426614174000&campaignId=123e4567-e89b-12d3-a456-426614174000&orderBy=createdTime&pageToken=C2VNYXJrEg4KDCsxMjAxMjI2MzUyOQ%3D%3D&pageSize=20'

Responses

Bodyapplication/json

hostingOrdersArray of objects(HostingOrder)

nextPageTokenstring

totalSizeinteger, (int32)

Response

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

We'd love to hear from you!