Text enable Toll Free qualified numbers

Request

Text enable Toll Free qualified numbers of a specific project by creating a hosting order.

Security

Basic or OAuth2.0

Path

projectIdstringrequired

Found on your Sinch Customer Dashboard. Settings > Projects.

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

Bodyapplication/jsonrequired

The request to text-enable hosting orders Toll Free numbers in the current project

One of:

Request for text enabling project Toll Free numbers.

directLoaInfoobject(DirectLoaInfo)required

Letter of Authorization for direct Sinch customers.

allOfobject(TextEnableTollFreeNumbersLoaInfoCommon)

curl -i -X POST \
  -u '<username>:<password>' \
  https://imported.numbers.api.sinch.com/v1/projects/d1923022-5199-4bb3-a513-c47b3a656bc5/qualifiedNumbers:textEnableTollFreeNumbers \
  -H 'Content-Type: application/json' \
  -d '{
    "regionCode": "US",
    "numbers": [
      "+18335870229",
      "+18339460473"
    ],
    "servicePlanId": "07d6c2621f364b68856fe4938b7bb78f",
    "callbackUrl": "https://www.your-callback-server.com/callback",
    "directLoaInfo": {
      "authorisedPerson": {
        "firstName": "John",
        "lastName": "Smith",
        "email": "email@domain.com"
      },
      "address": {
        "buildingNumber": "2433",
        "street": "Vesta Drive",
        "city": "Chicago",
        "state": "IL",
        "postalCode": "60647",
        "country": "US"
      },
      "currentVoiceCarrier": "Verizon",
      "scheduledZipwhipProvisioningTime": "2023-01-13T14:34:40.968Z",
      "migrateToSinchTmo": true
    }
  }'

Responses

A successful response with a hosting order, or an error

Bodyapplication/json

projectIdstring

The project ID to which the hosting order is associated.

Example:"YOUR_project_id"

hostingOrderIdstring

The unique ID of the hosting order.

Example:"YOUR_hosting_order_id"

displayNamestring

The friendly name of the hosting order.

Example:"MyHostingOrder"

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".

Example:"US"

statestring

The state of the hosting order.

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.

typestring

The hosting order type.

Enum Value	Description
HOSTING_ORDER_TYPE_UNSPECIFIED	The type of hosting order is unspecified.
IMPORT	Hosting order to import numbers.
TYPE_TEXT_ENABLE	Hosting order to text-enable numbers.

createdTimestring, (date-time)read-only

Timestamp when the hosting order was created

updatedTimestring, (date-time)read-only

Timestamp when the hosting order was last updated

scheduledOsrUpdateTimestring, (date-time)read-only

Timestamp when the OSR update will be done

servicePlanIdstring

The service plan to which the hosting order is associated.

Example:"YOUR_service_plan_id"

campaignIdstring

The campaign to which the hosting order is associated.

Example:"YOUR_campaign_id"

migrateToSinchTmobooleanread-only

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

textEnableInfoobject(TextEnableInfo)

callbackUrlstring

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

Example:"https://www.your-callback-server.com/callback"

Response

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

We'd love to hear from you!