• 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 Channels

Introduction

A Channel is a container for triggers from a particular marketing source. Triggers can be made up of Online and Offline events, such as web site page views or calls. Each Channel is assigned a numeric ID that can be used to reference it in the APIs.

• Each Channel is assigned a numeric ID that can be used to reference it in the APIs.
• A Channel ID of 0 means “Unknown” and is used when a Visitor’s marketing source cannot be detected, or for assigning phone numbers to a shared channel pool (See Dial-In Groups)

List Channels

Lists the Channels for an IGRP.

Request:

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

URL Path Params

• IGRP SPECIFIER (int) - Installation ID.

GET Params

• filter (array) OPTIONAL - One or more filters, see Filter Types.
• sort (array) OPTIONAL - One or more sorting params, see Sort Types.
• limit (integer) OPTIONAL - limit on the result set.
• offset (integer) OPTIONAL - offset of the result set.

Filter Types

• channelId (string) - Channel ID
• channelName (string) - Channel Name
• channelType (string) - Channel Type
• channelOrder (string) - Channel Order

Sort Types

• channelId (string) - Channel ID
• channelName (string) - Channel Name
• channelType (string) - Channel Type
• channelOrder (string) - Channel Order

Response:

Returns a list of Channels under the given IGRP spec.

• igrp (int) - Installation ID.
• channelId (int) - Channel ID.
• channelName (string) - Friendly name of the channel (e.g. “My Channel”)
• channelType (string) - Type of Channel (e.g. Direct(direct), Custom (cust) etc.)
• channelOrder (string) - Channel ordering.

{"igrp":1,"channelId":11,"channelName":"Direct Channel","channelType":"direct","channelOrder":"1"}
{"igrpId":1,"channelId":12,"channelName":"Custom Channel","channelType":"cust","channelOrder":"4"}

Get Channel Config

Get the properties for a particular channel.

Request:

GET /reports/v2/igrps/{IGRP SPECIFIER}/channels/{channelId}

URL Path Params

• IGRP SPECIFIER (int) - Installation ID.
• channelId (int) - Channel ID of the channel for which the details are required.

Response:

Returns the details of the channel specified by the {IGRP SPECIFIER} and {channelId}

• igrp (int) - Installation ID.
• channelId (int) - Channel ID.
• channelName (string) - Friendly name of the channel (e.g. “My Channel”)
• channelType (string) - Type of Channel (e.g. Direct(direct), Custom (cust) etc.)
• channelOrder (string) - Channel ordering.

{"igrp":1,"channelId":11,"channelName":"Direct Channel","channelType":"direct","channelOrder":"1"}