Unscheduled dialog termination

Description

The event is generated when the IVR script component "External control via API" completes. After the event, commands from the external service for script control are no longer processed.
Control termination can occur by timeout (if a control capture request is not received in time) or when the script completes.

Table 1. System characteristics

Class

Type

api_stop

Properties

Table 2. Properties
Specification Description

Name: callid
Type: varchar
Empty value: — 

Subscriber callid.

Name: sm_id
Type: varchar
Empty value: — 

Script handler identifier.

Name: componentid
Type: int
Empty value: — 

Numeric identifier of the "API control" component in the IVR script entity.

Name: componentname
Type: int
Empty value: — 

Name of the "API control" component in the IVR script entity.

Name: key
Type: varchar
Empty value: — 

Control session key, set in the "API control" component settings in the IVR script entity.

Name: reason
Type: varchar
Empty value: — 

Control session termination reason.
- script - the script completed (BYE received from the subscriber, or it was interrupted in another way);
- timeout - timeout waiting for control acquisition;
- abort - control interruption command received from the controlling service.

Name: ivrid
Type: varchar
Empty value: — 

IVR dialog identifier, the same for all events within one dialog. Addresses dialogs at runtime.

Name: ivrts
Type: bigint
Empty value: — 

IVR dialog initiation timestamp, the same for all events within one dialog. Together with ivrid ensures uniqueness in historical data.

Name: cid
Type: uuid
Empty value: empty

Unique IVR dialog identifier, the same for all events within one dialog. Independently ensures uniqueness in historical data.

See also