Cisco Acano X-series 開発者ガイド

8.11.1 Retrieving participants

GET method performed on the “/participants” node.

Parameters

Type/Value

Description/Notes

filter

String

Supply filter=<string> in the URI to return just those active participants that
match the filter

offset
limit

Number
Number

An "offset" and "limit" can be supplied to retrieve elements other than the first
"page" in the notional list (see

tenantFilter

ID

Supply the tenantFilter to return only those participants belonging to that tenant

callBridgeFilter

ID

Supply the callBridgeFilter to return only those participants located on that
tenant

Response
elements

Type/Value

Description/Notes

Response is structured as a top-level <participants total=”N”> tag with potentially
multiple <participant> elements within it.

<participant> elements follow the general form on the left.

name

String

The human-readable display name associated with this participant

call

ID

The call that this participant is part of

tenant

ID

If present, the id of the tenant that this participant is associated with

callBridge

ID

If present, the remote, clustered, Call Bridge that this participant is connected to

8.11.2 Retrieving detailed information on an individual participant

GET method performed on a “/participants/<participant ID>” node

If the participant ID supplied is valid, a “200 OK” response is received, with XML content of the
form:

Response
elements

Type/Value

Description/Notes

name

String

The human-readable display name associated with this participant

call

ID

The call that this participant is part of

tenant

ID

If present, the id of the tenant that this participant is associated with

callbridge

ID

If present, the remote, clustered, Call Bridge that this participant is connected to

uri

String

The URI associated with this participant