Nesting

You must always nest the<agent> element within a <Connect> element. You can only nest one <Agent> element within each <connect> element.

Attribute

• muted

  Boolean value specifying if the conference should be muted. Default Value: false. Allowed Value: true or false.

• beep

  Boolean value specifying if a beep should play upon entrance to conference. Default Value: false. Allowed Value: true or false.

• startConferenceOnEnter

  Boolean value specifying if conference should begin upon entrance. Default Value: false. Allowed Value: true or false.

• endConferenceOnExit

  Boolean value specifying if conference should end upon a specific users exit. Default Value: false. Allowed Value: true or false.

• maxParticipants

  The maximum number of participants allowed in the conference call. Default Value: 40. Allowed Value: integer from 2 to 40.

• waitSound

  URL to inboundXML where conference participants can be sent to while they wait for entrance into the conference. Only method supported at this time.

• hangupOnStar

  Boolean value specifying if pressing * should end the conference. Default Value: false. Allowed Value: true or false.

• callbackUrl

  URL where some parameters specific to will be sent when participants enter and exit the conference and once it is completed. There is only one callbackUrl allowed per conference. The first callbackUrl will be the only one used.

• callbackMethod

  Method used to request the callback URL. Default Value: POST. Allowed Value: POST or GET.

• digitsMatch

  Specifies digits that Avaya Communications APIs should listen for and send to the callbackUrl if a caller inputs them. Separate additional digits or digit patterns with a comma. Allowed Value: Pattern made up of the digits 0-9, #, or *.

• stayAlone

  Boolean value specifying if the caller should stay alone in the conference call. Default Value: true. Allowed Value: true or false.

• record

  Boolean value specifying if the conference should be recorded. Default Value: false. Allowed Value: true or false.

• recordCallbackUrl

  URL to sound that the recording will be sent to from the conference.

• recordFileFormat

  File format in which the recording will be saved in. Default Value: mp3. Allowed Value: mp3 or wav.

Nesting

In addition to the default <Response> element, the <Conference> element must also be nested within the following <Dial> verb. No other elements may be nested within the <Conference> element.

Attribute

• action

  A URL to which Avaya Communications APIs forwards the conversation with the agent bot. The default value is null.

• method

  A method used to send a request to the action URL. Allowed Values: GET and POST. The default value is POST.

• params

  Parameters used for a specific third-party integration, for example, Dialogflow. The default value is null.

Nesting

You can use the <connect> element anywhere within the <response> element, but you cannot nest it within any other element. You can use several <connect> elements within a single <response> element if you want to call to several different agent bots one after another.

Attribute

• action

  URL where some parameters specific to will be sent for further processing. The calling party can be redirected here upon the hangup of the B leg caller.

• method

  Method used to request the action URL. Default Value: POST. Allowed Value: POST or GET.

• timeLimit

  The duration in seconds a call made through should occur for before ending. Default Value: 14400. Allowed Value: integer greater than or equal to 1.

• callerId

  Number to display as calling. Defaults to the ID of phone being used. This parameter is optional in general. However, if your vendor is Telnyx, TATA or Flowroute, this parameter is required in order for your vendor to process the call correctly.

• callerName

  The name registered to the phone calling. Note: it is recommended that you use both the callerId and callerName attributes if you're attempting to pass through the original caller information using dynamic content from HTTP request parameters.

• hideCallerId

  Boolean value specifying if the caller ID should be hidden or not. Default Value: false. Allowed Value: true or false.

• dialMusic

  URL to an InboundXML document to be executed in place of the call ringtone (a or would be appropriate in this document).

• callbackUrl

  URL requested when the dialed call connects and ends. Note that this URL only receives parameters containing information about the call, the call does not execute XML given as a callbackUrl.

• callbackMethod

  Method used to request the callback URL. Default Value: POST. Allowed Value: POST or GET.

• confirmSound

  Boolean value specifying if a sound should play when dial is successful. Defaults Value: false.

• digitsMatch

  Specifies digits that Avaya Communications APIs should listen for and send to the callbackUrl if a caller inputs them. Separate additional digits or digit patterns with a comma. Allowed Value: Pattern made up of the digits 0-9, #, or *.

• straightToVm

  Boolean value specifying if call should be redirected to voicemail immediately. Note: only works if dialing TO a mobile number. Default Value: false. Allowed Value: true or false.

• heartbeatUrl

  A URL Avaya Communications APIs can request every 60 seconds during the call to notify of elapsed time and pass other general information.

• hearbeatMethod

  Method used to request the heartbeatUrl. Default Value: POST. Allowed Value: POST or GET.

• ifMachine

  Specifies the number to list the call as forwarded from.

• ifMachineUrl

  The URL Avaya Communications APIs will redirect to if a voicemail machine is detected while the ifMachine=“redirect” attribute is set.

• ifMachineMethod

  The method used to request the ifMachineUrl. Default Value: POST. Allowed Value: POST or GET.

• record

  Specifies if this call should be recorded. Allowed positive values are "true" - any other value will default to "false".

• recordDirection

  Specifies which stream of call audio to record. “in” to record the incoming caller audio, “out” to record the outgoing caller audio, or “both” to record all audio on the call. “out” audio can only be captured if an outbound is performed during the call. “in” blocks any subsequent InboundXML elements until the inbound audio recording is finished (via finishOnKey or timeout). Default Value: both. Allowed Value: in, out, both.

• recordCallbackUrl

  URL where some parameters specific to the recording will be sent for further processing.

Attribute

• DialCallStatus

  Status of the dial. May be completed, busy, no-answer, failed, or canceled.

• DialCallSid

  The call sid of the outgoing dial.

• DialCallDuration

  The length of the dialed call in seconds.

Attribute

• ElapsedTime

  The elapsed time of the dialed call in seconds.

• AnsweredTime

  The date and time the call was answered.

Attribute

• input

  A list of inputs that Avaya Communications APIs should accept. Default value is "dtmf". Accepted values are "dtmf", "speech", or "speech dtmf"

• hints

  A set of words or phrases that Avaya Communications APIs should listen for. Commas should seperate words.

• language

  BCP-47 language tags. Defaults to en-US

• action

  URL where the flow of the call and the gathered digits will be forwarded to (if digits are input).

• method

  Method used to request the action URL. Default value is POST. Available methods are GET and POST.

• timeout

  The number of seconds should wait for digits to be entered before requesting the action URL. Timeout resets with each new digit input. Default value is 5 seconds. Timeout accepts any integer greater than or equal to 0.

• finishOnKey

  The key a caller can press to end the . Default value is #. Acceptable values are digits from 0 to 9, # or *

• numDigits

  The maximum number of digits to . Default value is set to no limit. Acceptable value is any integer greater than or equal to 0.

Parameter

• Digits

  All gathered digits, not including finishOnKey.

• SpeechResult

  All captured speech to text words

Attribute

• schedule

  Specifies in seconds when a hangup should occur during a call. Allowed Value: integer greater than or equal to 0

• reason

  Reason for the hangup. It can be rejected or busy. Default is none.

Attribute

• to

  The phone number that will receive the SMS message. If this parameter is not specified, the SMS will be sent back to the number that made the request to the Avaya Communications APIs number’s SMS request URL.

• from

  The number that will display as sending the SMS message. This should be one of your Avaya Communications APIs numbers. If this parameter is not specified, the default from number is the Avaya Communications APIs number hosting the SMS request URL.

• action

  URL to direct Avaya Communications APIs to once the <Sms> element is executed. Parameters specific to <Sms> are sent here along with the request.

• method

  Method used to request the action URL. Default Value: POST. Allowed Value: POST or GET.

• statusCallback

  URL where the status of the SMS can be sent.

• mediaUrl

  URL of an image to be sent in the message.

Attributes

• sendDigits

  Specifies which DTMF tones to play to the called party. w indicates a half second pause.

Attribute

• length

  The length in seconds the pause should be. Default Value: 1. Allowed Value: integer greater than 0, less than 99999

Attribute

• method

  Method used to request ping url. Default Value: POST. Allowed Value: POST or GET.

Attribute

• loop

  The amount of times the should be repeated. 0 indicates an infinite loop. The default value is 1. Allowed values are integers greater than or equal to 0.

Attribute

• action

  URL where some parameters specific to <Record> will be sent for further processing.

• method

  Method used to request the action URL. Default value is POST. Available values are POST and GET.

• timeout

  The number of seconds <Record> should wait during silence before ending. Default timeout value is 5 seconds. Valid value is integer greater than or equal to 0.

• finishOnKey

  The key a caller can press to end the <Record>. Default value is #. Allowed values are digits from 0 to 9, # or *.

• maxLength

  The maximum length in seconds a recording should be. Default Value: 3600. Allowed Value: integer greater than or equal to 0.

• transcribe

  Boolean value specifying if the recording should be transcribed. Default Value: false. Allowed Value: true or false.

• transcribeQuality

  Specifies the quality used to process the transcription. Default Value: auto. Allowed Value: auto or keywords.

• transcribeCallback

  A URL some parameters regarding the transcription will be passed to once it is completed. Allowed Value: Valid URL.

• playBeep

  Boolean value specifying if a beep should be played when the recording begins. Default Value: false. Allowed Value: true or false.

• direction

  Specifies which stream of call audio to record. “in” to record the incoming caller audio, “out” to record the out going caller audio, or “both” to record all audio on the call. “out” audio can only be captured if an outbound Dial is performed during the call. “in” blocks any subsequent XML elements until the inbound audio recording is finished (via finishOnKey or timeout). Default Value: both. Allowed Value: in, out, both.

• fileFormat

  The recording file format. Can be mp3 or wav. Default is mp3. Default Value: mp3. Allowed Value: mp3 or wav.

• background

  Begin recording the call while continuing the execution of any other present InboundXML in the background (true) or block the execution of subsequent InboundXML until the record element finishes (via finishOnKey or timeout). Note that the timeout, finishOnKey, and playBeep attributes have no effect when the background is set to true. Default Value: true. Allowed Value: true or false

• trimSilence

  Trims all silence from the beginning of the recording. Allowed values are "true" or "false" - any other value will default to "false".

Attribute

• Digits

  The key used to end the recording.

• RecordingDuration

  The length of the recording in seconds.

• RecordingSid

  Unique recording identifier.

• RecordingUrl

  A URL leading to an audio file of the recording.

• RecordingInterference

  Status if we detected any interference during recording. Can be true or false.

Parameter

• Duration

  The duration of the recording that was transcribed.

• Price

  The cost of the transcription.

• TransactionStatus

  The status of the transcription.

• TranscriptionSid

  An alphanumeric string identifying the transcription.

• RecordingUrl

  A URL leading to an audio file of the recording.

• TranscriptionUrl

  A URL containing the transcription.

• TranscriptionText

  The text of the transcription.

Attribute

• method

  Method used to request the InboundXML document the call is being redirected to. Default Value: POST. Allowed Value: POST or GET.

Attribute

• action

  URL to fetch the set of instructions for further processing. It is executed when the transfer fails with a failure response or when the <Refer> verb is timed out.

• method

  Method used to request the action URL.

• timeout

  The number of seconds Avaya Communications APIs should wait for <Refer> verb to conclude.

• callbackUrl

  URL where the status of the <Refer> can be sent.
  Note:
  This URL only receives parameters containing information about the call. The call does not execute XML given as a callbackUrl.

• callbackMethod

  Method used to request the callback URL. Default Value: POST. Allowed Value: POST or GET.

Attribute

• ReferCallStatus

  Based on SIP NOTIFY messages, this parameter provides the application with the Avaya Communications APIs understanding of the new call status created in response to <Refer>.

• ReferSipResponseCode

  The SIP response code received in response to the <Refer> request that Avaya Communications APIs sends to the SIP endpoint.

• NotifySipResponseCode

  As determined by examining the SIP NOTIFY messages, this is the last SIP response code received on the referred leg. If the <Refer> fails or the endpoint does not send any NOTIFY requests, this parameter will be omitted.

Attribute

• reason

  This allows you to define why the call was rejected. Default Value: rejected. Allowed Values: busy or rejected.

Attribute

• voice

  The gender of the voice that will speak the text. Allowed values are "man" or "woman". The default value is "woman".

• language

  The language used to speak the text.

• loop

  The amount of times the text should be repeated. Allowed values are any integer greater than or equal to 0. "0" indicates an infinite loop.

• cy-gb

  Welsh

• da-dk

  Danish

• de-de

  German

• en-au

  Australian English

• en-gb

  British English

• en-gb-wls

  Welsh English

• en-in

  Indian English

• en-us

  US English

• es-es

  Castilian Spanish

• es-us

  US Spanish

• fr-ca

  Canadian French

• fr-fr

  French

• is-is

  Icelandic

• it-it

  Italian

• ja-jp

  Japanese

• nb-no

  Norwegian

• nl-nl

  Dutch

• pl-pl

  Polish

• pt-br

  Brazilian Portuguese

• pt-pt

  Portuguese

• ro-ro

  Romanian

• ru-ru

  Russian

• sv-se

  Swedish

• tr-tr

  Turksih

Attribute

• username

  If provided, will be passed along as sip authentication username.

• password

  If provided, will be passed along as sip authentication password.

• directMedia

  If this value set to true, two SIP participants will connect to each other directly without an additional charge for the connection. The media (RTP) will be directly between the two participants. Default Value: false. Allowed Values: true or false

Attribute

• to

  The phone number that will receive the SMS message. If this parameter is not specified, the SMS will be sent back to the number that made the request to the Avaya Communications APIs number’s SMS request URL.

• from

  The number that will display as sending the SMS message. This should be one of your Avaya Communications APIs numbers. If this parameter is not specified, the default from number is the Avaya Communications APIs number hosting the SMS request URL.

• action

  URL to direct Avaya Communications APIs to once the element is executed. Parameters specific to are sent here along with the request.

• method

  Method used to request the action URL. Default Value: POST. Allowed Value: POST or GET.

• statusCallback

  URL where the status of the SMS can be sent.

Parameter

• SmsSid

  The Sid Avaya Communications APIs has assigned for the SMS message.

• SmsStatus

  The current status of the SMS message. Either sent or failed.

• Body

  The text of the SMS message you want to send. 160 character limit.