Skip to content
Elastic SIP Trunking/
/Country Permissions

Elastic SIP Trunk API (1.0.0)

This document provides a detailed user guide and reference documentation on the Sinch Elastic SIP Trunk API. For information on how to authenticate API requests, please check the Authentication section.

Authentication

Elastic SIP Trunk API supports both basic and OAuth2 authentication types.

Basic

HTTP Basic authentication works on all Sinch REST APIs. Basic auth is often the preferred option for testing because it is simple and easy to use.

Important!

Basic authentication is intended for test purposes only, and should only be used for experimenting with APIs and building prototypes. API calls using basic authentication are heavily rate limited, and these limits may change at any time without warning. Production systems should use OAuth access tokens instead.

Basic authentication is sent in the authorization header with each call.

No matter the programming language, there are three main components for successful basic authentication in a request:

  • The designation of authorization type, which is basic
  • The username, which in Sinch's case is YOUR_Key_ID, corresponding to your project
  • The password, which is YOUR_Key_Secret, again, corresponding to the project

You can view and manage your API credentials here.

Need help?

Check out this article for a walk-through on finding your key and secret.

To use basic auth in an API call, do the following:

  1. First, create a new access key in the Sinch Build Dashboard by clicking Create Access Key.

  2. Copy your project ID, key ID, and key secret.

    Important!

    Keep your key secret somewhere safe as it is only viewable upon initial project creation. The project ID and key ID are always readily available in the Sinch Build Dashboard. If you misplace your key secret, simply generate a new key!

  3. Use your key ID as the username (sometimes called the client_id) and your key secret as the password (can be referred to as the client_secret) in every call made to a Sinch API.

OAuth2

Achieve more secure API authentication with OAuth 2.0 access tokens.

Access tokens are short lived. Typically, they will only last one hour. This is done to keep your data (and ours) safer.

In exchanging credentials, you'll get a long string called an access token. This access token will serve as your bearer token in the authorization header of API calls.

Find your credentials in the Sinch Build Dashboard.

There are two pieces of information needed to obtain an access token: the key ID and key secret corresponding to your project ID.

To get an access token, do the following:

  1. Login to the Sinch Build Dashboard to get your access keys.

  2. Click on Create Access Key and when prompted, enter a display name, then click Confirm.

    Does it have to be a new key?

    Not at all. If you have existing credentials saved, feel free to use them.

  3. A Key ID and Key Secret will display. Save the project ID, key ID, and key secret someplace safe.

    Important!

    The key secret is only viewable at the time of initial creation.

    If you accidentally misplace they key secret, no worries! Create a new key.

  4. Using the following curl command, get your access token using the key ID and key secret.

    curl https://auth.sinch.com/oauth2/token \
-d grant_type=client_credentials \
-u YOUR_Key_ID:YOUR_Key_Secret

  5. You'll see your new access token in the response. Now you're ready to use this token on calls to the API. The access token will be useable for one hour.

Short lived

The access token is meant to be short lived for enhanced security. Generate one as often as it is necessary.

Servers

Elastic SIP Trunk API serves all endpoints from the following server:

https://elastic-trunking.api.sinch.com/v1/projects/{projectId}

Note:

The projectId is a required parameter you must include when making any API calls. You can find your project ID on your dashboard.

Download OpenAPI description
est.json
est.yaml
Overview
support at sinch

support@sinch.com

License

MIT

Languages
Servers

https://elastic-trunking.api.sinch.com/v1/projects/{projectId}/

SIP Trunks

The SIP Trunks endpoint has operations that allow you to create, view, update, and remove SIP trunks.

Operations

SIP Endpoints

A SIP endpoint is the resource that represents your SIP infrastructure, typically an SBC. Note the Elastic SIP Trunk API does not support user registration and presence.

Operations

Country Permissions

Country permissions are used to control which countries can be dialed from a specific SIP trunk. You can view, update, and remove country permissions. For beta, only US, CA and wild card are supported. Please note that these permissions are not per trunk but rather they are per project/account. In the future Sinch may extend these permissions to other voice and messaging products. If you are using sub-projects you can use the same country permissions for all sub-projects. You can also specify different country permissions for each sub-project that will override the parent country permissions.

Operations

Fetch all country permissions

Request

Fetches the list of country permissions.

Security
Basic or OAuth2.0
curl -i -X GET \
  -u <username>:<password> \
  'https://elastic-trunking.api.sinch.com/v1/projects/{projectId}/countryPermissions'

Responses

The list of countries available

Bodyapplication/json
countryPermissionsArray of objects(CountryPermission)
Response
application/json
{
  "countryPermissions": [
    { … }
  ]
}

Fetch country permission

Request

Fetches the requested country permission.

Security
Basic or OAuth2.0
Path
isoCodestringrequired

The ISO code of the country.

curl -i -X GET \
  -u <username>:<password> \
  'https://elastic-trunking.api.sinch.com/v1/projects/{projectId}/countryPermissions/{isoCode}'

Responses

The returned country permission

Bodyapplication/json
enabledbooleanrequired

If the country is enabled or not. When this is enabled regular numbers can be dialed from the account.

Default true
Example: true
isoCodestring<= 2 charactersread-only

The ISO code of the country

Example: "US"
namestringread-only

Country name in english

Example: "United States/Canada"
continentstringread-only

Continent of the country

Example: "North America"
countryDialingCodesArray of stringsread-only

The country calling codes as an array, most countries have only one but some have multiple like the San Marino, China, and a few others.

Example: ["+1"]
Response
application/json
{
  "isoCode": "US",
  "name": "United States/Canada",
  "continent": "North America",
  "countryDialingCodes": [
    "+1"
  ],
  "enabled": true
}

Update country permission

Request

Update the requested country permission.

Security
Basic or OAuth2.0
Path
isoCodestringrequired

The ISO code of the country.

Bodyapplication/json
enabledbooleanrequired

If the country is enabled or not. When this is enabled regular numbers can be dialed from the account.

Default true
Example: true
curl -i -X PUT \
  -u <username>:<password> \
  'https://elastic-trunking.api.sinch.com/v1/projects/{projectId}/countryPermissions/{isoCode}' \
  -H 'Content-Type: application/json' \
  -d '{
    "enabled": true
  }'

Responses

The updated country permission

Bodyapplication/json
enabledbooleanrequired

If the country is enabled or not. When this is enabled regular numbers can be dialed from the account.

Default true
Example: true
isoCodestring<= 2 charactersread-only

The ISO code of the country

Example: "US"
namestringread-only

Country name in english

Example: "United States/Canada"
continentstringread-only

Continent of the country

Example: "North America"
countryDialingCodesArray of stringsread-only

The country calling codes as an array, most countries have only one but some have multiple like the San Marino, China, and a few others.

Example: ["+1"]
Response
application/json
{
  "isoCode": "US",
  "name": "United States/Canada",
  "continent": "North America",
  "countryDialingCodes": [
    "+1"
  ],
  "enabled": true
}

Phone Numbers

The /phoneNumbers endpoint has operations that allow you to assign and remove phone numbers from SIP trunks.

Operations

Calls

The /calls endpoint has operations that allow you to retrieve call history and details about calls made or received using EST.

Operations

Access Control List

The Access Control List (ACL) endpoint has operations that allow you to create, view, update, and remove ACLs. You use ACLs to control which IP addresses can send traffic to your SIP trunk. You can create multiple ACLs and assign them to multiple SIP trunks. In order to make outbound calls you need to have at least one ACL set up.

Operations

Credential List

The Credential List endpoint has operations that allow you to view credential lists. You use credential lists to easily configure which users are allowed to make calls on a trunk.

Operations

Projects

Manage your Elastic SIP Trunking projects.

Operations