Service XML structure

All services are described using the following XML structure:-

![CDATA[<?xml version="1.0" encoding="utf-8" ?>
<Service>
  <Name><![CDATA[ServiceName]]></Name>
  <Description><![CDATA[ServiceDescription]]></Description>
  <Version>1.0</Version>
  <CustomServiceVariables>
    <Variable Name="@VariableName" DefaultValue="######" Description="" Scope="Call" />
  </CustomServiceVariables>
  <Nodes>

	[2 or more Node elements go here]

  </Nodes>
  <CustomData>
	[Custom XML data can be defined here]
  </CustomData>
  <SubPlans>
	[Sub plans can be defined here, see section 4.6]
  </SubPlans>
</Service>]]

The version element within the Service element must be specified but is currently ignored in this version of the API.

  • A service XML document must have one β€œStart” node.

  • Nodes can appear in any order within the <Nodes> element.

  • The integer NodeID reference you assign to each node must be unique within the service XML document, including any sub plans that may have been defined.

  • A nodes branch cannot reference its own NodeID.

  • All mandatory properties must be defined within the service XML document.

  • A service design having infinite loops without telephony interaction is not allowed.

  • A service design that could follow a path with 6 or more nodes without having telephony interaction is not allowed.

  • The CustomServiceVariables section is not mandatory.

Last updated

Was this helpful?