Inteliquent Voice Platform Developer Resource

Overview

This repository is intended to provide developers, who are looking to develop their applications on the Inteliquent Voice Platform, with useful code from basic building blocks to entire apps. Our goal at Inteliquent is to get your development team to a useful code as fast as possible.

Table of Content

Note: Each code snippet should be associated with an Inteliquent Number/Domain to function as described below.

Code Snippets

• Hello World
• Hello World w/ callback
• Initial script w/ callback
• Forward call to SIP URI
• Forward call to another number
• Forward call to four numbers and loadshare among them
• Forward call to registered SIP client
• Number masking with external proxy
• Transfer caller between two agents
• Dial from registered client
• Snippet
• Record something
• Record something in your GCP bucket
• Voicemail
• Outbound A2P call
• IVR
• IVR with Hubspot integration
• Authenticated conference
• Live transcription
• Key word spotter
• Bi-lingual conversational IVR
• AMD with beep detection
• Appointment reminder
• Busy

Demos:

• Doorman app

WebRTC:

• SIP.js SDK that can be used to integrate with Inteliquent
• Inteliquent specific Integration snippet .js

Hello World see xml

1. Call is answered
2. "Hello World" text is played after text-to-speech conversion.
3. Call is hung-up

Hello World with callback see xml

1. Call is answered
2. "Hello World" text is played after text-to-speech conversion.
3. Call is hung-up
4. Call related information is sent to specified webhook

Initial script with callback and "Hello World" response see xml

Note: This script is equivalent to default webhook configuration seen with e.g. Twilio but with some customization to showcase flexibility. The script expects to receive additional XML from the called webservice with instructions of what to do next.

1. Call is accepted (183 Session Progress returned)
2. Caller hears ringing (200OK + ACK)
3. Webhook is sent to a defined URL with useful parameters ( JSON) as well as information in the HTTP header that can be used for authentication for example. The webservice can use this information to determine what the next steps should be. In our case the webservice responds with simple Hello World XML script.
4. The script will wait up to 4 seconds for this response after which timeout is declared (error equivalent)
5. In case of a timeout or error (e.g. 404) message will be played to a caller informing them of an issue. The script will wait 1 second before this message is played to account for possible network latency don't and to ensure the cut message is not cut off.
6. Originating call leg is hung up

Forward call to SIP URI see xml

1. Call is Accepted
2. Ringing tone is played to calling leg
3. New call leg is initiated to SIP URI
4. INBOUND_CALLER_NUMBER variable is used as Caller Id
5. When SIP URI answers the two call legs are joined
6. When either party hangs up both call legs are hung up

Forward call to another number see xml

1. Call is Accepted
2. Ringing tone is played to calling leg
3. New call leg is initiated to a dialable number
4. INBOUND_CALLER_NUMBER variable is used as Caller Id
5. When called party answers the two call legs are joined
6. When either party hangs up both call legs are hung up

Forward call to four numbers and loadshare among them see xml

1. Call is Accepted
2. Ringing tone is played to calling leg
3. Array of four numbers is loaded as a variable (this array could be requested dynamically with a webhook as well)
4. One number is selected at random and stored as variable called RANDOM
5. New call leg is initiated to the randomly selected number
6. When called party answers the two call legs are joined
7. When either party hangs up both call legs are hung up

Forward call to registered SIP client see xml

1. Call is Accepted
2. Ringing tone is played to calling leg
3. New call leg is initiated to a registered client on Inteliquent's network
4. INBOUND_CALLER_NUMBER variable is used as Caller Id
5. When called party answers the two call legs are joined
6. When either party hangs up both call legs are hung up

Note 1: Inteliquent's syntax allows for the full control of all call legs. This requires that each leg is named. The name is also used to hang up the specific leg should the other one be disconnected first.

Note 2: Client specific domains include the vp.sip.global suffix. Customer specific registration domain will be established during customer onboarding.

Number masking with external proxy see xml

1. Call is Accepted
2. Webhook is sent to masking proxy containing useful network parameters. JSON response is expected with values of the proxy_from and proxy_to numbers
3. JSON parameters are saved in order to be used later in the call
4. New call leg is dialed with the new to/from values
5. When called party answers, the two call legs are joined
6. When either party hangs up both call legs are hung up

Transfer caller between two agents see xml

1. Caller hears IVR prompt
2. Caller is instructed to press 1 or 2
3. Based on their choice SIP client (agent) or WebRTC client(operator) are dialed and connected
4. Customer is provided with option of how to transfer call at any time.
5. If customer pressed 1 and wishes to be transferred to WebRTC operator she can press 2
6. During the transfer the other call leg is hung up.
7. If caller hangs up all call legs are terminated

Dial from registered SIP client see xml

1. Call from client is Accepted
2. Ringing tone is played to calling leg
3. New call leg is initiated to PSTN
4. INBOUND_CALLER_NUMBER variable is used as Caller Id and INBOUND_CALLEE_NUMBER variable is used for the dialed number.
5. When called party answers the two call legs are joined
6. When either party hangs up both call legs are hung up

Snippet see xml

1. Call is answered
2. helloworld snippet is referenced
3. the snippet will convert "Hello World" text to speech and play it to customer.
4. Call is hung-up

Note: Snippets are re-usable code objects. As such they need to be defined at the beginning of the script before any call event (e.g. ) Snippets are very useful in IVRs

Record something see xml

1. Call is answered
2. record_and_playback snippet is called
3. Text is converted to speech and played
4. External Audio file with the "Beep" sound is played
5. Recording with maximum duration of 5 seconds is started.
6. After the 5 second elapsed time the recorded audio is played to customer.
7. Call is hung up

Note: In this example Inteliquent's internal storage product is used. The next example demonstrates the use of Bring Your Own storage functionality as an alternative(Google Cloud Platform is supported). We expect to add AWS to BYOS offering soon.

Record something in your GCP bucket see xml

1. GCP authentication and account information is declared
2. Call is answered
3. record_and_playback snippet is called
4. Text is converted to speech and played
5. External Audio file with the "Beep" sound is played
6. Recording with maximum duration of 10 seconds is started.
7. Format of the file is mp3 (wav is the used if omitted)
8. After the 10 second elapsed time the recorded audio is played to customer.
9. Call is hung up

Note: For more detail refer to our API documentation

Voicemail see xml

1. Snippet voicemail is declared
2. Call is accepted
3. Leg to registered client is dialed.
4. Timer of 20 seconds for the registered client to answer is started
5. Upon expiration of the timer the client leg is hung up
6. voicemail snippet is called
7. Voicemail prompt is played to the caller
8. Audio file with "beep" sound is played
9. Recording with 1 minute max duration is started
10. When recording is complete link to the recording and call parameters is POSTed to a webhook.
11. At the end of the 1 minute timer or whenever the caller hangs up all legs are hung up.
12. Bonus: voicemail snippet is called for variety of cause codes generated by the platform.

Note: For more detail refer to our Disconnect Codes

Outbound A2P call see xml

1. Call from +17200000001 to +17200000002 is dialed
2. When +17200000002 answers text converted to speech is played.
3. Call is hung-up

Note: A2P calls are cURL calls to https://external-api.inteliquent.net/v2/callback/submit?apiKey= , API Key is required before this API endpoint can be used. Above is an example of XML script included in the cURL.

IVR see xml

This code plays back the number pressed on your keypad.

1. Snippet main_menu is declared
2. Snippet ready_dtmfs is declared
3. Call is answered
4. Snippet main_menu is called
5. All previous DTMF tones are flushed out
6. Main Menu text is converted to speech and played
7. Snippet ready_dtmfs is declared
8. Users is asked to press keys 0-9 on their keypad
9. Depending on the digit pressed the user hears Your pressed digit.
10. User is returned to the main menu and can press any of the digits again.
11. Limit of 99 loops is put on the IVR.

IVR with Hubspot Integration see xml

This code is for complex Pizza shop IVR that personalizes the customer experience thanks to integration with Hubspot

1. Customer information is looked up based on their calling number
2. If record is found, customer is greeted by their name
3. They are offered the option to order what they had last time
4. They are also offer to use credit card on file
5. If they want to make a new choice they are given that option and can choose both size and type of pizza.
6. Their order is repeated
7. They can still use their card on file or can enter new credit card
8. Credit card information is sent to payement gateway
9. Order information is sent to the restaurants POS system
10. Caller hears a thank you messege and call hangs up.

Authenticated Conference see xml

This code provides example of authenticated audio conference

1. This script should be attached to a conference access number
2. Caller will hear prompt to enter conference id
3. When customer enters 6 digits a webhook will be sent to customer portal.
4. If the conference exists, the webservice will return PIN code to the platform
5. Caller will hear prompt to enter PIN code.
6. If the PIN code is entered correctly the caller is placed into the conference.
7. Once the caller is joined into the conference she hears message You are now part of the conference room number 654321
8. Customer will have 3 opportunities to enter conf. room and PIN correctly. After 3 failed attempts the call ends

Live transcription see xml

This code will answer a call, record what the caller says and return the transcription to caller in real time

1. GCP authentication and account information is declared
2. Call is answered
3. Disclaimer prompt is played to the caller
4. Recording with max duration of 10 seconds is started
5. Live transcription is started that provides results back every 1s to the specified webhook URL.
6. Upon expiration of 10 second timer call is hung up
7. Link to the recording is sent to specified webhook

Note 1: This service uses our integration with Google and requires Google Account.

Note 2: For more detail refer to our API documentation

Key Word Spotter see xml

This code will return webhook whenever specified word is uttered.

1. GCP authentication and account information is declared
2. Call is answered
3. Prompt is played
4. Recording with max duration of 10 seconds is started
5. Key word spotting service is declared with spotting for words "Yes" and "No".
6. Webhook information for what information should be sent to webhook whenever each word is detected is specified.
7. Upon expiration of 10 second timer call is hung up
8. Link to the recording is sent to specified webhook

Note: For more detail refer to our API documentation

Bi-lingual Conversational IVR see xml

This is an example of 3 layer bi-lingual (English/Spanish) conversational IVR. This is a more advanced application of the key word spotter.

1. GCP authentication and account information is declared
2. Call is answered
3. Main Menu prompts are played in English and Spanish.
4. If customer presses #2 the Spanish language branch is selected, if customer does nothing the English branch is used.
5. Key words are declared for the key word spotter together with the language of the branch.
6. Correct language and voice for Text-to-Speech is declared.
7. Depending on the key word utterances calls may be routed to an agent.
8. Fake ringing tone is used to simulate a call to an agent. In real scenario this would be replaced with a <dial>verb

Note: This is an example of a serverless IVR, if decision making logic is required <query>can be declared in every <onSpeak> event to return the desired behavior.

AMD with beep detection see xml

This is an example of an API call that will deliver voice message to a customer or customer's voicemail and is very useful for all voice notification use cases

1. Call to a number is dialed
2. When call is answered, 1 second pause is added to allow the human to start listening to the message
3. It is assumed that human will answer and an audio file intended for the human is played
4. Answering machine detection (AMD) is started at the same time.
5. If voicemail greeting is detected by AMD the message for the human is stopped
6. When the voicemail beep is detected, a message intended for voicemail is played
7. When the message is completed call is hung up.

Note: A2P calls are cURL calls to https://external-api.inteliquent.net/v2/callback/submit?apiKey= , API Key is required before this API endpoint can be used. Above is an example of XML script included in the cURL.

Appointment Reminder see xml

This is an example of an API call that call customer and reminder of their medical appointemnt and will allow them to change it if required

1. Call to patient's number is dialed
2. API call to your scheduling system is initiated based on patient's number to retrieve any existing appointment times to remind them off
3. Patient hears welcome message with appointment reminder
4. Answering machine detection (AMD) is started at the same time and follows the logic in the previous example
5. Customer is given a choice to keep the existing time or reschedule
6. If they reschedule the newly entered dates are sent back to the scheduling system and if desired time is confirmed patient is notified
7. If date and time are not available Patient is notified and they are asked to dial the office to reschedule their appintment

Note: A2P calls are cURL calls to https://external-api.inteliquent.net/v2/callback/submit?apiKey= , API Key is required before this API endpoint can be used. Above is an example of XML script included in the cURL.

Busy Tone see xml

This code will play busy tone to the caller

1. Plays busy tone without answering the call