• Home
• Config V2 Basics
• Config V2 Organisations
• Config V2 Organisation Types
• Config V2 Channels
• Config V2 Installation Groups
• Config V2 Report Schedule Subscribers
• Config V2 Segments
• Config V2 Dial-In Groups
• Config V2 Goals
• Config V2 Goal Groups
• Config V2 Numbers
• Config V2 Custom
• Config V2 Profile
• Config V2 Users
• Config V2 Roles
• Config V2 Visitor Types
• Config V2 Attribution
• Config V2 SIP Phone System
• Config V2 Notifications
• Config V2 Dialplans
• Config V2 Integrations
• Config V2 PPC
• Config V2 DGRP maps
• Config V2 DGRP map items
• Config V2 IGRP Caller Blocks
• Config V2 Caller Insight
• Config V2 Caller Insight for Salesforce
• Config V2 Call Rating
• Config V2 Custom Vocabulary
• Reports V2 Basics
• Reports V2 Installation Groups

• Reports V2 Dial-In Groups

• Reports V2 Triggers
• Reports V2 Triggers (Deprecated)
• Reports V2 Custom
• Reports V2 Metrics
• Reports V2 Call Rating
• Reports V2 Channels
• Reports V2 Organisations
• Reports V2 Organisation Types
• Reports V2 Segments
• Reports V2 Visitors
• Reports V2 Attribution
• Reports V2 Audit
• Reports V2 Currencies
• Reports V2 Goals
• Reports V2 Real Time
• Reports V2 PBX triggers
• Export V2 Invoices
• Event API Basics
• Event API Example
• Event FTP Upload
• Call Events
• Salesforce Events
• Config V2 Oauth2
• Config V2 Scheduled Reports
• Reports V2 PPC
• Config V2 Keyword Spotting
• Reports V2 Call Keywords

Reports 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.

• Each DGRP is assigned a numeric ID that can be used to reference it in the APIs.
• DGRPs can contain either or both fixed and pool numbers.
• A single DGRP of pool numbers can be displayed in multiple places on a web page if required.
• Call features can be enabled/disabled at DGRP level.
• Each DGRP is associated with an IGRP.
• Each DGRP can have its own number allocation config for each channel.

DGRP Properties

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

• igrp (int) - Installation ID this DGRP is associated to.
• dgrp (int) - Dial-In Group ID.
• dgrpRef (string) - Your reference for this Dial-In Group (e.g. “sales”).
• dgrpName (string) - Friendly name of the Dial-In Group (e.g. “Sales Numbers”).
• dgrpType (date) - Type of DGRP. The valid values are offline & nas.
• segment (int) - Segment ID this DGRP is associated to.
• startDate (date) - Start date for the DGRP (Date format: yyyy-mm-dd e.g. “2011-12-29”).
• endDate (date) - End date for the DGRP (Date format: yyyy-mm-dd e.g. “2011-12-29”).
• dgrpStatus (int) - An integer representing dgrp status: 200 - active, 410 - expired.

List DGRPs

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

Request:

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

URL Path Params

• IGRP SPECIFIER (int) - Installation ID.

GET Params

• sort (array) OPTIONAL - One or more sorts, see Sort Types.
• filter (array) OPTIONAL - One or more filters, see Filter Types.
• limit (int) OPTIONAL - Limit result set, see Pagination.
• offset (int) OPTIONAL - Offset result set, see Pagination.

Response:

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

• igrp (int) - Installation ID.
• dgrp (int) - Dial-In Group ID.
• dgrpRef (string) - Your reference for this Dial-In Group (e.g. “sales”).
• dgrpName (string) - Friendly name of the Dial-In Group (e.g. “Sales Numbers”).
• dgrpType (date) - Type of DGRP. The valid values are offline & nas.
• segment (int) - Segment ID this DGRP is associated to.
• startDate (date) - Start date for the DGRP (Date format: yyyy-mm-dd e.g. “2011-12-29”).
• endDate (date) - End date for the DGRP (Date format: yyyy-mm-dd e.g. “2011-12-29”).
• dgrpStatus (int) - An integer representing dgrp status: 200 - active, 410 - expired.

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

Read DGRP Config

Returns the properties for a particular DGRP.

Request:

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

URL Path Params

• IGRP SPECIFIER (int) - Installation ID.
• DGRP SPECIFIER (int) - DGRP ID.

Response:

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

• igrp (int) - Installation ID.
• dgrp (int) - Dial-In Group ID.
• dgrpRef (string) - Your reference for this Dial-In Group (e.g. “sales”).
• dgrpName (string) - Friendly name of the Dial-In Group (e.g. “Sales Numbers”).
• dgrpType (date) - Type of DGRP. The valid values are offline & nas.
• segment (int) - Segment ID this DGRP is associated to.
• startDate (date) - Start date for the DGRP (Date format: yyyy-mm-dd e.g. “2011-12-29”).
• endDate (date) - End date for the DGRP (Date format: yyyy-mm-dd e.g. “2011-12-29”).
• dgrpStatus (int) - An integer representing dgrp status: 200 - active, 410 - expired.

{"igrp":1,"dgrp":11,"dgrpName":"Sales Enquiries","dgrpType":"offline","dgrpRef":"sales","segment":1,"startDate":"2011-04-04","endDate":"0000-00-00", "dgrpStatus":"200"}