PlcmIvrTemplate

PlcmIvrTemplate

Parameters controlling a configurable in-conference IVR experience


PlcmIvrTemplate Fields

NameTypeDescriptionAttributes
atomLinkList Array of LinkSee Definition of Link
ivrTemplateIdentifierIvrTemplateIdentifier ID which uniquely identifies each IVR template. This is system generated unique identifier. This attribute is read-only.
nameName The name of the IVR template Mandatory
descriptionDescription Description of the IVR template.
maxPromptAttemptsMaxPromptAttempts Number of times may an end user attempt to respond to a prompt.
responseTimeoutResponseTimeout Number of seconds the system shall wait for an end user to enter DTMF in response to a prompt. Range for valid timeout is 5-60
dtmfTerminatorDtmfTerminator Key to terminate DTMF input. Pattern for valid key is [*#]?
chairpersonIdentifierKeyChairpersonIdentifierKey Key for lobby participant to request promotion to chairperson. Pattern for valid key is [0-9*#]
requestPasscodeOnDialoutboolean Indicates whether the system should prompt for a passcode from a participant who is being dialed out to
autoTerminateboolean Indicates whether the conference should terminate when only one call remains
muteCodeMuteCode In conference DTMF sequence that allows a caller to mute his own line
unmuteCodeUnmuteCode In conference DTMF sequence that allows a caller to unmute his own line
muteAllCodeMuteAllCode In conference DTMF sequence that allows a chairperson to mute all participants
unmuteAllCodeUnmuteAllCode In conference DTMF sequence that allows a chairperson to unmute all participants
lockCodeLockCode In conference DTMF sequence that allows a chairperson to lock the conference
unlockCodeUnlockCode In conference DTMF sequence that allows a chairperson to unlock the conference
dialOutCodeDialOutCode In conference DTMF sequence that allows a chairperson to dial out to a new caller
helpMenuCodeHelpMenuCode In conference DTMF sequence that plays a list of available DTMF commands
terminateConferenceCodeTerminateConferenceCode In conference DTMF sequence that allows a chairperson to terminate the conference
upgradeToChairpersonCodeUpgradeToChairpersonCode In conference DTMF sequence that allows a participant to enter the chairperson passcode and become a chairperson
entityTagEntityTag The unique value generated from the server object instance. This value is the same value that MUST be applied to the HTTP Entity Tag (ETag) header for a single instance of this object. Client modification of this field is not allowed for this instance.


Nested Types/Restrictions


NameTypeRestrictions
EntityTagstring
Length of value must be >=1
Length of value must be <=64
UpgradeToChairpersonCode
Length of value must be >=0
Length of value must be <=15
TerminateConferenceCode
Length of value must be >=0
Length of value must be <=15
HelpMenuCode
Length of value must be >=0
Length of value must be <=15
DialOutCode
Length of value must be >=0
Length of value must be <=15
UnlockCode
Length of value must be >=0
Length of value must be <=15
LockCode
Length of value must be >=0
Length of value must be <=15
UnmuteAllCode
Length of value must be >=0
Length of value must be <=15
MuteAllCode
Length of value must be >=0
Length of value must be <=15
UnmuteCode
Length of value must be >=0
Length of value must be <=15
MuteCode
Length of value must be >=0
Length of value must be <=15
ChairpersonIdentifierKey
Length of value must be >=0
Length of value must be <=1
DtmfTerminator
Length of value must be >=0
Length of value must be <=1
ResponseTimeoutint
MaxPromptAttemptsint
Descriptionstring
Length of value must be >=0
Length of value must be <=1000
Namestring
Length of value must be >=1
Length of value must be <=40
IvrTemplateIdentifierstring
Length of value must be >=0
Length of value must be <=256
T0string
Pattern of value must match the regular expression [0-9*#]*
T1string
Pattern of value must match the regular expression [0-9*#]*
T2string
Pattern of value must match the regular expression [0-9*#]*
T3string
Pattern of value must match the regular expression [0-9*#]*
T4string
Pattern of value must match the regular expression [0-9*#]*
T5string
Pattern of value must match the regular expression [0-9*#]*
T6string
Pattern of value must match the regular expression [0-9*#]*
T7string
Pattern of value must match the regular expression [0-9*#]*
T8string
Pattern of value must match the regular expression [0-9*#]*
T9string
Pattern of value must match the regular expression [0-9*#]*
T10string
Pattern of value must match the regular expression [0-9*#]?
T11string
Pattern of value must match the regular expression [*#]?