Maintenance Notice - PDF Generation
Dynamic PDF generation for web-based content is temporarily unavailable. This maintenance affects dynamic PDF files that are generated from either the HTML-based page or manual that you are viewing. Links that normally allow this functionality have been hidden, and will reappear as soon as the feature is restored.


Note: Access to static files, including PDF files that are not dynamically generated from our web-based content, is unaffected.

Jump to: navigation, search

Request-access

Overview

This service provides a service with access information that has been allocated for it and can then be used to contact the contact center. This service will do the following for any service:

  • It will validate that the requesting service is active and running.
  • It will acquire the appropriate access information based on the basic allocation algorithm.
    • It can reserve the access information for a configurable period of time
    • Simple random or round robin allocation
  • It support the following types of access information:
    • Access Number (DNIS) which is to be called by the application
    • Access code which is to be supplied by the customer/application when the contact is being established. This provides an extra level of authentication.

Create Request Data

These are the service specific parameters that will be supplied on the Create service API.

Parameters
Mandatory
Description
_id
Yes
This is the identifier of the service which the allocated access information should be associated with.
_provide_code No This indicates if the service should return an access code which will add more security and reliability when trying to correlate the incoming call with the service. The value is a boolean. The default is false.
_phone_number
No
This is the phone number that is to be associated with the reserved access information.
_resource_group
Yes
This is the resource group from which an available access number will be taken.
_booking_expiration_timeout No This is the resource _booking_expiration_timeout used to book the resource. This parameter will override the value in Resource options and in CME options.

Create Response Data

Parameters
Mandatory
Description
_access_number
Yes
This is the access number which was allocated for this application. The application should use this number to contact the contact center.
_access_code
No
This is the access code that should be supplied by the application or end user when the call is established to further authentication the application/user. This will be present when the Create API specifies that it needs a access code (_provide_code = true).
_expiration_time
Yes
This is the amount time that this access information will be locked/reserved for the service.

Specific Requests

There are no specific requests for this service.

Events

There are no events associated with this service.

Configuration

The following are the configuration options that are defined for this service:

Option
Type
Mandatory
Default
Description
_access_code_length
int
false
6
This is the length of the access code which can be allocated.
This page was last edited on December 11, 2015, at 14:28.

Feedback

Comment on this article:

blog comments powered by Disqus