Text enable numbers

Request

Enables text capability for the specified qualified numbers. You can enable up to 500 numbers at once. To enable a number for SMS, you must include a Campaign ID and billing information for a Letter of Authorization to be generated. The information required can differ depending on if you are a direct customer of Sinch or a reseller. The Letter of Authorization will be sent to the email you provide in the request to be e-signed.

Security

Basic or OAuth2.0

Path

projectIdstringrequired

Found on your Sinch Customer Dashboard. Settings > Projects.

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

Bodyapplication/jsonrequired

regionCodestringrequired

The region code for the hosting order.

Example:"US"

numbersArray of stringsrequired

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

Example:

[
  "+12025550134"
]

servicePlanIdstringrequired

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

Example:"YOUR_service_plan_id"

projectIdstring

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

Example:"YOUR_project_id"

displayNamestring

The optional display name of the hosting order.

Example:"MyHostingOrder"

nnidstring

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.

campaignIdstring

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

Example:"YOUR_campaign_id"

directLoaInfoobject(DirectLoaInfo)

Letter of Authorization for direct Sinch customers.

resellerLoaInfoobject(ResellerLoaInfo)

Letter of Authorization for resellers.

blanketLoaInfoobject(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.

scheduledOsrUpdateTimestring, (date-time)

The scheduled time for OSR to be updated.

callbackUrlstring

The client's callback URL to be called for text enablement updates.

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

curl -i -X POST \
  -u '<username>:<password>' \
  https://imported.numbers.api.sinch.com/v1/projects/d1923022-5199-4bb3-a513-c47b3a656bc5/qualifiedNumbers:textEnableNumbers \
  -H 'Content-Type: application/json' \
  -d '{
    "regionCode": "US",
    "numbers": [
      "+12025550134"
    ],
    "servicePlanId": "YOUR_service_plan_id",
    "campaignId": "YOUR_campaign_id",
    "directLoaInfo": {
      "authorisedPerson": {
        "firstName": "John",
        "lastName": "Doe",
        "email": "john.doe@email.com"
      },
      "address": {
        "buildingNumber": "1234",
        "street": "Main St",
        "city": "NYC",
        "state": "NY",
        "postalCode": "01002",
        "country": "US"
      },
      "currentVoiceCarrier": "Verizon"
    },
    "scheduledOsrUpdateTime": "2023-01-13T14:34:40.968Z",
    "migrateToSinchTmo": true
  }'

Responses

OK

Bodyapplication/json

hostingOrderIdstring

The ID of the hosting order.

Response

{
  "hostingOrderId": "string"
}

We'd love to hear from you!