diff options
| -rw-r--r-- | res/ari/resource_channels.h | 2 | ||||
| -rw-r--r-- | rest-api/api-docs/channels.json | 1 |
2 files changed, 3 insertions, 0 deletions
diff --git a/res/ari/resource_channels.h b/res/ari/resource_channels.h index 953d58f4e..e4dcc1b7d 100644 --- a/res/ari/resource_channels.h +++ b/res/ari/resource_channels.h @@ -72,6 +72,8 @@ struct ast_originate_args { /*! * \brief Create a new channel (originate). * + * The new channel is not created until the dialed party picks up. Not wanting to block this request indefinitely, this request returns immediately with a 204 No Content. When the channel is created, a StasisStart event is sent with the provided app and appArgs. In the event of a failure (timeout, busy, etc.), an OriginationFailed event is sent. + * * \param headers HTTP headers * \param args Swagger parameters * \param[out] response HTTP response diff --git a/rest-api/api-docs/channels.json b/rest-api/api-docs/channels.json index 0f3b8e20e..b408d8b17 100644 --- a/rest-api/api-docs/channels.json +++ b/rest-api/api-docs/channels.json @@ -20,6 +20,7 @@ { "httpMethod": "POST", "summary": "Create a new channel (originate).", + "notes": "The new channel is not created until the dialed party picks up. Not wanting to block this request indefinitely, this request returns immediately with a 204 No Content. When the channel is created, a StasisStart event is sent with the provided app and appArgs. In the event of a failure (timeout, busy, etc.), an OriginationFailed event is sent.", "nickname": "originate", "responseClass": "void", "parameters": [ |