Parameters controlling a configurable in-conference IVR experience
Name | Type | Description | Attributes |
---|---|---|---|
atomLinkList | List of link | See Definition of link | |
ivr-template-identifier | IvrTemplateIdentifier | ID which uniquely identifies each IVR template. This is system generated unique identifier. This attribute is read-only. | |
name | Name | The name of the IVR template | Mandatory |
description | Description | Description of the IVR template. | |
max-prompt-attempts | MaxPromptAttempts | Number of times may an end user attempt to respond to a prompt. | |
response-timeout | ResponseTimeout | 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 | |
dtmf-terminator | DtmfTerminator | Key to terminate DTMF input. Pattern for valid key is [*#]? | |
chairperson-identifier-key | ChairpersonIdentifierKey | Key for lobby participant to request promotion to chairperson. Pattern for valid key is [0-9*#] | |
request-passcode-on-dialout | xs:boolean | Indicates whether the system should prompt for a passcode from a participant who is being dialed out to | |
auto-terminate | xs:boolean | Indicates whether the conference should terminate when only one call remains | |
mute-code | MuteCode | In conference DTMF sequence that allows a caller to mute his own line | |
unmute-code | UnmuteCode | In conference DTMF sequence that allows a caller to unmute his own line | |
mute-all-code | MuteAllCode | In conference DTMF sequence that allows a chairperson to mute all participants | |
unmute-all-code | UnmuteAllCode | In conference DTMF sequence that allows a chairperson to unmute all participants | |
lock-code | LockCode | In conference DTMF sequence that allows a chairperson to lock the conference | |
unlock-code | UnlockCode | In conference DTMF sequence that allows a chairperson to unlock the conference | |
dial-out-code | DialOutCode | In conference DTMF sequence that allows a chairperson to dial out to a new caller | |
help-menu-code | HelpMenuCode | In conference DTMF sequence that plays a list of available DTMF commands | |
terminate-conference-code | TerminateConferenceCode | In conference DTMF sequence that allows a chairperson to terminate the conference | |
upgrade-to-chairperson-code | UpgradeToChairpersonCode | In conference DTMF sequence that allows a participant to enter the chairperson passcode and become a chairperson | |
entity-tag | EntityTag | 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. |
Name | Type | Restrictions |
---|---|---|
EntityTag | xs:string | Length of value must be >=1 Length of value must be <=64 |
UpgradeToChairpersonCode | T0 | Length of value must be >=0 Length of value must be <=15 |
TerminateConferenceCode | T1 | Length of value must be >=0 Length of value must be <=15 |
HelpMenuCode | T2 | Length of value must be >=0 Length of value must be <=15 |
DialOutCode | T3 | Length of value must be >=0 Length of value must be <=15 |
UnlockCode | T4 | Length of value must be >=0 Length of value must be <=15 |
LockCode | T5 | Length of value must be >=0 Length of value must be <=15 |
UnmuteAllCode | T6 | Length of value must be >=0 Length of value must be <=15 |
MuteAllCode | T7 | Length of value must be >=0 Length of value must be <=15 |
UnmuteCode | T8 | Length of value must be >=0 Length of value must be <=15 |
MuteCode | T9 | Length of value must be >=0 Length of value must be <=15 |
ChairpersonIdentifierKey | T10 | Length of value must be >=0 Length of value must be <=1 |
DtmfTerminator | T11 | Length of value must be >=0 Length of value must be <=1 |
ResponseTimeout | xs:int | |
MaxPromptAttempts | xs:int | |
Description | xs:string | Length of value must be >=0 Length of value must be <=1000 |
Name | xs:string | Length of value must be >=1 Length of value must be <=40 |
IvrTemplateIdentifier | xs:string | Length of value must be >=0 Length of value must be <=256 |
T0 | xs:string | Pattern of value must match the regular expression [0-9*#]* |
T1 | xs:string | Pattern of value must match the regular expression [0-9*#]* |
T2 | xs:string | Pattern of value must match the regular expression [0-9*#]* |
T3 | xs:string | Pattern of value must match the regular expression [0-9*#]* |
T4 | xs:string | Pattern of value must match the regular expression [0-9*#]* |
T5 | xs:string | Pattern of value must match the regular expression [0-9*#]* |
T6 | xs:string | Pattern of value must match the regular expression [0-9*#]* |
T7 | xs:string | Pattern of value must match the regular expression [0-9*#]* |
T8 | xs:string | Pattern of value must match the regular expression [0-9*#]* |
T9 | xs:string | Pattern of value must match the regular expression [0-9*#]* |
T10 | xs:string | Pattern of value must match the regular expression [0-9*#]? |
T11 | xs:string | Pattern of value must match the regular expression [*#]? |