📖
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
  • Service Number Rules
  • Presentation Number Rules
  • First Party Ring Duration
  • B Party Number

Was this helpful?

  1. Introduction
  2. Scheduled Call Feature

How to create a Scheduled Call request

In order to invoke a Scheduled Call, you must have the permission on your account and then you would need to call the CreateScheduledCallRequest (section 24.1) web API method. The settings and rules are explained below:

Service Number Rules

This will be used as the network CLI for the calls which are originated for this request. The number must reside on your account or one of your sub accounts. The number must be configured and have a valid active call plan assigned with the ‘Scheduled Call’ branch on the ‘Start’ node connected. The call plan will be used when the first party connects.

The Service Number can be one of the following number types:

· UK 01xx numbers

· UK 02xx numbers

· UK 03xx numbers

· UK 080x freephone numbers

Presentation Number Rules

This will be used as the presentation CLI for the calls which are originated for this request. If your account has custom CLI permission, you can specify a number which doesn’t reside on this platform and must be one of the following:

· UK 01xx numbers

· UK 02xx numbers

· UK 03xx numbers

· UK 080x freephone numbers

· UK Mobile numbers (doesn’t include UK 070 – Personal Numbers)

To request the custom CLI permission you need to speak to your account manager, a contractual agreement would need to be signed and you would need to conform to the OFCOM guidelines. The permission maybe revoked if you or your customers don’t conform to the OFCOM guidelines.

If you don’t have permission the number must reside on the platform as a Service Number and meet the rules as per the Service Number listed above. It does not need to be the same Service Number.

First Party Ring Duration

The maximum ring duration you can set for the first party is 60 seconds. Once that call has been connected the normal ring durations apply which you can set elsewhere within the call flow. Please note this is only the maximum, a carrier may choose to end the call attempt earlier such as a mobile carrier not wanting to waste their finite network resources in cell sites.

B Party Number

This is optional if you choose to pass a secondary number to call into your call flow. It can allow you to connect the First Party to the Second Party. This must be a valid Custom Service Variable within your call flow, and you would need to build the call flow to call the second party such as hanging a ‘Deliver Call’ node off the ‘Scheduled Call Connected’ branch on the ‘Start’ node.

PreviousScheduled Call FeatureNextWhat CLI be presented to the called parties

Last updated 2 months ago

Was this helpful?