6 isdn gateway methods, 1 common structures, Participant records – TANDBERG 3.0 User Manual

Page 42: Isdn gateway methods, 1 common, Structures

Advertising
background image

Copyright © TANDBERG 2008

Reference Guide Version 3.0 rev 3.0

38

6 ISDN Gateway methods

The following methods are present on ISDN gateway products, such as the ISDN GW 3220.

6.1 Common structures

Participant records
Several functions return participant records, which have the following fields:

Field

Type

Comments

uniqueId

Integer

A unique index for this participant.

protocol String

Either

h323

(for IP) or

h320

(for ISDN).

number

String

the E164 number, IP address or DNS name of the
participant.

Name

String

The name of this participant (e.g. the h323
name).

autoAttendant

boolean

True if this participant is an auto attendant
running on the gateway, false otherwise.

incoming

boolean

True if the call is incoming to the gateway, false if
the call is outgoing.

videoCodec

String

The video codec used for this participant.

audioCodec

String

The audio codec used for this participant.

progress

String

The state of the connection to this participant.
One of:

none

,

initial

,

proceeding

,

alerting

,

connected

or

finished.

Only present for

active participants.

Fecc

boolean

True if far end camera control is established, false
otherwise. Only present for active participants.

ipAddress

String

The IP address if the participant. Only present for
IP participants.

callIdentifier

base64

The h323 Call Identifier for this participant. Only
present for h323 participants.

channelCount Integer

The

number

of ISDN channels in use. Only

present for ISDN participants.

channels

array of integers

The channels in use by this call. Only present for
ISDN participants.


It is worth pointing out that, while in the functions below, these structures are called participantOne and
participantTwo, if the call was not initiated by the web interface or API (which is not currently possible), then
participantOne will be the calling party, and participantTwo the called party.

Advertising