Sinch Developer Documentation

Building blocks to enable rich customer communication

Get a virtual number

Learn how to get, search and configure a virtual number using the Sinch Numbers API.

Get a virtual number in the US

To get a virtual number, you first need to find a number that suits the needs for your application.

Search for a virtual number

Search for virtual numbers that are available for you to get. In this example, you will search for any virtual US number.

curl --request GET \
 --url 'https://numbers.api.sinch.com/v1alpha1/projects/{projectId}/availableNumbers?regionCode=US' \
 --header 'Accept: application/json' \
 -u {clientId}:{clientSecret}

Replace {projectId}, {clientId} and {clientSecret} with your values.

You can filter by any property on the available virtual number resource. Learn more about it in the API specification.

Response

{
  "availableNumbers": [
    {
      "phoneNumber": "+12089087284",
      "regionCode": "US",
      "type": "LOCAL",
      "capability": ["SMS"],
      "setupPrice": {
        "currencyCode": "USD",
        "amount": "0.00"
      },
      "monthlyPrice": {
        "currencyCode": "USD",
        "amount": "2.00"
      },
      "paymentIntervalMonths": 1
    }
  ]
}

Take a note of the phoneNumber, you will need it in the next step.

Get the virtual number

Get a virtual number to use with SMS or Voice products.

curl --request POST \
 --url https://numbers.api.sinch.com/v1alpha1/projects/projectId/availableNumbers/+12089087284:rent \
 --header 'Accept: application/json' \
 --u {clientId}:{clientSecret} 

Replace {projectId}, {clientId} and {clientSecret} with your values.

Response

{
  "phoneNumber": "+12092224786"
}

Get the virtual number and configure it for SMS

Get a virtual number to use with SMS or Voice products.

curl --request POST \
 --url https://numbers.api.sinch.com/v1alpha1/projects/projectId/availableNumbers/+12089087284:rent \
 --header 'Accept: application/json' \
 --u {clientId}:{clientSecret} 
 --d '{"smsConfiguration":{"servicePlanId":"sdfewe383408d"}}'

Replace {projectId}, {clientId} and {clientSecret}, and servicePlanId with your values.

Search for a virtual Toll free number.

Take the same steps as above, but add the virtual number type you are interested in.

curl --request GET \
 --url 'https://numbers.api.sinch.com/v1alpha1/projects/{projectId}/availableNumbers?regionCode=US&type=TOLL_FREE' \
 --header 'Accept: application/json' \
 -u {clientId}:{clientSecret}

Edit on GitHub

Updated 2 months ago


Get a virtual number


Learn how to get, search and configure a virtual number using the Sinch Numbers API.

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.