Start of the IVR script external control stage via API
Description
The event is generated at the start of the corresponding IVR script component. After the event is generated, control capture by the external service is awaited within the configured timeout (up to 30 seconds). Until completion, the controlling service can send API commands (playback, recording, etc.) with parameters identical to the corresponding IVR script components.
Class |
|
Type |
|
Properties
| Specification | Description |
|---|---|
Name: |
Subscriber callid. |
Name: |
Script handler identifier. |
Name: |
Numeric identifier of the "API control" component in the IVR script entity. |
Name: |
Name of the "API control" component in the IVR script entity. |
Name: |
Control session key, set in the "API control" component settings in the IVR script entity. |
Name: |
Parameter string (may be JSON or something else), set in the "API control" component settings in the IVR script entity. |
Name: |
IVR dialog state. Variants: |
Name: |
IVR dialog identifier, the same for all events within one dialog. Addresses dialogs at runtime. |
Name: |
IVR dialog initiation timestamp, the same for all events within one dialog. Together with ivrid ensures uniqueness in historical data. |
Name: |
Unique IVR dialog identifier, the same for all events within one dialog. Independently ensures uniqueness in historical data. |