Skip to main content

Create Meeting Key

This request creates a meeting key for the selected subscriber using the data passed in the query body.

post/subscribers/{sid}/meetingRooms/{meetingNumber}/keychain

Sample Request

A sample POST request to create a Meeting Key object for the selected subscriber:

curl -X POST \
'https://api.carrierx.com/conference/v1/subscribers/6v9u9-p35vZo1Cxq0qKkQn9X57T5cfAj/meetingRooms/946827/keychain' \
-H 'Content-Type: application/json' \
--data-binary '{"accessCode":"3141591", "role":2}' \
-u '[your_user_name]:[your_password]'

Sample Response

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

{
"accessCode": "3141591",
"id": 4028,
"meetingRoomId": 2127,
"role": 2
}

Path Arguments

ParameterData TypeDescription
meetingNumber
required
integerThe meeting room number.
sid
required
stringThe subscriber secure ID.

Body Arguments

JSON representation of the fields and values of the Meeting Key object to be created.

A required field to create a meeting key is role.

note

If you do not pass an accessCode value, a random access code will be generated automatically.

Refer to this table to view all fields that appear in the Meeting Key object.