TABLE OF CONTENTS

Usage

This API is designed as an Agent Remote Control. The API commands will control an already existing agent that is currently logged into the system

Authentication

An authentication token is required to access this API. A token can be requested from the token service using the Lead Management API (refer to lead management documentation same guide and sample code).

A token key must be passed to each API endpoint along with the request.

Responses

The API by default will return an XML response, but a Content-Type header of application/json can be supplied in your requests if desired.

CallActionResponse

All methods will return a CallActionResponse object. The “data” property will be a different type dependent on the method used.

{
Success: Bool,
Data: This type is dependant on the method used, entities are described  below
ResponseCode: Int,
ResponseDetail: String
}

Entities

Call

Returned by /dial, and an array of these is returned by /getcalls, this represents an active call.

{
CallId:int,
CallStartTime:dateTime,
CallState:int,
CallStatus:int,
CustomerName:string,
CustomerName2:string,
PhoneNumber:string,
RecordingState:int
}

Agent Name ID Pair

An array of these is returned by /users

{
FullName: string,
ID:int
}

Lead Phone

This object is returned by /leadphones

{
LeadId:int,
PhoneNumber:string,
RecordType:string,
RecordTypeId:int
}

Campaign

Returned by /campaigns

{
Active:boolean
AlwaysRun:boolean
AutoRecord:boolean
BlackoutDates:string
BlackoutDateses:array
CalculatedLines:int
CallerID:string
CallsPlacedThisMinute:int
CampaignID:int
CampaignIcon:string
CampaignName:string
Cps:int
DefaultListID:int
DefaultPhoneType:int
Description:string
DropQueue:array
EndLine:int
EstimatedRecordCount:int
FirstCreated:string
InitialPacing:int
IvrSessions:array
LastFetch:string
LastModified:string
LastPacingAdjust:string
Leads:object
Leads:object
LeadsInProgress:array
LinesToReturn:int
Lists: array
ListsForStats:array
LiveStats:object
LiveStatsTemp:object
MOTD:string
MaxCallCap:int
NumToCall:int
Pacing:int
PlacedPredictiveCallsLock:object
PlacingInterval:int
PreviewQueue:array
ReadyUsers: array
ResultSessions: array
Schedule:string
SchedulePlanID:int
Schedules: array
SchedulesUI: array
SessionID:int
SessionStats:object
SoftCap:int
StartLine:int
Status:int
TargetDropPercent:int
TeleParamPlanID:int
TenantID:int
Type:int
UncalledLeads: array
UseAutoPacing:boolean
UseGlobalBlackoutDates:boolean
UserAddress:string
UserName:string
ZipTone:int
ZipToneBeep:int
ZipToneWav:object
}

ACD (Skill) Queue

An array of this type is returned by /acdqueues

{
AbandonThreshold:int
AcceptableQueueTime:int
AcdIcon:string
AcdName:string
Active:boolean
DefaultTimeout:int
DefaultTimeoutIvr:int
ID:int
SessionStats:object
SkipIndex:int
SnapshotStats:object
TenMinuteOffers:object
TenMinuteOffersVirtualQueue:object
UserAddress:string
UserName:string
ZipTone:int
ZipToneBeep:int
ZipToneWav:object
}

Result Code

An array of this type is returned by /resultcodes

{
Code:string
Description:string
IsAgentViewable:boolean
IsCallAgain:boolean
IsCallback:boolean
IsSuccess:boolean
IsSystemResultCode:boolean
IsTransfer:boolean
ResultCodeID:int
Sales:int
StatusID:int
SuccessType:int
}

Methods