đź“–
API Documentation
  • About
  • Version History
  • Introduction
    • Account Setup
    • Platform Features
    • Mid Call Divert/Mid Call Conference
    • Call Whisper
    • Conferencing
    • Percentage Distribution Algorthm
    • Call Queueing
    • Call Recording
    • Outbound Call
    • IVR Voicemail Retrieval Telephone Service
    • IVR Service Switcher Telephone Service
    • Web Service Security
    • Web Service Definition Language
      • Using a development environment other than the .NET Platform
    • Web Service Error Handling
    • Real-Time Multi-leg Call Data Records
      • Pseudo Code
      • Real-Time Multi-Leg CDR Call Types
    • Status Code Table
    • Default Audio
    • Development Guidelines
      • Development LAB Platform Test Harness
    • Post Call
    • DTMF Controlling Party
    • Data Rentention Policy
    • API Availability
    • Dynamic Call Agent (DCA)
      • Status Code Table
      • Call Outcome Table
      • Call Status Table
      • IVR Dynamic Call Agent Service
      • Apology Modes
    • JSON API
    • Emails
      • Custom Email Settings
      • Not Receiving Emails
      • Global Email Variables
      • Using Custom Service Variables within your emails
      • Email Content Type
      • Email Address HTML encoding
    • TimeZone Offset Setting
      • TimeZone Offset Table
      • Daylight Saving Time Changes
    • Public IP Addresses
    • Default Email Settings
    • Scheduled Call Feature
      • How to create a Scheduled Call request
      • What CLI be presented to the called parties
      • How to check the progress of a Scheduled Call request
      • How to retrieve the call statistics for my Scheduled Calls
      • How to delete a queued Scheduled Call request
      • How many simultaneous Scheduled Calls can be in progress
      • How many Scheduled Call requests can be created
  • Service Creation
    • Node XML structure
    • Service XML structure
    • Custom Service Variables
    • Variable Scope
    • Node Security
    • Graphical Representation of a Sample Service
    • Sample Service XML
    • Sub Plans
    • Sub Plan Example XML
  • Web Service Authentication
  • Service Audio
  • Node Reference
    • Start
    • Page 1
  • Security Methods
  • Service Management Methods
  • Audio Management Methods
  • General Methods
  • File Management Methods
  • Real-Time Data Methods
  • Service Number Activation Methods
  • Number Group Methods
  • Account Methods
  • Payphone Barring
  • Dynamic Call Agent Methods
  • Tiff to Fax Methods
  • Call Barring Methods
  • Platform Logging Methods
  • Platform Logging
  • Data Tables
  • Scheduled Call
  • External Number Management Methods
  • Phone Book Management Methods
  • Origin List Management Methods
  • Private SIP Management Methods
  • Bulk Configuration
  • Appendix
Powered by GitBook
On this page

Was this helpful?

  1. Service Creation

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.

You must wrap the XML document with a CDATA when sending the XML through XML web services.

  • 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.

PreviousNode XML structureNextCustom Service Variables

Last updated 2 months ago

Was this helpful?