/agent/list
GET http://voice.simpsy.com/api/v1/agent/list
List of agents and details, use id of agent to perfom other API
Query Parameters
Parameter | Type | Required | Description |
key | string | Yes | API Key |
secret | string | Yes | API Secret |
Code Samples
JavaScript PHP Railsvar xmlHttp = new XMLHttpRequest();
xmlHttp.open("GET", "http://voice.simpsy.com/api/v1/agent/list?key=%key%&secret=%secret%", 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/agent/list?key=%key%&secret=%secret%");
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/agent/list?key=%key%&secret=%secret%")
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":"Success",
"result":
[
{
"id":"23",
"name": "testagent",
"sip_login": "12345678",
"sip_password": "87654321",
"callerid": "+6591234567",
"ipaddress": "enabled",
"followme": "disabled",
"webphone":"https://simpsy.com/customersupport/agent/phone/call?userid=&agent_id=&from=&8289fefi2342f243feer"
},
{
"id":"43",
"name": "testagent1",
"sip_login": "123123123",
"sip_password": "321321321",
"callerid": "+6597654321",
"ipaddress": "enabled",
"followme": "disabled",
"webphone":"https://simpsy.com/customersupport/agent/phone/call?userid=&agent_id=&from=&8289fefi2342f243feer"
}
]
}
"status":"200",
"message":"Success",
"result":
[
{
"id":"23",
"name": "testagent",
"sip_login": "12345678",
"sip_password": "87654321",
"callerid": "+6591234567",
"ipaddress": "enabled",
"followme": "disabled",
"webphone":"https://simpsy.com/customersupport/agent/phone/call?userid=&agent_id=&from=&8289fefi2342f243feer"
},
{
"id":"43",
"name": "testagent1",
"sip_login": "123123123",
"sip_password": "321321321",
"callerid": "+6597654321",
"ipaddress": "enabled",
"followme": "disabled",
"webphone":"https://simpsy.com/customersupport/agent/phone/call?userid=&agent_id=&from=&8289fefi2342f243feer"
}
]
}
400:
Missing or invalid properties
401:
Invalid API Key & Password