Sign in
latestOpenAPI 3.0.3MIT2026-08-102357127.0 KB

c3d50cf4681d

Hosting Orders

Import numbers using hosting orders

Import numbers associated with hosting orders of a specific project and schedule the async provisioning to Sinch SMS platform and linking to campaign if applicable.

<b>Note:</b> This operation is limited to five numbers. If you want to increase the quantity of numbers you can import using this operation, please contact your account manager for authorization.

post/v1/projects/{projectId}/hostingOrders:importNumbers

Path parameters

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

Found on your Sinch Customer Dashboard. Settings > Projects.

Request body

projectIdstring

The ID of the project to which the import request is associated.

displayNamestring

The optional display name of the import request.

regionCodestring required

The region code for the import request.

numbersstring[] required

An array of all the phone numbers associated with the import request.

servicePlanIdstring required

The ID of the service plan to which the import request is associated.

campaignIdstring

The ID of the campaign to which the request is associated.

callbackUrlstring

The callback URL to be called for import numbers updates

migrateToSinchTmoboolean

If a number is assigned to another aggregator in T-Mobile's platform, then T-Mobile will give an error code 60135 indicating that number needs to be “migrated” from previous aggregator to Sinch. This “migration” requires provisioning of number by setting this flag named to true for successful number linking process.

Example request

{
  "projectId": "YOUR_project_id",
  "displayName": "MyImportRequest",
  "regionCode": "US",
  "numbers": [
    "+12025550134"
  ],
  "servicePlanId": "YOUR_service_plan_id",
  "campaignId": "YOUR_campaign_id"
}

Response

A successful response with a hosting order, or an error

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

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",
  "callbackUrl": "https://www.your-callback-server.com/callback"
}