Meeting Attributes

The following are meeting attributes that can be applied on the Meeting Room, DID Group, or DID object levels. For each of these levels, the meeting attributes will be passed as a value of attributes as an array of objects.

This will look like the following format: "attributes":[{"name":"call_maxduration","value":120}].

Some fields accept a string containing the first letter of the access level name. The three access levels are host, participant, or listener. To enable a feature for all three access levels, enter the string hpl. Alternatively, to enable the feature for one access level, enter the first letter of the word. For example, participant is p.

Sample request

Below is a sample PUT request, which updates the Meeting Room object for the selected subscriber, targeted by meetingNumber, with the values in the request body.

put	/meetingRooms/{meetingNumber}

curl -X PUT \
'https://api.carrierx.com/conference/v1/meetingRooms/452650' \
-H 'Content-Type: application/json' \
--data-binary '{"attributes":[{"name":"call_maxduration","value":120}]}' \
-u '[your_user_name]:[your_password]'

Sample Response

200 status code with a serialized copy of the updated Meeting Room object:

{
    "attributes": [
        {
            "description": "Maximal calls duration (s)",
            "group": 0,
            "name": "call_maxduration",
            "value": "120"
        }
    ],
    "created": 1568822760000,
    "description": "another_meeting_room",
    "didGroupReferences": [
        {
            "didGroupId": 2325,
            "state": 0
        }
    ],
    "keychain": [
        {
            "accessCode": "666",
            "id": 5302,
            "role": 3
        },
        {
            "accessCode": "444",
            "id": 5300,
            "role": 1
        },
        {
            "accessCode": "555",
            "id": 5301,
            "role": 2
        }
    ],
    "meetingNumber": 508005,
    "primaryDidGroupId": 4425,
    "subscriberSid": "cxDD96hPO-bGt6TvLlluid23UQs01Djz"
}

Attributes List

Attribute	Data Type	Description	Where to Set
call_announceparticipantcount	string	Determines for which access levels the number of participants will be announced upon entering the meeting room. Enter the access levels as a string.	Meeting Room object, DID Group object
call_associate_dtmf	string	Determines which access levels will be able to associate calls.	Meeting Room object, DID Group object
call_associate_dtmf_binding	string	The DTMF sequence to associate audio.	DID Group object
call_delay	integer	The number of seconds to delay before the call is answered.	DID Group object, DID object
call_exit_dtmf	string	Determines which access levels will be able to enter the DTMF sequence to leave a call. The DTMF sequence is set as call_exit_dtmf_binding.	Meeting Room object, DID Group object
call_exit_dtmf_binding	string	Determines the DTMF sequence that will trigger exiting a call when call_exit_dtmf is enabled.	DID Group object
call_instructions_dtmf	string	Determines which access levels will be able to enter the DTMF sequence to access the help playback. Enter the access levels as a string for the field value. The DTMF sequence is set as call_instructions_dtmf_binding.	Meeting Room object, DID Group object
call_instructions_dtmf_binding	string	The DTMF sequence that will trigger the help playback for the access levels designated in call_instructions_dtmf.	DID Group object
call_jobcodeonenter	string	Determines whether or not the caller will be prompted for a job code prior to entering the meeting. Values accepted in this field are on and off.	Meeting Room object, DID Group object
call_maxduration	integer	The maximum duration of the call.	Meeting Room object, DID Group object
call_mute_dtmf	string	Determines which access levels can mute themselves. Enter the access levels as a string for the field value.	Meeting Room object, DID Group object
call_mute_dtmf_binding	string	The DTMF sequence that triggers self muting.	DID Group object
call_operator_after	integer	Determines how many times an unsuccessful attempt can be made to enter the access code. Enter -1 to allow unlimited amounts of unsuccessful attempts.	DID Group object
call_operator_dtmf	string	Determines which access levels can call the operator. Enter the access levels as a string for the field value.	Meeting Room object, DID Group object
call_operator_dtmf_binding	string	The DTMF sequence that triggers a call to the operator.	DID Group object
call_participantsnumber_dtmf	string	Determines which access levels can enter the DTMF sequence to hear the number of participants currently in the conference. Enter the access levels as a string for the field value.	Meeting Room object, DID Group object
call_participantsnumber_dtmf_binding	string	The DTMF sequence that triggers stating the number of participants in the conference.	DID Group object
conference_appspecific	string	Application-specific data.	Meeting Room object, DID Group object
conference_callerdb	string	The callers database. Values accepted in this field are on and off.	Meeting Room object, DID Group object
conference_country	string	The conference country.	Meeting Room object, DID Group object
conference_distributed	string	Determines whether or not distributed conferencing is enabled. Values accepted in this field are on and off.	Meeting Room object, DID Group object
conference_entryexittones_dtmf	string	Determines which access levels can change the entry and exit tone by entering a DMTF sequence. Entering the DTMF sequence will alternate through the following combinations: ON:ON, ON:OFF, OFF:ON, and OFF:OFF.	Meeting Room object, DID Group object
conference_entryexittones_dtmf_binding	string	The DTMF sequence that triggers the change between the tone combinations outlined in conference_entryexittones_dtmf.	DID Group object
conference_entrytones	string	Determines whether or not a noise will be played when a new participant joins the conference. Values accepted in this field are on and off.	Meeting Room object, DID Group object
conference_exittones	string	Determines whether or not a noise will be played when a new participant exits the conference. Values accepted in this field are on and off.	Meeting Room object, DID Group object
conference_hold_dtmf	string	Determines which access levels will be able to put a conference on hold.	Meeting Room object, DID Group object
conference_hold_dtmf_binding	string	The DTMF sequence that will trigger putting a conference on hold.	DID Group object
conference_hold_policy	string	Determines which access levels will be on hold at the beginning of the conference. Enter the access levels as a string for the field value.	Meeting Room object, DID Group object
conference_jobcode_dtmf	string	Allows participants to enter the * key during a conference followed by a job code. Enter the access levels as a string for the field value.	Meeting Room object, DID Group object
conference_jobcode_dtmf_binding	string	The DTMF sequence to trigger entering a job code.	DID Group object
conference_language	string	Determines the language of the meeting. The default value is EN. Refer to the table below for all of the currently supported languages.	Meeting Room object, DID Group object
conference_lock_dtmf	string	Determines which access levels can lock a conference, meaning that no more participants can join. Note that hosts are still able to join even if lock is enabled. Enter the access levels as a string for the field value.	Meeting Room object, DID Group object
conference_lock_dtmf_binding	string	The DTMF sequence that triggers locking a conference.	DID Group object
conference_maxcalls	integer	The maximum number of calls per conference.	Meeting Room object, DID Group object
conference_maxcallsperrole	string	The maximum number of calls per role per conference. The following denotes that there can be an unlimited amount of calls from each role: -1:-1:-1.	Meeting Room object, DID Group object
conference_maxduration	integer	The maximum duration of the conference. To enable the conference to endure indefinitely, assign the value -1.	Meeting Room object, DID Group object
conference_mute_dtmf	string	Determines which access levels are able to mute other participants. Enter the access levels as a string for the field value.	Meeting Room object, DID Group object
conference_mute_dtmf_binding	string	The DTMF sequence to trigger muting other participants.	DID Group object
conference_mute_policy	string	Defines which roles will be muted at the beginning of the conference. Enter the access levels as a string for the field value.	Meeting Room object, DID Group object
conference_qa_dtmf	string	Determines which access levels can start a Q&A session. Enter the access levels as a string for the field value.	Meeting Room object, DID Group object
conference_qa_dtmf_binding	string	The DTMF sequence to trigger starting a Q&A session.	DID Group object
conference_qa_policy	string	Determines which access levels will be muted when a Q&A session is started. Enter the access levels as a string for the field value.	Meeting Room object, DID Group object
conference_realtime	string	Defines whether or not the conference generates real time notifications, which allows viewing attendee lists and controlling the conference from a computer. Values accepted in this field are on and off.	Meeting Room object, DID Group object
conference_recording	string	Defines whether or not a recording will begin once the meeting starts. Values accepted in this field are on, off, and auto. auto means that the recording will begin as soon as the conference begins.	Meeting Room object, DID Group object
conference_rollcall	string	Determines whether or not participants will be prompted to record their names upon entering the conference. Values accepted in this field are on and off.	Meeting Room object, DID Group object
conference_rollcall_onenter	string	Determines whether or not the recordings of participants saying their names will be played upon entering the conference. Values accepted in this field are on and off.	Meeting Room object, DID Group object
conference_rollcall_onexit	string	Determines whether or not recordings of the participants saying their names will be played upon exiting the conference. Values accepted in this field are on and off.	Meeting Room object, DID Group object
conference_schedule	string	The conference schedule.	Meeting Room object, DID Group object
conference_schedule_extend	string	The conference schedule extended maximum time in seconds.	DID Group object
conference_schedule_extend_dtmf	string	Defines the access levels that will be able to extend a conference schedule.	Meeting Room object, DID Group object
conference_schedule_extend_dtmf_binding	string	The DMTF sequence that will trigger extending the conference schedule.	DID Group object
conference_schedule_hold	integer	The amount of time in seconds to wait before the scheduled conference begins.	Meeting Room object, DID Group object
conference_schedule_remind	integer	The amount of time in seconds to wait before the scheduled conference reminder.	Meeting Room object, DID Group object
conference_scheduled	string	Defines whether or not a conference is scheduled. Values accepted in this field are on and off.	Meeting Room object, DID Group object
conference_start_how	string	Determines when the conference will begin. Values accepted in this field are first, moderator, and explicit.	Meeting Room object, DID Group object
conference_start_wait	integer	The number of seconds to wait before starting a meeting when a moderator has not entered the meeting.	Meeting Room object, DID Group object
conference_stop_how	string	Determines whether the meeting will end when the moderator exits, or when the last participant exits. Values accepted in this field are last and moderator.	Meeting Room object, DID Group object
conference_stop_wait	integer	The number of seconds to wait before stopping the conference after the host disconnects.	Meeting Room object, DID Group object
conference_video_policy	string	Determines which access levels will have video enabled at the beginning of a conference. Enter the access levels as a string for the field value.	Meeting Room object, DID Group object
conference_whitelist	string	Defines whether or not the conference has a white list. Values accepted in this field are on and off.	Meeting Room object, DID Group object
dnis_welcomeprompt	string	The URL to a recorded greeting.	DID Group object, DID object
polling_dtmf	string	Determines which access levels can start a polling vote.	Meeting Room object, DID Group object
polling_dtmf_binding	string	The DTMF sequence to trigger starting a polling vote.	DID Group object
recording_addr	string	The recording server address.	DID Group object
recording_dtmf	string	Determines which access levels are able to start a recording. Enter the access levels as a string for the field value.	Meeting Room object, DID Group object
recording_dtmf_binding	string	Defines the DTMF sequence that triggers starting a recording of the meeting.	DID Group object
recording_metadata	string	Defines the recording metadata passing method. Values accepted in this field are contact and custom.	DID Group object
recording_method	string	Determines the recording method. Values accepted in this field are: remote, remote+pin, local, and local+pin.	DID Group object
recording_stop_how	string	Determines the recording method. Values accepted in this field are: last and moderator.	Meeting Room object, DID Group object
recording_stop_wait	integer	Defines the amount of seconds to wait before stopping recording after the moderator has left the conference.	Meeting Room object, DID Group object

Conference Language

Code	Language
EN	English (default)
AR	Argentinian
DE	German
EL	Greek
ES	Spanish (Spain)
ES-LATAM	Spanish (Latin America)
FR	French
GB	British English
HE	Vietnamese
IT	Italy
JA	Japanese
KO	Korean
NL	Dutch
PT	Portuguese (Portugal)
PT-BR	Portuguese (Brazil)
RU	Russian
TR	Turkish
UA	Ukrainian
UK	Ukrainian (Ukraine)
ZH	Chinese