Codian MCU 4200 Series Manuale Utente Scaricare il pdf (Pagina 6)

Codian MCU 4200 Series Remote Management API

2 Messages

Authentication

All messages must contain a user name and password as follows:

Parameter Type Comments

authenticationUser string Name of a user with sufficient privilege for the operation being

performed. The name is case sensitive.

authenticationPassword string The corresponding user’s password.

Participant identification parameters

The following parameters appear in the majority of messages, and are used to identify a specific

participant on which operations are to be performed.

Parameter Type Description

participantName string This is an “internal” name, and hence not necessarily related to any

name configured on an endpoint itself. Within the scope of a

particular conference or auto attendant, the combination of

“participantType”, “participantProtocol” and “participantName” is

always unique.

participantProtocol string

participantType string

Used in conjunction with “participantName” to uniquely identify a

participant within a connection. Typically these should be treated as

opaque values, but the current possibilities are:

for “participantProtocol”:

h323 – the H.323 protocol

vnc – a VNC connection (e.g. remote desktop)

for “participantType”:

ad_hoc – this participant called into the MCU

by_address – fully-specified participant

by_name – MCU-configured endpoint

API-created participants (i.e. those originated by

“conference.participant.add”) will be of type “by_address”.

conferenceName string Unique conference name – the conference name space is shared

between API-generated conferences and all other ad hoc and

scheduled MCU conferences.

autoAttendantUniqueId string If the participant in question is connected to an auto attendant rather

than a conference, this field contains a unique identifier for that auto

attendant.

When modifying or querying parameters for a specific endpoint, “participantName”, “participantProtocol”

and “participantType” parameters are supplied, along with either a “conferenceName” or an

“autoAttendantUniqueId”. However, as the API can only create H.323 participants of type “by_address”,

if the protocol and type fields are absent then they are assumed to be “h323” and “by_address”.

2.1 conference.create

1 2 3 4 5 6 7 8 9 10 11 ... 32 33

Nessun commento

Codian MCU 4200 Series Manuale Utente Pagina 6