Management of IVR scripts execution (ivrscript_runtimes)
Overview
Manages active IVR script handlers.
An IVR script handler is an algorithm that interprets an instance of an IVR script.
Requests
| HTTP verb | Endpoint | Description |
|---|---|---|
|
|
|
|
|
Getting the list of running instances of IVR scripts
Returns a list of all IVR script handlers executed by the system in the current domain at all available sites where it is served.
Request
| Name | Type | Description |
|---|---|---|
|
|
Filter by field values. |
|
|
A list of fields to output. |
|
|
Offset in the list of resources to be issued. |
|
|
The maximum number of resources in the list. |
|
|
The sort order of the resources in the list. |
|
|
Conversion to flat form of composite fields. |
GET /rest/v1/uc/ivrscript_runtimes HTTP/1.1Response
Returns all detected active running IVR script handlers.
| Field | Description |
|---|---|
|
Scenario handler identifier |
|
The site where the handler is executed. |
|
Node within which the handler is executed. |
|
Script Domain. |
|
Scenario Type. |
|
The code of the running script. If the source script has transferred control to a nested script, the code of the nested script is returned. |
|
The name of the running scenario. If the source script has transferred control to a nested script, the name of the nested script is returned. |
|
Date and time of the handler start in RFC3339 format in UTC. |
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
[
{
"id": "244f84aa-0624-e639-8061-a80000000006",
"site": "SITE1",
"node": "site1_h6@192.168.0.12",
"domain": "test.rootdomain.ru",
"type": "ivr",
"code": "player",
"name": "TEST PLAY",
"starttime": "2019-11-05T08:36:40Z"
},
{
"id": "6b3ba923-0624-e8c9-6bee-b00000000008",
"site": "SITE1",
"node": "site1_h8@192.168.0.12",
"domain": "test.rootdomain.ru",
"type": "ivr",
"code": "welcome",
"name": "Main scenario",
"starttime": "2019-11-05T11:31:34Z"
}
]Stopping the IVR script instance
Forcibly terminates the script handler.
If a post-processing branch corresponding to the External Stop' termination type is specified in the currently executing script, control is passed to it and the handler continues to execute.
In this case, another API request will be needed to stop the handler completely `DELETE.
See also
-
Scenario Type: IVR
-
Entity IVR script
-
API entity management IVR scripts