Bring Your Own Number

Last updated on 2024/11/08

The Bring Your Own Number (BYON) API allows you to incorporate voice calling capabilities using a T-Mobile phone number into your application. Whether you're building a SIM call forking system, a click to call application that uses your customer’s SIM line, or any other communication-based application, the BYON voice calling API will help you do it.

Using WebRTC, your application will be able to use the BYON API to make and receive voice calls through over-the-top VOIP internet data connections, as well as placing calls on hold, resuming them, and ending calls, all via simple API requests.

To get started, you need:

An active DevEdge account

Create a DevEdge account, if you haven't already.
An active BYON API subscription

Subscribe here if you don't have an active subscription.
A registered application

See the documentation for more info.
Your API keys

Get your API keys from the DevEdge dashboard. Instructions here.

Getting Started

Using WebRTC for Voice Calls

To use the BYON API for voice calling, your application will need to use WebRTC. Click below to learn more about WebRTC and how to use it with the BYON API.

Linking User Lines

To place and receive voice calls with the BYON API, your application must be authorized to use a T-Mobile subscriber's line. Click below to learn more about how to build this functionality into your solution.

Establishing a Notification Channel

The BYON API needs to be able to notify your application when events related to your user's lines occur, including inbound call requests, updates to the status of an active call, and call-end notifications. Click below to learn more about how to build this into your application.

Managing Voice Calls

Starting a Voice Call

Learn how to start oubound calls and accept inbound call requests using the BYON API.

Holding Calls

Learn how to place active calls on hold from both the perspective of the party initiating the action, and the recipient.

Resuming a Call

Learn how to resume an active call previously placed on hold using the BYON API.

Ending a Call

Learn how to end an active call using the BYON API.

Managing Call Logs

Use the BYON API to fetch call log details

Managing Voicemails

Learn how to retrieve voicemail information and details with the BYON API.

Additional Resources

API Reference

Dig into the technical details for the BYON Calling API, including specifics of the methods, request parameters, and expected responses.

See API Reference

Tools and Sample Code

Check out our Postman Collection and code samples

Did you find what you were looking for?

Complete this short survey to help us improve this documentation. Your feedback is appreciated.