Sign in
latestOpenAPI 3.0.3MIT2026-08-102357127.0 KB

c3d50cf4681d

Hosting Orders

Get hosting order

Returns the hosting order specified by the hosting order ID.

get/v1/projects/{projectId}/hostingOrders/{hostingOrderId}

Path parameters

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

Found on your Sinch Customer Dashboard. Settings > Projects.

hostingOrderIdstring required
Example:01arz3ndektsv4rrffq69g5fav

Found on your Sinch Customer Dashboard. Settings > Projects.

Response

OK

projectIdstring

The project ID to which the hosting order is associated.

hostingOrderIdstring

The unique ID of the hosting order.

displayNamestring

The friendly name of the hosting order.

regionCodestring

The region code of the hosting order. Number hosting is only available for the US and Canada, so you must enter either "US" or "CA".

state'HOSTING_ORDER_STATE_UNSPECIFIED' | 'DRAFT' | 'SUBMITTED' | 'WAITING_FOR_LOA_SIGNATURE' | 'IN_PROGRESS' | 'COMPLETED' | 'REJECTED'

The state of the hosting order.

type'HOSTING_ORDER_TYPE_UNSPECIFIED' | 'IMPORT' | 'TYPE_TEXT_ENABLE'

The hosting order type.

createdTimestring date-time

Timestamp when the hosting order was created

updatedTimestring date-time

Timestamp when the hosting order was last updated

scheduledOsrUpdateTimestring date-time

Timestamp when the OSR update will be done

servicePlanIdstring

The service plan to which the hosting order is associated.

campaignIdstring

The campaign to which the hosting order is associated.

migrateToSinchTmoboolean

Displays if a number is assigned to another aggregator in T-Mobile's platform, and requires migration from previous aggregator to Sinch.

callbackUrlstring

The client's callback URL to be called upon finishing the number import.

Example response

{
  "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"
}