Using the Voice API requires signing up for a free account on the Sinch Build Dashboard. If you haven't already done so, sign up now!
Follow the steps below to learn how to quickly start making calls using the Sinch Voice API:
Get your free Sinch testing number. When you sign up for a Sinch Build Dashboard account, you get a free virtual number for testing. You must activate your test number before you can use it. To activate your number, simply click the link.
Assign your number to your Voice app. After your number is activated, navigate to your apps. You'll be redirected to the Test Application which was automatically created for you. Under Assigned Numbers, click Add Numbers and assign your free number to your app.
Also take note of your app's key and secret, as you will need these to authenticate your request and make your call.
Now you're ready to get started making calls with Voice API. The raw payload to make a text to speech call is below:
{
"method": "ttsCallout",
"ttsCallout": {
"cli": "YOUR_Number",
"destination": {
"type": "number",
"endpoint": "YOUR_Destination_number"
},
"locale": "en-US",
"text": "Hello, this is a call from Sinch."
}
}
The placeholder values included in the payload above are detailed in the table below:
Placeholder value | Your value |
---|---|
YOUR_Number | This is your test number that you activated in a previous step. |
YOUR_Destination_number | This is a number you have verified in the Build dashboard. |
If you already have experience making API calls, you could create a simple app that makes the phone call in your preferred coding language, or even make a simple cURL command. Use the payload to make a POST
API call to https://calling.api.sinch.com/calling/v1/callouts
. Include authentication information in the header. Since this guide is intended for testing purposes, you can use your application key and application secret to authenticate using basic authentication.
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:
If at any point you need more help, you can find support documentation and answers to frequently asked questions in the Sinch Support Community.