API : PBX : Conference list

Introduction

A Conference item provides the ability for multiple participants to have a phone meeting. A conference can be a single conference or can have multi rooms that is access by pin code. A conference can also be used in presenter mode where 1 party speaks and the rest can only listen. Optionally the conference may have an access list to limit who may join the conference.

Request

This request returns a list of all of the customers conferences.

URL	https://api.telecomx.dk/pbx/conference
Method	GET
Access level	VIEWER, MANAGE, OWNER if extensions belongs to the customer, RESELLER if customer belongs to the reseller or ADMIN.
Query	offset	`[optional]` Index of the first item to return, default 0.
	limit	`[optional]` The number of items to return, default 50, min 1, max 100.
	filter	`[optional]` Search query that will match against searchable fields.
	full	`[optional]` True to include all settings.
	customer	`[optional]` Id of customer to show conferences for. Defaults to the users own customer if not specified.
	sort	`[optional]` Which property to sort result by: number (default), name, redirect.

Query examples

https://api.telecomx.dk/pbx/conference
https://api.telecomx.dk/pbx/conference?customer=123458789012457890ABCD
https://api.telecomx.dk/pbx/conference?filter=donald
https://api.telecomx.dk/pbx/conference?customer=12345678901234567890ABCD&full=true

Response

JSON object
offset	Index of the first conference returned.
limit	Number of conferences to return. Note that the actual number of returned items may be lower.
total	Number of conferences that can be returned when offset and limit is not considered. This is to be used for paging through the data.
conferences	Array of conferences, see definition below.

Conference object (normal)
_id	Id	Unique id of the conference room.
name	String	Friendly name of the item. 3-64 chars.
number	String	The phone number to dial to reach this item, null if it should not be dial-able.
redirect	String	Number to redirect to when execution starts. Used to quickly circumvent a dialplan item.
notes	String	Notes about the item.
permissionList	Boolean	True if access to the conference room is restricted.
multiRoom	Boolean	True if conference hosts multi rooms, false if its a single room.

Conference object (full=true)
_id	Id	Unique id of the conference.
type	String	Always 'CONFERENCE'.
name	String	Friendly name of the item. 3-64 chars.
number	String	The phone number to dial to reach this item, null if it should not be dial-able.
startAudio	Id	A sound item to playback when the conference item is entered, null if not used.
redirect	String	Number to redirect to when execution starts. Used to quickly circumvent a dialplan item.
notes	String	Notes about the item.
multiRoom	Boolean	True if the conference is a multi-room'ed, and callers must enter a pincode + # to enter the same room. If false all callers enters the same room.
announce	Boolean	True to play an audio indication when a caller enters or leaves.
presenter	String	If the conference is used for a presentation where only a single person will speak, this is the phone number of the speaker. All other callers will be muted. Null if normal conference room.
locked	Boolean	True if locked and no new participants may enter. Automatically unlocked when nobody is in the room. If multiRoom is enabled, locked cannot be used.
permissionList	Array	Access list - if populated, only these participants may join the conference.
permissionList[].number	String	Phone number or local extension.
permissionList[].name	String	Optional name.
participants	Array	List of participants currently in the conference
participants[].number	String	Phone number.
participants[].name	String	Name, if available.
participants[].employee	ObjectId	Employee id - if the participant is a PBX user.
participants[].muted	Boolean	True if muted and may only listen.
participants[].room	String	If multiroom, this is the room number, otherwise 0.
participants[].callId	String	Call ID - used for muting and kicking out the participant.
participants[].channelId	String	Channel ID - used for kicking, muting, unmuting the participant.
participants[].entered	Date	Date and time when the participant entered the conference.

Example - normal

{
  offset: 0,
  limit: 50,
  total: 25,
  extensions: [
    {
      _id: '12345678901234567890ABCD',
      name: 'Donald Duck',
      number: '592',
      redirect: null,
      notes: 'The boss',
      permissionList: true,
      multiRoom: false
    },
    {
      ...
    }
  ]

Example - full=true

{
  offset: 0,
  limit: 50,
  total: 25,
  extensions: [
    {
      _id: '12345678901234567890ABCD',
      type: 'CONFERENCE',
      name: 'Donald Duck',
      number: '592',
      startAudio: null,
      redirect: null,
      notes: 'The boss',
      multiRoom: false,
      announce: true,
      presenter: '200',
      locked: false,
      conferenceRoomServer: '8.8.8.8',
      permissionList: [
        {
            name: 'Donald Duck',
            number: '592'
        },{
          ...
        }
      ],
      participants: [
        {
            name: 'Donald Duck',
            number: '592',
            employee: '12345678901234567890AAAA',
            muted: false,
            room: '123',
            callId: '12345678901234567890AAAA',
            channelId: '57373t57573',
            entered: '2018-08-20T00:00:00+0100'
        },{
          ...
        }
      ]
    },
    {
      ...
    }
  ]

Errors

Error code	Message	Description
403	access_denied	Insufficient access level
500	internal_error	<Unspecified>

WIKI

Table of Contents