Jump to: navigation, search

CfgIVR

Description

An IVR (Interactive Voice Response) is a telephony object that contains IVR Ports; it is controlled through IVR interface drivers.

Filter Keys

Filter Name Type Description
tenant_dbid int A unique identifier of a tenant. If specified, Configuration Server will return information only about the DNs that belong to this tenant.
name string Name of IVR. Shall be specified as a character string. If specified, Configuration Server will return information only about the IVR with that name.
type int Type of the IVR (see type CfgIVRType). If specified, Configuration Server will return information only about the IVR of this type.
ivr_server_dbid int A unique identifier of an IVR interface server. If specified, Configuration Server will return information only about the IVRs that associated with this IVR interface server.
state int Current state of an IVR (see CfgObjectState). If specified, Configuration Server will return information only about IVRs that are currently in this state.
dbid int A unique identifier of an IVR. If specified, Configuration Server will return information only about this IVR.

Attributes

  • DBID — An identifier of this object in the Configuration Database. Generated by Configuration Server and is unique within an object type. Identifiers of deleted objects are not used again. Read-only.
  • tenantDBID — A unique identifier of the CfgTenant to which this IVR belongs. Once specified cannot be changed.
  • name — A pointer to the name of the IVR. Mandatory. Must be unique within configuration database.
  • description — A pointer to the description of the IVR.
  • type — Type of this IVR. See type CfgIVRType. Mandatory. Once specified cannot be changed.
  • version — A pointer to the version of the IVR. Mandatory.
  • IVRServerDBID — A unique identifier of the CfgApplication of CfgIVRInterfaceServer type permanently associated to serve this IVR.
  • state — Current object state. Mandatory. Refer to CfgObjectState.
  • userProperties — A pointer to the list of user-defined properties. Parameter userProperties has the following structure: Each key-value pair of the primary list (TKVList *userProperties) uses the key for the name of a user-defined section, and the value for a secondary list, that also has the TKVList structure and specifies the properties defined within that section.

Comments

Deletion of IVR X will cause the following events set out in the order of arrival:

  • Deletion of all IVR Ports of IVR X
  • Deletion of all folders that had IVR X defined as the parent object
  • Deletion of IVR X

See Also

CfgDeltaIVR

CfgIVRPort

Feedback

Comment on this article:

blog comments powered by Disqus
This page was last modified on June 27, 2017, at 12:20.