¶ SIP trunk connection
You can connect TelTel's SIP trunk to your own PBX or call system using one of the following authentication methods:
- Credential-based authentication. Also known as friend connection. This method uses a SIP username and password to connect to our SIP network. This option does not require a fixed IP address and also allows to register the SIP with any softphone of your choice.
- IP-based authentication. This option requires a fixed IP address. Your SIP Trunk does not register with our servers but calls can be made without registration. Using this method, you must add your PBX IP address.
You can find all required data for connecting the SIP trunk via your TelTel account, by going to the Users tab and clicking on the SIP device number.
¶ Method 1: Credential-based authentication
Connection configuration example. You can find DEVICEDID and PASSWORD parameters by opening SIP device data per instruction above.
username=DEVICEID
fromuser=DEVICEID
type=friend
secret=PASSWORD
host=DEVICEID.sip.teltel.io
sendrpid=yes
trustrpid=yes
¶ Method 2: IP-based authentication
To begin, open the SIP device details and click the Edit button in the Authentication Method field. A window will appear, allowing you to switch to IP-based authentication. Enter the IP address of your PBX in the designated field. This IP address will be whitelisted and our system will accept calls from it.
Connection configuration example. You can find DEVICEID as described in the above section.
type=peer
host=DEVICEID.sip.teltel.io
¶ Suppoted codecs
We support the following codecs for media compression:
- aLaw
- uLaw
- GSM
¶ RESTful API
We provide a RESTful API for TelTel services, enabling you to access and manage your account data and resources. For detailed information, please refer to our OpenAPI documentation , which adheres to the OpenAPI v3.0 specification.
To use the API, you'll need an API key, which you can find in the "Settings" section of your TelTel.io account. Authorization with the API key can be done in two ways:
- Include the key in the HTTP query string parameter named "apikey"
- Include the key in the HTTP header named "X-API-KEY"
¶ SMS API
TelTel's SMS API enables you to send and receive text messages globally through a simple RESTful interface. You can programmatically manage a high volume of SMS traffic worldwide. Programmatically send and receive a high volume of SMS anywhere in the world.*
- Easy Integration: Build scalable apps using the web technologies you're already familiar with.
- Efficient Messaging: Send SMS with low latency and high delivery rates.
- Free Incoming SMS: Receive SMS at no cost using SMS-enabled local numbers in various countries.
- Cost-Effective: Pay only for what you use, with no hidden fees.
*A verification process might be required before SMS service is enabled. Contact our support for more details.
¶ Auto Dialer API
TelTel's Auto Dialer API provides a powerful tool for managing campaigns and contacts efficiently through a simple RESTful interface. This API allows you to automate dialing processes, streamline your communication efforts, and ensure more effective campaign management.
- Automated Campaign Management: Easily create, update, and monitor your campaigns programmatically.
- Contact Management: Add, update, and organize your contact lists with ease.
- Scalability: Easily scale your campaigns to match your growing business needs using the web technologies you are already familiar with.
- Customizable Settings: Configure dialing settings to fit your specific business requirements, ensuring optimal campaign execution.
- Integration Capabilities: Integrate with your existing CRM or other systems to enhance workflow efficiency.
¶
Call data
Easily access comprehensive information about each call you make with our API. This functionality allows you to store call data locally or display it within your CRM or other integrated systems.
- Detailed Call Logs: Retrieve in-depth information about each call, including call duration, time, status, and more.
- Data Storage: Store call records on your own systems for future reference and analysis.
- CRM Integration: Seamlessly display call details within your CRM, enhancing your customer relationship management efforts.
¶
HLR test
Utilize our HLR feature through the API to easily verify the availability of phone numbers.
- Number Verification: Quickly check the status and availability of any phone number to ensure it is active and reachable.
- Reliable, real-time Information: Access up-to-date and accurate data, reducing the chances of communication failures.
- Integration Flexibility: Seamlessly integrate HLR checks into your existing workflows and systems through a simple API.
- Cost Efficiency: Save resources by verifying numbers before initiating any communication, ensuring you only reach out to viable contacts.
- Global Reach: Verify phone numbers from around the world, supporting your international communication needs.
¶ Webphone integration into CRM
Webphone is a web application developed by TelTel that allows users to make phone calls directly from their web browser. It leverages built-in browser technology to support voice communications, with WebRTC serving as the standard framework. WebRTC is a stable, secure, and open-source platform known for delivering high-quality sound.
Webphone operates similarly to a softphone, featuring an intuitive interface and clickable buttons for dialing phone numbers worldwide. It is compatible with Windows PCs, macOS, Linux, and Android devices. Users only need to connect a headset to their device to begin making calls.
We provide a fully customizable solution to integrate the Webphone into your own CRM.
¶ Webphone prerequisites
- The recommended browser is Google Chrome (at least version 96). Extensive testing of all of our services were made on this browser, ensuring smooth operations.
- Option Blocking Third-Party Cookies should be turned off.
- Third-party Storage Partitioning should be disabled in Google Chrome for version <129. You can find the option by following the link: chrome://flags/#third-party-storage-partitioning. If you're using the latest Chrome version, this doesn't apply.
¶ Webphone base code
Copy / paste the following script into the source code of your CRM. This is a mandatory minimum for the Webphone to appear. Take in mind, that in this code we included examples of some extra features. You can find explanations of the code further in the documentation.
<body>
<script src="https://www.teltel.io/v2/static/webphone/latest/plugin/webphone.js">
</script>
<script>
var phone = new Phone('user-key');
phone.event("all", function(data) {
if(data.event == 'RING') {
if(data.direction == 'inbound') {
line2 = {
type: "link",
target: "_blank",
url: "https://www.google.com/search?q=" + data.caller,
text: "From: " + data.caller
};
} else {
line2 = "From: " + data.caller;
}
phone.info({
line1: data.event,
line2: line2,
line3: "To: " + data.callee,
});
}
});
phone.action(function(data) {
if(data.action == 'click') {
window.open(data.url, "", "width=300, height=300");
}
});
function myFunctionClick2Call(number) {
phone.call(number);
phone.info({
line1: "You are calling to",
line2: number,
line3: {
type: "link",
target: "callback",
url: "https://www.google.com/search?q=" + number,
text: "Number lookup"
}
});
}
</script>
<a href="javascript:myFunctionClick2Call('18271627')">
Call to 18271627
</a>
</body>¶ Webphone initialization / authorization
Place the following script into the source code of your CRM system. Replace the user-key with the speicific user API key to open the Webphone for that user. This is a mandatory minimum for the Webphone to appear on a page.
<body>
<script src="https://www.teltel.io/v2/static/webphone/latest/plugin/webphone.js">
</script>
<script>
var phone = new Phone('user-key');
</script>
</body>user-key - this unique key is used to authorize and identify individual users of the Webphone. You can find it in the "Users" section of your TelTel profile by clicking on the SIP device assigned to the specific user.
¶ Webphone user and CRM user mapping
Any CRM system has its own set of users. Since TelTel platform maintains a separate user database from the CRM system, it is necessary to map users between the two systems. When a CRM user logs into the CRM system and the system needs to initialize the Webphone, it is essential to identify the Webphone's user-key for that specific user. The user-key is stored in the TelTel database. To obtain the list of users in your TelTel account, you can make the following HTTP API request:
GET https://api.teltel.io/v2/users?apikey=account-api-keyWhere account-api-key is your account API key, which you can find in your account settings.
The response will be a JSON object containing an array of user objects. Key attributes include:
- api_key: This should be used for Webphone authorization.
- name: We strongly recommend using the "name" attribute as the user mapping identifier, as its value never changes.
For more information about API methods, please refer to TelTel API Documentation.
¶ Webphone Click2Call
Click2Call is a feature that uses a hyperlink to initiate a call from the Webphone. There are two options for generating these hyperlinks:
- Manually Generated Hyperlinks: These can be created by modifying your CRM source code to include the necessary phone number links.
- Automatically Generated Hyperlinks: By enabling the relevant Webphone setting, the Webphone can automatically detect phone numbers on the web page and make them clickable, allowing users to start a call with a simple click.
¶ Option 1 : manually generated hyperlinks
The function phone.call() must be used to start the call.
<a href="javascript:click2call('37120031413')">Call +37120031413</a>
<script>
var phone = new Phone('user-key');
function click2call(number) {
phone.call(number);
}
</script>¶ Option 2 : automatically generated hyperlinks
Please specify the "click2call" attribute during the Webphone initialization phase. For further customization options of the Click2Call feature with this option, refer to the following section, Webphone properties.
<script>
var phone = new Phone('user-key', {
click2call: {
clickableNumbers: true,
}
});
</script>¶ Webphone properties
Webphone can be initialized with additional properties that enable or disable specific features. See below all available parameters. Please note, that the agents can also configure these parameters by pressing the settings icon in their Webphone. If required, you can also block permission to these settings for users.
<script>
var phone = new Phone('user-key', {
click2call: {
// Find numbers in a page and makes them clickable for Click2Call
// Default is false
clickableNumbers: true,
// Custom regular expression for number finding
clickableNumbersRegex: /(?<=\s+|^)(\+\d{1,3}[ -]{0,1}\d{7,11})(?=\s+|$)/gm,
// Allow numbers in <a> elements too, default is false
clickableLinks: true,
// Allow only the following protocols for <a> elements
// Default is "tel"
clickableLinksProtocol: "tel, mailto",
// Make call immediately after the click on hyperlink
// Default is true
autoCall: true,
},
expand: {
// Expand web phone on incoming call, default is false
onCallIn: true,
// Expand web phone on outgoing call, default is false
onCallOut: true,
}
});
</script>¶ Webphone info lines
The Webphone has 3 info lines that represent essential details about a call. When you make or receive a call then by default each info line shows the following information:
- 1st line - caller/callee number
- 2nd line - caller/callee name
- 3rd line - empty line
You have the ability to override default values in info lines.
The function phone.info() must be used to override values in info lines.
<script>
function click2call(number) {
phone.call(number);
/*
Here you can write your own method to get
information what you would like to show in info lines.
For example, you can find the lead by number
and show the lead's name and status in info lines.
*/
phone.info({
line1: "number",
line2: "Some text",
line3: {
type: "link",
url: "http://www.teltel.io",
text: "This is a link to teltel",
dataset: {
lorem: "ipsum"
}
},
});
}
</script>Parameter line[N] (line1, line2, line3) can be a string, an object or point to variables in data object.
Data object contains crucial call event information, like caller and callee number, direction of the call, timestamp and so on. Check out the next section for more information on this. You can display these parameters in info lines of the Webphone.
Object definition currently has only one type - “link”. Object with this type will be represented as an <a> tag in Webphone and should contain the following params:
- url - the URL address that will be <a> tag’s href attribute;
- text - visible text;
- target - target of the link. Default value: “callback”;
- dataset - an object that will be represented as data-* attributes of <a> tag.
¶ Webphone events
You can catch events for each call. There are 3 types of events:
- RING - dial started
- RINGRESULT - dial result
- COMPLETED - call ended.
Depending on the event you can execute your own special logic. Each event has it's own set of parameters.
The function phone.event() must be used to catch call events.
<script>
phone.event("all", function(data) {
/*
The "data" contains event details,
for example, callee and caller number.
*/
/*
Execute here your own special logic.
*/
});
</script>¶ Webphone actions
You can catch user actions within the Webphone by calling function phone.action().
For example if you set info lines with type “link” with target “callback”, you can capture the clicks on that link.
<script>
phone.action(function(action) {
/*
The "action" object contains data about the user action,
for example, what type of user action it is,
target element and some info about the element.
*/
});
</script>¶ Click2Call URL
Easily integrate TelTel call service with your CRM or other software using our Click2Call URL. The functionality is as follows: our server connects to the agents SIP device or your phone (A leg) and then the phone of the person you want to reach (B leg). Both connections are made via the telephone line or SIP, so there is no need to use the internet or any other program.
apikey - Found in the settings of your TelTel account.
called - Here you can either enter a SIP number of the agent that should be connected to the client, or a phone number.*
calling - The number of the client to be connected to the agent.
callerid - Any number that will be displayed to the agent. You can set this to the client's number, for example.
callerid_b - The number that will be displayed to the client during the call. Here, it's best to use a proper number that was purchased from TelTel. In case if called parameter is set to a SIP number, you can leave this parameter empty and the system will automatically select a number from the Caller ID’s assigned to this user in your TelTel profile. You can also choose a Caller ID group, by entering the prefix ID of the group - for example c1, c2… and the system will pick a Caller ID from the assigned group.
To get all Caller ID groups assigned to the user use:
https://api.teltel.io/v2/public/users/<user_id>/cidgroups?apikey=<apikey>
If your request is valid and the call is successfully initiated, you will receive an "OK" response with a status code of 200.
However, if there is an issue with your request, you will receive an error response with details of the reason for failure.
* In the first case there will be only 1 call that will have a charge, in the second case there will be 2 calls in total that will be charged. This is because the call to the SIP device is an internal call and is free of charge.
¶ Click2Call (Simple)
Click2Call allows users to easily make outbound calls to phone numbers found on web pages, emails, and contact lists with just the click of a button. Unlike the URL option, this is easily configured and can be used immediately. When a user clicks on a phone link, their softphone automatically opens and initiates a call to the selected number.
For this to work and cover most numbers on pages, enable the following parameters in Webphone settings:
- Clickable phone numbers - this option will recognize phone numbers on the page based on the default regex. You can also edit the phone number recognition regex in the appropriate field of Webphone settings.
- Clickable links - this option will make links with predefined protocols become clickable. You can edit which protocols will be recognized in the Clickable link protocal field. Most widely used are tel, callto and zoiper.
Next, make sure that you have set the correct protocol associations for the links to work correctly. On Windows, you can edit them by going to:
Control Panel > Programs > Default Programs > Set Associations.
Here are HTML code examples of c2c links:
<a href="zoiper://3716666666">Call 3716666666</a>
<a href="tel://3716666666">Call 3716666666</a>You can add custom parameters separated by a vertical bar |:
<a href="zoiper://3716666666|123">Call 3716666666</a> In this example, the 123 parameter could be a customer ID or call ID, which will be included in the TelTel call list and webhooks.
¶ Webhooks
Webhook notifications are used to receive real-time information about call events. This allows you to connect and sync other applications - such as customer databases, ERP, CRM, helpdesk, chat systems, e-commerce shopping carts, etc. with TelTel call center software.
To enable notifications, please log in and navigate to the Settings of your account: https://www.teltel.io/account/main
Enter the URL where you want to receive the call event data in the "Webhook for full call notifications URL" field. An example of a URL, that you might use: https://test.com/teltelwebhook?data=
Webhook responses are returned as JSON-encoded strings via the GET method.
You can find detailed information about the list of events and the corresponding data received here: www.teltel.io/integrations/events
If you wish to download call recordings, you can use the following link :https://storage.teltel.io/playaudio?uniqueid=[encryptedID]&download=1
Feel free to contact us if you have any questions.
¶ Call forwarding
Call Forwarding allows you to redirect incoming calls based on your own custom rules executed on your server. This feature allows for further customization to fit the unique needs of your organization.
In Call Flow, add an HTTP Notification element and enter the URL to your server script.
- When an incoming call is received, TelTel will send an HTTP request to your server.
- You can set up a custom parameter by responding to this request. For example, your response might include: `param_1:EXTENSION`.
- In the Call Flow, add a Call To SIP element and enter `(param_1)` in the phone number field.
- TelTel will automatically forward the call to the custom parameter you specified.
¶ Inbound SMS forwarding
To forward your inbound SMS, go to the Phone numbers page, press More under an eligible DID number and click Receive SMS by email or URL. Numbers that are able to receive SMS are marked with envelope icon.
In the configuration popup you can set both a Webhook and an e-mail to forward your incoming SMS.
If Webhook is set a GET request will be made with the following query parameters:
- originator;
- message;
- msg_id;
- recipient;
- price.
If e-mail is set an SMS will be forwarded to this email address. In the e-mail you will receive the following information:
- sender number;
- receiver number;
- message text.
¶ WebSocket events
You can receive certain WebSocket events if that is required. Contact us for more information.
Example:
wscat -c wss://events.teltel.io
> user:<SIP device>[ENTER]
> password:<password for SIP device>[ENTER]
> login[ENTER]