summaryrefslogtreecommitdiff
path: root/rest-api/api-docs/channels.json
diff options
context:
space:
mode:
authorJason Parker <jparker@digium.com>2013-06-28 16:23:24 +0000
committerJason Parker <jparker@digium.com>2013-06-28 16:23:24 +0000
commiteba573947059f42f8778f09e2e8640050fb8b444 (patch)
treebf126d0ef4e1e747d548f60e6f03b9f25e9174e8 /rest-api/api-docs/channels.json
parent6cc03db6426b70dce47471a20ab5d42f163dc419 (diff)
Change ARI originate to also allow dialing an exten/context/priority.
The old way didn't make much sense, so some of the fields were repurposed. (closes issue ASTERISK-21658) Review: https://reviewboard.asterisk.org/r/2626/ git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@393144 65c4cc65-6c06-0410-ace0-fbb531ad65f3
Diffstat (limited to 'rest-api/api-docs/channels.json')
-rw-r--r--rest-api/api-docs/channels.json40
1 files changed, 24 insertions, 16 deletions
diff --git a/rest-api/api-docs/channels.json b/rest-api/api-docs/channels.json
index d097267e7..15e76e4f8 100644
--- a/rest-api/api-docs/channels.json
+++ b/rest-api/api-docs/channels.json
@@ -25,15 +25,15 @@
"parameters": [
{
"name": "endpoint",
- "description": "Endpoint to call. If not specified, originate is routed via dialplan",
+ "description": "Endpoint to call.",
"paramType": "query",
- "required": false,
+ "required": true,
"allowMultiple": false,
"dataType": "string"
},
{
"name": "extension",
- "description": "When routing via dialplan, the extension to dial",
+ "description": "The extension to dial after the endpoint answers",
"paramType": "query",
"required": false,
"allowMultiple": false,
@@ -41,44 +41,52 @@
},
{
"name": "context",
- "description": "When routing via dialplan, the context to use. If omitted, uses 'default'",
+ "description": "The context to dial after the endpoint answers. If omitted, uses 'default'",
"paramType": "query",
"required": false,
"allowMultiple": false,
"dataType": "string"
},
{
- "name": "callerId",
- "description": "CallerID to use when dialing the endpoint or extension.",
+ "name": "priority",
+ "description": "The priority to dial after the endpoint answers. If omitted, uses 1",
"paramType": "query",
"required": false,
"allowMultiple": false,
- "dataType": "string"
+ "dataType": "long"
},
{
- "name": "timeout",
- "description": "Timeout (in seconds) before giving up dialing, or -1 for no timeout.",
+ "name": "app",
+ "description": "The application name to pass to the Stasis application.",
"paramType": "query",
"required": false,
"allowMultiple": false,
- "dataType": "int",
- "defaultValue": 30
+ "dataType": "string"
},
{
- "name": "app",
- "description": "Application name to pass to the Stasis application.",
+ "name": "appArgs",
+ "description": "The application arguments to pass to the Stasis application.",
"paramType": "query",
- "required": true,
+ "required": false,
"allowMultiple": false,
"dataType": "string"
},
{
- "name": "appArgs",
- "description": "Application arguments to pass to the Stasis application.",
+ "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
}
]
}