Project

General

Profile

Read All Campaigns

Technical documentation
04/13/2018

Method: POST/GET

Version 4.0

Authentication

This method is public/private

HTTP Request

GET/POST https://HOST_NAME/goAPI/goCampaigns/goAPI.php?goUser=GO_USER&goPass=GO_PASS&responsetype=json&goAction=getAllCampaigns&session_user=goautodial&user_group=ADMIN

Request body

In the request body set json resource:

{

"goUser" : "goAPI",

"goPass" : "K3T160slqc",

"goAction" : "getAllCampaigns",

"responsetype" : "json",

"session_user" : "goautodial",

"user_group" : "ADMIN"

}

Request parameters:
Property name Value Description Notes
goUser GO_USER
goPass GO_PASS

goAction getAllCampaigns

responsetype json

session_user string (20) Must be a valid / existing user
user_group string (20) Must be a valid / User Group

Response

Success

HTTP 200:

{

"result" : "success",

"campaign_id" : ["19355","32833605","88888881","88888882","88888883","88888888","TESTCAMP"],

"campaign_name" : ["TestCampPBP","WHR WYO Campaign","Wittie Camp API","INBOUND CAMP API","BLENDED API","CAMPAIGN_NAME","TEST CAMPAIGN"],

"dial_method" : ["MANUAL","RATIO","MANUAL","RATIO","","RATIO","MANUAL"],

"active" : ["Y","Y","Y","Y","Y","Y","Y"]

}

Property name Value Description Notes
result string("success")
campaign_id array( string (8) )

campaign_name array( string (40) )

dial_method array( string ("MANUAL", "RATIO", "ADAPT_HARD_LIMIT", "ADAPT_TAPERED", "ADAPT_AVERAGE", "INBOUND_MAN") )

active array( string ("Y" or "N") )

Failure

HTTP 400:

{

"code" : "40001"

"result" : "Error: Missing required parameters"

}

Files

Go to top