Methods

Objects

conference/10

Conference (version 10) management service

Method Description
conference/10.add_room_access Create an room access and assign it to a room. Use Room Access to defi...
conference/10.assign_did Assign a DID to a conference room.
conference/10.call_number Outbound conferencing! Call a phone number, and add it to the conferen...
conference/10.call_room_access Outbound conferencing! Call a pre-configured room access, and add it t...
conference/10.create_room Create a new conference room.
conference/10.delete_room Delete a conference room.
conference/10.edit_room Edit conference room parameters
conference/10.hangup Hangup a list of connected
conference/10.list_connections_history List connections history. Currently connected participants are not ret...
conference/10.list_events List room events (filtered)
conference/10.list_live_rooms List conference rooms with at least one connected.
conference/10.list_rooms List conference rooms.
conference/10.mute Mute a list of connected
conference/10.pause Pause (put out of the conference room) a list of connected
conference/10.remove_room_access Delete a room access.
conference/10.start_recording Start recording on the room
conference/10.stop_recording Stop the recording
conference/10.unassign_did Unassign a DID from a conference room.
conference/10.unmute Unmute a list of connected
conference/10.unpause Unpause a list of connected
conference/10.update_room_access Update a room access.
conference/10.view_live_room View a live room
conference/10.view_room View conference room.

Methods

conference/10.add_room_access

Description

Create an room access and assign it to a room. Use Room Access to define entry points in the room. A Room Access defines a "pin" needed to enter the room. Multiples Room Access may be added to a Room. Each Room Access has a label. This is useful to determine who has entered the room, given that you gave each of your participant a different PIN (each participant has his specific Room Access). You can also define specific pin codes (even empty ones) on a specific CLI (calling number), and/or on specific DIDs. Thus, some of your participant may need to enter a PIN when calling the 'generic' DID, but some callers may be whitelisted.

This method is DEPRECATED and may be removed in the future.
Relying on this method is highly discouraged.

Signature

method: conference/10.add_room_access

params: [string room_hash, object room_access_parameters]

Parameters

Parameter Type Description NULL
room_hash string Room ID
Format: hash (Unique object identifier)
NO
room_access_parameters object Room access
Object: CONFERENCE10.Room.Access
NO

Result

Type Description Format/Object
object Conference room access Object: CONFERENCE10.Room.Access

conference/10.assign_did

Description

Assign a DID to a conference room.

This method is DEPRECATED and may be removed in the future.
Relying on this method is highly discouraged.

Signature

method: conference/10.assign_did

params: [string room_hash, string did_hash]

Parameters

Parameter Type Description NULL
room_hash string Room ID
Format: hash (Unique object identifier)
NO
did_hash string DID ID
Format: hash (Unique object identifier)
NO

Result

Type Description Format/Object
bool Always TRUE. Thows an exception otherwise.

conference/10.call_number

Description

Outbound conferencing! Call a phone number, and add it to the conference room. It's magic. An access room will be dynamically created.

This method is DEPRECATED and may be removed in the future.
Relying on this method is highly discouraged.

Signature

method: conference/10.call_number

params: [string room_hash, string number, string cli, bool confirm, object options]

Parameters

Parameter Type Description NULL
room_hash string Room ID
Format: hash (Unique object identifier)
NO
number string Phone number to call
Format: phone_number (International E.164 format "+CCNSN". Example: "+16467890800", "+447890123456", or "+33678912345")
NO
cli string CLI (phone number presented to the callee).
Format: cli_phone_number (International E.164 format "+CCNSN". Example: "+16467890800", "+447890123456", "+33678912345" or "BLOCKED")
NO
confirm bool Set to TRUE to ask for a confirmation before putting the callee in the conference. Useful to detect voicemail. NO
options object A few facultative options.
Object: CONFERENCE10.CallNumber.Options
YES

Result

Type Description Format/Object
object Created Room Access . Throws an exception if an error occurs. Object: CONFERENCE10.Room.Access

conference/10.call_room_access

Description

Outbound conferencing! Call a pre-configured room access, and add it to the conference room. It's magic.

This method is DEPRECATED and may be removed in the future.
Relying on this method is highly discouraged.

Signature

method: conference/10.call_room_access

params: [string room_access_hash, string cli, bool confirm]

Parameters

Parameter Type Description NULL
room_access_hash string Room Access ID
Format: hash (Unique object identifier)
NO
cli string CLI (phone number presented to the callee).
Format: cli_phone_number (International E.164 format "+CCNSN". Example: "+16467890800", "+447890123456", "+33678912345" or "BLOCKED")
NO
confirm bool Set to TRUE to ask for a confirmation before putting the callee in the conference. Useful to detect voicemail. NO

Result

Type Description Format/Object
bool Did it work?

conference/10.create_room

Description

Create a new conference room.

This method is DEPRECATED and may be removed in the future.
Relying on this method is highly discouraged.

Signature

method: conference/10.create_room

params: [string room_name, object room_parameters, array room_access]

Parameters

Parameter Type Description NULL
room_name string Room name. NO
room_parameters object Room parameters.
Object: CONFERENCE10
NO
room_access array Optional array of room access to add to the room.
Array of objects: CONFERENCE10.Room.Access
NO

Result

Type Description Format/Object
object Conference room Object: CONFERENCE10.Room

conference/10.delete_room

Description

Delete a conference room.

This method is DEPRECATED and may be removed in the future.
Relying on this method is highly discouraged.

Signature

method: conference/10.delete_room

params: [string room_hash]

Parameters

Parameter Type Description NULL
room_hash string Room ID
Format: hash (Unique object identifier)
NO

Result

Type Description Format/Object
bool Did it work?

conference/10.edit_room

Description

Edit conference room parameters

This method is DEPRECATED and may be removed in the future.
Relying on this method is highly discouraged.

Signature

method: conference/10.edit_room

params: [string room_hash, string room_name, object room_parameters]

Parameters

Parameter Type Description NULL
room_hash string Room ID
Format: hash (Unique object identifier)
NO
room_name string Room name. Send NULL to ignore. YES
room_parameters object Room parameters. Send NULL to ignore.
Object: CONFERENCE10
YES

Result

Type Description Format/Object
object Conference room Object: CONFERENCE10.Room

conference/10.hangup

Description

Hangup a list of connected

This method is DEPRECATED and may be removed in the future.
Relying on this method is highly discouraged.

Signature

method: conference/10.hangup

params: [array connected_hash_list]

Parameters

Parameter Type Description NULL
connected_hash_list array Array of connected IDs
Format: hash (Unique object identifier)
NO

Result

Type Description Format/Object
array Array of successfully hungup connected. Array of CONFERENCE10.Connected objects.

conference/10.list_connections_history

Description

List connections history. Currently connected participants are not returned.

This method is DEPRECATED and may be removed in the future.
Relying on this method is highly discouraged.

Signature

method: conference/10.list_connections_history

params: [object filters, int offset, int quantity]

Parameters

Parameter Type Description NULL
filters object List filters
Object: CONFERENCE10.ConnectionsHistory.Filters
NO
offset int List index (zero-based) NO
quantity int Quantity NO

Result

Type Description Format/Object
object Listing results. Object: CONFERENCE10.ConnectionsHistory.Results

conference/10.list_events

Description

List room events (filtered)

This method is DEPRECATED and may be removed in the future.
Relying on this method is highly discouraged.

Signature

method: conference/10.list_events

params: [object filters, int offset, int quantity]

Parameters

Parameter Type Description NULL
filters object List filters
Object: CONFERENCE10.Events.Filters
NO
offset int List index (zero-based) NO
quantity int Quantity NO

Result

Type Description Format/Object
object Listing results. Object: CONFERENCE10.Events.Results

conference/10.list_live_rooms

Description

List conference rooms with at least one connected.

This method is DEPRECATED and may be removed in the future.
Relying on this method is highly discouraged.

Signature

method: conference/10.list_live_rooms

params: []

Parameters

No parameters.

Result

Type Description Format/Object
array Array of live rooms. Array of CONFERENCE10.Room.Live objects.

conference/10.list_rooms

Description

List conference rooms.

This method is DEPRECATED and may be removed in the future.
Relying on this method is highly discouraged.

Signature

method: conference/10.list_rooms

params: [int offset, int quantity]

Parameters

Parameter Type Description NULL
offset int List index (zero-based). NO
quantity int Quantity returned. NO

Result

Type Description Format/Object
array Conference rooms. Array of CONFERENCE10.Room objects.

conference/10.mute

Description

Mute a list of connected

This method is DEPRECATED and may be removed in the future.
Relying on this method is highly discouraged.

Signature

method: conference/10.mute

params: [array connected_hash_list]

Parameters

Parameter Type Description NULL
connected_hash_list array Array of connected IDs
Format: hash (Unique object identifier)
NO

Result

Type Description Format/Object
array Array of successfully muted connected. Array of CONFERENCE10.Connected objects.

conference/10.pause

Description

Pause (put out of the conference room) a list of connected

This method is DEPRECATED and may be removed in the future.
Relying on this method is highly discouraged.

Signature

method: conference/10.pause

params: [array connected_hash_list]

Parameters

Parameter Type Description NULL
connected_hash_list array Array of connected IDs
Format: hash (Unique object identifier)
NO

Result

Type Description Format/Object
array Array of successfully paused connected. Array of CONFERENCE10.Connected objects.

conference/10.remove_room_access

Description

Delete a room access.

This method is DEPRECATED and may be removed in the future.
Relying on this method is highly discouraged.

Signature

method: conference/10.remove_room_access

params: [string room_access_hash]

Parameters

Parameter Type Description NULL
room_access_hash string Room access ID
Format: hash (Unique object identifier)
NO

Result

Type Description Format/Object
object Conference room Object: CONFERENCE10.Room

conference/10.start_recording

Description

Start recording on the room

This method is DEPRECATED and may be removed in the future.
Relying on this method is highly discouraged.

Signature

method: conference/10.start_recording

params: [string room_hash]

Parameters

Parameter Type Description NULL
room_hash string Room ID
Format: hash (Unique object identifier)
NO

Result

Type Description Format/Object
bool Did it work?

conference/10.stop_recording

Description

Stop the recording

This method is DEPRECATED and may be removed in the future.
Relying on this method is highly discouraged.

Signature

method: conference/10.stop_recording

params: [string room_hash]

Parameters

Parameter Type Description NULL
room_hash string Room ID
Format: hash (Unique object identifier)
NO

Result

Type Description Format/Object
bool Did it work?

conference/10.unassign_did

Description

Unassign a DID from a conference room.

This method is DEPRECATED and may be removed in the future.
Relying on this method is highly discouraged.

Signature

method: conference/10.unassign_did

params: [string did_hash]

Parameters

Parameter Type Description NULL
did_hash string DID ID
Format: hash (Unique object identifier)
NO

Result

Type Description Format/Object
bool Always TRUE. Thows an exception otherwise.

conference/10.unmute

Description

Unmute a list of connected

This method is DEPRECATED and may be removed in the future.
Relying on this method is highly discouraged.

Signature

method: conference/10.unmute

params: [array connected_hash_list]

Parameters

Parameter Type Description NULL
connected_hash_list array Array of connected IDs
Format: hash (Unique object identifier)
NO

Result

Type Description Format/Object
array Array of successfully unmuted connected. Array of CONFERENCE10.Connected objects.

conference/10.unpause

Description

Unpause a list of connected

This method is DEPRECATED and may be removed in the future.
Relying on this method is highly discouraged.

Signature

method: conference/10.unpause

params: [array connected_hash_list]

Parameters

Parameter Type Description NULL
connected_hash_list array Array of connected IDs
Format: hash (Unique object identifier)
NO

Result

Type Description Format/Object
array Array of successfully unpaused connected. Array of CONFERENCE10.Connected objects.

conference/10.update_room_access

Description

Update a room access.

This method is DEPRECATED and may be removed in the future.
Relying on this method is highly discouraged.

Signature

method: conference/10.update_room_access

params: [string room_access_hash, object room_access_parameters]

Parameters

Parameter Type Description NULL
room_access_hash string Room access ID
Format: hash (Unique object identifier)
NO
room_access_parameters object Room access parameters
Object: CONFERENCE10.Room.Access
NO

Result

Type Description Format/Object
object Conference room access Object: CONFERENCE10.Room.Access

conference/10.view_live_room

Description

View a live room

This method is DEPRECATED and may be removed in the future.
Relying on this method is highly discouraged.

Signature

method: conference/10.view_live_room

params: [string room_hash]

Parameters

Parameter Type Description NULL
room_hash string Room ID
Format: hash (Unique object identifier)
NO

Result

Type Description Format/Object
object Live room Object: CONFERENCE10.Room.Live

conference/10.view_room

Description

View conference room.

This method is DEPRECATED and may be removed in the future.
Relying on this method is highly discouraged.

Signature

method: conference/10.view_room

params: [string room_hash]

Parameters

Parameter Type Description NULL
room_hash string Room ID
Format: hash (Unique object identifier)
NO

Result

Type Description Format/Object
object Conference room Object: CONFERENCE10.Room