Config API Version 2 Dial-In Groups

Introduction

A Dial-In Group (DGRP) represents a collection of one or more phone numbers that can be dialled. DGRPs can contain both pool numbers and fixed numbers. Pool numbers are dynamically assigned to a Visitor to your web site, whereas Fixed numbers are assigned to a fixed Channel and Usage Filter.

DGRP Properties

These are the DGRP properties that can be accessed using the API

Call Features

Each DGRP can have several call features configured, these are described below:

Call Reference

Some of these call features work in combination to present the call reference number to the operator.

By setting the callRef value to either ‘announce’ or ‘both’, an automated voice will read out the call ref to the operator (inaudible to the the caller, who will still hear a ringing tone at this point). This call reference will be re-read to the operator if the endAnnounce flag is set to 1.

Setting the callRef value to either ‘clid’ or ‘both’ will present the call ref in place of the caller ID. If the zeroPadCallRefClid value is set then the call ref will be prefixed with a number of zeros, to make the whole string this length. If a callRefClidPrefix value is provided then this will be used to prefix the padded call reference.

For example, if zeroPadCallRefClid is set to 12, and callRefClidPrefix is set to “+1443”, then the call reference “1234” would be presented as “+14430001234”.

Call Rating

The callRate and callRatingId settings work together to allow calls to be rated with one of a preset list of values.

Setting the callRate value to “0” will disable the end of call rating IVR. You may still be able to rate calls through the portal or Caller Insight applications.

Setting the callRate value to “1” will enable the end of call rating IVR. This is an automated voice prompt at the end of each call, asking your operators to rate the call from a list of values. If the callRatingId value is also set, then the values will be chosen from a list defined in Config V2 Call Rating. If the callRatingId is not set (zero), then our generic call rating script will be used, with the following options:

  1. enquiry
  2. warm lead
  3. hot lead
  4. sale (with the option to give a sale value)
  5. other

Setting the callRate value to a custom string value will attempt to use the hard-coded custom script by that name. If the script does not exist then no call rating IVR will take place. Please contact your account manager if you have any questions relating to this feature.

The callRatingId setting is currently in BETA status. Do not use it unless advised to do so.

List DGRPs

Returns a list of DGRPs that the current user can access.

Request:

GET /config/v2/igrps/{IGRP SPECIFIER}/dgrps

URL Path Params

Response:

Returns a list of DGRPs under the given {IGRP SPECIFIER} that the user has access to.

{"igrp":1,"dgrp":11,"dgrpName":"Sales Enquiries","dgrpType":"offline","dgrpRef":"sales","startDate":"2011-12-01","endDate":"2012-12-01","dgrpStartDate":"2011-12-01","dgrpEndDate":"2012-12-01","dgrpStatus":"410"}
{"igrp":1,"dgrp":12,"dgrpName":"Timetable Enquiries","dgrpType":"nas","dgrpRef":"timetable","startDate":"2011-02-01","endDate":"2012-12-01","dgrpStartDate":"2011-02-01","dgrpEndDate":"2012-12-01","dgrpStatus":"200"}

Read DGRP Config

Returns the properties for a particular DGRP.

Request:

GET /config/v2/igrps/{IGRP SPECIFIER}/dgrps/{DGRP SPECIFIER}

URL Path Params

Response:

Returns the details of the Dial-In Group (DGRP) specified by the IGRP and DGRP

{"igrpId":1,"dgrpId":11,"dgrpName":"Sales Enquiries","dgrpType":"offline","dgrpRef":"sales","startDate":"2011-12-01","endDate":"2012-12-01","dgrpStartDate":"2011-12-01","dgrpEndDate":"2012-12-01","dgrpStatus":"200"}

Create DGRP

Creates a new DGRP with properties.

Request:

POST /config/v2/igrps/{IGRP SPECIFIER}/dgrps

URL Path Params

POST Params

Provision number prefix

If specified the provisionNumberPrefix parameter will attempt to provision a DGRP populated with pool numbers. Given a prefix of 0203, the DGRP will be provisioned with the following

Response:

Returns the HTTP response code to reflect the request outcome.

{"dgrp":"123"}

Update DGRP Config

Update the properties for a particular DGRP.

Request:

POST /config/v2/igrps/{IGRP SPECIFIER}/dgrps/{DGRP SPECIFIER}

URL Path Params

POST Params

Response:

Returns the HTTP 204 (No Content) status code if update successful.

HTTP 204 - NO CONTENT

DGRP channels

Structure for channels property. Channels are supplied as an array of properties, keyed on the channel ID. Currently only one property is allowed for channels, the call algorithm, callAlgo

Valid call algorithms

array(
    '1' => array(
        'callAlgo' => array(
            'sessionsh',
            'infinity',
        ),
    ),
    '2' => array(
        'callAlgo' => array(
            'sessionsh',
        ),
    ),
)

Delete DGRP

Deletes a DGRP. Dgrp Numbers are set to ‘quarantined’

Request:

DELETE /config/v2/igrps/{IGRP SPECIFIER}/dgrps/{DGRP SPECIFIER}

URL Path Params

Response:

Returns the HTTP 204 (No Content) status code if update successful.

HTTP 204 - NO CONTENT