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.

Table 1. System characteristics

Class

Type

api_start

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: params
Type: varchar
Empty value: — 

Parameter string (may be JSON or something else), set in the "API control" component settings in the IVR script entity.

Name: state
Type: varchar
Empty value: — 

IVR dialog state. Variants: dialog, early, ringing, incoming. The state depends on the responses sent to the incoming call in IVR.

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