📖
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?

Web Service Authentication

The XML web service uses the Simple Object Access Protocol (SOAP)

Communication is over an encrypted https connection.

All web service methods with the exception of the Security methods require the following soap header:-

<soap:Header>
  <AuthenticationSoapHeader xmlns="https://www.advancedservicesplatform.com/ASPAPI/">
    <Token>string</Token>
  </AuthenticationSoapHeader>
</soap:Header>

The Token within the header is allocated to your account by your service provider when your portal account is set up. The Token can be supplied by your service provider or can be retrieved using the GetToken method using your portal Username and Password.

You should use this Token as a constant within your application code to make calls to web methods that require the soap header.

You should only use the GetToken method once to initially retrieve the Token.

DO NOT build the GetToken method into your application to retrieve your Token each time you make calls to other methods.

The GetToken method requires your portal username and password which expires every 28 days so unless you change your application to use your new usename and password the GetToken method will fail to return your Token.

PreviousSub Plan Example XMLNextService Audio

Last updated 2 months ago

Was this helpful?