API SIMPSY Voice

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

/didnumber/dialplan/list


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

GET

List of dialplan actions details

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/dialplan/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/dialplan/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/dialplan/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":
    [
      {
      "didnumber": "12345678",
      "dialplan_id": "20",
      "dialplan_name": "United States",
      "details":
        [
        {
        "priority": "1",
        "action_id": "10",
        "action": "ringing",
        "action_details": ""
        },
        {
        "priority": "2",
        "action_id": "11",
        "action": "queue",
        "action_details": "5"
        }
        ]


      }
    ]
}

 

400:

Missing or invalid properties

 

401:

Invalid API Key & Password