Guides
Developer Hub
ContactBack to TTNC

EnableCallQueueing

Set up or edit Call Queuing on a number

Description

Enabled Call Queuing on a number.

Parameters

string NumberThe number
mixed MOHRecordingUIDEither the string 'ringing' or the int id of the recording to assign as the Music on Hold (MOH) the caller will listen to in the queue. The recording must already be uploaded to the TTNC system. A list of available recordings on your account can be retrieved by calling NoveroRecordings::RecordingsList().
int QueueChannelsThe number of concurrent channels (calls) which will be passed through to the destinations. All other callers are held in the queue until a call that has already been passed through ends.

For example; if you have 2 destinations set for call forwarding, you would want to set QueueChannels to 2, so that both destinations can concurrently receive a call each. If QueueChannels was set to 1, only 1 call would be passed through to the destinations, and all others held in the queue until that call ends regardless that one of the other destination being available.

QueueChannels can be used to increase the number of channels used. If one of the destinations was a PBX with 3 channels/handsets attached, for the example above you may want to set QueueChannels to 4 so that all channels/handsets across the two destinations will be sent calls.

QueueChannels is only applicable for Call Queuing. For call forwarding without a queue, appropriate channels are automatically assigned.
int AnnouceRecordingUID optionalThe id of the recording to assign as the periodically announced message during a queue. The recording must already be uploaded to the TTNC system. A list of available recordings on your account can be retrieved by calling NoveroRecordings::RecordingsList().
int AnnounceFrequency optionalThe number of seconds of delay between each instance of the periodically announced message. This delay is started from the end of the previous instance of the periodically announced message, or the beginning of the queue.
int QueueTimeout optionalThe maximum number for seconds a caller will be held in the queue. Once this time has expired the queue will end, sending this caller to TTNC Voicemail (if set up) otherwise, the call will end. To never end the queue set QueueTimeout to 0.

Request

<?xml version="1.0"?>
<NoveroRequest>
    <Request target="NoveroNumbers" name="EnableCallQueueing" id="TestRequest">
        <Number>01245123456</Number>
        <MOHRecordingUID>4174</MOHRecordingUID>
        <AnnouceRecordingUID>4175</AnnouceRecordingUID>
        <AnnounceFrequency>45</AnnounceFrequency>
        <QueueChannels>7</QueueChannels>
        <QueueTimeout>500</QueueTimeout>
    </Request>
</NoveroRequest>

<?php
    require_once('TTNCApi.php');
    $Api = new TTNCApi('<username>', '<password>', '<VKey>');
    $Request = $Api->NewRequest('NoveroNumbers', 'EnableEnableCallQueueing', 'TestRequest');
    $Request->SetData('Number', '01245123456');
    $Request->SetData('MOHRecordingUID', 4174);
    $Request->SetData('AnnouceRecordingUID', 4175);
    $Request->SetData('AnnounceFrequency', 45);
    $Request->SetData('QueueChannels', 7);
    $Request->SetData('QueueTimeout', 500);
    $Api->MakeRequests();
    $Response = $Api->GetResponseFromId('TestRequest');
?>

require TTNCApi
api = TTNCApi.new('<username>', '<password>', '<vkey>')
request = api.newrequest('NoveroNumbers', 'EnableCallQueueing', 'TestRequest')
request.setdata('Number', '01245123456')
request.setData('MOHRecordingUID', 4174);
request.setdata('AnnouceRecordingUID', 4175)
request.setdata('AnnounceFrequency', 45)
request.setdata('QueueChannels', 7)
request.setdata('QueueTimeout', 500)
api.makerequest()
p request.getresponse()

api = TTNCApi('<username>', '<password>', '<vkey>')
request = api.newrequest('NoveroNumbers', 'EnableCallQueueing', 'TestRequest')
request.setdata('Number', '01245123456')
request.setData('MOHRecordingUID', 4174)
request.setdata('AnnouceRecordingUID', 4175)
request.setdata('AnnounceFrequency', 45)
request.setdata('QueueChannels', 7)
request.setdata('QueueTimeout', 500)
api.makerequest()
p request.getresponse()

using System;
using TTNCApi;
 
class Program
{
    static void Main(string[] args)
    {
        TTNCApi api = new TTNCApi("<username>", "<password>", "<vkey>");
        TTNCRequest request = api.NewRequest("NoveroNumbers", "EnableCallQueueing", "TestRequest");
        request.setData("Number", "01245123456");
        request.setData("MOHRecordingUID", 4174);
        request.setData("AnnouceRecordingUID", 4175);
        request.setData("AnnounceFrequency", 45);
        request.setData("QueueChannels", 7);
        request.setData("QueueTimeout", 500);
        api.MakeRequests();
        TTNCParser dic = request.GetResponse();
     }
}

Response

<?xml version="1.0"?>
<NoveroResponse>
    <Response target="NoveroNumbers" name="EnableCallQueueing" Code="200" RequestId="TestRequest">
        <ResponseMessage>1</ResponseMessage>
        <Success>1</Success>
    </Response>
</NoveroResponse>