Manage Conferences Sample¶
A command line console application that provides access to the conference management facilities of the Aculab Cloud Web Services API.
Usage¶
python manage_conferences.py [--wsserver <cloudWebServerAddress>] <cloudId> <username> <apiAccessKey> <command>
Arguments¶
cloudWebServerAddress
The address of the cloud web server. By default the wrappers call web services on
https://ws-<cloudId>.aculabcloud.net. In certain circumstances you may need to use a different address which you can set here.
cloudId
Cloud region id (e.g. 1-2-0)
username
Cloud account username
apiAccessKey
Cloud API Access key
command
One of the following...
listConferences
listParticipants <conferenceName>
setParticipantOptions <conferenceName> <participantId> <mute> <enableDtmf>
ejectParticipant <conferenceName> <participantId>
reserve <conferenceName> <maxParticipants> [<divertToService> [<startTime> [<minutesDuration>]]]
unreserve <reservationToken>
extend <reservationToken> <additionalMinutes>
Where...
reservationToken
The reservation token as returned by the reserve command.
conferenceName
A conference name consisting of alphanumeric characters only and must be unique on the chosen cloud.
participantId
The id of a conference participant as returned by the listParticipants command.
mute
'true' or 't' to mute the participant. Any other value to unmute.
enableDtmf
'true' or 't' to enable DTMF key actions for the participant. Any other value to disable DTMF actions.
maxParticipants
The maximum number of parties to reserve for a conference.
divertToService
The name of an inbound service on the cloud to which participants will be diverted when they call a conference before it has started. "" just busies the call (defaults to "").
startTime
The earliest start time of the conference (UTC) in the ISO 8601 format yyyy-mm-ddThh:mm:ss (e.g. 2019-02-13T11:22:02). The time is rounded down to the nearest minute. This must be at least 5 minutes and at most 24 hours away. The conference can only be started after this time. Default is 20 minutes from now.
minutesDuration
The maximum duration of the conference in minutes (Default is 20 minutes, allowable range 15-480).
additionalMinutes
The number of minutes by which to extend the conference (Allowable range is 15-60 minutes)
Note
For users running Python 2 under Windows, this tool does not support command line arguments containing non-ASCII characters. If you wish to specify command line arguments containing non-ASCII characters, please use Python 3.
Examples¶
List conferences
python manage_conferences.py 0-2-0 bob@acompany.com bobspswd listConferences
List participants
python manage_conferences.py 0-2-0 bob@acompany.com bobspswd listParticipants MyConf1
set participant options
python manage_conferences.py 0-2-0 bob@acompany.com bobspswd setParticipantOptions MyConf1 01234567a1b1c1c1.12345x0 true true
Eject participant
python manage_conferences.py 0-2-0 bob@acompany.com bobspswd ejectParticipant MyConf1 01234567a1b1c1c1.12345x0
Reserve a conference
python manage_conferences.py 0-2-0 bob@acompany.com bobspswd reserve MyConf1 60
Reserve a conference specifying start time and duration
python manage_conferences.py 0-2-0 bob@acompany.com bobspswd reserve MyConf2 60 null 2019-02-13T11:22:02 60
Reserve a conference specifying a divertToService
python manage_conferences.py 0-2-0 bob@acompany.com bobspswd reserve MyConf3 60 PlayHoldingMusic 2019-02-13T11:22:02
Unreserve a conference
python manage_conferences.py 0-2-0 bob@acompany.com bobspswd unreserve GIYDCMZNGA2C2MRVFUYTKLJRGVPXE33CONZG633NL5ZG6YTFOJ2C443UMFYGK4TUIBQWG5LMMFRC4Y3PNU888888
Extend a conference
python manage_conferences.py 0-2-0 bob@acompany.com bobspswd extend GIYDCMZNGA2C2MRVFUYTKLJRGVPXE33CONZG633NL5ZG6YTFOJ2C443UMFYGK4TUIBQWG5LMMFRC4Y3PNU888888 20