ConneXML¶

Example

<Response> <!--Body of the code>
    <!-- Here, Play and Dial are the Verbs -->
    <Play loop="2">http://www.music.com/fun.wav</Play>
    <Dial>
        <!-- Number is a Dial Noun -->
        <Number>189765441</Number>
    </Dial>
</Response>

Example

<?xml version="1.0" encoding="UTF-8"?>
<Response>
    <Hangup/>
</Response>

Example

<?xml version="1.0" encoding="UTF-8"?>
<Response>
    <Say>I will pause default time starting now!</Say>
    <Pause/>
</Response>

Example

<?xml version="1.0" encoding="UTF-8"?>
<Response>
    <Pause length="10"/>
    <Say>I just paused 10 seconds</Say>
</Response>

Example

<?xml version="1.0" encoding="UTF-8"?>
<Response>
    <Say>This is better  text to speech.</Say>
</Response>

Example

<?xml version="1.0" encoding="UTF-8"?>
<Response>
    <Reject/>
</Response>

Example

<?xml version="1.0" encoding="UTF-8"?>
<Response>
    <Reject reason="busy"/>
</Response>

Example

1. Loop

   <?xml version="1.0" encoding="UTF-8"?>
   <Response>
       <Play loop="3">ivr/ivr-invalid_number_format.wav</Play>
   </Response>
   

2. Local Files

   <?xml version="1.0" encoding="UTF-8"?>
   <Response>
       <Play>ivr/ivr-invalid_number_format.wav</Play>
   </Response>
   

3. Remote HTTP

   <?xml version="1.0" encoding="UTF-8"?>
   <Response>
       <Play>https://file-examples.com/storage/fef3ad87fb6568c5a9d7b04/2017/11/file_example_WAV_1MG.wav</Play>
   </Response>
   

4. User Files

   <?xml version="1.0" encoding="UTF-8"?>
   <Response>
       <Play>user/adam.wav</Play>
   </Response>
   

Example

<?xml version="1.0" encoding="UTF-8"?>
<Response>
    <Redirect>http://yourdomain.com/connex/test.xml</Redirect>
</Response>

Example

<Response>
    <Redirect method="GET">https://yourdomain.com/yourscript.php</Redirect>
</Response>

Example

<?xml version="1.0" encoding="UTF-8"?>
<Response>
    <Gather actionOnEmptyResult="false" action="https://yourdomain.com/youwebserver.php" method="GET" numDigits="6" finishOnKey="*" timeout="120">
        <Play>https://samplelib.com/lib/preview/wav/sample-12s.wav</Play>
    </Gather>
    <Say>Sorry.The entered number in invalid</Say>
</Response>

Example

<?xml version="1.0" encoding="UTF-8"?>
<Response>
    <Enqueue>1000</Enqueue>
</Response>

Example

<?xml version="1.0" encoding="UTF-8"?>
<Response>
    <Dial>123456</Dial>
</Response>

Example

1. callerID

   <?xml version="1.0" encoding="UTF-8"?>
   <Response>
       <Dial callerId="1234">12345</Dial>
       <Say>This is after hangup.</Say>
   </Response>
   

2. fromDisplayName

   <?xml version="1.0" encoding="UTF-8"?>
   <Response>
       <Dial fromDisplayName="1234">12345</Dial>
       <Say>This is after hangup.</Say>
   </Response>
   

3. hangupOnStar

   <?xml version="1.0" encoding="UTF-8"?>
   <Response>
       <Dial hangupOnStar="true">12345</Dial>
       <Say>This is after hangup.</Say>
   </Response>
   

4. ringTone

   <?xml version="1.0" encoding="UTF-8"?>
   <Response>
       <Dial fromDisplayName="1234" ringtone="in">160</Dial>
   </Response>
   

5. timeout

   <?xml version="1.0" encoding="UTF-8"?>
   <Response>
       <Dial timeout="60">123456</Dial>
   </Response>
   

6. Number

   <?xml version="1.0" encoding="UTF-8"?>
   <Response>
       <Dial>
           <Number>4423456789</Number>
       </Dial>
   </Response>"
   

7. Queue

   <?xml version="1.0" encoding="UTF-8"?>
   <Response>
       <Dial>
           <Queue>1000</Queue>
       </Dial>
   </Response>
   

8. Client

   <?xml version="1.0" encoding="UTF-8"?>
   <Response>
       <Dial>
           <Client>test1</Client>
       </Dial>
   </Response>
   

9. Conference

   <?xml version="1.0" encoding="UTF-8"?>
   <Response>
       <Dial>
           <Conference>Room5</Conference>
       </Dial>
   </Response>
   

10. Voicemail

    <?xml version="1.0" encoding="UTF-8"?>
    <Response>
        <Dial>
            <Voicemail />
        </Dial>
    </Response>
    

11. Voicemail Inbox

    <?xml version="1.0" encoding="UTF-8"?>
    <Response>
        <Dial>
            <Voicemail inbox="true">
             <Voicemail/>
        </Dial>
    </Response>
    

12. Barge (Default Method)

    <?xml version="1.0" encoding="UTF-8"?>
    <Response>
        <Dial>
            <Barge></Barge>
        </Dial>
    </Response>
    

13. Barge

    <?xml version="1.0" encoding="UTF-8"?>
    <Response>
        <Dial>
            <Barge>
                whisper="a" <!-- Enables whisper mode in the A leg-->
                bridge="b" <!-- Enables listen to B leg -->
                commands="false" <!-- Disables DTMF signals/commands during barge -->
            </Barge>
        </Dial>
    </Response>
    

14. Barge (Group)

    <?xml version="1.0" encoding="UTF-8"?>
    <Response>
        <Dial>
            <Barge
            >GROUPA</Barge> <!-- Listens to the conversation of the specified group. If no group is mentioned, it can listen to any ongoing calls for this customer -->
        </Dial>
    </Response>
    

15. statusCallbackEvent, statusCallback, statusCallbackMethod

    <?xml version="1.0" encoding="UTF-8"?>
    <Response>
        <Dial>
            <Client
            statusCallbackEvent="initiated ringing answered completed"
            statusCallback="https://api.example.com/compile?rateCompact=true&ids=101,202,303"
            statusCallbackMethod="POST">
            7900
            </Client>
        </Dial>
    </Response>
    

    Send updates about the call's lifecycle (initiated, ringing, answered, and completed) to the callback URL via HTTP POST requests.

16. Queue music

    <?xml version="1.0" encoding="UTF-8"?>
    <Response>
        <Dial>
            <Queue music="user/Adamcall.wav">20000</Queue>
        </Dial>
    </Response>
    

17. Queue action

    <?xml version="1.0" encoding="UTF-8"?>
    <Response>
        <Dial>
            <Queue action="pickup" music="ivr/ivr-invalid_number_format.wav">20000</Queue>
        </Dial>
    </Response>
    

18. user

    <?xml version="1.0" encoding="UTF-8"?>
    <Response>
        <Dial>
            <Voicemail inbox="true" user="2890">
            </Voicemail>
        </Dial>
    </Response>
    

Example 1

<?xml version="1.0" encoding="UTF-8"?>
<Response>
    <Dial>
        <Number>>{{ substring Extension 5 }}</Number>
    </Dial>
</Response>

Actions: Extracts a substring from the Extension variable starting at the 5th character and uses it as the number to dial.

Example 2

Assuming the Extension variable is set to "1234567890": The substring starting at the 5th character is "67890". The system will dial the number "67890".

Example 3

Assuming the Extension variable is set to "afwd_[a-z0-9]+": It means if you dial newsetup_160 and

<?xml version="1.0" encoding="UTF-8"?>
<Response>
    <Dial>
        <Number>{{ substring Extension 9 }}</Number>
    </Dial>
</Response>

Example

When the digit 3 is pressed on the call leg b within the specified context A, the call will be transferred to test4.

<?xml version="1.0" encoding="UTF-8"?>
<Response>
    <Press dtmf_leg ='b'digit="3" context="A">
        <Transfer>test4</Transfer>
    </Press>
</Response>

Example

<?xml version="1.0" encoding="UTF-8"?>
<Response>
    <Before><Set name="newHome" value="Adam"/><Set name="headerName" value="Joe"/></Before>
</Response>

Example

<?xml version="1.0" encoding="UTF-8"?>
<Response>
    <Start>
        <Stream url="wss://your-websocket-server.com/your-endpoint" />
    </Start>
</Response>

Example

<?xml version="1.0" encoding="UTF-8"?>
<Response>
    <Start>
        <Stream url="ws://fr1js1.connexcs.net:3001" mix_type="stereo" >
            <Parameter name="Hello" value="how are you, " />
        </Stream>
    </Start>
</Response>

Example

<?xml version="1.0" encoding="UTF-8"?>
<Response>
   <Echo></Echo>
</Response>

Example 1

<?xml version="1.0" encoding="UTF-8"?>
<Response>
    <Set name="name" value="Adam"/>
    <Set name="{{ x-name }}" value="Water" header="true" />
    <Dial>
        <Number>160</Number>
    </Dial>
</Response>

Example 2

<?xml version="1.0" encoding="UTF-8"?>
<Response>
    <Before>
        <Set name="newHome" value="Adam"/>
        <Set name="headerName" value="Joe"/>
    </Before>
    <Set name="name" value="" header="true"/>
    <Set name="{{ x-name }}" value="" header="true" />
    <Say>Hello my name is newHome</Say>
    <Say>Hello my name is headerName</Say>
    <Say>Hello my name is {{ x-name }}</Say>
    <Dial>
        <Number>160</Number>
    </Dial>
</Response>

1. The variables newHome and headerName are initialized.

2. The SIP INVITE message is prepared with headers:

   1. name: Joe
   2. x-name: Adam

3. The system plays the following audio prompts:

   1. Hello my name is Adam.
   2. Hello my name is Joe.
   3. Hello my name is.

4. Finally, the system dials the number 160.

5. This script ensures that specific headers are included in the SIP INVITE if specified with header="true" and provides clear audio prompts before connecting the call.

6. If the Set elements don't include header="true", they will only set the variables and not as headers in the SIP INVITE.

Example: File ID method

<?xml version="1.0" encoding="UTF-8"?>
<Response>
    <Dial>
        <LLM-Agent>asst_MTbETp3jyb9tG9eAepFGxgPb</LLM-Agent>
    </Dial>
</Response>

Example: Embedded Instructions Method

<?xml version="1.0" encoding="UTF-8"?>
<Response>
    <Dial>
        <LLM-Agent>You are a knowledgeable fitness coach, providing advice on workout routines, nutrition, and healthy habits. Offer personalized guidance based on the user's fitness level, goals, and preferences, and motivate them to stay consistent and make progress toward their objectives.</LLM-Agent>
    </Dial>
</Response>

Example: XML Integration (App Script Method)

App Script Example (within the IDE):

    const llm = require('cxLLM');
    // Retrieves the current day of the week
    function dayOfWeek() {
        return 'Monday';
    }

    // Transfers the call to a specified person
    function transfer({name}) {
        console.log(`We are going to transfer the call to ${name}`);
        return {action: 'transfer', data: {number: '160'}};
    }

Example: XML Response

<?xml version="1.0" encoding="UTF-8"?>
<Response>
    <Say>Hi, we are redirecting your call to our revolutionary AI Agent.</Say>
    <Dial>
        <LLM-Agent appId="0506a202-4377-11ef-9324-d05099d1f064">
        You are the friendly and professional receptionist for a company Test Account specializing in revolutionary technology. Begin each conversation by saying 'Hello' and then pausing briefly. Greet callers and provide information, informing them that there are 5 key members in the organization: Jonathan Hulme, Rizwan Syed, Adam Nawaz, Ankit Patel, and Bani Gandhi. Let the caller know that you can transfer them to any of these individuals. However, if none of these names are mentioned, politely inform the caller that you cannot transfer the call and encourage them to continue the conversation. Always be polite, concise, and clear in your responses.
        </LLM-Agent>
    </Dial>
</Response>

Example

<?xml version="1.0" encoding="UTF-8"?>
<Response>
    <!-- Initial Greeting -->
    <Say>Welcome to the conference system. Please enter your 1-digit conference code.</Say>
    <Gather actionOnEmptyResult="true" method="GET" numDigits="1" timeout="120">
        <Play>https://samplelib.com/lib/preview/wav/sample-12s.wav</Play>
    </Gather>
    <!-- Logic for conference -->
    <Condition field="gather_result" expression="1">
        <Say>You have pushed 1, which was the correct digit and connecting to the conference.</Say>
        <Dial>
            <Conference>MyConferenceRoom</Conference>
        </Dial>
    </Condition>
    <!-- If no valid input, play an error message -->
    <Say>No input received.</Say>
</Response>

Processing the Input: The Condition tag evaluates a specific field (field="gather_result") against a condition (expression="1"). Field: gather_result refers to the value collected from the user's input (via the Gather tag). Expression: "1" specifies the required value for the condition to be true

Handling Valid and Invalid Inputs: If the condition is met (user pressed 1), the system responds accordingly. If no input is received or the input doesn't match the condition, an error message is played.

Variable Examples in Condition Field

1. year: calendar year

   <?xml version="1.0" encoding="UTF-8"?>
   <Response>
       <condition year="2024">
           <Say>Welcome to the events of 2024!</Say>
       </condition>
   </Response>
   

2. yday: day of the year

   <?xml version="1.0" encoding="UTF-8"?>
   <Response>
       <!-- Welcome Message -->
       <Say>Welcome to the system. Checking the day of the year.</Say>
       <!-- Condition to check the value of yday -->
       <condition yday="1">
           <Say>It's the first day of the year!</Say>
       </condition>
   </Response>
   

3. mon: month

   <?xml version="1.0" encoding="UTF-8"?>
   <Response>
       <condition day="mon">
           <Say>Welcome! It's Monday, starting the week strong!</Say>
       </condition>
   </Response>
   

4. mday: date of the month

   <?xml version="1.0" encoding="UTF-8"?>
   <Response>
       <condition mday="1">
           <Say>Welcome! It's the first day of the month.</Say>
       </condition>
   </Response>
   

5. week: week of the year

   <?xml version="1.0" encoding="UTF-8"?>
   <Response>
       <condition week="1">
           <Say>Welcome to Week 1 activities.</Say>
       </condition>
   </Response>
   

6. mweek: week of the month

   <?xml version="1.0" encoding="UTF-8"?>
   <Response>
       <condition mweek="2">
           <Say>Welcome to the second week of the month. Stay tuned for updates.</Say>
       </condition>
   </Response>
   

7. wday: day of the week

   <?xml version="1.0" encoding="UTF-8"?>
   <Response>
       <condition wday="3">
           <Say>Today is Tuesday. Keep going!</Say>
       </condition>
   </Response>
   

8. sunmontuewedthufrisat: days of the week

   <?xml version="1.0" encoding="UTF-8"?>
   <Response>
       <condition sunmontuewedthufrisat="mon,tue,wed,thu,fri">
           <Say>It's a weekday. Let's get to work!</Say>
       </condition>
   </Response>
   

9. hour

   <?xml version="1.0" encoding="UTF-8"?>
   <Response>
       <condition hour="12">
           <Say>Good afternoon! You are connecting at noon.</Say>
       </condition>
   </Response>
   

10. minute

    <?xml version="1.0" encoding="UTF-8"?>
    <Response>
        <condition minute="30">
            <Say>It's 30 minutes past the hour, proceeding with the action.</Say>
        </condition>
    </Response>
    

11. minute-of-day

    <?xml version="1.0" encoding="UTF-8"?>
    <Response>
    <!-- Check if the time is before noon (720 minutes) -->
        <condition minute-of-day="720">
            <Say>The time is before noon. Connecting you to morning services.</Say>
        </condition>
    </Response>
    

12. time-of-day

    <?xml version="1.0" encoding="UTF-8"?>
    <Response>
        <!-- Check time of day and respond accordingly -->
        <condition time-of-day="09:00-17:00">
            <Say>Good day! Our office hours are from 9 AM to 5 PM.</Say>
        </condition>
    </Response>
    

13. time-of-day: time range with seconds

    <?xml version="1.0" encoding="UTF-8"?>
    <Response>
        <!-- Check time range -->
        <condition time-of-day="09:00:00-17:00:00">
            <Say>Welcome! You are accessing the system during business hours.</Say>
        </condition>
    </Response>
    

14. date-time

    <?xml version="1.0" encoding="UTF-8"?>
    <Response>
        <!-- Evaluate date-time range -->
        <condition date-time="2024-11-22 10:00**~**2024-11-22 14:00">
            <Say>The current time is within the specified range.</Say>
        </condition>
    </Response>
    

15. date-time: date-time range with seconds

    <?xml version="1.0" encoding="UTF-8"?>
    <Response>
        <condition date_time="2024-11-22 14:00:00**~**2024-11-22 16:00:00">
            <Say>The date-time is within the specified range. Proceeding with the action.</Say>
            <Dial>
                <Number>+123456789</Number>
            </Dial>
        </condition>
        <Say>The date-time is outside the specified range. Please try again later.</Say>
    </Response>
    

Wrap Around Condition Examples

1. Time Range (Crossing Midnight)

   <condition time="22:00-06:00">
   <!-- Handles times from 10 PM to 6 AM (crossing midnight) -->
   </condition>
   

2. Month Range (Crossing Year End)

   <condition mon="10-2">
   <!-- From October to February -->
   </condition>
   

3. Day Range (Crossing Week)

   <condition day="Friday-Sunday">
   <!-- From Friday to Sunday -->
   </condition>
   

Example

<?xml version="1.0" encoding="UTF-8"?>
<Response>
    <condition time="09:00-12:00,14:00-17:00">
        <Say>The support system is available during this time. Connecting you to a support agent now.</Say>
        <Dial>
            <Number>+123456789</Number>
        </Dial>
    </condition>
    <Say>The support system is currently unavailable. Please try again during our working hours: 09:00-12:00 or 14:00-17:00 GMT.</Say>
</Response>