Overview

Getting Started with WebRTC

Requirements

WebRTC calls can be received without requiring the purchase or porting of a number. You will need:

• An API Key
• A connection of type Credential Connection
• A Credential for that connection
• A Token for authenticating to Telnyx WebRTC

Configuration and Usage

Telnyx WebRTC is enabled using Credential Connections. You can set up several connections to differentiate between use cases. A Credential Connection groups configuration for your calls, such as which codecs to use (tip: enable VP8 coded for video).

A Credential Connection will be used to set up On-demand Credentials which provide expiring telephony credentials sharing the connection configuration. A JWT (JSON Web Token) can be created for these On-demand Credentials to be used by client-facing applications using a WebRTC SDK.

Every On-demand Credential and Access Token (JWT) can be used to receive Inbound Calls using SIP addresses and for placing Outbound Calls.

To create a Credential Connection, On-demand Credentials and JWTs, use our APIs and authenticate using the API Key associated with your Mission Control account under API Keys. Find out more about authenticating with API V2 here.

WebRTC functionality can be added to your app using one of our WebRTC SDKs. For testing purposes we provide a sample application that uses our Javascript SDK. With this application you can authenticate to Telnyx WebRTC servers using either a SIP username/password or a JWT and be able to receive and place calls using audio and video.

Glossary

Term	Description
Credential Connection	Used to configure inbound/outbound calls for one or more credential
Outbound Voice Profile	Used to configure outbound traffic and billing for one or more phone numbers
On-demand Credential	An expiring SIP credential associated with a Connection, created via API.
JWT	JSON Web Token. A standard method for representing claims (https://jwt.io/)
Access Token (JWT)	A token associated with an On-demand Credential and used for authenticating to Telnyx WebRTC
API Key	Secret API Key generated via Portal and used to authenticate Telnyx API calls.
WebRTC SDK	A library used to provide RTC features to your application using Telnyx WebRTC platform.

JavaScript Client SDK

The Telnyx WebRTC Client SDK provides all the functionality you need to start making voice & video calls from a browser.

Adding Telnyx to your JavaScript client application

Include the @telnyx/webrtc npm module as a dependency:

npm install @telnyx/webrtc --save

Copy Code

Then, import @telnyx/webrtc in your application code.

// main.js
import { TelnyxRTC } from '@telnyx/webrtc';

Copy Code

Adding Telnyx to your React application

Our @telnyx/react-client library is the quickest way to get up and running if your application is written in React. See react-client on GitHub for all available components and hooks.

npm install @telnyx/react-client --save

Copy Code

// App.js
import {
  TelnyxRTCProvider,
  /* Or, if you prefer React hooks: */
  // useTelnyxRTC
} from '@telnyx/react-client';

Copy Code