Import number

Request

You can use the Import Numbers API to import a non-Sinch number that you want to enable for SMS with Sinch as the Direct Connectivity Aggregator (DCA) without porting (or even partially porting) the number.

Note: Customers who are importing numbers (i.e. want to use their own NNID) will need to complete the NNID provisioning process to support proper message routing with the carriers. To learn more, refer to the article How can you provision a Network Number ID (NNID)?

Security

Basic or OAuth2.0

Path

projectIdstringrequired

Found on your Sinch Customer Dashboard. Settings > Projects.

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

Bodyapplication/jsonrequired

regionCodestringrequired

ISO 3166-1 alpha-2 country code of the phone number. Example US, UK or SE.

Example:"US"

smsConfigurationobject(SmsConfiguration)required

Configuration for SMS

phoneNumberstring

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

Example:"+12025550134"

projectIdstring

The ID of the project resource. You can find your project ID on dashboard.sinch.com.

Example:"YOUR_project_id"

displayNamestring

User supplied name for the phone number.

Example:"MyPhoneNumber"

callbackUrlstring

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

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/importedNumbers \
  -H 'Content-Type: application/json' \
  -d '{
    "regionCode": "US",
    "smsConfiguration": {
      "servicePlanId": "YOUR_service_plan_id",
      "campaignId": "YOUR_campaign_id",
      "migrateToSinchTmo": true
    },
    "phoneNumber": "+11234567890",
    "displayName": "MyPhoneNumber",
    "callbackUrl": "https://www.your-callback-server.com/callback"
  }'

Responses

Bodyapplication/json