Knowledgebase

[[API:Function]] – goAddInbound

• This application is used to create new inbound. Newly created inbound belongs to user that authenticated a request.

Mandatory parameters from “postfields” variables:

• goUser- Username. String

• goPass- Password. String

• goAction- Action performed by the [[API:Functions]]. String

• group_id – group id. Integer

• group_name – name of the inbound. String

• group_color – color of inbound. String

• active – status of inbound. Values is Y or N only. String

• web_form_address – web form address. String

• voicemail_ext – voicemail. String

• next_agent_call – next agent call. String

• fronter_display – fronter display, values are N or Y only. String

• ingroup_script – script of inbound. String

• get_call_launch – call launch of inbound. String

• user_group – Assign user group to specific user group. String
  
  

Returns:

result – “success” means that in-group has been created. String

result – “error” means that in-group has not been created, containing the error occurred. String

• Error: Set a value for Group ID.

• Error: Special characters found in group_id

• Error: Special characters found in group_name.

• Error: Special characters found in group_color.

• Error: Default value for active is Y or N only..

• Error: Default value for fronter_display is Y or N only..

• Error: Default value for get_call_launch is NONE, SCRIPT, WEBFORM, WEBFORMTWO, FORM or EMAIL only.

• Error: Default value for next_agent_call is fewest_calls_campaign, longest_wait_time, ring_all, random, oldest_call_start, oldest_call_finish, overall_user_level, inbound_group_rank, campaign_rank or fewest_calls only.

• GROUP NOT ADDED - there is already a Inbound in the system with this ID.

• GROUP NOT ADDED - there is already a campaign in the system with this ID.

• GROUP NOT ADDED - Please go back and look at the data you entered\n <br>Group ID must be between 2 and 20 characters in length and contain no ' -+'.\n <br>Group name and group color must be at least 2 characters in length.

• GROUP NOT ADDED - Check the name and value you type.

• INVALID User Group

group_id – created group id. Integer

Sample Code:

<?php

$url = "https://jameshv.goautodial.com/goAPI/goInbound/goAPI.php"; # URL to GoAutoDial API file

$postfields["goUser"] = ""; #Username goes here. (required)

$postfields["goPass"] = ""; #Password goes here. (required)

$postfields["goAction"] = ""; #action performed by the [[API:Functions]]

$postfields["responsetype"] = "json"; #json. (required)

$postfields["group_id"] = ""; #Desired group ID (required)

$postfields["hostname"] = $_SERVER['REMOTE_ADDR']; #Default value

$postfields["group_name"] = ""; #Desired name (required)

$postfields["group_color"] = ""; #Desired color (required)

$postfields["active"] = ""; #Y or N (required)

$postfields["web_form_address"] = ""; #Desired web form address (required)

$postfields["voicemail_ext"] = ""; #Desired voicemail (required)

$postfields["next_agent_call"] = ""; #'fewest_calls_campaign','longest_wait_time','ring_all','random','oldest_call_start','oldest_call_finish','overall_user_level','inbound_group_rank','campaign_rank', or 'fewest_calls' (required)

$postfields["fronter_display"] = ""; #Y or N (required)

$postfields["ingroup_script"] = ""; #Desired script (required)

$postfields["get_call_launch"] = ""; #Desired call launch (required)

$postfields["user_group"] = ""; #Assign user group (required)

//group_id, group_name, group_color,active, web_form_address, voicemail_ext, next_agent_call, fronter_display, ingroup_script, get_call_launch, user_group

$ch = curl_init();

curl_setopt($ch, CURLOPT_URL, $url);

curl_setopt($ch, CURLOPT_HTTPHEADER, $header);

curl_setopt($ch, CURLOPT_POST, 1);

curl_setopt($ch, CURLOPT_TIMEOUT, 100);

curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);

curl_setopt($ch, CURLOPT_POSTFIELDS, $postfields);

$data = curl_exec($ch);

curl_close($ch);

$output = json_decode($data);

// print_r($data);

if ($output->result=="success") {

# Result was OK!

echo "Added New In-group ID: ";

} else {

# An error occured

echo $output->result;

}

?>

[[API:Function]] – goEditInbound

• This application is used to update a in-group. Only in-group that belongs to authenticated user can be updated.

Mandatory parameters from “postfields” variables:

• goUser- Username. String

• goPass- Password. String

• goAction- Action performed by the [[API:Functions]]. String

• group_id – group id. Integer

Returns:

result – “success” means that in-group has been updated successfully. String

result – “error” means that in-group has not been updated, containing the error occurred. String

• Error: Set a value for Inbound ID.

• Error: queue_priority Value should be in between -99 and 99

• Error: Special characters found in group_id

• Error: Special characters found in group_name

• Error: Special characters found in group_color

• Error: Default value for active is Y or N only.

• Error: Default value for fronter_display is Y or N only.

• Error: Default value for get_call_launch is NONE, SCRIPT, WEBFORM, WEBFORMTWO, FORM or EMAIL only.

• Error: Default value for next_agent_call is fewest_calls_campaign, longest_wait_time, ring_all, random, oldest_call_start, oldest_call_finish, overall_user_level, inbound_group_rank, campaign_rank or fewest_calls only.

• GROUP NOT MODIFIED - Inbound doesn't exist

• Error: Failed to modified the Group ID

• GROUP NOT ADDED - Please go back and look at the data you entered\n <br>Group name and group color must be at least 2 characters in length

group_id – updated group id. Integer

Sample Code:

<?php

$url = "https://jameshv.goautodial.com/goAPI/goInbound/goAPI.php"; # URL to GoAutoDial API file

$postfields["goUser"] = ""; #Username goes here. (required)

$postfields["goPass"] = ""; #Password goes here. (required)

$postfields["goAction"] = ""; #action performed by the [[API:Functions]]

$postfields["responsetype"] = "json"; #json. (required)

$postfields["group_id"] = ""; #Desired group ID (required)

$postfields["hostname"] = $_SERVER['REMOTE_ADDR']; #Default value

$ch = curl_init();

curl_setopt($ch, CURLOPT_URL, $url);

curl_setopt($ch, CURLOPT_HTTPHEADER, $header);

curl_setopt($ch, CURLOPT_POST, 1);

curl_setopt($ch, CURLOPT_TIMEOUT, 100);

curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);

curl_setopt($ch, CURLOPT_POSTFIELDS, $postfields);

$data = curl_exec($ch);

curl_close($ch);

$output = json_decode($data);

// print_r($data);

if ($output->result=="success") {

# Result was OK!

echo "Update Success";

} else {

# An error occured

echo $output->result;

}

?>

[[API:Function]] – goDeleteInbound

• This application is used to delete a in-group. Only in-group that belongs to authenticated user can be delete.

Mandatory parameters from “postfields” variables:

• goUser- Username. String

• goPass- Password. String

• goAction- Action performed by the [[API:Functions]]. String

• group_id – group id. Integer

Returns:

result – “success” means that in-group has been deleted successfully. String

result – “error” means that in-group has not been deleted, containing the error occurred. String

• Error: Set a value for group_id.

• Error: Inbound doesn't exist.

group_id – deleted in-group. Integer

Sample Code:

<?php

$url = "https://YOUR_URL/goAPI/goInbound/goAPI.php"; #URL to GoAutoDial API. (required)

$postfields["goUser"] = ""; #Username goes here. (required)

$postfields["goPass"] = ""; #Password goes here. (required)

$postfields["goAction"] = ""; #action performed by the [[API:Functions]]. (required)

$postfields["responsetype"] = "json"; #json. (required)

$postfields["group_id"] = ""; #Desired Group ID. (required)

$postfields["hostname"] = $_SERVER['REMOTE_ADDR']; #Default value

$ch = curl_init();

curl_setopt($ch, CURLOPT_URL, $url);

curl_setopt($ch, CURLOPT_HTTPHEADER, $header);

curl_setopt($ch, CURLOPT_POST, 1);

curl_setopt($ch, CURLOPT_TIMEOUT, 100);

curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);

curl_setopt($ch, CURLOPT_POSTFIELDS, $postfields);

$data = curl_exec($ch);

curl_close($ch);

$output = json_decode($data);

// print_r($data);

if ($output->result=="success") {

# Result was OK!

echo "Inbound deleted successfully";

} else {

# An error occured

echo $output->result;

}

?>

[[API:Function]] – goGetAllInboundList

• This application is used to get list of in-group belongs to user.

Mandatory parameters from “postfields” variables:

• goUser- Username. String

• goPass- Password. String

• goAction- Action performed by the [[API:Functions]]. String

• group_id – group id. Integer

 Returns:

result – “success” means that query was successful. String

result – “error” means that query was not successful, containing the error occurred. String

group_id – group id. Integer

group_name – name of in-group. String

active – status of in-group. String

queue_priority – queue priority. Integer

call_time_id – call time id of in-group. Integer

Sample Code:

<?php

 $url = "https://YOUR_URL/goAPI/goInbound/goAPI.php"; #URL to GoAutoDial API. (required)

$postfields["goUser"] = ""; #Username goes here. (required)

$postfields["goPass"] = ""; #Password goes here. (required)

$postfields["goAction"] = ""; #action performed by the [[API:Functions]]. (required)

$postfields["responsetype"] = "json"; #json. (required)

$ch = curl_init();

curl_setopt($ch, CURLOPT_URL, $url);

curl_setopt($ch, CURLOPT_HTTPHEADER, $header);

curl_setopt($ch, CURLOPT_POST, 1);

curl_setopt($ch, CURLOPT_TIMEOUT, 100);

curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);

curl_setopt($ch, CURLOPT_POSTFIELDS, $postfields);

$data = curl_exec($ch);

curl_close($ch);

$output = json_decode($data);

if ($output->result=="success") {

# Result was OK!

for($i=0;$i<count($output->group_id);$i++){

echo $output->group_id[$i]."</br>";

echo $output->group_name[$i]."</br>";

echo $output->queue_priority[$i]."</br>";

echo $output->active[$i]."</br>";

echo $output->call_time_id[$i]."</br>";

}

} else {

# An error occured

echo "The following error occured: ".$results["message"];

}

?>

[[API:Function]] – goGetListInfo

• Allows to retrieve some attributes of a given in-group. in-group should belong to the user that authenticated the request.

Mandatory parameters from “postfields” variables:

• goUser- Username. String

• goPass- Password. String

• goAction- Action performed by the [[API:Functions]]. String

• group_id – group id. Integer

Returns:

result – “success” means that query was successful. String

result – “error” means that query was not successful. , containing the error occurred. String

• Error: Set a value for group id.

• Error: Inbound doesn't exist.

group_id – group id. Integer

group_name – name of in-group. String

active – status of in-group. String

queue_priority – queue priority. Integer

call_time_id – call time id of in-group. Integer

Sample Code:

<?php

$url = "https://YOUR_URL/goAPI/goInbound/goAPI.php"; #URL to GoAutoDial API. (required)

$postfields["goUser"] = ""; #Username goes here. (required)

$postfields["goPass"] = ""; #Password goes here. (required)

$postfields["goAction"] = ""; #action performed by the [[API:Functions]]. (required)

$postfields["responsetype"] = "json"; #json. (required)

$postfields["group_id"] = ""; #Desired Group ID. (required)

$ch = curl_init();

curl_setopt($ch, CURLOPT_URL, $url);

curl_setopt($ch, CURLOPT_HTTPHEADER, $header);

curl_setopt($ch, CURLOPT_POST, 1);

curl_setopt($ch, CURLOPT_TIMEOUT, 100);

curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);

curl_setopt($ch, CURLOPT_POSTFIELDS, $postfields);

$data = curl_exec($ch);

curl_close($ch);

$output = json_decode($data);

// print_r($data);

if ($output->result=="success") {

# Result was OK!

for($i=0;$i<count($output->group_id);$i++){

echo $output->group_id[$i]."</br>";

echo $output->group_name[$i]."'</br>";

echo $output->queue_priority[$i]."</br>";

echo $output->active[$i].'</br>';

echo $output->call_time_id[$i]."</br>";

}

} else {

# An error occured

echo $output->result;

}

?>