This is the API V2 documentation. To switch out of beta revert back to our API V1.

Open SidemenuAPI Reference
API Reference
Close Sidemenu

Overview

Use Telnyx for Real Time Communication embedded in your web applications.

  • WebRTC is currently under development

The WebRTC product and SDK enables you to:

  • Build mobile clients that embed real time communications
  • Generate on-demand tokens for your clients
  • Add real time video communication to your web applications

GUIDES AND EXAMPLESguides-and-examples

WebRTC SDKwebrtc-sdk

Telnyx WebRTC SDK is available for both Javascript and React-Native:

Getting Started with WebRTCgetting-started-with-webrtc

Requirementsrequirements

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 Usageconfiguration-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 SDKTelnyx Developers. 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.

Glossaryglossary

TermDescription
Credential ConnectionUsed to configure inbound/outbound calls for one or more credential
Outbound Voice ProfileUsed to configure outbound traffic and billing for one or more phone numbers
On-demand CredentialAn expiring SIP credential associated with a Connection, created via API.
JWTJSON Web Token. A standard method for representing claims (https://jwt.io/Telnyx Developers)
Access Token (JWT)A token associated with an On-demand Credential and used for authenticating to Telnyx WebRTC
API KeySecret API Key generated via Portal and used to authenticate Telnyx API calls.
WebRTC SDKA library used to provide RTC features to your application using Telnyx WebRTC platform.
Guided Exampleguided-example

Follow our guided example to set up WebRTC SDK using JWT and place SIP calls.