Skip to main content

Endpoints

Introduction​

CarrierX endpoints are used as connection points between regular phones – both landline and mobile – and external applications representing various types of software phones. Applications hosted and developed by CarrierX, as well as third-party VoIP software, all use these endpoints to communicate with the users on the other side of the phone line. That is why endpoints are an important concept of the CarrierX API.

Third Party Endpoint​

CarrierX third_party endpoint type is a set of configs that allows a calling number to find and connect to your application, which will manage the call by its own means. For this, a Third Party endpoint on the CarrierX side needs to have the following information:

  • The application public IP address, which must be accessible by the CarrierX Third Party endpoint;
  • The application port (or it defaults to 5060), which must also be opened for the CarrierX Third Party endpoint;
  • The transport protocol used by the application (tcp, tls, or udp).

A typical call flow for a Third Party endpoint will look like this:

Third Party Endpoint Inbound

Here, the caller dials a phone number, then they are connected via the PSTN to the CarrierX DID, and then to the Third Party endpoint via trunks in the trunk group associated with that particular endpoint. Once the endpoint is reached, it passes call flow control to your application, which manages the call by itself from now on. This means that all the call data is sent to the application, and the application must be able to process the data.

note

Third Party endpoints use both inbound and outbound connections.

A Third Party endpoint with an outbound call looks almost the same, the call is originated by your VoIP application and directed to a regular phone (landline or mobile).

Third Party Endpoint Outbound

Further Reading​

Endpoint Object API Reference​

Refer to the Endpoint object API reference to get the complete list of the endpoints attributes and methods used with the endpoints:

How It Works​

Read the following articles to get a better understanding of how things work in CarrierX:

  • shared_menu/how_bottom