📖
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
  • Mandatory Properties
  • Optional Settings
  • Branches
  • Dynamic Properties
  • Dynamic Branches

Was this helpful?

  1. Node Reference

Start

The call flow for a service begins with a “Start” node. All services must have a start node defined.

A validation error will occur if a “Start” node is missing or you have defined more than one within the service XML document.

NodeType

Start

Description

Place holder for start of call flow.

Category

Entry Point

Availability

Unsecured

Mandatory Properties

Name
Description
DataType
Valid Values

MaxLength

Maximum length of the call in minutes.

Integer

0 to 720 0 = Unlimited

EnableSpeedDial

Enables speed dial functionality when invoking Mid-Call Divert/Mid-Call Conference on nodes that support this feature.

Boolean

True

False

Optional Settings

MissedCallAlert

Description

Sends a missed call alert email if the call ends without an outbound leg being answered.

Availability

Secured

Property Name

Description

DataType

Valid Values

Enabled

Enable the option.

Boolean

True

False

EmailAddress

Email address to deliver the missed call alert email.

String

Up to 10 email addresses separated by comma.

EmailSettings

Description

Overrides the default email settings for missed call alerts.

Availability

Secured

Property Name

Description

DataType

Valid Values

FromEmailAddress

String(320)

Single Email address

FromName

String(100)

ReplyToAddress

String(320)

Single Email address

Subject

Email subject text.

String(250)

Body

Email body text.

String(8000)

If the “ContentType = HTML” you need to HTML encode your Body text.

IncludeCallingNumber

Includes the caller’s CLI within the email body.

Boolean

True

False

If “ContentType = HTML” this is ignored.

IncludeCalledNumber

Includes the inbound service number within the email body.

Boolean

True

False

If “ContentType = HTML” this is ignored.

IncludeCallTime

Includes the call start time within the email body.

Boolean

True

False

If “ContentType = HTML” this is ignored.

ContentType

Specifies the Content Type the email is sent out as.

String

PlainText

HTML

** Please refer to section “3.20 – DTMF Controlling Party” for more information **

DTMFControllingParty

Description

Determines which party is in control of DTMF.

Availability

Secured

Property Name

Description

DataType

Valid Values

Enabled

Enable the option.

Boolean

True

False

Party

The party in control of DTMF

String

AParty

BParty

BPartyForceClearDTMF

Key(s) to Force Terminate B Party.

When setting this to KeyStar, mid-call conference functionality is disabled and cannot be invoked.

String

Key827

KeyStar

Key6

TimeZone

Description

Allows the Timezone Offset to be changed which is used to evaluate the current day, date and time related nodes.

Availability

Secured

Property Name

Description

DataType

Valid Values

Enabled

Enable the option.

Boolean

True

False

Offset

The TimeZone offset to use.

String

Default UTCMinus1200

UTCMinus1100

UTCMinus1000

UTCMinus0930

UTCMinus0900

UTCMinus0800

UTCMinus0700

UTCMinus0600

UTCMinus0500

UTCMinus0400

UTCMinus0330

UTCMinus0300

UTCMinus0200

UTCMinus0100

UTCPlus0000

UTCPlus0100

UTCPlus0200

UTCPlus0300

UTCPlus0330

UTCPlus0400

UTCPlus0430

UTCPlus0500

UTCPlus0530

UTCPlus0545

UTCPlus0600

UTCPlus0630

UTCPlus0700

UTCPlus0800

UTCPlus0830

UTCPlus0845

UTCPlus0900

UTCPlus0930

UTCPlus1000

UTCPlus1030

UTCPlus1100

UTCPlus1200

UTCPlus1245

UTCPlus1300

UTCPlus1400

ScheduledCallSettings

Description

These settings are used for scheduled calls – see section 24 for more information

Availability

Secured

Property Name

Description

DataType

Type

Valid Values

Enabled

Enable the option.

Boolean

Mandatory

True

False

BPartyNumberVariable

The name of the Custom Service Variable that will be populated with the Scheduled Call

B-Party Number

String

Mandatory

A Valid Customer Service Variable

APartyRingingAudio

The audio to be played to the A-Party during an outdial to another party

Audio

Non-Mandatory

Audio file reference.

Branches

Name

Description

Type

Permitted Nodes

Continue

Default branch

Mandatory

Audio

CLI Routing

Conference

Custom CDR

Date

Dates

Day

Delete Record

Deliver Call

Distribution

DTMF Capture

Dynamic Audio

IF

Insert Record

Fax

Menu

Month

Multi-Outdial

Outbound Call

Queue

Record

Select Record

Send Email

Send Post

Set Variable

Special Day

Time

Time of Day

Update Record

Voicemail

Voice Capture

Jump

ScheduledCallConnected

Taken when the A-Party for a scheduled call request has been answered

Not Mandatory

As Continue

Fax Not Allowed

Dynamic Properties

Dynamic properties are only required when the EnableSpeedDial mandatory property is enabled.

Name

Data Type

Description

SpeedDialDigits

Integer

Value between 1 and 999999

DestinationNumber

Integer

Valid destination telephone number

Description

String

Descriptive text.

Dynamic Branches

Dynamic branches do not exist for this node.

PreviousNode ReferenceNextPage 1

Last updated 2 months ago

Was this helpful?