API SIMPSY Voice: /didnumber/dialplan/add

/didnumber/dialplan/add

GET http://voice.simpsy.com/api/v1/didnumber/dialplan/add

Add dialplan actions

Query Parameters

Parameter	Type	Required	Description
key	string	Yes	API Key
secret	string	Yes	API Secret
dialplan_id	string	Yes	Dialplan to create action in; dialplan_id from /list
action	string	Yes	Option:(choose one) ringing answer wait playback - playback sound track queue dial_agent - call directly to agent authenticate - get caller to input password getdtmf - DTMF let caller choose call to go to which queue hangup
action_details	string	Yes	if action ringing, action_details leave empty if action answer, action_details leave empty if action wait, action_details as seconds; number of seconds to wait if action playback, action_details as unique_sound_name from /sound/list; playback which soundtrack if action queue, action_details as queue id from /queue/list if action dial_agent, action_details agent id from /agent/list if action authenticate, action details will be password in numeric if action getdtmf, action_details as unique_sound_name from /sound/list; playback soundtrack for caller option if action hangup, action_details leave empty
priority	number	Yes	Set the priority of the action

Code Samples

JavaScript PHP Rails

var xmlHttp = new XMLHttpRequest();
xmlHttp.open("GET", "http://voice.simpsy.com/api/v1/didnumber/dialplan/add?key=%key%&secret=%secret%&dialplan_id=%dialplan_id%&action=%action%&action_details=%action_details%&priority=%priority%", 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/dialplan/add?key=%key%&secret=%secret%&dialplan_id=%dialplan_id%&action=%action%&action_details=%action_details%&priority=%priority%");
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/dialplan/add?key=%key%&secret=%secret%&dialplan_id=%dialplan_id%&action=%action%&action_details=%action_details%&priority=%priority%")
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"

}

400:

Missing or invalid properties

401:

Invalid API Key & Password