Config 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:
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.
Filter Types
- channelId (string) - Channel ID
- channelName (string) - Channel Name
- channelType (string) - Channel Type
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.
- srcMode (array) - Channel Source Modes.
- numberAllocationMode (string) - Number Allocation Mode.
Get Channel Config
Get the properties for a particular channel.
Request:
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.
- srcMode (array) - Channel Source Modes.
- numberAllocationMode (string) - Number Allocation Mode.
Create Channel
Create a new channel.
Request:
URL Path Params
- IGRP SPECIFIER (int) - Installation ID.
POST Params
- channelName (string) - Friendly name of the channel (e.g. “My Channel”)
- channelOrder (int) - Channel ordering. Must be between 100 and 199.
- srcMode (array) - List of srcModes. Allowed modes (ppc, tag, utm, ppcauto, vref). The order the modes are sent in determines the order they will be run
- numberAllocationMode (string) - Number Allocation Mode (none, sessionsh, session).
Response:
Returns the HTTP response code to reflect the request outcome.
Update Channel Config
Update the channel configuration. Only channels of type affiliate, cust, display, email, offline, ppc, sms, social, and video can have their Source Mode and Channel Name edited.
In addition to the channels listed above, direct, ref, and seo can have their Number Allocation Mode set.
Request:
URL Path Params
- IGRP SPECIFIER (int) - Installation ID.
- channelId (int) - Channel ID.
POST Params
- channelName (string) - Friendly name of the channel (e.g. “My Channel”)
- srcMode (array) - List of srcModes. Allowed modes (ppc, tag, utm, ppcauto, vref). The order the modes are sent in determines the order they will be run
- numberAllocationMode (string) - Number Allocation Mode (none, sessionsh, session).
Response:
Returns the HTTP response code to reflect the request outcome.
Delete Channel
Delete an existing channel. Only user-defined channels, ordered within the range 100 to 199, may be deleted.
Request:
URL Path Params
- IGRP SPECIFIER (int) - Installation ID.
- channelId (int) - Channel ID.
Response:
Returns the HTTP 204 (No Content) status code if delete successful.
Set channel order
Sets the channel order order. Channels can only be ordered within the range 100 to 199 can be re-ordered and can only be re-ordered within this range
Request:
URL Path Params
- IGRP SPECIFIER (int) - Installation ID.
POST Params
- channelIds (array) - An array of channelIds, the array index used as the new channel order