Voice InboundXML

The API interprets the InboundXML document based on its markup. The markup, composed of basic XML elements, contains the instructions that determine how Ytel API should respond. All InboundXML elements are camelcase and case-insensitive and are organized into Verbs or Nouns.

Verbs - Elements that define the behavior of the call or text.

Nouns - Elements that define the specifics of the behavior. These are always nested inside of verbs and they can be XML elements or plain text.

  <Say>You are about to execute a new call.</Say>
  <Dial action="http://your-url.com/">+XXXYYYZZZZ</Dial>
  <Say>We have passed the Dial. The call will now be terminated</Say>

For simplicity, the Verbs are referred to as Voice Elements, and the Nouns are the attribute parameters for the Voice Elements.

All supported InboundXML elements are documented below. For each Voice Element definition, there is:

  1. A description/purpose of what the element does
  2. A table of voice element attributes (nouns)
  3. Information on how the voice element can be nested, if applicable
  4. A code snippet
  5. A list of usage tips, if applicable


Note : The following special characters are not supported in the URL query string options: ' " & # { } < > ? and will be stripped from the URL during parsing.