Beginning of the stage of external management of IVR script via API

Table of Contents

Description

The event is generated at the beginning of the corresponding script component’s operation IVR. After the event is generated, the external service is expected to take control with a set timeout (up to 30 seconds). The control service can send commands (playback, recording, etc.) with parameters identical to the corresponding script components via API until the work is completed IVR.

Table 1. System Characteristics

Class

Type

api_start

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

Parameter string (can be JSON or something else) set in the settings of the "API Management" component in the IVR script entity.

Name: state
Type: varchar
Empty value: — 

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

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