This guide will instruct you on how to get started using the Sinch Numbers API. The steps below will walk you through account creation and help you gather the information you'll need to configure the Numbers API for SMS, Voice, or both.
Let's get started!
Using the Numbers API requires signing up for a free account on the Sinch Build Dashboard. If you haven't already done so, sign up now!
Get your project ID and create your access key: First, you'll need your project ID, which can be found in the Sinch Build Dashboard under Setting, then Projects.
Then, create your access key. Access keys are used to authenticate calls when using Numbers API. Access keys are generated in the Sinch Build Dashboard.
Make sure you have your access key, access key secret, and project ID readily available. This information will be required when making the API call to send the text message. The access key and access key secret must be recorded during access key creation. The project ID can be found on the Sinch Build Dashboard's Project Settings page.
The client ID will be readily visible. The secret ID, however, will only be visible upon new key creation. Create a new key and then save your secret ID in a safe place.
You will need both the client ID and the client secret for most endpoints in the Numbers API.
Now, you're ready to search for a virtual number. The cURL command to search for available numbers is below:
curl -i -X GET \
-u <YOUR_access_key>:<YOUR_access_secret> \
'https://numbers.api.sinch.com/v1/projects/YOUR_projectId/availableNumbers?regionCode=US&type=MOBILE&capabilities=SMS'This command searches for available mobile numbers in the US that have SMS capabilities. The placeholder values included in the payload above are detailed in the table below:
| Placeholder value | Your value |
|---|---|
| YOUR_access_key | This is your access key that you created in a previous step. |
| YOUR_access_secret | This is your access secret that you created in a previous step. |
Since this guide is intended for testing purposes, you can use your access key and access secret to authenticate using basic authentication, but for production we recommend using a stronger method of authentication, like OAuth 2.0.
Alternatively, these guides will walk you through setting up a simple application in the following languages (make sure you bring all the information you gathered during this process!):
Our Unified SDKs provide cross-product functionality and streamline code development. Select your preferred language SDK and set up a simple application:
You can access the Voice API directly through HTTP requests. Select your preferred language and learn how to set up a simple application:
Want the whole OpenAPI specification? View it here.
If at any point you need more help, you can find support documentation and answers to frequently asked questions in the Sinch Support Community.