Download OpenAPI specification:Download

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.

List hosting orders

Lists the hosting orders for the project.

SecurityBasic or OAuth2.0
Request
path Parameters
projectId
required
string

Found on your Sinch Customer Dashboard. Settings > Projects.

Example: d1923022-5199-4bb3-a513-c47b3a656bc5
query Parameters
states
required
string

The hosting order states

Enum: "HOSTING_ORDER_STATE_UNSPECIFIED" "DRAFT" "SUBMITTED" "WAITING_FOR_LOA_SIGNATURE" "IN_PROGRESS" "COMPLETED" "REJECTED"
type
required
string

The hosting order type

Enum: "HOSTING_ORDER_TYPE_UNSPECIFIED" "IMPORT" "TYPE_TEXT_ENABLE"
servicePlanId
required
string

The hosting order servicePlanId

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

The hosting order campaignId

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

Region code to filter by. ISO 3166-1 alpha-2 country code of the phone number. Currently supported are US, CA

Example: regionCode=US
orderBy
string

Parameter used to order the returned hosting orders

pageToken
string

The next page token value returned from a previous listing.

Example: pageToken=C2VNYXJrEg4KDCsxMjAxMjI2MzUyOQ==
pageSize
integer

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

Example: pageSize=20
Responses
200

OK

Response Schema: application/json
Array of objects (HostingOrder)
Array
projectId
string

The project ID to which the hosting order is associated.

hostingOrderId
string

The unique ID of the hosting order.

displayName
string

The friendly name of the hosting order.

regionCode
string

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
string

The state of the hosting order.

Enum: "HOSTING_ORDER_STATE_UNSPECIFIED" "DRAFT" "SUBMITTED" "WAITING_FOR_LOA_SIGNATURE" "IN_PROGRESS" "COMPLETED" "REJECTED"
type
string

The hosting order type.

Enum: "HOSTING_ORDER_TYPE_UNSPECIFIED" "IMPORT" "TYPE_TEXT_ENABLE"
createdTime
string <date-time>

Timestamp when the hosting order was created

updatedTime
string <date-time>

Timestamp when the hosting order was last updated

scheduledOsrUpdateTime
string <date-time>

Timestamp when the OSR update will be done

servicePlanId
string

The service plan to which the hosting order is associated.

campaignId
string

The campaign to which the hosting order is associated.

migrateToSinchTmo
boolean

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

object (TextEnableInfo)
callbackUrl
string

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

nextPageToken
string
totalSize
integer <int32>
404

NOT FOUND: The resource could not be found.

500

INTERNAL: Internal server error. Typically, a server bug.

get/v1/projects/{projectId}/hostingOrders
Request samples 
Response samples 
application/json
{
  • "hostingOrders": [
    • {
      }
    ],
  • "nextPageToken": "string",
  • "totalSize": 0
}
Get hosting order
Returns the hosting order specified by the hosting order ID.


SecurityBasic or OAuth2.0 
Request 
path Parameters
projectId
required
string
Found on your Sinch Customer Dashboard. Settings > Projects.


 
 Example:  d1923022-5199-4bb3-a513-c47b3a656bc5
hostingOrderId
required
string
Found on your Sinch Customer Dashboard. Settings > Projects.


 
 Example:  01arz3ndektsv4rrffq69g5fav
Responses 
200
OK


Response Schema: application/json
projectId
string
The project ID to which the hosting order is associated.


 
hostingOrderId
string
The unique ID of the hosting order.


 
displayName
string
The friendly name of the hosting order.


 
regionCode
string
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
string
The state of the hosting order.


 Enum: "HOSTING_ORDER_STATE_UNSPECIFIED" "DRAFT" "SUBMITTED" "WAITING_FOR_LOA_SIGNATURE" "IN_PROGRESS" "COMPLETED" "REJECTED"  
type
string
The hosting order type.


 Enum: "HOSTING_ORDER_TYPE_UNSPECIFIED" "IMPORT" "TYPE_TEXT_ENABLE"  
createdTime
string <date-time> 
Timestamp when the hosting order was created


 
updatedTime
string <date-time> 
Timestamp when the hosting order was last updated


 
scheduledOsrUpdateTime
string <date-time> 
Timestamp when the OSR update will be done


 
servicePlanId
string
The service plan to which the hosting order is associated.


 
campaignId
string
The campaign to which the hosting order is associated.


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


 
object (TextEnableInfo) 
 
businessName
string
The name of the business.


 
object (AuthorizedPerson) 
The person authorized and responsible for the hosting order.


 
firstName
required
string
The first name of the authorized person.


 
lastName
required
string
The last name of the authorized person.


 
email
required
string
The email address of the authorized person.


 
object (Address) 
The address of the business.


 
buildingNumber
required
string
The building number of the address.


 
street
required
string
The street name of the address.


 
city
required
string
The city name of the address.


 
state
required
string
The state name of the address.


 
postalCode
required
string
The postal code of the address.


 
country
required
string
The country of the address.


 
serviceProvider
string
 
currentVoiceCarrier
string
The current carrier you are using for voice services for the number you want to host on Sinch.


 
nnid
string
The Net Number ID for the number you want to host on Sinch.


 
loaType
integer <enum> 
The type of the letter of authorization.


 Enum Value Description
Direct
If you are a direct Sinch customer.


Reseller
If you are a Sinch partner or reseller.


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


 
404
NOT FOUND: The resource could not be found.


500
INTERNAL: Internal server error. Typically, a server bug.


get/v1/projects/{projectId}/hostingOrders/{hostingOrderId}
Request samples 
Response samples 
application/json
{
  • "projectId": "YOUR_project_id",
  • "hostingOrderId": "YOUR_hosting_order_id",
  • "displayName": "MyHostingOrder",
  • "regionCode": "US",
  • "state": "HOSTING_ORDER_STATE_UNSPECIFIED",
  • "type": "HOSTING_ORDER_TYPE_UNSPECIFIED",
  • "createdTime": "2019-08-24T14:15:22Z",
  • "updatedTime": "2019-08-24T14:15:22Z",
  • "scheduledOsrUpdateTime": "2019-08-24T14:15:22Z",
  • "servicePlanId": "YOUR_service_plan_id",
  • "campaignId": "YOUR_campaign_id",
  • "migrateToSinchTmo": true,
  • "textEnableInfo": {
    • "businessName": "Acme, Inc.",
    • "authorisedPerson": {
      },
    • "address": {
      },
    • "serviceProvider": "string",
    • "currentVoiceCarrier": "TMO",
    • "nnid": "string",
    • "loaType": 0
    },
  • "callbackUrl": "https://www.your-callback-server.com/callback"
}
Retrieve a hosting order report
Returns the report object for a specific hosting order


SecurityBasic or OAuth2.0 
Request 
path Parameters
projectId
required
string
Found on your Sinch Customer Dashboard. Settings > Projects.


 
 Example:  d1923022-5199-4bb3-a513-c47b3a656bc5
hostingOrderId
required
string
Found on your Sinch Customer Dashboard. Settings > Projects.


 
 Example:  01arz3ndektsv4rrffq69g5fav
Responses 
200
A successful response with a hosting order report, or an error


Response Schema: application/json
total
integer <int32> 
 
osrUpdated
integer <int32> 
 
smsProvisioned
integer <int32> 
 
addedToCampaign
integer <int32> 
 
ongoingManualAction
integer <int32> 
 
404
The imported number, project, hosting order, qualified number or phone number could not be found


500
Internal server error. Typically, a server bug.


get/v1/projects/{projectId}/hostingOrders/{hostingOrderId}/report
Request samples 
Response samples 
application/json
{
  • "total": 1,
  • "osrUpdated": 1,
  • "smsProvisioned": 1,
  • "addedToCampaign": 1
}
List hosting order numbers
Lists the numbers belonging to the specified hosting order.


SecurityBasic or OAuth2.0 
Request 
path Parameters
projectId
required
string
Found on your Sinch Customer Dashboard. Settings > Projects.


 
 Example:  d1923022-5199-4bb3-a513-c47b3a656bc5
hostingOrderId
required
string
Found on your Sinch Customer Dashboard. Settings > Projects.


 
 Example:  01arz3ndektsv4rrffq69g5fav
query Parameters
orderBy
string
Parameter used to order the returned hosting orders


 
pageToken
string
The next page token value returned from a previous listing.


 
 Example:  pageToken=C2VNYXJrEg4KDCsxMjAxMjI2MzUyOQ==
pageSize
integer
The maximum number of items to return, server can enforce an upper limit and overwrite the value.


 
 Example:  pageSize=20
osrUpdateState
integer <enum> 
 
campaignProvisioningState
integer <enum> 
 
platformProvisioningState
integer <enum> 
 
Responses 
200
OK


Response Schema: application/json
Array of objects (HostingOrderNumber) 
 
 Array 
projectId
string
The project ID to which the number belongs.


 
hostingOrderId
string
The ID of the hosting order to which the number belongs.


 
phoneNumber
string
The phone number in e.164 format with leading +.


 
object (HostingOrderNumber_OsrUpdate) 
 
object (HostingOrderNumber_CampaignProvisioning) 
 
object (HostingOrderNumber_PlatformProvisioning) 
 
nextPageToken
string
 
totalSize
integer <int32> 
 
404
NOT FOUND: The resource could not be found.


500
INTERNAL: Internal server error. Typically, a server bug.


get/v1/projects/{projectId}/hostingOrders/{hostingOrderId}/numbers
Request samples 
Response samples 
application/json
{
  • "numbers": [
    • {
      }
    ],
  • "nextPageToken": "string",
  • "totalSize": 0
}
Get hosting order number
Returns the specified phone number belonging to the specified hosting order.


SecurityBasic or OAuth2.0 
Request 
path Parameters
projectId
required
string
Found on your Sinch Customer Dashboard. Settings > Projects.


 
 Example:  d1923022-5199-4bb3-a513-c47b3a656bc5
hostingOrderId
required
string
Found on your Sinch Customer Dashboard. Settings > Projects.


 
 Example:  01arz3ndektsv4rrffq69g5fav
phoneNumber
required
string
The phone number in E.164 format with leading +.


 
 Example:  +12025550134
Responses 
200
OK


Response Schema: application/json
projectId
string
The project ID to which the number belongs.


 
hostingOrderId
string
The ID of the hosting order to which the number belongs.


 
phoneNumber
string
The phone number in e.164 format with leading +.


 
object (HostingOrderNumber_OsrUpdate) 
 
nnid
string
The Net Number ID identifying the phone number.


 
state
string <enum> 
 Enum: "STATE_UNSPECIFIED" "WAITING" "DONE" "FAILED"  
object (HostingOrderNumber_CampaignProvisioning) 
 
campaignId
string
The campaign ID to which the hosting order is associated.


 
state
string <enum> 
 Enum: "STATE_UNSPECIFIED" "WAITING" "DONE" "FAILED"  
object (HostingOrderNumber_PlatformProvisioning) 
 
servicePlanId
string
The service plan ID to which the hosting order number is associated.


 
state
string <enum> 
 Enum: "STATE_UNSPECIFIED" "WAITING" "DONE" "FAILED"  
404
NOT FOUND: The resource could not be found.


500
INTERNAL: Internal server error. Typically, a server bug.


get/v1/projects/{projectId}/hostingOrders/{hostingOrderId}/numbers/{phoneNumber}
Request samples 
Response samples 
application/json
{
  • "projectId": "YOUR_project_id",
  • "hostingOrderId": "YOUR_hosting_order_id",
  • "phoneNumber": "+12025550134",
  • "osrUpdate": {
    • "nnid": "string",
    • "state": "WAITING"
    },
  • "campaignProvisioning": {
    • "campaignId": "YOUR_campaign_id",
    • "state": "WAITING"
    },
  • "platformProvisioning": {
    • "servicePlanId": "YOUR_service_plan_id",
    • "state": "WAITING"
    }
}
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.


Note: 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. 


SecurityBasic or OAuth2.0 
Request 
path Parameters
projectId
required
string
Found on your Sinch Customer Dashboard. Settings > Projects.


 
 Example:  d1923022-5199-4bb3-a513-c47b3a656bc5
Request Body schema: application/json
required
The request to import hosting orders numbers in the current project


regionCode
required
string
The region code for the import request.


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


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


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


 
displayName
string
The optional display name of the import request.


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


 
callbackUrl
string
The callback URL to be called for import numbers updates


 
migrateToSinchTmo
boolean
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.


 
Responses 
200
A successful response with a hosting order, or an error


Response Schema: application/json
projectId
string
The project ID to which the hosting order is associated.


 
hostingOrderId
string
The unique ID of the hosting order.


 
displayName
string
The friendly name of the hosting order.


 
regionCode
string
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
string
The state of the hosting order.


 Enum: "HOSTING_ORDER_STATE_UNSPECIFIED" "DRAFT" "SUBMITTED" "WAITING_FOR_LOA_SIGNATURE" "IN_PROGRESS" "COMPLETED" "REJECTED"  
type
string
The hosting order type.


 Enum: "HOSTING_ORDER_TYPE_UNSPECIFIED" "IMPORT" "TYPE_TEXT_ENABLE"  
createdTime
string <date-time> 
Timestamp when the hosting order was created


 
updatedTime
string <date-time> 
Timestamp when the hosting order was last updated


 
servicePlanId
string
The service plan to which the hosting order is associated.


 
campaignId
string
The campaign to which the hosting order is associated.


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


 
numberImport
object
The number import object.


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


 
500
INTERNAL: Internal server error. Typically, a server bug.


post/v1/projects/{projectId}/hostingOrders:importNumbers
Request samples 
application/json
{
  • "displayName": "Import numbers order",
  • "regionCode": "US",
  • "numbers": [
    • "+17724295286",
    • "+17724295287"
    ],
  • "servicePlanId": "07d6c2621f364b68856fe4938b7bb78f",
  • "campaignId": "C3O8OGA",
  • "callbackUrl": "https://www.your-callback-server.com/callback",
  • "migrateToSinchTmo": true
}
Response samples 
application/json
{
  • "projectId": "d1923022-5199-4bb3-a513-c47n7a656bc5",
  • "hostingOrderId": "01arz3nhyrtsv4rrffq69g5fav",
  • "displayName": "Hosting order with campaignId and smsAppId",
  • "regionCode": "US",
  • "state": "SUBMITTED",
  • "type": "IMPORT",
  • "createdTime": "2023-01-12T14:34:40.968Z",
  • "updatedTime": "2023-01-12T14:34:40.968Z",
  • "servicePlanId": "16e5c8d2odc842bda9a1b90e1673c174",
  • "campaignId": "C3O84GA",
  • "migrateToSinchTmo": true,
  • "callbackUrl": "https://www.your-callback-server.com/callback",
  • "numberImport": "{}"
}
Text enable numbers in hosting orders
Text enable numbers associated with hosting orders of a specific project.


SecurityBasic or OAuth2.0 
Request 
path Parameters
projectId
required
string
Found on your Sinch Customer Dashboard. Settings > Projects.


 
 Example:  d1923022-5199-4bb3-a513-c47b3a656bc5
Request Body schema: application/json
required
The request to text-enable hosting orders numbers in the current project


regionCode
required
string
The region code for the hosting order.


 
numbers
required
Array of strings
An array of all the phone numbers associated with the hosting order.


 
servicePlanId
required
string
The ID of the service plan to which the hosting order is associated.


 
projectId
string
The ID of the project to which the hosting order is associated.


 
displayName
string
The optional display name of the hosting order.


 
nnid
string
Defaults to either Sinch NNID or what was originally configured on the customer account. Sinch encourages customers to use the Sinch NNID, but if you want to use another NNID, please contact your account manager.


 
campaignId
string
The ID of the campaign to which the hosting order is associated.


 
object (DirectLoaInfo) 
Letter of Authorization for direct Sinch customers.


 
required
object (AuthorizedPerson) 
The person authorized and responsible for the hosting order.


 
firstName
required
string
The first name of the authorized person.


 
lastName
required
string
The last name of the authorized person.


 
email
required
string
The email address of the authorized person.


 
required
object (Address) 
The address of the business.


 
buildingNumber
required
string
The building number of the address.


 
street
required
string
The street name of the address.


 
city
required
string
The city name of the address.


 
state
required
string
The state name of the address.


 
postalCode
required
string
The postal code of the address.


 
country
required
string
The country of the address.


 
currentVoiceCarrier
required
string
The current carrier you are using for voice services for the number you want to host on Sinch.


 
object (ResellerLoaInfo) 
Letter of Authorization for resellers.


 
businessName
required
string
The name of the business.


 
required
object (AuthorizedPerson) 
The person authorized and responsible for the hosting order.


 
firstName
required
string
The first name of the authorized person.


 
lastName
required
string
The last name of the authorized person.


 
email
required
string
The email address of the authorized person.


 
required
object (Address) 
The address of the business.


 
buildingNumber
required
string
The building number of the address.


 
street
required
string
The street name of the address.


 
city
required
string
The city name of the address.


 
state
required
string
The state name of the address.


 
postalCode
required
string
The postal code of the address.


 
country
required
string
The country of the address.


 
currentVoiceCarrier
required
string
The current carrier you are using for voice services for the number you want to host on Sinch.


 
blanketLoaInfo
object (BlanketLoaInfo) 
You can set up a blanket Letter of Authorization (LoA) that will allow you to import numbers to your account without having to sign an LoA each time you submit a request. To set up a blanket LoA, email your account manager. Once the LoA has been approved, you can use this blanketLoaInfo object in your requests. The blanketLoaInfo object should be sent as an empty object.


 
scheduledOsrUpdateTime
string <date-time> 
 
callbackUrl
string
The client's callback URL to be called for text enablement updates.


 
Responses 
200
A successful response with a hosting order, or an error


Response Schema: application/json
projectId
string
The project ID to which the hosting order is associated.


 
hostingOrderId
string
The unique ID of the hosting order.


 
displayName
string
The friendly name of the hosting order.


 
regionCode
string
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
string
The state of the hosting order.


 Enum: "HOSTING_ORDER_STATE_UNSPECIFIED" "DRAFT" "SUBMITTED" "WAITING_FOR_LOA_SIGNATURE" "IN_PROGRESS" "COMPLETED" "REJECTED"  
type
string
The hosting order type.


 Enum: "HOSTING_ORDER_TYPE_UNSPECIFIED" "IMPORT" "TYPE_TEXT_ENABLE"  
createdTime
string <date-time> 
Timestamp when the hosting order was created


 
updatedTime
string <date-time> 
Timestamp when the hosting order was last updated


 
scheduledOsrUpdateTime
string <date-time> 
Timestamp when the OSR update will be done


 
servicePlanId
string
The service plan to which the hosting order is associated.


 
campaignId
string
The campaign to which the hosting order is associated.


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


 
object (TextEnableInfo) 
 
businessName
string
The name of the business.


 
object (AuthorizedPerson) 
The person authorized and responsible for the hosting order.


 
firstName
required
string
The first name of the authorized person.


 
lastName
required
string
The last name of the authorized person.


 
email
required
string
The email address of the authorized person.


 
object (Address) 
The address of the business.


 
buildingNumber
required
string
The building number of the address.


 
street
required
string
The street name of the address.


 
city
required
string
The city name of the address.


 
state
required
string
The state name of the address.


 
postalCode
required
string
The postal code of the address.


 
country
required
string
The country of the address.


 
serviceProvider
string
 
currentVoiceCarrier
string
The current carrier you are using for voice services for the number you want to host on Sinch.


 
nnid
string
The Net Number ID for the number you want to host on Sinch.


 
loaType
integer <enum> 
The type of the letter of authorization.


 Enum Value Description
Direct
If you are a direct Sinch customer.


Reseller
If you are a Sinch partner or reseller.


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


 
400
Status returned if any of the projectId, displayName, regionCode, numbers, nnid, servicePlanId or campaignId parameters are not valid


404
The imported number, project, hosting order, qualified number or phone number could not be found


409
The imported number already exists and cannot be created


500
Internal server error. Typically, a server bug.


post/v1/projects/{projectId}/hostingOrders:textEnableNumbers
Request samples 
application/json
{
  • "regionCode": "US",
  • "numbers": [
    • "+17724295286",
    • "+17724295287"
    ],
  • "servicePlanId": "07d6c2621f364b68856fe4938b7bb78f",
  • "campaignId": "C3O8OGA",
  • "callbackUrl": "https://www.your-callback-server.com/callback",
  • "directLoaInfo": {
    • "authorisedPerson": {
      },
    • "address": {
      },
    • "currentVoiceCarrier": "Verizon"
    },
  • "scheduledOsrUpdateTime": "2023-01-13T14:34:40.968Z",
  • "migrateToSinchTmo": true
}
Response samples 
application/json
{
  • "projectId": "d1923022-5199-4bb3-a513-c47n7a656bc5",
  • "hostingOrderId": "01arz3nhyrtsv4rrffq69g5fav",
  • "displayName": "Hosting order with campaignId, nnid and smsAppId",
  • "regionCode": "US",
  • "state": "SUBMITTED",
  • "type": "TYPE_TEXT_ENABLE",
  • "createdTime": "2023-01-12T14:34:40.968Z",
  • "updatedTime": "2023-01-12T14:34:40.968Z",
  • "scheduledOsrUpdateTime": "2023-01-13T14:34:40.968Z",
  • "servicePlanId": "16e5c8d2odc842bda9a1b90e1673c174",
  • "campaignId": "C3O84GA",
  • "migrateToSinchTmo": true,
  • "callbackUrl": "https://www.your-callback-server.com/callback",
  • "hostingOrderInfo": {
    • "businessName": "Sinch AB",
    • "authorisedPerson": {
      },
    • "address": {
      },
    • "serviceProvider": "Sinch America Inc.",
    • "currentVoiceCarrier": "Verizon",
    • "nnid": "104029",
    • "loaType": "DIRECT"
    }
}
Text enable Toll Free numbers in hosting orders
Text enable Toll Free numbers associated with hosting orders of a specific project.


SecurityBasic or OAuth2.0 
Request 
path Parameters
projectId
required
string
Found on your Sinch Customer Dashboard. Settings > Projects.


 
 Example:  d1923022-5199-4bb3-a513-c47b3a656bc5
Request Body schema: application/json
required
The request to text-enable hosting orders Toll Free numbers in the current project


One of:
Request for text enabling project Toll Free numbers.


regionCode
required
string
ISO 3166-1 alpha-2 country code of the phone number. Example: US, CA


 
numbers
required
Array of strings
 
servicePlanId
required
string
The SMS service that the number will be linked to. The servicePlanId can be found in the Sinch Customer Dashboard.


 
required
object (DirectLoaInfo) 
Letter of Authorization for direct Sinch customers.


 
required
object (AuthorizedPerson) 
The person authorized and responsible for the hosting order.


 
firstName
required
string
The first name of the authorized person.


 
lastName
required
string
The last name of the authorized person.


 
email
required
string
The email address of the authorized person.


 
required
object (Address) 
The address of the business.


 
buildingNumber
required
string
The building number of the address.


 
street
required
string
The street name of the address.


 
city
required
string
The city name of the address.


 
state
required
string
The state name of the address.


 
postalCode
required
string
The postal code of the address.


 
country
required
string
The country of the address.


 
currentVoiceCarrier
required
string
The current carrier you are using for voice services for the number you want to host on Sinch.


 
displayName
string
The display name of the numbers.


 
scheduledZipwhipProvisioningTime
string
Optional field which allow to determine when Zipwhip provisioning will be done. Timestamp needs to be from UTC zone. Important! If LOA is signed after scheduledZipwhipProvisioningTime, date will be rescheduled to the next day at the same time.


 
callbackUrl
string
The callback URL to be called for text enablement updates


 
Responses 
200
A successful response with a hosting order, or an error


Response Schema: application/json
projectId
string
The project ID to which the hosting order is associated.


 
hostingOrderId
string
The unique ID of the hosting order.


 
displayName
string
The friendly name of the hosting order.


 
regionCode
string
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
string
The state of the hosting order.


 Enum: "HOSTING_ORDER_STATE_UNSPECIFIED" "DRAFT" "SUBMITTED" "WAITING_FOR_LOA_SIGNATURE" "IN_PROGRESS" "COMPLETED" "REJECTED"  
type
string
The hosting order type.


 Enum: "HOSTING_ORDER_TYPE_UNSPECIFIED" "IMPORT" "TYPE_TEXT_ENABLE"  
createdTime
string <date-time> 
Timestamp when the hosting order was created


 
updatedTime
string <date-time> 
Timestamp when the hosting order was last updated


 
scheduledOsrUpdateTime
string <date-time> 
Timestamp when the OSR update will be done


 
servicePlanId
string
The service plan to which the hosting order is associated.


 
campaignId
string
The campaign to which the hosting order is associated.


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


 
object (TextEnableInfo) 
 
businessName
string
The name of the business.


 
object (AuthorizedPerson) 
The person authorized and responsible for the hosting order.


 
firstName
required
string
The first name of the authorized person.


 
lastName
required
string
The last name of the authorized person.


 
email
required
string
The email address of the authorized person.


 
object (Address) 
The address of the business.


 
buildingNumber
required
string
The building number of the address.


 
street
required
string
The street name of the address.


 
city
required
string
The city name of the address.


 
state
required
string
The state name of the address.


 
postalCode
required
string
The postal code of the address.


 
country
required
string
The country of the address.


 
serviceProvider
string
 
currentVoiceCarrier
string
The current carrier you are using for voice services for the number you want to host on Sinch.


 
nnid
string
The Net Number ID for the number you want to host on Sinch.


 
loaType
integer <enum> 
The type of the letter of authorization.


 Enum Value Description
Direct
If you are a direct Sinch customer.


Reseller
If you are a Sinch partner or reseller.


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


 
400
Status returned if any of the projectId, displayName, regionCode, numbers, nnid, servicePlanId or campaignId parameters are not valid


404
The imported number, project, hosting order, qualified number or phone number could not be found


409
The imported number already exists and cannot be created


500
Internal server error. Typically, a server bug.


post/v1/projects/{projectId}/hostingOrders:textEnableTollFreeNumbers
Request samples 
application/json
{
  • "regionCode": "US",
  • "numbers": [
    • "+18335870229",
    • "+18339460473"
    ],
  • "servicePlanId": "07d6c2621f364b68856fe4938b7bb78f",
  • "callbackUrl": "https://www.your-callback-server.com/callback",
  • "directLoaInfo": {
    • "authorisedPerson": {
      },
    • "address": {
      },
    • "currentVoiceCarrier": "Verizon",
    • "scheduledZipwhipProvisioningTime": "2023-01-13T14:34:40.968Z",
    • "migrateToSinchTmo": true
    }
}
Response samples 
application/json
{
  • "projectId": "d1923022-5199-4bb3-a513-c47n7a656bc5",
  • "hostingOrderId": "01arz3nhyrtsv4rrffq69g5fav",
  • "displayName": "Hosting order with campaignId, nnid and smsAppId",
  • "regionCode": "US",
  • "state": "SUBMITTED",
  • "type": "TYPE_TEXT_ENABLE",
  • "createdTime": "2023-01-12T14:34:40.968Z",
  • "updatedTime": "2023-01-12T14:34:40.968Z",
  • "scheduledOsrUpdateTime": "2023-01-13T14:34:40.968Z",
  • "servicePlanId": "16e5c8d2odc842bda9a1b90e1673c174",
  • "campaignId": "C3O84GA",
  • "migrateToSinchTmo": true,
  • "callbackUrl": "https://www.your-callback-server.com/callback",
  • "hostingOrderInfo": {
    • "businessName": "Sinch AB",
    • "authorisedPerson": {
      },
    • "address": {
      },
    • "serviceProvider": "Sinch America Inc.",
    • "currentVoiceCarrier": "Verizon",
    • "nnid": "104029",
    • "loaType": "DIRECT"
    }
}
SecurityPrivacyLegal & ComplianceCookie Statement
© 2024 Sinch. All rights reserved.