API SIMPSY Voice: /didnumber/queue/edit

/didnumber/queue/edit

GET http://voice.simpsy.com/api/v1/didnumber/queue/edit

Add new queue

Query Parameters

Parameter	Type	Required	Description
key	string	Yes	API Key
secret	string	Yes	API Secret
queue_name	string	Yes	Name of queue
maxlen	number	Yes	Maximum number of callers waiting in the queue. Option - 0 for unlimited, 5, 10, 15, 20, 30, 40, 50 seconds
acd_type	string	Yes	Distributes incoming calls in the order of arrival to the first available agent. Option - ringall, leastrecent, fewestcalls, random
announce_postion	string	Yes	Play caller's position in the queue. Option - Yes,No
announce_frequency	string	Yes	How often to announce caller position and/or estimated holdtime. Option - Yes,No
announce_holdtime	string	Yes	Announce Average Hold Time to Caller . Option - Yes,No, Once
retry	number	Yes	How long do we wait before trying all the agents again. Option - 0 for No, 5 , 10, 15, 20, 25, 30 seconds
timeout	number	Yes	How long does system let the agent phone ring before it considers this a timeout. Option - 0 for No, 5 , 10, 15, 20, 25, 30 seconds
wrapuptime	number	Yes	After a successful call, how long to wait before sending another call to free agent. Option - 0, 5 , 10, 15, 20, 25, 30 seconds
periodic_announce	string	Yes	Which sound file to play at regular intervals while a caller is in the queue. Get sound name from /sound
periodic_announce_frequency	number	Yes	Keep Playing a sound file to the caller in the queue after every selected seconds. Option - 0 for no, 20, 30, 40, 50, 60, 120 seconds
reportholdtime	number	Yes	Report the caller's hold time to the agent before they are connected. Option - 0 for no, 1 for yes

Code Samples

JavaScript PHP Rails

var xmlHttp = new XMLHttpRequest();
xmlHttp.open("GET", "http://voice.simpsy.com/api/v1/didnumber/queue/edit?key=%key%&secret=%secret%&queue_name=%queue_name%&maxlen=%maxlen%&acd_type=%acd_type%&announce_postion=%announce_postion%&announce_frequency=%announce_frequency%&announce_holdtime=%announce_holdtime%&retry=%retry%&timeout=%timeout%&wrapuptime=%wrapuptime%&periodic_announce=%periodic_announce%&periodic_announce_frequency=%periodic_announce_frequency%&reportholdtime=%reportholdtime%", false);

// Make sure you set the appropriate headers
xmlHttp.setRequestHeader("Header Key", "Header Value");

xmlHttp.send(null);

var response = xmlHttp.responseText;

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "http://voice.simpsy.com/api/v1/didnumber/queue/edit?key=%key%&secret=%secret%&queue_name=%queue_name%&maxlen=%maxlen%&acd_type=%acd_type%&announce_postion=%announce_postion%&announce_frequency=%announce_frequency%&announce_holdtime=%announce_holdtime%&retry=%retry%&timeout=%timeout%&wrapuptime=%wrapuptime%&periodic_announce=%periodic_announce%&periodic_announce_frequency=%periodic_announce_frequency%&reportholdtime=%reportholdtime%");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1); 

// Make sure you set the nessary headers as a $headers array
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$response = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

uri = URI.parse("http://voice.simpsy.com/api/v1/didnumber/queue/edit?key=%key%&secret=%secret%&queue_name=%queue_name%&maxlen=%maxlen%&acd_type=%acd_type%&announce_postion=%announce_postion%&announce_frequency=%announce_frequency%&announce_holdtime=%announce_holdtime%&retry=%retry%&timeout=%timeout%&wrapuptime=%wrapuptime%&periodic_announce=%periodic_announce%&periodic_announce_frequency=%periodic_announce_frequency%&reportholdtime=%reportholdtime%")
http = Net::HTTP.new(uri.host, uri.port)
request = Net::HTTP::Get.new(uri.request_uri)

# Make sure you set the appropriate headers
request["header"] = "header value"

response = http.request(request)

Response

200:

application/json

{
"status": "200",
"message": "Successfully edited",

}

400:

Missing or invalid properties

401:

Invalid API Key & Password