đź“–
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
  • NodeType
  • NodeID
  • Mandatory Properties
  • Optional Settings
  • Branches
  • Dynamic Branches
  • Dynamic Properties

Was this helpful?

Service Creation

Advanced inbound telephony services are built using a “node” based design model. A service is described using a Service XML document. The XML document is then sent to the platform using XML web services to assign and activate against inbound service numbers.

Each node encompasses a unit of functionality which may or may not link to other nodes which as a whole represents the service call flow. Services are built by linking several nodes together using unique NodeID references.

Nodes have the following structure:-

NodeType

The NodeType identifies the type of node within the Service XML document. See the Node Reference for details.

NodeID

The NodeID is a unique integer reference that you assign to each node to uniquely identify the node within the service XML document. This allows the node to be linked to other nodes by referencing its unique NodeID within the Branches of other nodes.

Mandatory Properties

Each node may have a number of mandatory properties which must be configured. See the individual node reference for more details.

Optional Settings

Each node may have a number of optional settings each with its own properties which customise the functionality of the node.

Branches

A branch is where call flow exits from a node. Each node may have a number of mandatory/non-mandatory branches which must reference a NodeID of another node.

Dynamic Branches

Dynamic branches are branches added by the service designer to nodes that require them. The number of branches is determined by the functionality required from the node.

Dynamic Properties

Dynamic properties are properties added by the service designer to nodes that require them. These are properties determined by the functionality required from the node.

PreviousHow many Scheduled Call requests can be createdNextNode XML structure

Last updated 2 months ago

Was this helpful?