Unscheduled end of dialog

Table of Contents

Description

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

Table 1. System Characteristics

Class

Type

api_stop

Properties

Table 2. Properties
Specification Description

Name: callid
Type: varchar
Empty value: — 

caller callid.

Name: sm_id
Type: varchar
Empty value: — 

Scenario Handler Identifier.

Name: componentid
Type: int
Empty value: — 

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

Name: componentname
Type: int
Empty value: — 

The name of the "API management" component in the IVR script entity.

Name: key
Type: varchar
Empty value: — 

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

Name: reason
Type: varchar
Empty value: — 

Control session termination reason.
- script - the scenario is completed (BYE is received from the subscriber, or it was interrupted in another way);
- timeout - control takeover timeout;
- abort - a control interrupt command is received from the control service.

Name: ivrid
Type: varchar
Empty value: — 

ivr-dialog identifier, uniform for all events within a single dialog. Addresses dialogs in runtime.

Name: ivrts
Type: bigint
Empty value: — 

Timestamp of ivr dialog initiation, uniform for all events within a single dialog. Together with ivrid provides uniqueness in historical data.

Name: cid
Type: uuid
Empty value: empty

Unique ivr-dialog identifier, uniform for all events within a single dialog. Independently ensures uniqueness in historical data.

See also