đź“–
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. Introduction

Platform Features

Feature

Description

Max Call Length

Restrict the maximum length of a call to an inbound number.

Missed Call Alerts

Send email to up to 10 Email Addresses.

Custom Email Settings can be set for a service. (Subject, Body, From etc.)

Speed Dial

Used with Mid-Call Divert (See 3.3 Mid-Call Divert section).

Speed dial digits can be between 1 and 999999.

Call Whisper

Whisper Accept – B-Party can press 1 to accept or 2 to reject if enabled.

See section 3.4 for more information.

Outbound Call

Allow A-Party to key in a destination to be connected to.

Optional PIN Protection.

Control of permitted destinations. (Landline, Mobile, International etc.)

Calls can be recorded (see Record Call feature).

Default audio announcements can be replaced with custom audio (see Custom Audio feature).

Record Call

Ability to mute/unmute the recording during the call.

Ability to set the percentage of calls to be recorded.

Start/Stop the recording of a call via the telephone key pad.

Audio files can be delivered by Email (up to 10 email addresses), FTP/SFTP or Both and can also be retrieved using the API method.

Audio file format can be delivered as MP3, WMA or WAV.

Custom Email Settings can be set for each record call function. (Subject, Body, From etc.)

Call Recording Mode allows individual parties to be recorded separately.

Time Based Routing

Ability to route a call based individually or a combination of Time of Day, Date, Date Range, Day of Week, Month, Month Range and Special Days (Bank holidays, Christmas day etc).

Fax

Received faxes can be delivered via email (up to 10 email addresses).

Received faxes can be collected via an API method.

Custom Email Settings can be set for each Fax node. (Subject, Body, From etc.)

Fax file format can be delivered as TIFF or PDF.

Conference

Create a conference service without the need for rooms and pins.

A conference host can optionally be configured with PIN protection.

Configurable maximum number of callers.

Ability to create custom rooms requiring RoomID only, Pin only or RoomID and Pin entry modes.

Up to 8 digits for RoomID’s and PIN’s

Custom rooms can be set to dynamic so they do not need to be predefined.

Configurable music on hold (Classical, Easy Listening, Light Rock, Eighties, Pop).

Conference call can be recorded. (see 3.8 Call Recording section)

The default conference audio announcements can be replaced with custom audio (see Custom Audio feature).

Record name feature can be enabled.

Host can request a roll call.

Passive Conference can be enabled so only the Host can be heard.

See section 3.5 for more information

Custom Audio

Audio files can be uploaded to the platform into a “pool” which can then be referenced within nodes that allow the assignment of custom audio.

Supported audio formats are MP3, WMA and WAV.

Voicemail

The default Voicemail greeting can be replaced with custom audio (see Custom Audio feature).

The voicemail message file format can be MP3, WMA or WAV.

Configurable maximum duration of a captured voicemail message.

Voicemail messages can be delivered via email (up to 10 email addresses) or collected via an IVR retrieval telephone service (See section 3.10 for more information) or both.

Additional call flow can be added after the voicemail message has been captured.

Custom Email Settings can be set for each voicemail node. (Subject, Body, From etc.)

Deliver Call

Connect the inbound call to a destination number.

Custom audio can be used as ring tone (see Custom Audio feature).

Connected call can be recorded (see 3.8 Call Recording section).

Override CLI

The caller’s presentation CLI can be replaced with the inbound service number.

Restrict CLI

The caller’s presentation CLI can be hidden (number withheld).

Mid-Call Divert

Allows the B-Party to invoke an outdial to a 3rd party destination number.

Permitted destination type (mobile, landline etc.) can be restricted.

See section 3.3 for more information

Menu

Ability to create single key multilevel interactive voice response menu systems.

Script Logging can be enabled to capture key presses by the caller

Multi-Outdial

Outdial to up to 7 destination numbers to connect to the first destination that answers.

Connected call can be recorded (see 3.8 Call Recording section).

Queue

Provides functionality for network based call queuing.

Connected calls can be recorded (see 3.8 Call Recording section).

Connected calls can be delivered to destinations based on a distribution configuration (Round Robin, Random, Bounce, Percentage and First Last Exit).

Call Distribution Evaluation can be “Call” or “Service” based.

Queue dropout can be enabled (press # or 1 to exit the queue).

Standard queue settings can be configured (Max Calls, Max Queue Size, Queue Timeout, RNR Time Out).

Configurable music on hold (Classical, Easy Listening, Light Rock, Eighties, Pop).

Custom audio announcements can be assigned (see Custom Audio feature).

Custom Service Variables

Custom Service Variables can be declared and used within the Service XML. These can then be used to assign values to any node property value or branch NodeID.

Custom Service Variables can be manipulated by the DTMF Capture, Send Post and Set Variable nodes.

The value of a Custom Service Variable can be evaluated using the IF node to change the call flow.

CLI Routing

Route a call based on a callers CLI or DTMF input.

Between 1 and 15 DTMF digits can be input.

The default audio used to collect DTMF can be assigned custom audio (see Custom Audio).

Configurable match type (Most Matching digits or Exact).

Send Email

Ability to send email messages within the call flow. (up to 10 email addresses)

Custom email settings can be set for each Send Email node. (Subject, Body, From etc.)

Send Post

Ability to send HTTP post’s within the call flow. The query string can be constructed using Literal Values, Service Variables and Custom Service Variables.

Assign data returned in the response from a send post action to Custom Service Variables.

Allows an audio file to be played whilst the Send Post request is being processed

Allows authentication credentials to be sent to the server

Distribution

Call flow can be controlled based on a distribution configuration (Round Robin, Random, Bounce and Percentage).

Distribution Evaluation can be “Call” or “Service” based.

DTMF Capture

Assign DTMF entered by the A-Party to Custom Service Variables.

Voicemail Retrieval Telephone Service

Ability to collect and manage voicemail messages via an IVR telephone service, API or white label portal.

Multiple Service Assignment

Multiple services can be assigned to inbound service numbers which can be instantly switched via an IVR telephone service or the API.

Inbound Service Number Groups

Inbound service numbers can be grouped to allow services to be activated en mass via an IVR telephone service (see section 3.11 for more information), API or white label portal.

Post Call

Allows activity to continue on the call after either the A-Party (calling) or B-Party (receiving) has ended the call e.g. perform a feedback survey.

Also allows limited nodes to be used when both parties have cleared.

Transmit DTMF

Allows a configurable DTMF sequence up to 20 digits to be transmitted to the B-party when an answer signal has been received whilst the A-party hears simulated ringing.

Mid Call Breakout

Allows either the A or B-party to break out whilst Mid Call to navigate through the Mid Call sequence of nodes. Keying sequence 23 will put the B-party into the Mid Call Breakout, or keying sequence 24 will put the A-party into the Mid Call Breakout. They will be reconnected when the Mid Call sequence of nodes finishes.

Parties On Hold

Allows both parties to be put on hold listening to the configured On Hold audio when the DTMF controlling party keys sequence 29 and then reconnected when the DTMF controlling party presses the # key.

Tiff to Fax

Allows a .tiff image file to be sent to a fax machine

Voice Capture

Allows a caller to be asked multiple questions and for the answers to be captured and recorded into a single audio file.

A minimum of 1 and a maximum of 20 questions.

Audio files can be delivered by Email (up to 10 email addresses), FTP/SFTP or Both and can also be retrieved using the API method.

Audio file format can be delivered as MP3, WMA or WAV.

FTP/SFTP

The FTP protocol can be configured in the white labelled web portal. This can be set as standard FTP or SFTP

Platform Logging

New in version 1.45 – Audit logs generated by the platform can be downloaded using the methods in section 20

Service Templates

New in version 1.48 – Added new Service Management Methods to support storage and retrieval of Service XML Templates.

Data Tables

New in version 1.50 - The Data Tables feature provides your inbound telephony services with access to document-oriented database tables. See section 23 Data Tables for further information.

There are 4 nodes available for accessing Data Table documents from within your service plans – Select Document, Delete Document, Update Document and Insert Document. See sections 7.32, 7.33, 7.34 and 7.35.

Detailed audit logs are generated when Data Tables are accessed or modified. See section 22 Platform Logging for further information.

Dynamic Audio

New in version 1.52 – The Dynamic Audio node allows a textual value to be played back to a caller as spoken words. Date, Time and Currencies can be played back as English words and numerical values as conversational words and more.

Scheduled Call

New in version 1.53 – The Scheduled Call feature allows customers with API access to initiate outbound calls from the Advanced Services Platform, where the Initial Target Destination (“First Party”) receiving the call might be a customer that requested a call-back for example. Scheduled Call requests can be submitted for immediate processing or can be scheduled for a future date.

See sections 3.29 and 24 for more information.

Service Version History

New in version 1.54 – We have added a new feature which allows you to access up to the previous 19 versions of a service, you can then choose to promote one of those versions or see a full list of all the changes between that version and the previous version.

See sections 9.22 and 9.23 for more information.

Service Assignment History Log

New in version 1.54 – We have added a new feature which allows you to access the assignment history for a service. This will track when a service has been assigned/unassigned/activated/deactivated against one or more service numbers.

See sections 9.24 and 9.25 for more information.

Number Audit Log

New in version 1.54 – We have added a new feature which allows you access the number audit log. This will track when either a PIN, description or status of a number (Active/Parked/Suspended) has been changed. It will also track anytime the number is moved between accounts on the platform.

See section 9.26 for more information.

Phone Book

New in version 1.58.4 – New phone book feature allows a list of phone book entries to be created against an account. The phone book entries can then be used in place of a destination number on the Deliver Call, Multi-Outdial and Queue nodes.

PreviousAccount SetupNextMid Call Divert/Mid Call Conference

Last updated 1 year ago

Was this helpful?