Portal Configuration

WebRTC SDK Documentation - Portal Config

Sign Up for a Telnyx Mission Control Portal Account

Head to telnyx.com/sign-up to sign up for your free Telnyx account. It’ll give you access to our Mission Control Portal where you can buy phone numbers, set up and manage Call Control Applications, and more.

Create a Credential Connection for your Calls

A Credential Connection groups configuration for your calls, such as which codecs to use (tip: enable VP8 codec for video).

  1. Navigate to the SIP Connections page of the Mission Control Portal.
  2. Click the "+ Add SIP Connection" button near the top right corner of the page.
  3. Enter the name you wish to have for your SIP Connection.

Add SIP ConnectionAdd SIP Connection

  1. Select "Credentials" as the "Connection Type".
  2. A username and password will automatically be generated. You can ignore it for now.
  3. Click "Set Credentials".
  4. Click "Done".

Note: Credential Connections by default have the VP8 codec disabled. Edit the connection "Inbound" settings to enable it.

Edit SIP Connection

Create an Outbound Voice Profile

To be able to place calls, you must first create an Outbound Voice Profile and assign your Credential Connection to it.

Select "Outbound Voice Profiles" on the left-hand navigation menu, click "+Add New Profile" and set up your profile name.

Create Outbound Profile

Add the Credential Connection you just created above and select your traffic type.

Associate Connection to Profile

Customise outbound traffic by Region and Country

Calling countries outside of North America? You can customise your outbound traffic within the Outbound Voice Profile tab's Traffic Type section, which has North America added by default.

You can search for a country within the Available Regions and Countries search bar. Search for your country, hit this plus button and save - in this example, we are adding Irish calling abilities.

Note: Calling internationally will affect the rate at which you are charged, you can view rates by selecting the “View Your Rates” link in the Billing Method section.

Traffic Type

(Optional) Applying a purchased number to your SIP Connection

Purchasing a number and applying it to a SIP connection will allow your connection to be called via the assigned number on the PSTN (Public Switched Telephone Network) by other numbers.

For example, you could use your personal telephone number on your mobile device to call your connection via the number logged into a voice application built with Telnyx SDKs (Mobile or Web).

You can search for, buy, and provision new numbers, or port existing numbers - all within the Numbers section of the Telnyx Portal.

Simply click on "Numbers", then "Search & Buy Numbers", type in your region of choice, as well as the features, and select the search button

Purchase by Region

Once the search completes, a list of available numbers for purchase will be displayed. Select one that is suitable for your use case and press the Add to Cart button

Add Number to Cart

Navigate to your cart and within the Number Orders tab, assign your number to the connection you just made, and then place your order.

Number Orders Cart

Note: A SIP connection that is logged into an application via a token cannot be called from an assigned Number. To do this, make sure to log in with Credentials instead.

Grab your API Key

  1. In the Telnyx Mission Control Portal, in the left menu bar navigate to "API Keys".
  2. Click "Create API key"
  3. Copy the API key and save it somewhere safe.

Create On-demand Credential

Using the API key created in the previous step:

Create the Credential:

curl -X POST \
  --header "Content-Type: application/json" \
  --header "Authorization: Bearer YOUR_API_KEY" \
  --data '{
    "connection_id": "<your connection ID>"
  }' \
  https://api.telnyx.com/v2/telephony_credentials

Example Response:

{
  "data": {
    "id": "68f28076-119e-440d-bb69-9a8d359857c2",
    "name": "2020-08-05 13:42:22.991499Z",
    "record_type": "credential",
    "resource_id": "connection:1431843891430033126",
    "sip_password": "570067b6e4d7495db417e150a81380d9",
    "sip_username": "gencredbcXbCt2uEOaD6e2VN2Bs3b2HDlQVW2v3CJFTQ6Xes9",
    "created_at": "2020-08-05T13:42:22.992Z",
    "expires_at": null,
    "updated_at": "2020-08-05T13:42:22.992Z",
    "user_id": "14c31d6d-aa05-4598-bef8-5acd2197f0c1"
  }
}

Notes:

  • By default, on-demand credentials will not expire.
  • The randomly generated sip_username will be used to receive SIP using <sip_username>@sip.telnyx.com as destination

Generate a token:

curl -X POST \
  --header "Content-Type: application/json" \
  --header "Authorization: Bearer YOUR_API_KEY" \
  --data '{}' \
 https://api.telnyx.com/v2/telephony_credentials/<credential_id>/token

Example Response:

{
  eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJ0ZWxueXhfdGVsZXBob255IiwiZXhwIjoxNTk2NzIxMzg1LCJpYXQiOjE1OTY2MzQ5ODUsImlzcyI6InRlbG55eF90ZWxlcGhvbnkiLCJqdGkiOiJkYmNkZTkzNi04NjdmLTRjMzctYWI1ZS00MGYzY2Q3ODJjZGEiLCJuYmYiOjE1OTY2MzQ5ODQsInN1YiI6IjY4ZjI4MDc2LTExOWUtNDQwZC1iYjY5LTlhOGQzNTk4NTdjMiIsInRlbF90b2tlbiI6IlN4N0tPQU9DblcxUGxIcXVxSEdMT29mTVRiRHJtM1pJM3Bnb1dXX0hkNHNMbmVQUHZXZXh2WXpVQWFLY2pxQ0d2amhfbTQ0S3MwMXFpaEpOMXVMOG95d2Rxdm13ZUExTzZjRlR2UF9jT0J3Skp3bjdZYmJYV3diYW9RR3VabzFNazJIS2dVYjlxQndTVDJxSUZ6dzkwa29CIiwidHlwIjoiYWNjZXNzIn0.ogJujxfbCktNxZ5eeyslLzZylswNqZW4OwLKrkehlb6w-tpbgJ-Ywfgy4Eirmi_BaZ_ThPlgTua0G1jafqFGRw
}

Notes:

  • The response body is a JWT (JSON Web Token) that expires in 24h
  • The token is associated with the Credential and is rendered invalid if the credential expires or is deleted
Was this page helpful?