summaryrefslogtreecommitdiff
path: root/rest-api/api-docs/channels.json
diff options
context:
space:
mode:
authorJason Parker <jparker@digium.com>2013-06-07 18:39:42 +0000
committerJason Parker <jparker@digium.com>2013-06-07 18:39:42 +0000
commitf19ff9579a0972e7be564da46179559f524203b9 (patch)
tree8d64c1b1970204534eeaa6203503fd0fa3ee6597 /rest-api/api-docs/channels.json
parent63c7141421e4070ab6a17338c595f4a5e31e9ebd (diff)
Implement ARI POST to /channels, to originate a call.
(closes issue ASTERISK-21617) Review: https://reviewboard.asterisk.org/r/2597/ git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@390885 65c4cc65-6c06-0410-ace0-fbb531ad65f3
Diffstat (limited to 'rest-api/api-docs/channels.json')
-rw-r--r--rest-api/api-docs/channels.json43
1 files changed, 36 insertions, 7 deletions
diff --git a/rest-api/api-docs/channels.json b/rest-api/api-docs/channels.json
index cb0332414..595b17e24 100644
--- a/rest-api/api-docs/channels.json
+++ b/rest-api/api-docs/channels.json
@@ -21,7 +21,7 @@
"httpMethod": "POST",
"summary": "Create a new channel (originate).",
"nickname": "originate",
- "responseClass": "Originated",
+ "responseClass": "void",
"parameters": [
{
"name": "endpoint",
@@ -33,7 +33,7 @@
},
{
"name": "extension",
- "description": "Extension to dial",
+ "description": "When routing via dialplan, the extension to dial",
"paramType": "query",
"required": false,
"allowMultiple": false,
@@ -41,7 +41,40 @@
},
{
"name": "context",
- "description": "When routing via dialplan, the context use. If omitted, uses 'default'",
+ "description": "When routing via dialplan, the context to use. If omitted, uses 'default'",
+ "paramType": "query",
+ "required": false,
+ "allowMultiple": false,
+ "dataType": "string"
+ },
+ {
+ "name": "callerId",
+ "description": "CallerID to use when dialing the endpoint or extension.",
+ "paramType": "query",
+ "required": false,
+ "allowMultiple": false,
+ "dataType": "string"
+ },
+ {
+ "name": "timeout",
+ "description": "Timeout (in seconds) before giving up dialing, or -1 for no timeout.",
+ "paramType": "query",
+ "required": false,
+ "allowMultiple": false,
+ "dataType": "int",
+ "defaultValue": 30
+ },
+ {
+ "name": "app",
+ "description": "Application name to pass to the Stasis application.",
+ "paramType": "query",
+ "required": true,
+ "allowMultiple": false,
+ "dataType": "string"
+ },
+ {
+ "name": "appArgs",
+ "description": "Application arguments to pass to the Stasis application.",
"paramType": "query",
"required": false,
"allowMultiple": false,
@@ -554,10 +587,6 @@
}
],
"models": {
- "Originated": {
- "id": "Originated",
- "properties": {}
- },
"Dialed": {
"id": "Dialed",
"properties": {}