ADSI_CPEID

Use the ADSI_CPEID state table to download an ADSI script to an ADSI telephone when an application calls the telephone while it is on-hook. This state table uses the customer premises equipment (CPE) identifier (CPE-id) of the telephone.

To allow on-hook operation, you must configure your telephone switch so that the MakeCall state table action returns without the handset being lifted.

The host application must call the ADSI telephone before calling this state table. When invoked, the ADSI_CPEID state table sends the telephone's identifier to the ADSI telephone, then downloads the specified FDM file.

ASCII syntax

InvokeStateTable ("DIRECT", ADSI_CPEID, mode, file, NameOfService, FDN,
SecurityCode, VersionNumber, parms, Interrupt, CPEID);

Entry point

mode

Specify one of:

main_mode

This entry point calls the ADSI_FDM_I state table to download the main function and the overlays from the ADSI script file.

skey_mode

This entry point calls the ADSI_FDM_I state table to download only the softkey definitions from the ADSI script file.

voice_mode

This entry point calls the ADSI_FDM_I state table to download the whole of the ADSI script file in voice mode.

In voice mode, each data transmission is preceded by a CAS tone/DTMF sequence.

Description

file

The name of the FDM script file to be downloaded.

You must include the file-name extension (.fdm).

The name is appended to the directory name $CUR_DIR/adsi/.

NameOfService

The name of the service that is to appear in the Service (FDM) page of the ADSI telephone.

The name can be a maximum of 18 bytes long.

FDN

The feature download number.

This is the number of the position on the telephone's (FDN) page to which the feature should be downloaded.

This parameter is four bytes long. You can specify decimal values in the range 0 through 6, depending on the type of ADSI telephone being used.

SecurityCode

The security code.

This parameter is four bytes long.

If you try to download a feature to a specific feature download number, and the security codes for that service do not match the one you are downloading, you will not be authorized to download the feature.

For more information on feature downloads, see Bellcore specification SR-INS-002461 .

VersionNumber

The version number of the feature you are downloading.

This parameter is one byte long.

parms

A string containing parameters to be passed to the ADSI function.

If you want to pass multiple parameters, you must concatenate them into one string, and separate each parameter using a 001 (X'01') delimiter. You could use the ADSI_Parameters state table to do this (see ADSI_Parameters).

If no parameters are to be passed to the ADSI function, set the parms parameter to a null string.

interrupt

Set this parameter to allow use of the telephone in an emergency while data is being downloaded.

Specify one of the following values:

0

Transmission of data for an on-hook download is not interrupted when the telephone user presses a DTMF key or lifts the handset. This is the default.

1

Transmission of data is interrupted when the user presses a DTMF key or lifts the handset.

CPEID

The CPE identifier of the ADSI telephone.

This should have been retrieved previously using the query_for_cpe_id SDC function (see query_for_cpe_id).

Results

The InvokeStateTable action terminates with a result that indicates whether or not the operation was successful. If it was not successful, the result shows the reason for the failure:

0

Success

3

FDM definition file not found

4

Error communicating with the ADSI device (no CAS tone acknowledgment)

5

Error communicating with the ADSI device (after 5 retries)

6

Line problem

7

Caller hung up

8

FDM download denied

9

ADSI application error

Related state tables

• ADSI_FDM and ADSI_FDM_I