API SIMPSY Voice

version v1           http://voice.simpsy.com/api/v1

/didnumber/queue/list


POST http://voice.simpsy.com/api/v1/didnumber/queue/list

GET

Show list of queue and settings and agents being assigned in

Query Parameters

ParameterTypeRequiredDescription
keystringYesAPI Key
secretstringYesAPI Secret

Code Samples

JavaScript PHP Rails
var xmlHttp = new XMLHttpRequest();
xmlHttp.open("POST", "http://voice.simpsy.com/api/v1/didnumber/queue/list", false);

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

var data = "# body is your JSON/ XML/ Text/ Form Query/ etc"
xmlHttp.send(data);

var response = xmlHttp.responseText;
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "http://voice.simpsy.com/api/v1/didnumber/queue/list");
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);

curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "post")
$body = '';
curl_setopt($ch, CURLOPT_POSTFIELDS, $body);

$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/list")
http = Net::HTTP.new(uri.host, uri.port)
request = Net::HTTP::Post.new(uri.request_uri)

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

# body is your JSON/ XML/ Text/ Form Query/ etc
request.set_form_data(body)

response = http.request(request)

Response

200:

application/json
{
"status": "200",
"message": "Success",
"result": [
{
"id": "2",
"name": "Customer Support",
"no_of_agents_in_queue": "2",
"agents_in_queue": [
{
"agentid": "1",
"agentname": "Tom"
},
{
"agentid": "2",
"agentname": "Dick"
}
]
}

],
"settings": [
{
"maximum_callers": "0",
"acd_type": "ringall",
"announce_caller_position": "No",
"announce_caller_position_frequency": "0",
"retry": "0",
"timeout": "20",
"wrapup_time": "0",
"periodic_announce": "welcome.wav",
"periodic_announce_frequency": "No",
"reportholdtime": "0"
}
]

}

 

400:

Missing or invalid properties

 

401:

Invalid API Key & Password