API : PBX : Conference Get

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 will return a single conference.

URL	https://api.telecomx.dk/pbx/conference/CONFERENCE_ID
Method	GET
Access level	VIEWER, MANAGER or OWNER if user belongs to the customer. RESELLER if customer belongs to the reseller. ADMIN.
Param	CONFERENCE_ID	Id of the conference (24 hex-char string)
Query	live	`[optional]` True to only return list of participants.

Query examples

https://api.telecomx.dk/pbx/conference/1234567890ABCDEF12345678

Response

JSON object
_id	Id	Unique id of the conference.
type	String	Always 'CONFERENCE'.
customer	Id	Id of the customer the conference belongs to.
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

{
  _id: '12345678901234567890ABCD',
  type: 'CONFERENCE',
  customer: '1234567890123457890ADEF',
  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: '6t6474657734',
      entered: '2018-08-20T00:00:00+0100'
    },{
      ...
    }
  ]
},
{
  ...
}

Example - live=true

[
  {
    name: 'Donald Duck',
    number: '592',
    employee: '12345678901234567890AAAA',
    muted: false,
    room: '123',
    callId: '12345678901234567890AAAA',
    entered: '2018-08-20T00:00:00+0100'
  },{
    ...
  }
]

Errors

Error code	Message	Description
400	bad_request	Id not found in requestURI
404	not_found	Conference not found
403	access_denied	Insufficient access level
500	internal_error	<Unspecified>

WIKI

Table of Contents