For marketing information on Digital Samba, please refer to the following web pages:
\nThe Samba Live API is a RESTful Web Service.
\n\nIt accepts requests using standard HTTP methods, such as GET, PUT, POST and DELETE. Currently, “Basic HTTP Authentication” is the only available method of authenticating. We are working to additionally provide “Digest HTTP Authentication”.
\n\nExamples given here are provided for the PHP programming language and uses cURL to make the HTTP requests.
\n\nAccording to the HTTP specification, when making GET requests, all parameters must be passed as URL/querystring parameters.
When making PUT, POST or DELETE requests, all parameters must be passed in the request body; URL/querystring parameters in such requests will be ignored, except for the format variable.
The data format of the request body must contain an input_type and rest_data variable, the former must be set to “json” and the latter must be a valid JSON array, such asinput_type=json&rest_data={\"id\":\"1\",\"var2\":\"val2\"}
The JSON approach is robust as it allows the passing of objects and arrays whilst also being simpler to implement (simply json_encode() your data array before sending it). We provide PHP code examples for how requests are made with each API method below.
In the future, we may allow for additional input_type (such as XML), but for the time being you must always set this to “json”.
There is more choice available for return formats - take a look at the section called “Return Formatting” below.
All special characters (+, $, <, >, ect) in rest_data array should be urlencoded. You can use urlencode PHP function, or similar.
To access the Samba Live API methods you must pass the Authorization header as part of each request, set it to basic and pass the required encrypted string. For example:
Authorization: Basic bWF0dGhpYXM6YWWtaW4=
The encrypted string must be a base64 encoded combination of username and password in the following format:
\n\nmyUsername:myPassword
In Fiddler you can create this string by opening the Encoder tab, selecting base64 and entering your credentials.
\n\n
Note when using non-latin usernames: you can use a normal browser to test GET methods. You will be asked to provide username/password in a popup, which is passed to the server as HTTP Basic Auth. Note that not all browsers support non-latin characters during this authentication. Chrome works, Firefox and others do not support it. This is only an issue when testing with a browser. cURL has no such issues.
Fiddler2 - HTTP Web Debugger. Allows you to send GET, PUT, POST, DELETE and other HTTP requests, modify headers and request body, and capture the return values. Essential for testing and debugging your API integration.
\n“RESTful Web Services” by Leonard Richardson & Sam Ruby (O’Reilly) - some formulations in this document have been borrowed from this excellent book, in particular for the section on HTTP Error Codes.
\n
[ver] - The version of the API endpoint, must be defined in each request URL. The current version is 2.
Example: GET http://domain.com/api/2/[username]/authverify
[username] - The username of the account which is making the API requests.
Example: GET http://domain.com/api/[ver]/johndoe/authverify
Returned when providing input during a PUT operation which would leave the resource in an incomplete or inconsistent state. The provided input is nonsensical or corrupt.
Example: Providing an alphabetic value of “abcd” for an integer parameter, such as “offset”.
\nReturned when trying to operate on a protected resource without providing the proper authentication credentials (either wrong or none at all). The response header WWW-Authenticate describes what kind of authentication the server will accept.
\n\n
Returned when trying to access a URI that does not correspond to any existing resource. The only possible exception is when a client is trying to PUT a new resource to that URI, see 201.
Example: Trying to retrieve a non-existing user.
Returned when the client tries to use an HTTP method which this particular resource doesn’t support.
\n\nExample: Trying to PUT or DELETE a read-only resource.
\n\nReturned when providing input during a PUT operation which would cause the resource state to conflict with some other resource.
\n\nExample: Trying to change your username to a name that’s already taken. Trying to delete a folder that is not empty.
\n\nReturned when the server knows there used to be a resource there, but there isn’t anymore. Also see 404, when the server has no idea about the resource at all.
\n\nThere is a problem on the server side.
\n\nReturned when a GET operation is successful, a POST operation to append to an existing resource is successful, and when a DELETE operation is successful.
\n\nWhen a successful PUT or POST (when creating new) operation is carried out a 201 is returned, along with the new URI in the Location header. See 400 and 409 for related error codes.
\n\nSometimes a PUT operation will change the URI of the resource just modified. In such cases, a 301 is returned, along with the new URI in the Location header. Future requests to the old URI will result in a 301, 404 or 410 return.
\n\nThe Digital Samba API supports a number of different return formats.
\n\nBy appending /format/[value]/ to the URLs of the API method calls, or by passing the correct MIME-type, you can choose the format of the returned data. These may differ for each call, so, for example you may wish to obtain a list of users in XML format, but get a list of invitees returned in JSON.
Available formats and how to request them:
\n\nFormat | URL Parameter | Sample return |
xml | none (default) or /format/xml | |
json | /format/json | |
serialize | /format/serialize | |
php (can be used in eval) | /format/php | |
html | /format/html | |
csv | /format/csv | |
Use to test if the auth credentials passed with HTTP Basic are valid.
\n\n| authenticated (bool) | \nIf 1/true, credentials are valid.. | \n
Get branding options by provides user ID #
\n| Required | \nid (int) | \nID# of user account. | \n
| Required | \nuser_id (str) | \nID# of user account. | \n
| Optional | \nsession_login (str) | \nURL to Session Login Page image.\n Dimensions: 275px wide, 46px high. Format: gif, jpg, png (transparent background recommended). Filesize: Max 256KB.\n | \n
| \n | top_of_account (str) | \nURL to Top of Account Center image. Dimensions: 264px wide, 51px high. Format: gif, jpg, png (transparent background recommended). Filesize: Max 256KB.\n | \n
| \n | intro_screen (str) | \nURL to Dashboard Welcome Image. Dimensions: 156px wide, 156px high. Format: gif, jpg, png. Filesize: Max 256KB. (Available in v4.4.5)\n | \n
| \n | in_room_logo_html5 (str) | \nURL to In Room Logo image (HTML5 rooms only).\n Recommended dimensions: 300px wide, 60px high (Maximum: 300px wide, 200px high). Format: svg or png preferred (Available in v5.1.5).\n | \n
| \n | mobile_landing_logo (str) | \nURL to the Mobile Landing Page image. Dimensions: 420px wide, 100px high. Format: png (transparent background recommended). Filesize: Max 512KB.\n | \n
| \n | event_header (str) | \nURL to event header image.\n Maximum Dimensions: 300px wide, 50px high. Format: gif, jpg, png. Filesize: Max 512KB. (Available in v5.0.2)\n | \n
| \n | event_photo (str) | \nURL to event Photo image.\n Dimensions: 240px wide, 180px high. Format: gif, jpg, png. Filesize: Max 1024KB.\n | \n
| \n | sharing_logo (str) | \nURL to Logo For Social Media Sharing.\n Maximum Dimensions: 256px wide, 256px high. Format: gif, jpg, png. Filesize: Max 512KB. (Available in v5.0.2)\n | \n
| \n | email_header (int) | \nURL to Email Header image.\n Maximum dimensions: 600px wide, 600px high. Format: png (transparent background recommended). Filesize: Max 1024KB.\n | \n
| \n | email_footer (str) | \nURL to Email Footer image.\n Maximum dimensions: 600px wide, 600px high. Format: png (transparent background recommended). Filesize: Max 1024KB.\n | \n
| \n | moderator_redirect_url (str) | \nModerator Redirect URL. At the end of the session, moderators are redirected to this URL. | \n
| \n | guest_redirect_url (str) | \nGuest Redirect URL. At the end of the session, guest participants are redirected to this URL.\n | \n
| \n | lobby_text (str) | \nLobby text (Available in v4.3.9). Maximum 200 letters\n | \n
Create/Update branding options for user account. Available in v4.3.4
\nSee POST /branding
","urlObject":{"path":["api","2","{{user_name}}","branding"],"host":["{{API_EndPoint}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"7a98b237-b37f-e66e-f2aa-933127f51754"},{"name":"/branding","id":"8056880c-ba39-5636-ef2e-09ea70ba3c75","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Basic YWRtaW46c2FtYmEyMDAy"}],"body":{"mode":"raw","raw":"input_type=json&rest_data={\n \"user_id\":1,\n \"session_login\":\"http://os4.dev.digitalsamba.com/storage/users/1/flat_ui_branding_session_login.png\",\n \"moderator_redirect_url\":\"http://moderator_redirect_url.com\",\n \"guest_redirect_url\":\"http://guest_redirect_url.com\"\n}"},"url":"{{API_EndPoint}}/api/2/{{user_name}}/branding","description":"Create/Update branding options for user account. Available in v4.3.4
\nNOTE: This method is alias of PUT /branding.
\n| Required | \nuser_id (str) | \nID# of user account. | \n
| Optional | \nsession_login (str) | \nURL to Session Login Page image.\n Dimensions: 275px wide, 46px high. Format: gif, jpg, png (transparent background recommended). Filesize: Max 256KB.\n | \n
| \n | top_of_account (str) | \nURL to Top of Account Center image. Dimensions: 264px wide, 51px high. Format: gif, jpg, png (transparent background recommended). Filesize: Max 256KB.\n | \n
| \n | intro_screen (str) | \nURL to Dashboard Welcome Image. Dimensions: 156px wide, 156px high. Format: gif, jpg, png. Filesize: Max 256KB. (Available in v4.4.5)\n | \n
| \n | in_room_logo_html5 (str) | \nURL to In Room Logo image (HTML5 rooms only).\n Recommended dimensions: 300px wide, 60px high (Maximum: 300px wide, 200px high). Format: svg or png preferred (Available in v5.1.5).\n | \n
| \n | mobile_landing_logo (str) | \nURL to the Mobile Landing Page image. Dimensions: 420px wide, 100px high. Format: png (transparent background recommended). Filesize: Max 512KB.\n | \n
| \n | event_header (str) | \nURL to event header image.\n Maximum Dimensions: 300px wide, 50px high. Format: gif, jpg, png. Filesize: Max 512KB. (Available in v5.0.2)\n | \n
| \n | event_photo (str) | \nURL to event Photo image.\n Dimensions: 240px wide, 180px high. Format: gif, jpg, png. Filesize: Max 1024KB.\n | \n
| \n | sharing_logo (str) | \nURL to Logo For Social Media Sharing.\n Maximum Dimensions: 256px wide, 256px high. Format: gif, jpg, png. Filesize: Max 512KB. (Available in v5.0.2)\n | \n
| \n | email_header (int) | \nURL to Email Header image.\n Maximum dimensions: 600px wide, 600px high. Format: png (transparent background recommended). Filesize: Max 1024KB.\n | \n
| \n | email_footer (str) | \nURL to Email Footer image.\n Maximum dimensions: 600px wide, 600px high. Format: png (transparent background recommended). Filesize: Max 1024KB.\n | \n
| \n | moderator_redirect_url (str) | \nModerator Redirect URL. At the end of the session, moderators are redirected to this URL.\n | \n
| \n | guest_redirect_url (str) | \nGuest Redirect URL. At the end of the session, guest participants are redirected to this URL.\n | \n
| \n | lobby_text (str) | \nLobby text (Available in v4.3.9). Maximum 200 letters\n | \n
| id (int) | \nThe id of the user account. | \n
| message (str) | \nText messsage. | \n
Reset the user account branding settings. Available in v4.3.4
\n| Required | \nid (str) | \nID# of user account. | \n
| Optional | \n- | \n- | \n
| id (int) | \nThe id of the user account. | \n
| message (str) | \nText messsage. | \n
User branding settings (available with v 4.3.4)
\n","_postman_id":"9ca37f3c-abe0-f1e5-2e8c-8b60e24e89a7"},{"name":"Company user limits","item":[{"name":"/company_user_limits/id/[int]","id":"ec734365-a8d1-312e-b27b-3453cccbae53","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"Get company user limits. Requires admin access rights. Available in v5.0.2
\n| Required | \nid (int) | \nID# of company user account. | \n
| id (int) | \nID# of comapny user account. | \n
| company_sim_bcaster (int) | \nNumber of broadcasters that can broadcast at the same time across all account holders in this company. | \n
| company_session_user_limit (int) | \nNumber of sessions that can run at the same time in this company. | \n
| company_account_user_limit (int) | \nNumber of attendees that can be in sessions at the same time across all account holders in this company. | \n
| company_filesize_limit (int) | \nThe limit on total filesize (in KB) of all files of all account holders in this company (Available in v5.0.4). | \n
| company_service_plans (array) | \nCompany Accounts Limits.\nservice_plan_id: ID# of parent service plan\nqty: Number of accounts which this company may assign to the service plan\n | \n
| enforce_expiry_date (bool) | \nApply the expiry date to all account holders in this company (Available in v5.1.5). | \n
Update company user limits. Requires admin access rights. Available in v5.0.2
\n| Required | \nid (int) | \nID# of comapny user account. | \n
| \n | company_sim_bcaster (int) | \nNumber of broadcasters that can broadcast at the same time across all account holders in this company. | \n
| \n | company_session_user_limit (int) | \nNumber of sessions that can run at the same time in this company. | \n
| \n | company_account_user_limit (int) | \nNumber of attendees that can be in sessions at the same time across all account holders in this company. | \n
| \n | company_filesize_limit (int) | \nThe limit on total filesize (in KB) of all files of all account holders in this company (Available in v5.0.4). | \n
| \n | company_service_plans (array) | \nCompany Accounts Limits. \nservice_plan_id: ID# of parent service plan\nqty: Number of accounts which this company may assign to the service plan\nFormat:\n\n[\n {\n \"service_plan_id\":1,\n \"qty\":50\n }, \n {\n \"service_plan_id\":2,\n \"qty\":10\n }\n]\n\n | \n
| \n | enforce_expiry_date (bool) | \nApply the expiry date to all account holders in this company (Available in v5.1.5). | \n
| id (int) | \nThe id of company user account. | \n
| message (str) | \nText messsage. | \n
Update company user limits. Requires admin access rights. Available in v5.0.2
\n\nSee PUT /company_user_limits
","urlObject":{"path":["api","2","{{user_name}}","company_user_limits"],"host":["{{API_EndPoint}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"514920aa-0807-ebe0-9f6b-fed7721c96cc"},{"name":"/company_user_limits","id":"539c247e-8a24-9e80-15d9-ca0c41536aa2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"Delete company user limits. Requires admin access rights. Available in v5.0.2
\n| Required | \nid (str) | \nID# of company user account. | \n
| id (int) | \nThe id of the company user account. | \n
| message (str) | \nText messsage. | \n
Manage Company user limits (available with v 5.0.2)
\nAdmin permissions required.
","_postman_id":"8fee1af2-30ea-7498-7f37-af1337dcc8b1"},{"name":"Recordings","item":[{"name":"/recording/id/[int]","id":"6cdf30b4-f06b-08a3-d516-6b9f0f6cdd31","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"Get recording associated with this user account.
\n| Required | \nid (int) | \nThe id of the recording. | \n
| id (int) | \nThe id of the recording. | \n
| session_id (int) | \nThe id of the session in which this recording was made. | \n
| title (str) | \nThe name or title of this recording. | \n
| description (str) | \nDescription of the recording. | \n
| duration (int) | \nLength of recording, in milliseconds. | \n
| password (str) | \nPassword for public recording page (available with v 5.42.0). | \n
| download_link (str) | \nFlash: URL to zip file. HTML5: URL to mp4 file. (available with v 4.3.6). | \n
| play_link (str) | \nURL public recording page. (available with v 5.42.0). | \n
| bookmarks (array) | \nRecording bookmars. (available with v 5.38.0). | \n
| creation_date (datetime) | \nDatetime stamp when the recording was made. | \n
Get recordings associated with this user account.
\n| Optional | \nsession (int) | \nPass a session id to limit results to recordings made in that session only. Otherwise recordings made across all sessions are returned.\n | \n
| \n | count (int) | \nSpecify number of returned results. Default is 100.\n | \n
| \n | offset (int) | \nSpecify to move the cursor through the recordset. Default is 0. | \n
| \n | order (str) | \nReturn results in ascending or descending order of recording ID (Depricated in 5.5). Default is asc. Accepted values: asc, desc\n | \n
| \n | order_field (str) | \nReturn results in order of this field (Available in 5.5). Default is id. \nAccepted values: id, title, description, duration, creation_date. | \n
| \n | order_dir (str) | \nReturn results in ascending or descending order (Available in 5.5). Default is desc. \nAccepted values: asc, desc. | \n
Edit an existing recording.
\n| Required | \nid (int) | \nThe id of the recording. | \n
| Optional | \ntitle (str) | \nThe title of the recording. | \n
| \n | description (str) | \nThe description of the recording. | \n
| \n | password (str) | \nThe password of the recording (available with v 5.42.0). | \n
| id (int) | \nThe id of the edited recording. | \n
| message (str) | \nText messsage. | \n
Delete an existing recording.
\n| Required | \nid (int) | \nThe id of the recording to be deleted. Note: the id may also be appended to the URL (.../id/xxx) instead of in the request body. | \n
| id (int) | \nThe id of the deleted recording. | \n
| message (str) | \nText messsage. | \n
Get recording associated with sub user account (available with version 5.7).
\n| Required | \nid (int) | \nThe id of the recording. | \n
| id (int) | \nThe id of the recording. | \n
| session_id (int) | \nThe id of the session in which this recording was made. | \n
| title (str) | \nThe name or title of this recording. | \n
| description (str) | \nDescription of the recording. | \n
| duration (int) | \nLength of recording, in milliseconds. | \n
| download_link (str) | \nFlash: URL to zip file. HTML5: URL to mp4 file. | \n
| creation_date (datetime) | \nDatetime stamp when the recording was made. | \n
Get recordings list associated with sub account (child account). (available with version 5.7).
\n| Required | \nuser_id (int) | \nID of child user. | \n
| Optional | \nsession (int) | \nPass a session id to limit results to recordings made in that session only. Otherwise recordings made across all sessions are returned.\n | \n
| \n | count (int) | \nSpecify number of returned results. Default is 100.\n | \n
| \n | offset (int) | \nSpecify to move the cursor through the recordset. Default is 0. | \n
| \n | order (str) | \nReturn results in ascending or descending order of recording ID (Depricated in 5.5). Default is asc. Accepted values: asc, desc\n | \n
| \n | order_field (str) | \nReturn results in order of this field (Available in 5.5). Default is id. \nAccepted values: id, title, description, duration, creation_date. | \n
| \n | order_dir (str) | \nReturn results in ascending or descending order (Available in 5.5). Default is desc. \nAccepted values: asc, desc. | \n
Edit an existing recording related to sub user account (available with version 5.7).
\n| Required | \nid (int) | \nThe id of the recording. | \n
| Optional | \ntitle (str) | \nThe title of the recording. | \n
| \n | description (str) | \nThe description of the recording. | \n
| id (int) | \nThe id of the edited recording. | \n
| message (str) | \nText messsage. | \n
Delete an existing recording related to sub user account (available with version 5.7).
\n| Required | \nid (int) | \nThe id of the recording to be deleted. Note: the id may also be appended to the URL (.../id/xxx) instead of in the request body. | \n
| id (int) | \nThe id of the deleted recording. | \n
| message (str) | \nText messsage. | \n
Get all medialibrary items and directories associated with this user account (available with version 5.23.0).
\n","urlObject":{"path":["api","2","{{user_name}}","files"],"host":["{{API_EndPoint}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"745da3c9-27f5-4bc2-9830-e8c66f026e15"},{"name":"/directory/id/[int]","id":"54e1f752-7dac-4463-bcb8-d733eb222f0e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"Get directory details by id (available with version 5.23.0).
\n| Required | \nid (int) | \nThe id of the specific directory. | \n
Get medialibrary item details by id (available with version 5.23.0).
\n| Required | \nid (int) | \nThe id of the specific medialibrary item. | \n
Share medialibrary item or directory (available with version 5.23.0).
\n| Required | \nfile_id (int) | \nThe id of the sharing medialibrary item (required when share medialibrary items). | \n
| \n | dir_id (int) | \nThe id of the sharing directory (required when share directores). | \n
| \n | session_id (int) | \nThe id of the session. | \n
| file_id (int) | \nThe id of the shared medialibrary item. | \n
| dir_id (int) | \nThe id of the shared directory. | \n
| message (str) | \nText messsage. | \n
Unshare file or directory.
\n| Required | \nfile_id (int) | \nThe id of the shared medialibrary item (required when share medialibrary items). | \n
| \n | dir_id (int) | \nThe id of the shared directory (required when share directores). | \n
| \n | session_id (int) | \nThe id of the session. | \n
| file_id (int) | \nThe id of the shared medialibrary item. | \n
| dir_id (int) | \nThe id of the shared directory. | \n
| message (str) | \nText messsage. | \n
Add online video to content library (available with version 5.41.0).
\n| Required | \nurl (str) | \nURL to youtu.be or vimeo.con video. | \n
| \n | name (str) | \nVideo title what is displayed in content library. | \n
| Optional | \ndir_id (int) | \nThe id of the video directory. | \n
| Optional | \nuser_id (int) | \nThe id of video owner. | \n
| file_id (int) | \nThe id of the medialibrary item. | \n
| dir_id (int) | \nThe id of the medialibrary directory. | \n
| file_url (str) | \nVideo URL. | \n
| file_name (str) | \nVideo title. | \n
| type (str) | \nVideo type (youtube or vimeo). | \n
Get server settings. Requires admin access rights. Available in v4.4.3
\n| allow_user_registration (bool) | \nEnable/disable the free user registration | \n
| user_registration_link (str) | \nLink to the free user registration | \n
| ldap_enabled (bool) | \nEnable/disable LDAP connection (Deprecated in v5.1.5). | \n
| allow_modify_branding (bool) | \nAllow account holders modify branding | \n
| maintenance_alert (bool) | \nEnable/disable the maintenance alert | \n
| maintenance_message (str) | \nMaintenance alert content | \n
Set server settings. Requires admin access rights. Available in v4.4.3
\n| Optional | \nallow_user_registration (bool) | \nEnable/disable the free user registration | \n
| \n | user_registration_link (str) | \nLink to the free user registration | \n
| \n | ldap_enabled (bool) | \nEnable/disable LDAP connection (Deprecated in v5.1.5) | \n
| \n | allow_modify_branding (bool) | \nAllow account holders modify branding | \n
| \n | maintenance_alert (bool) | \nEnable/disable the maintenance alert | \n
| \n | maintenance_message (str) | \nMaintenance alert content | \n
Server Settings (available with v 4.4.3).
\nAdmin prmissions required.
","_postman_id":"679dd270-1ea9-4066-ea73-37b2738697ca"},{"name":"Service Plans","item":[{"name":"/service_plan/id/[int]","id":"b37d60e3-6726-b8f2-3714-a57b545333eb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Basic YWRtaW46c2FtYmEyMDAy"}],"url":"{{API_EndPoint}}/api/2/{{user_name}}/service_plan/id/1","description":"Get service plan by given ID#
\n| Required | \nid (int) | \nID# of the service plan to be returned. | \n
| id (int) | \nThe ID# of service plan. | \n
| name (str) | \nCustom name of service plan. | \n
| description (str) | \nBrief description of service plan. | \n
| user_limit (int) | \nThe simultaneous user connection limit across all sessions in this account. | \n
| session_user_limit (int) | \nThe simultaneous user connection limit of any particular session in this account. | \n
| recording_limit (int) | \nThe limit on number of recordings this account may store. | \n
| filesize_limit (int) | \nThe limit on total filesize (in KB) of all files in this account's Media Library. | \n
| broadcasters_limit (int) | \nNumber of users in any session of this account who may broadcast at the same time. | \n
| simultaneous_speakers_limit (int) | \nNumber of speakers in any session of this account who may join at the same time (available with v 5.11.0). | \n
| modify_branding_enabled (bool) | \nAllow account holders to modify branding. | \n
| modify_colors_enabled (bool) | \nAllow account holders to modify theme colors. Available when new flat-ui theme is enabled (available with v 4.4.5). | \n
| advanced_sessions_enabled (bool) | \nEnable advanced scheduling features. | \n
| mobile_access_enabled (bool) | \nEnable access from mobile applications. | \n
| api_enabled (bool) | \nEnable access for API. | \n
| session_registration_enabled (bool) | \nAllow account holders to enable registration and create an event page (Applies to HTML5 only, available with v 5.9.0). | \n
| available_roles (array) | \nAvailable roles. Possible values:\n- 1: Speakers\n- 2: Audience\n- 3: Custom role\n (available with v 5.25.0). | \n
| custom_role_name (string) | \nName of the custom role\n (available with v 5.25.0). | \n
| modify_permissions_enabled (bool) | \nAllow account holders to modify session permissions (available with v 4.4.4). | \n
| webrtc_debug_enabled (bool) | \nEnable frontend console logs in this account for debugging (available with v 5.7.0). | \n
| password_protect_fast_session (bool) | \nPassword protect MeetNow meetings (available with v 5.1.5). | \n
| video_fit_to_screen (int) | \nDefault video display settings (available with v 5.6).\nValues: \n- 0: Display video in original aspect ratio\n- 1: Fit video to fill screen\n | \n
| chat_emoji_enabled (bool) | \nEnable chat emojis. (available with v 5.34.0) | \n
| chat_emoji_reactions_enabled (bool) | \nEnable chat emoji reactions. (available with v 5.34.0) | \n
| child_friendly_emoji_enabled (bool) | \nUse child friendly emoji set in the chat panel. (available with v 5.34.0) | \n
| e2ee_support_enabled (bool) | \nEnable/disable E2EE support (available with v 5.38.0). | \n
| menu_buttons (array) | \nMenu Buttons Available in Session. | \n
| components (array) | \nComponents Available in Session (available with v 4.4.4). | \n
| permissions (array) | \nPermissions Available in Session (available with v 4.4.4). | \n
| voip_session_audio (string) | \nDefault Session Audio. Allowed values: phone, voip. (available with v 4.3.2). | \n
| voip_available_session_audio (array) | \nAvailable session audio options (available with v 5.0.5). Values: \n-phone (Using external phone audio, users will be required to dial-in via the telephone)\n-hybrid (Users will see a pop-up screen where they are given the choice to listen via their speakers or to dial-in via the telephone)\n-voip (Using flash-based internal audio). | \n
| meeting_duration_limit (int) | \nMeeting duration limit in minutes. Users will be shown a warning 2 minutes before the meeting duration is reached and the session is ended (available with v 5.6). | \n
| meeting_duration_limit_enabled (bool) | \nEnabled/disabled meeting duration limit (available with v 5.6). | \n
| meeting_duration_limit_redirect (string) | \nWhen the duration is reached, redirect users to this URL (available with v 5.6). | \n
| unlimited_1_to_1_meetings (bool) | \nEnabled/disabled unlimited 1 to 1 meetings (available with v 5.6). | \n
| allow_max_one_content_opened (bool) | \nAllow maximum one content opened. Thumbnail and Tiled modes will allow opening maximum one piece of content in the Stage. Fullscreen mode will not display content thumbnails to quickly access the previously open content. (available with v 5.30.0). | \n
| enable_bitrate_limit (bool) | \nEnable Total Room Publisher Bitrate Limit (TRPBL) (available with v 5.7). | \n
| min_bitrate_cap (int) | \nHD OFF max bitrate. The max bitrate of the broadcaster's video (in kbit, eg 128), when the HD toggle is in the left OFF position. (available with v 5.7). | \n
| min_bitrate_cap (int) | \nHD ON max bitrate. The max bitrate of the broadcaster's video (in kbit, eg 512), when the HD toggle is in the right ON position. (available with v 5.7). | \n
| max_resolution (int) | \nMax resolution. The max resolution a broadcaster's video may reach (vertical pixel count, eg 720). Actual resolution will depend on available bandwidth, CPU, number of broadcasters and TRPBL. (available with v 5.7). | \n
| min_bitrate_cap_screen_share (int) | \nScreen share HD OFF max bitrate. The max bitrate of the broadcaster's screen share (in kbit, eg 256), when the HD toggle is in the left OFF position. (available with v 5.7). | \n
| max_bitrate_cap_screen_share (int) | \nScreen share HD ON max bitrate. The max bitrate of the broadcaster's screen share (in kbit, eg 1024), when the HD toggle is in the right ON position. (available with v 5.7). | \n
| max_resolution_screen_share (int) | \nScreen share Max resolution. The max resolution a broadcaster's screen share may reach (vertical pixel count, eg 1080). Actual resolution will depend on available bandwidth, CPU, number of broadcasters and TRPBL. (available with v 5.7). | \n
Get service plans.
\n| Optional | \ncount (int) | \nSpecify number of returned results. Default is 100.\n | \n
| \n | offset (int) | \nSpecify to move the cursor through the recordset. Default is 0. | \n
| \n | order (str) | \nReturn results in ascending or descending order of recording ID (Depricated in 5.5). Default is asc. Accepted values: asc, desc\n | \n
| \n | order_field (str) | \nReturn results in order of this field (Available in 5.5). Default is id. \nAccepted values: id, name, description. | \n
| \n | order_dir (str) | \nReturn results in ascending or descending order (Available in 5.5). Default is desc. \nAccepted values: asc, desc. | \n
Add new service plan
\n| Required | \nname (str) | \nThe name of service plan. | \n
| \n | description (str) | \nThe brief description for this service plan. | \n
| \n | user_limit (int) | \nThe simultaneous user connection limit across all sessions in this account. | \n
| \n | session_user_limit (int) | \nThe simultaneous user connection limit of any particular session in this account. | \n
| \n | recording_limit (int) | \nThe limit on number of recordings this account may store. | \n
| \n | filesize_limit (int) | \nThe limit on total filesize (in KB) of all files in this account's Media Library. | \n
| \n | broadcasters_limit (int) | \nNumber of users in any session of this account who may broadcast at the same time. | \n
| \n | simultaneous_speakers_limit (int) | \nNumber of speakers in any session of this account who may join at the same time (available with v 5.11.0). | \n
| \n | modify_branding_enabled (bool) | \nAllow account holders to modify branding. | \n
| \n | modify_colors_enabled (bool) | \nAllow account holders to modify theme colors. Available when new flat-ui theme is enabled (available with v 4.4.5). | \n
| \n | advanced_sessions_enabled (bool) | \nEnable advanced scheduling features. | \n
| \n | mobile_access_enabled (bool) | \nEnable access from mobile applications. | \n
| \n | api_enabled (bool) | \nEnable access for API. | \n
| \n | session_registration_enabled (bool) | \nAllow account holders to enable registration and create an event page (Applies to HTML5 only, available with v 5.9.0). | \n
| \n | modify_permissions_enabled (bool) | \nAllow account holders to modify session permissions (available with v 4.4.4) | \n
| \n | webrtc_debug_enabled (bool) | \nEnable frontend console logs in this account for debugging (available with v 5.7.0). | \n
| \n | password_protect_fast_session (bool) | \nPassword protect MeetNow meetings (available with v 5.1.5). | \n
| \n | video_fit_to_screen (int) | \nDefault video display settings (available with v 5.6).\n Values:\n - 0 - Display video in original aspect ratio\n - 1 - Fit video to fill screen\n | \n
| \n | meeting_duration_limit (int) | \nSet meeting duration limit in minutes. Users will be shown a warning 2 minutes before the meeting duration is reached and the session is ended (available with v 5.6). | \n
| \n | meeting_duration_limit_enabled (bool) | \nEnable/disable meeting duration limit (available with v 5.6). | \n
| \n | meeting_duration_limit_redirect (string) | \nChoose whether to redirect users to a custom url or to the URLs they have defined on their branding screens. Set branding_url to use URLs from branding settings (available with v 5.6). | \n
| \n | unlimited_1_to_1_meetings (bool) | \nEnable/disable unlimited 1 to 1 meetings. Don't apply a meeting duration when 2 people are in a session. The time limitation will start when a third person enters or a recording is started. (available with v 5.6). | \n
| \n | allow_max_one_content_opened (bool) | \nAllow maximum one content opened. Thumbnail and Tiled modes will allow opening maximum one piece of content in the Stage. Fullscreen mode will not display content thumbnails to quickly access the previously open content. (available with v 5.30.0). | \n
| \n | available_roles (array) | \nAvailable roles. Possible values:\n- 1 - Speakers\n- 2 - Audience\n- 3 - Custom role\n (available with v 5.25.0). | \n
| \n | custom_role_name (string) | \nName of the custom role\n (available with v 5.25.0). | \n
| \n | chat_emoji_enabled (bool) | \nEnable chat emojis. (available with v 5.34.0) | \n
| \n | chat_emoji_reactions_enabled (bool) | \nEnable chat emoji reactions. (available with v 5.34.0) | \n
| \n | child_friendly_emoji_enabled (bool) | \nUse child friendly emoji set in the chat panel. (available with v 5.34.0) | \n
| \n | menu_buttons (array) | \nMenu Buttons Available in Session.\n Set one of allowed values to TRUE to show menu button, or to FALSE to hide that one.\n Leave this option EMPTY to use default menu settings.\n Allowed values:\n - screensharingitem (bool) - Show/Hide “Screen Sharing” item\n - inviteparticipantsitem (bool) - Show/Hide “Invite Participants” item\n - medialibrary (bool) - Show/Hide “Media Library” \n - camera (bool) - Show/Hide “Camera” item\n - options (bool) - Show/Hide “Options” item\n - recording (bool) - Show/Hide “Recording” item\n - notifications (bool) - Show/Hide “Notifications” item\n - microphone (bool) - Show/Hide “Microphone” item\n - endsession - (bool) - Show/Hide \"End Session\" item (available with v 5.33.0) | \n
| \n | components (array) | \nComponents Available in Session (available with v 4.4.4). Set one of allowed values to TRUE to show menu button, or to FALSE to hide that one.\nAllowed values:\n - chat (bool) - Show/Hide “Chat” component\n - notes (bool) - Show/Hide “Notes” component\n - poll (bool) - Show/Hide “Poll” component\n - qa (bool) - Show/Hide “Q & A” component\n - caption_stream (bool) - Show/Hide “Caption Stream” component (available with v 5.0.4 when caption stream feature is enabled on the server level)\n- live_streaming (bool) - Show/Hide \"Live Streaming\" component\n- forced_layouts (bool) - Show/Hide \"Forced layouts\" component\n- whiteboard (bool) - Show/Hide \"Whiteboard\" component (available with v 5.33.0)\n | \n
| \n | e2ee_support_enabled (bool) | \nEnable/disable E2EE support (available with v 5.38.0). | \n
| \n | permissions (array) | \n\nPermissions Available in Session (available with v 4.4.4). Use following format to set permissions:\n{\"allow_invite_users\": {\n \"moderator\": \"1\",\n \"participant\": \"0\"\n},\n\"allow_all_chat\": {\n \"moderator\": \"1\",\n \"participant\": \"1\"\n}}\nCheck “Session in-room permissions” table to see all possible permissions and default settings.\n | \n
| \n | voip_session_audio (string) | \nDefault Session Audio. Allowed values: phone, voip, hybrid. (available with v 4.3.2) | \n
| \n | voip_available_session_audio (array) | \nAvailable session audio options (available with v 5.0.5). Values: \n- phone (Using external phone audio, users will be required to dial-in via the telephone)\n- hybrid (Users will see a pop-up screen where they are given the choice to listen via their speakers or to dial-in via the telephone)\n- voip (Using flash-based internal audio) | \n
| \n | enable_bitrate_limit (bool) | \nEnable Total Room Publisher Bitrate Limit (TRPBL) (available with v 5.7). | \n
| \n | min_bitrate_cap (int) | \nHD OFF max bitrate. The max bitrate of the broadcaster's video (in kbit, eg 128), when the HD toggle is in the left OFF position. (available with v 5.7). | \n
| \n | min_bitrate_cap (int) | \nHD ON max bitrate. The max bitrate of the broadcaster's video (in kbit, eg 512), when the HD toggle is in the right ON position. (available with v 5.7). | \n
| \n | max_resolution (int) | \nMax resolution. The max resolution a broadcaster's video may reach (vertical pixel count, eg 720). Actual resolution will depend on available bandwidth, CPU, number of broadcasters and TRPBL. (available with v 5.7). | \n
| \n | min_bitrate_cap_screen_share (int) | \nScreen share HD OFF max bitrate. The max bitrate of the broadcaster's screen share (in kbit, eg 256), when the HD toggle is in the left OFF position. (available with v 5.7). | \n
| \n | max_bitrate_cap_screen_share (int) | \nScreen share HD ON max bitrate. The max bitrate of the broadcaster's screen share (in kbit, eg 1024), when the HD toggle is in the right ON position. (available with v 5.7). | \n
| \n | max_resolution_screen_share (int) | \nScreen share Max resolution. The max resolution a broadcaster's screen share may reach (vertical pixel count, eg 1080). Actual resolution will depend on available bandwidth, CPU, number of broadcasters and TRPBL. (available with v 5.7). | \n
| id (int) | \nThe id of the added entity. | \n
| message (str) | \nText messsage. | \n
Update service plan settings
\n| Required | \nid (int) | \nThe id of the service plan to be edited. | \n
| Optional | \nname (str) | \nThe name of service plan. | \n
| \n | description (str) | \nThe brief description for this service plan. | \n
| \n | user_limit (int) | \nThe simultaneous user connection limit across all sessions in this account. | \n
| \n | session_user_limit (int) | \nThe simultaneous user connection limit of any particular session in this account. | \n
| \n | recording_limit (int) | \nThe limit on number of recordings this account may store. | \n
| \n | filesize_limit (int) | \nThe limit on total filesize (in KB) of all files in this account's Media Library. | \n
| \n | broadcasters_limit (int) | \nNumber of users in any session of this account who may broadcast at the same time. | \n
| \n | modify_branding_enabled (bool) | \nAllow account holders to modify branding. | \n
| \n | modify_colors_enabled (bool) | \nAllow account holders to modify theme colors. Available when new flat-ui theme is enabled (available with v 4.4.5). | \n
| \n | advanced_sessions_enabled (bool) | \nEnable advanced scheduling features. | \n
| \n | mobile_access_enabled (bool) | \nEnable access from mobile applications. | \n
| \n | api_enabled (bool) | \nEnable access for API. | \n
| \n | session_registration_enabled (bool) | \nAllow account holders to enable registration and create an event page (Available with v 5.9.0). | \n
| \n | modify_permissions_enabled (bool) | \nAllow account holders to modify session permissions (available with v 4.4.4) | \n
| \n | chat_emoji_enabled (bool) | \nEnable chat emojis. (available with v 5.34.0) | \n
| \n | chat_emoji_reactions_enabled (bool) | \nEnable chat emoji reactions. (available with v 5.34.0) | \n
| \n | child_friendly_emoji_enabled (bool) | \nUse child friendly emoji set in the chat panel. (available with v 5.34.0) | \n
| \n | available_roles (array) | \nAvailable roles. Possible values:\n- 1 - Speakers\n- 2 - Audience\n- 3 - Custom role\n (available with v 5.25.0). | \n
| \n | custom_role_name (string) | \nName of the custom role\n (available with v 5.25.0). | \n
| \n | menu_buttons (array) | \nMenu Buttons Available in Session.\n Set one of allowed values to TRUE to show menu button, or to FALSE to hide that one.\n Leave this option EMPTY to use default menu settings.\n Allowed values:\n - screensharingitem (bool) - Show/Hide “Screen Sharing” item\n - inviteparticipantsitem (bool) - Show/Hide “Invite Participants” item\n - medialibrary (bool) - Show/Hide “Media Library” \n - camera (bool) - Show/Hide “Camera” item\n - options (bool) - Show/Hide “Options” item\n - recording (bool) - Show/Hide “Recording” item\n - notifications (bool) - Show/Hide “Notifications” item\n - microphone (bool) - Show/Hide “Microphone” item\n - endsession (bool) - Show/Hide \"End Session\" item(available with v 5.33.0)\n | \n
| \n | components (array) | \nComponents Available in Session (available with v 4.4.4). Set one of allowed values to TRUE to show menu button, or to FALSE to hide that one.\nAllowed values:\n - chat (bool) - Show/Hide “Chat” component\n - notes (bool) - Show/Hide “Notes” component\n - poll (bool) - Show/Hide “Poll” component\n - qa (bool) - Show/Hide “Q & A” component\n - caption_stream (bool) - Show/Hide “Caption Stream” component (available with v 5.0.4 when caption stream feature is enabled on the server level)\n- live_streaming (bool) - Show/Hide \"Live Streaming\" component\n- forced_layouts (bool) - Show/Hide \"Forced layouts\" component\n- whiteboard (bool) - Show/Hide \"Whiteboard\" component (available with v 5.33.0)\n | \n
| \n | permissions (array) | \n\nPermissions Available in Session (available with v 4.4.4). Use following format to set permissions:\n{\"allow_invite_users\": {\n \"moderator\": \"1\",\n \"participant\": \"0\"\n},\n\"allow_private_chat\": {\n \"moderator\": \"1\",\n \"participant\": \"1\"\n}}\nCheck “Session in-room permissions” table to see all possible permissions and default settings.\n | \n
| \n | voip_session_audio (string) | \nDefault Session Audio. Allowed values: phone, voip, hybrid. (available with v 4.3.2) | \n
| \n | voip_available_session_audio (array) | \nAvailable session audio options (available with v 5.0.5). Values: \n- phone (Using external phone audio, users will be required to dial-in via the telephone)\n- hybrid (Users will see a pop-up screen where they are given the choice to listen via their speakers or to dial-in via the telephone)\n- voip (Using flash-based internal audio) | \n
| id (int) | \nThe id of the updated entity. | \n
| message (str) | \nText messsage. | \n
Delete service plan.
\n| Required | \nid (int) | \nThe id of the service plan to be deleted. Note: the id may also be appended to the URL (.../id/xxx) instead of in the request body. | \n
| id (int) | \nThe id of the deleted entity. | \n
| message (str) | \nText messsage. | \n
Service Plans (available with v 4.3.1).
\nAdmin permissions required.
","_postman_id":"87188d21-cd1d-85a7-f732-b15ae719b9fa"},{"name":"Polls","item":[{"name":"/poll/id/[int]","id":"98fa8a7e-3e81-4520-8564-abfb35f8dd73","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Basic YWRtaW46c2FtYmEyMDAy"}],"url":"{{API_EndPoint}}/api/2/{{user_name}}/poll/id/1","description":"Get poll by given ID#
\n| Required | \nid (int) | \nID# of the poll to be returned. | \n
| id (int) | \nPoll ID#. | \n
| description (str) | \nPoll description. | \n
| session_id (int) | \nPoll session ID#. | \n
| group_id (int) | \nPoll group ID#. | \n
| is_multiple (int) | \nAllow to select multiple options. | \n
| is_anonymous_vote (int) | \nAllow anonymous vote. | \n
| share_results (int) | \nAllow to share poll results. | \n
| position (int) | \nPoll position. | \n
| options (bool) | \nArray of poll options. | \n
| status (str) | \nPoll status. | \n
| created_at (datetime) | \nPoll creation date. | \n
Get polls.
\n| Optional | \ncount (int) | \nSpecify number of returned results. Default is 100.\n | \n
| \n | offset (int) | \nSpecify to move the cursor through the recordset. Default is 0. | \n
| \n | order (str) | \nReturn results in ascending or descending order of recording ID (Depricated in 5.5). Default is asc. Accepted values: asc, desc\n | \n
| \n | order_field (str) | \nReturn results in order of this field (Available in 5.5). Default is id. \nAccepted values: id, name, description. | \n
| \n | order_dir (str) | \nReturn results in ascending or descending order (Available in 5.5). Default is desc. \nAccepted values: asc, desc. | \n
Add new poll
\n| Required | \ndescription (str) | \nPoll description. | \n
| \n | session_id(int) | \nSession ID#. | \n
| Optional | \ngroup_id (str) | \nGroup ID #. | \n
| \n | group (str) | \nGroup name (New group with this name will be created). | \n
| \n | is_multiple (int) | \nAllow to select multiple options (1/0). | \n
| \n | share_results (int) | \nAllow to share poll results (1/0) | \n
| \n | is_anonymous_vote (int) | \nAllow anonymous vote (1/0) | \n
| \n | position (int) | \nPoll position. | \n
| \n | options(bool) | \nArray of poll options.\n[{\n \"description\": \"Option #1\",\n \"color\": \"#C0C0C0\"\n}]\n | \n
| id (int) | \nThe id of the added entity. | \n
| message (str) | \nText messsage. | \n
Update poll settings
\n| Required | \nid (int) | \nThe id of the poll to be edited. | \n
| Optional | \ndescription (str) | \nPoll description. | \n
| \n | session_id(int) | \nSession ID#. | \n
| \n | group_id (str) | \nGroup ID #. | \n
| \n | group (str) | \nGroup name (New group with this name will be created). | \n
| \n | is_multiple (int) | \nAllow to select multiple options (1/0). | \n
| \n | share_results (int) | \nAllow to share poll results (1/0) | \n
| \n | is_anonymous_vote (int) | \nAllow anonymous vote (1/0) | \n
| \n | status (str) | \nPoll status (new, open or closed). | \n
| \n | position (int) | \nPoll position. | \n
| \n | options(bool) | \nArray of poll options.\n\n[{\n \"id\": 1, \n \"description\": \"Option #1\",\n \"color\": \"#C0C0C0\"\n}]\n\nNOTE: leave option id empty if you want to create new option.\n | \n
| id (int) | \nThe id of the updated entity. | \n
| message (str) | \nText messsage. | \n
Delete poll.
\n| Required | \nid (int) | \nThe id of the poll to be deleted. Note: the id may also be appended to the URL (.../id/xxx) instead of in the request body. | \n
| id (int) | \nThe id of the deleted entity. | \n
| message (str) | \nText messsage. | \n
Get poll group by given ID#
\n| Required | \nid (int) | \nID# of the group to be returned. | \n
| id (int) | \nThe ID# of poll group. | \n
| name (str) | \nGroup name. | \n
| status(str) | \nGroup status. | \n
Get poll groups.
\nAdd new poll group
\n| Required | \nname (str) | \nThe name of group. | \n
| id (int) | \nThe id of the added entity. | \n
| message (str) | \nText messsage. | \n
Update poll group
\n| Required | \nid (int) | \nThe id of the group to be edited. | \n
| Optional | \nname (str) | \nThe name of service plan. | \n
| \n | status (str) | \nGroup status (new, open or closed). | \n
| id (int) | \nThe id of the updated entity. | \n
| message (str) | \nText messsage. | \n
Delete poll group.
\n| Required | \nid (int) | \nThe id of the group to be deleted. Note: the id may also be appended to the URL (.../id/xxx) instead of in the request body. | \n
| id (int) | \nThe id of the deleted entity. | \n
| message (str) | \nText messsage. | \n
Poll Groups (available with v 5.38.0).
","_postman_id":"2ae06d9e-b009-4707-9f0f-46a4e196dd66"},{"name":"Session invitees","item":[{"name":"/invitees/id/[int]","id":"1c894e78-2905-046c-e131-4bf7adc4a3c3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"Get data of people invited to a session. All invitees are grouped into either speakers or audience users, depending on the role given to them when creating the session.
\n| Required | \nid (int) | \nThe id of the session for which invitees should be retrieved. | \n
| Optional | \nrole (string) | \nLimit the returned invitees to users holding a particular role in the session. \nPossible values: all, speakers, audience and custom (available with version 5.25.0). | \n
| id (int) | \nAccount id of the invitee. | \n
| first_name (str) | \nThe first name of the invited user. | \n
| last_name (str) | \nThe last name of the invited user. | \n
| email (str) | \nThe email address of the invited user. | \n
| personal_session_link (string) | \nA custom session link for this particular user. It is different from the session_link in GET sessions in that it does not prompt for a login, and will put the user into the session (with his username) with a single click. | \n
Get session invitees by email of the invited user (Available in v5.29.0).
\n| Required | \nemail (str) | \nThe email of the user for which invitees should be retrieved. | \n
| id (int) | \nId of the invited user. | \n
| session_id (int) | \nId of the session to which the user is invited. | \n
| first_name (str) | \nThe first name of the invited user. | \n
| last_name (str) | \nThe last name of the invited user. | \n
| email (str) | \nThe email address of the invited user. | \n
| personal_session_link (string) | \nA custom session link for this particular user. It is different from the session_link in GET sessions in that it does not prompt for a login, and will put the user into the session (with his username) with a single click. | \n
Get data of single person invited to a session. (available with version 4.2.9)
\n| Required | \nid (int) | \nThe id of the user for which invitees should be retrieved. | \n
| \n | session_id (int) | \nThe id of the session for which invitees should be retrieved. | \n
| id (int) | \nAccount id of the invitee. | \n
| first_name (str) | \nThe first name of the invited user. | \n
| last_name (str) | \nThe last name of the invited user. | \n
| role (str) | \nRole of invited person. Possible values: \n 1 => Speaker\n 2 => Audience\n | \n
| email (str) | \nThe email address of the invited user. | \n
| personal_session_link (string) | \nA custom session link for this particular user. It is different from the session_link in GET sessions in that it does not prompt for a login, and will put the user into the session (with his username) with a single click. | \n
Add an invitee to a session.
\n| Requred | \nsession_id (int) | \nID of the session to which invitee is added. | \n
| \n | email (str) | \nEmail address of the invitee. | \n
| Optional | \nfirst_name (str) | \nFirst name of the invitee. | \n
| \n | last_name (str) | \nLast name of the invitee. | \n
| \n | send_email_invitation (bool) | \nSet to false (or 0) to avoid sending a server-generated email invitation to the user. Default is true. Email invitations will be sent as soon as this call is made. If you want to send your own invitation emails, use GET recording_invitees to obtain the personal_link for each user.. | \n
| \n | role (int) | \nDefine role of the invitee in the session. Default is 2.\n1 = Speaker, \n2 = Audience.\n3 = Custom role (Available in v5.25.0)\n | \n
| \n | profile_image_url (str) | \nURL to profile image (Available in v5.33.0)\n | \n
| id (int) | \nAccount id of the invitee. | \n
| first_name (str) | \nThe first name of the invited user (Available in v5.1.7). | \n
| last_name (str) | \nThe last name of the invited user (Available in v5.1.7). | \n
| email (str) | \nThe email address of the invited user (Available in v5.1.7). | \n
| personal_session_link (string) | \nA custom session link for this particular user. It is different from the session_link in GET sessions in that it does not prompt for a login, and will put the user into the session (with his username) with a single click (Available in v5.1.7). | \n
Modify the role of an invitee to a session.
\n| Requred | \nsession_id (int) | \nID of the session to which invitee is added. | \n
| \n | user_id(int) | \nUser ID of the invitee. The PUT call returned this. | \n
| Optional | \nfirst_name (str) | \nThe first name of the invited user (Available in v5.37.0). | \n
| \n | last_name (str) | \nThe last name of the invited user (Available in v5.37.0). | \n
| \n | send_email_invitation (bool) | \nSet to false (or 0) to avoid sending a server-generated email invitation to the user. Default is true. Email invitations will be sent as soon as this call is made. If you want to send your own invitation emails, use GET recording_invitees to obtain the personal_link for each user.. | \n
| \n | role (int) | \nDefine role of the invitee in the session. Default is 2.\n1 = Speaker, \n2 = Audience,\n3 = Custom role (Available in v5.25.0).\n | \n
| \n | profile_image_url (str) | \nURL to profile image (Available in v5.33.0)\n | \n
| id (int) | \nAccount id of the invitee. | \n
| first_name (str) | \nThe first name of the invited user (Available in v5.1.7). | \n
| last_name (str) | \nThe last name of the invited user (Available in v5.1.7). | \n
| email (str) | \nThe email address of the invited user (Available in v5.1.7). | \n
| personal_session_link (string) | \nA custom session link for this particular user. It is different from the session_link in GET sessions in that it does not prompt for a login, and will put the user into the session (with his username) with a single click (Available in v5.1.7). | \n
Delete an invitee from a session.
\n| Requred | \nsession_id (int) | \nID of the session to which invitee is added. | \n
| \n | user_id (int) | \nUser ID of the invitee. | \n
| id (int) | \nThe id of deleted invitee. | \n
| message (str) | \nText messsage. | \n
Delete all invitees from a session (Available in v5.5.0).
\n| Requred | \nid (int) | \nID of the session to which invitees are added. | \n
| id (int) | \nID of the session. | \n
| message (str) | \nText messsage. | \n
Get data of people invited to a session. All invitees are grouped into either moderators, participants or observers, depending on the role given to them when creating the session (Available in v5.4.0).
\n| Required | \nid (int) | \nThe id of the session for which invitees should be retrieved. | \n
| Optional | \nrole (string) | \nLimit the returned invitees to users holding a particular role in the session. \nPossible values: all, speakers, audience and custom (Available in v5.25.0). | \n
| id (int) | \nAccount id of the invitee. | \n
| first_name (str) | \nThe first name of the invited user. | \n
| last_name (str) | \nThe last name of the invited user. | \n
| email (str) | \nThe email address of the invited user. | \n
| personal_session_link (string) | \nA custom session link for this particular user. It is different from the session_link in GET sessions in that it does not prompt for a login, and will put the user into the session (with his username) with a single click. | \n
Get data of single person invited to a session (Available in v5.4.0).
\n| Required | \nid (int) | \nThe id of the user for which invitees should be retrieved. | \n
| \n | session_id (int) | \nThe id of the session for which invitees should be retrieved. | \n
| id (int) | \nAccount id of the invitee. | \n
| first_name (str) | \nThe first name of the invited user. | \n
| last_name (str) | \nThe last name of the invited user. | \n
| role (str) | \nRole of invited person. Possible values: \n 1 => Moderator\n 2 => Participant\n 3 => Observer\n | \n
| email (str) | \nThe email address of the invited user. | \n
| personal_session_link (string) | \nA custom session link for this particular user. It is different from the session_link in GET sessions in that it does not prompt for a login, and will put the user into the session (with his username) with a single click. | \n
Add an invitee to a session (Available in v5.4.0).
\n| Requred | \nsession_id (int) | \nID of the session to which invitee is added. | \n
| \n | email (str) | \nEmail address of the invitee. | \n
| Optional | \nfirst_name (str) | \nFirst name of the invitee. | \n
| \n | last_name (str) | \nLast name of the invitee. | \n
| \n | send_email_invitation (bool) | \nSet to false (or 0) to avoid sending a server-generated email invitation to the user. Default is true. Email invitations will be sent as soon as this call is made. If you want to send your own invitation emails, use GET recording_invitees to obtain the personal_link for each user.. | \n
| \n | role (int) | \nDefine role of the invitee in the session. Default is 2.\n1 = Speaker, \n2 = Audience,\n3 = Custom role (Available in v5.25.0). | \n
| \n | profile_image_url (str) | \nURL to profile image (Available in v5.33.0)\n | \n
| id (int) | \nAccount id of the invitee. | \n
| first_name (str) | \nThe first name of the invited user (Available in v5.1.7). | \n
| last_name (str) | \nThe last name of the invited user (Available in v5.1.7). | \n
| email (str) | \nThe email address of the invited user (Available in v5.1.7). | \n
| personal_session_link (string) | \nA custom session link for this particular user. It is different from the session_link in GET sessions in that it does not prompt for a login, and will put the user into the session (with his username) with a single click (Available in v5.1.7). | \n
Modify the role of an invitee to a session (Available in v5.4.0).
\n| Requred | \nsession_id (int) | \nID of the session to which invitee is added. | \n
| \n | user_id(int) | \nUser ID of the invitee. The PUT call returned this. | \n
| Optional | \nfirst_name (str) | \nThe first name of the invited user (Available in v5.37.0). | \n
| \n | last_name (str) | \nThe last name of the invited user (Available in v5.37.0). | \n
| \n | send_email_invitation (bool) | \nSet to false (or 0) to avoid sending a server-generated email invitation to the user. Default is true. Email invitations will be sent as soon as this call is made. If you want to send your own invitation emails, use GET recording_invitees to obtain the personal_link for each user.. | \n
| \n | role (int) | \nDefine role of the invitee in the session. Default is 2.\n1 = Speaker, \n2 = Audience,\n3 = Custom role (Available in v5.25.0). | \n
| \n | profile_image_url (str) | \nURL to profile image (Available in v5.33.0)\n | \n
| id (int) | \nAccount id of the invitee. | \n
| first_name (str) | \nThe first name of the invited user (Available in v5.1.7). | \n
| last_name (str) | \nThe last name of the invited user (Available in v5.1.7). | \n
| email (str) | \nThe email address of the invited user (Available in v5.1.7). | \n
| personal_session_link (string) | \nA custom session link for this particular user. It is different from the session_link in GET sessions in that it does not prompt for a login, and will put the user into the session (with his username) with a single click (Available in v5.1.7). | \n
Delete an invitee from a session related to sub user account (Available in v5.4.0).
\n| Requred | \nsession_id (int) | \nID of the session to which invitee is added. | \n
| \n | user_id (int) | \nUser ID of the invitee. | \n
| id (int) | \nThe id of deleted invitee. | \n
| message (str) | \nText messsage. | \n
Delete all invitees from a session related to sub user account (Available in v5.5.0).
\n| Requred | \nid (int) | \nID of the session to which invitees are added. | \n
| id (int) | \nThe id of the session. | \n
| message (str) | \nText messsage. | \n
Get data of single pre-assigned breakout room. (available with version 5.12.0)
\n| Required | \nid (int) | \nThe id of pre-assigned breakout room. | \n
| id (int) | \nID of pre-assigned breakout room. | \n
| topic (str) | \nTopic of pre-assigned breakout room. | \n
| session_link (str) | \nURL of pre-assigned breakout room. | \n
| invitations (array) | \nArray of invited users\n | \n
invitations (array):
\n| user_id (int) | \nID of invited user. | \n
| first_name (str) | \nInvited user first name. | \n
| last_name (str) | \nInvited user last name. | \n
| email (str) | \nInvited user email.\n | \n
| personal_link (array) | \nPersonal join link\n | \n
Get data of pre-assigned breakout \n rooms (Available in v5.12.0).
\n| Required | \nsession_id (int) | \nThe id of the session for which pre-assigned breakout \n rooms should be retrieved. | \n
\nSee GET /breakouts/id/[int]\n
","urlObject":{"path":["api","2","{{user_name}}","breakouts","session_id","1"],"host":["{{API_EndPoint}}"],"query":[],"variable":[]}},"response":[{"id":"6c9ec3be-d97e-4c96-b3e9-42501d5b491e","name":"Response","originalRequest":{"method":"GET","header":[{"key":"Authorization","type":"text","name":"Authorization","value":"Basic YWRtaW46c2FtYmEyMDAy"}],"url":"{{API_EndPoint}}/api/2/{{user_name}}/breakouts/session_id/[int]"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"name":"Cache-Control","key":"Cache-Control","value":"no-store, no-cache, must-revalidate, post-check=0, pre-check=0","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Encoding","key":"Content-Encoding","value":"gzip","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/xml","description":""},{"name":"Date","key":"Date","value":"Thu, 01 Jun 2017 10:11:02 GMT","description":""},{"name":"Expires","key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT","description":""},{"name":"Pragma","key":"Pragma","value":"no-cache","description":""},{"name":"Server","key":"Server","value":"nginx/1.10.3","description":""},{"name":"Transfer-Encoding","key":"Transfer-Encoding","value":"chunked","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"PHP/5.4.30","description":""}],"cookie":[],"responseTime":null,"body":"See POST /breakouts
\n","urlObject":{"path":["api","2","{{user_name}}","breakouts"],"host":["{{API_EndPoint}}"],"query":[],"variable":[]}},"response":[{"id":"a70531e7-4e89-4b0a-a19a-ad0bfdc05129","name":"Response","originalRequest":{"method":"PUT","header":[{"key":"Authorization","type":"text","name":"Authorization","value":"Basic YWRtaW46c2FtYmEyMDAy"},{"key":"Content-Type","name":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"input_type=json&rest_data={\n\t\"session_id\":1,\n\t\"email\":\"robin@arsenal.com\",\n\t\"first_name\":\"Robin\", \n\t\"last_name\":\"van Persie\",\n\t\"send_email_invitation\":false,\n\t\"role\":1\n}"},"url":"{{API_EndPoint}}/api/2/{{user_name}}/invitee"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"name":"Cache-Control","key":"Cache-Control","value":"no-store, no-cache, must-revalidate, post-check=0, pre-check=0","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Encoding","key":"Content-Encoding","value":"gzip","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/xml","description":""},{"name":"Date","key":"Date","value":"Thu, 01 Jun 2017 10:49:41 GMT","description":""},{"name":"Expires","key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT","description":""},{"name":"Pragma","key":"Pragma","value":"no-cache","description":""},{"name":"Server","key":"Server","value":"nginx/1.10.3","description":""},{"name":"Transfer-Encoding","key":"Transfer-Encoding","value":"chunked","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"PHP/5.4.30","description":""}],"cookie":[],"responseTime":null,"body":"\nCreate pre-assigned breakout rooms.
\n| Requred | \nsession_id (int) | \nID of the session to which breakout rooms are added. | \n
| Requred | \n\n breakouts (array)\n | \nPre-assigned breakout rooms data. Data example:\n\n{\n \"id\": 1,\n \"topic\":\"Test breakout 1\",\n \"invitations\":[\n {\n \"user_id\": 1,\n \"first_name\":\"Fname1\",\n \"last_name\":\"Lname1\",\n \"email\":\"user1@email.com\"\n }\n ]\n}\n\n | \n
| Optional | \nsend_email_invitation (bool) | \nSet to false (or 0) to avoid sending a server-generated email invitation to the users. Default is 0. \n1 - send invitations to all users.\n2 - send invitations to new added users.\n | \n
breakouts (array):
\n| Requred | \ntopic (str) | \nBreakout room name. | \n
| Optional | \ninvitations (array) | \nArray of invited users. | \n
| \n | id (int) | \nID of the breakout session (Required when you want to update already added breakout room). | \n
invitations (array):
\n| Requred | \nfirst_name (str) | \nFirst name of invited user. | \n
| \n | last_name (str) | \nLast name of invited user. | \n
| \n | email (str) | \nEmail of invited user. | \n
| Optional | \nuser_id (int) | \nID of previously invited user (Required when you want to update invited user). | \n
Put empty array to clean up previously invited users.
\n| message (str) | \nText messsage. | \n
Delete pre-assigned breakout room by ID (Available in v5.12.0).
\n| Requred | \nid (int) | \nID of pre-assigned breakout room. | \n
| id (int) | \nID breakout room. | \n
| message (str) | \nText messsage. | \n
Delete all pre-assigned breakout rooms from a session (Available in v5.12.0).
\n| Requred | \nsession_id (int) | \nID of the session to which breakout rooms are added. | \n
| session_id (int) | \nID of the session. | \n
| message (str) | \nText messsage. | \n
Get session recurring settings (Available in v5.1.8).
\n| Required | \nsession_id (int) | \nThe id of the recurring session (The main session in the series). | \n
| session_id (int) | \nThe id of the recurring session (The main session in the series). | \n
| start_time (str) | \nThe start time of the first recurring session (series start time). | \n
| period (str) | \nRecurring period: day, week or month. | \n
| frequency (int) | \nRecurring frequency. | \n
| repeat_on (string) | \nWhen repeat session in selected period. Days of week for week period, or day of the month for month period. | \n
| end_date (date) | \nThe series end date. | \n
| end_occurrences (int) | \nNumber of sessions in the series. | \n
| id (int) | \nThe id of the recurring session. | \n
| start_date (date) | \nThe start date of the recurring session. | \n
Make recurring session series (Available in v5.1.8).
\n| Required | \nsession_id (int) | \nThe id of the recurring session (The main session in the series). | \n
| \n | period (str) | \nRecurring period: day, week or month. | \n
| \n | frequency (int) | \nRecurring frequency. Repeat every [frequency] period. For example: set 2 to repeat every 2 week, or set 5 to repeat session onse in 5 days. | \n
| \n | end_date (date) | \nThe series end date. Should be date up to 6 months into the future. | \n
| Optional | \nend_occurrences (int) | \nNumber of sessions in the series (this argument required when end_date is empty). | \n
| \n | repeat_on (string) | \n\n Set when repeat session in selected period. Days of week for week period, or day of the month for month period (this argument is accepted for week or month periods only).\n Weeks: 1 = Mon, 2 = Tue, 3 = Wed, 4 = Thu, 5 = Fri, 6 = Sat, 7 = Sun. You should select one or few week days. \"5\" - repeat session every Friday, \"1,3,5\" - repeat session every Monday, Wednesday and Friday.\n Months: monthday = Repeat every day of month, weekday = Repeat every week day of the week.\n | \n
| \n | type (string) | \nPossible values:\n - reuse: re-use same session (default)\n - duplicate: create new session for each \n (Available in v5.1.9)\n | \n
| id (int) | \nThe id of the recurring session. | \n
| start_date (date) | \nThe start date of the recurring session. | \n
Update recurring session shedule (Available in v5.1.8).
\n| Required | \nsession_id (int) | \nThe id of the recurring session (The main session in the series). | \n
| \n | period (str) | \nRecurring period: day, week or month. | \n
| \n | frequency (int) | \nRecurring frequency. Repeat every [frequency] period. For example: set 2 to repeat every 2 week, or set 5 to repeat session onse in 5 days. | \n
| \n | end_date (date) | \nThe series end date. Should be date up to 6 months into the future. | \n
| Optional | \nend_occurrences (int) | \nNumber of sessions in the series (this argument required when end_date is empty). | \n
| \n | repeat_on (string) | \n\n Set when repeat session in selected period. Days of week for week period, or day of the month for month period (this argument is accepted for week or month periods only).\n Weeks: 1 = Mon, 2 = Tue, 3 = Wed, 4 = Thu, 5 = Fri, 6 = Sat, 7 = Sun. You should select one or few week days. \"5\" - repeat session every Friday, \"1,3,5\" - repeat session every Monday, Wednesday and Friday.\n Months: monthday = Repeat every day of month, weekday = Repeat every week day of the week.\n | \n
| \n | type (string) | \nPossible values:\n - reuse: re-use same session (default)\n - duplicate: create new session for each \n (Available in v5.1.9)\n | \n
| id (int) | \nThe id of the recurring session. | \n
| start_date (date) | \nThe start date of the recurring session. | \n
Delete recurring sessions and convert main session in the series to regular session (Available in v5.1.8).
\n| Requred | \nsession_id (int) | \nThe id of the recurring session (The main session in the series). | \n
| session_id (int) | \nThe id of the recurring session (The main session in the series). | \n
| message (str) | \nText messsage. | \n
Return session data by given ID#.
\n\n| Requred | id (int) | id of the session to be returned. |
| id (int) | The id of the edited recording. |
| topic (str) | The name or title of this session. |
| start_time (datetime) | The datetime string of when this session will take or has taken place. Will always default to the user’s timezone & DST settings. |
| duration (int) | Duration of the meeting, in minutes (The meeting will not automatically end after the specified duration; this setting fits only scheduling purposes). |
| password (str) | The session’s access password, required to join. None, if empty. |
| session_link (str) | Full link to the session. If friendly_url is NULL, session_key is used. |
| custom_data(array) | An array of objects containing custom fields in the form of custom1, custom2 etc. |
Return sub account session's data by given ID#. Available with version 5.2.1.
\n\n| Requred | id (int) | id of the session to be returned. |
| id (int) | The id of the edited recording. |
| topic (str) | The name or title of this session. |
| start_time (datetime) | The datetime string of when this session will take or has taken place. Will always default to the user’s timezone & DST settings. |
| duration (int) | Duration of the meeting, in minutes (The meeting will not automatically end after the specified duration; this setting fits only scheduling purposes). |
| password (str) | The session’s access password, required to join. None, if empty. |
| session_link (str) | Full link to the session. If friendly_url is NULL, session_key is used. |
| custom_data(array) | An array of objects containing custom fields in the form of custom1, custom2 etc. |
Return list of sessions.
\n| Optional | \ncount(int) | \nSpecify number of returned results. Default is 100. | \n
| \n | offset(int) | \nSpecify to move the cursor through the recordset. Default is 0. | \n
| \n | order(str) | \nReturn results in ascending or descending order of session ID (Depricated in 5.5). Default is asc. \nAccepted values: asc, desc. | \n
| \n | order_field (str) | \nReturn results in order of this field (Available in 5.5). Default is id. \nAccepted values: id, topic, start_time, duration, friendly_url, type, advanced_mode. | \n
| \n | order_dir (str) | \nReturn results in ascending or descending order (Available in 5.5). Default is desc. \nAccepted values: asc, desc. | \n
| \n | return (str) | \nSpecify what fieldset should be in the results.\nExample: id;topic;start_time (field names separated by semicolons). | \n
See GET /session/id/[int] method.
Return list of sessions related to sub account. Available with version 5.2.1.
\n| Required | \nuser_id(int) | \nID of child user. | \n
| Optional | \ncount(int) | \nSpecify number of returned results. Default is 100. | \n
| \n | offset(int) | \nSpecify to move the cursor through the recordset. Default is 0. | \n
| \n | order(str) | \nReturn results in ascending or descending order of session ID. Default is asc. \nAccepted values: asc, desc. | \n
| \n | return (str) | \nSpecify what fieldset should be in the results.\nExample: id;topic;start_time (field names separated by semicolons). Available from 5.5. | \n
See GET /session/id/[int] method.
Get invited sessions associated with this user account. Available with version 4.2.4.
\n| Optional | \ncount(int) | \nSpecify number of returned results. Default is 100. | \n
| \n | offset(int) | \nSpecify to move the cursor through the recordset. Default is 0. | \n
| \n | order(str) | \nReturn results in ascending or descending order of session ID. Default is asc. \nAccepted values: asc, desc. | \n
See GET /session/id/[int] method.
Create a new session
\n| Required | \ntopic (str) | \nThe title of the meeting. | \n
| \n | duration (int) | \nDuration of the meeting, in minutes (The meeting will not automatically end after the specified duration; this setting fits only scheduling purposes). | \n
| \n | start_time (datetime) | \nStart time in datetime format eg \"2010-08-31 11:05:00\". Will always default to the user’s timezone & DST settings.See the \"Timezones\" section for more info. | \n
| Optional | \nfriendly_url (str) | \nDefine a friendly URL segment to be used instead of auto-generated rather than encrypted meeting ID. | \n
| \n | password (str) | \nTo password protect the meeting define this. | \n
| \n | invited_participants (array) | \nJSON array of users who should receive an email invitation, in the following format:[\n {\n \"id\": \"1\",\n \"email\": \"email@domain.com\",\n \"first_name\": \"First Name\",\n \"last_name\": \"Last Name\",\n \"role\": 1,\n \"send_email_invitation\": false\n }\n]role (int): Defines the user’s status in the meeting: \n - 1 - Speaker, \n - 2 - Audience,\n - 3 - Custom Role (available with v 5.25.0).\n | \n
| \n | send_email_invitations (bool) | \nSet to false (or 0) to avoid sending a server-generated email invitation to the user. Default is true. Email invitations will be sent as soon as this call is made. If you want to send your own invitation emails, use GET invitees to obtain the personal_session_link for each user. | \n
| \n | custom_data (array) | \nJSON array of custom data, in the following formats:[\n {\n \"custom1\": \"custom value 1\",\n \"custom2\": \"custom value 2\",\n \"custom3\": \"custom value 3\"\n }\n]You may add additional custom fields (custom4 and beyond), provided the field name is in the format “customX” where X is an integer incremented by 1.\n Custom value is varchar(200).\n | \n
Available since version 4.2.3 and only if advanced scheduling features are enabled in Product Admin (via UI only). These parameters mimic the options available when creating a session in the web-interface and clicking “Advanced options”.
\nAdvanced params are available in PUT and POST session API methods
\n| Required | \nadvanced_mode (bool) | \nSet to true to enable advanced params for this session. Default is false. | \n
| Optional | \nprevent_user_count (bool) | \nSet to true to hide the user count from audience users. Speakers can always see this number. Default is false. | \n
| \n | save_contacts_to_ab (bool) | \nSet to true to save invitees to your Address Book. Default is false. | \n
| \n | display_participant_name (str) | \nSet format of participant names in the meeting room (available with v 5.5.0). Allowed values:\n - full_name - Full Name (Emily Harper)\n - user_id - User Id (User 123456)\n - last_name_first_name - Last Name, First Name (Harper, Emily)\n - first_name_initial - First Name + Initial (Emily H.)\n - initial_last_name - Initial + Last Name (E. Harper)\n - first_name - First Name only (Emily)\n - last_name - Last Name only (Harper)\n - initials - Initials only (E. H.)\n | \n
| \n | hide_recording_notifications (bool) | \nSet this param to true to remove all UI notifications from recordings. The MP4 files will not contain notifications (available with v 5.5.0). | \n
| \n | all_day (bool) | \nSet this param to true when session should take all day (available with v 5.1.5). | \n
| \n | attach_calendar_file (int) | \nSelect ICS attacments mode (available with v 5.1.5).\n Allowed values:\n - 0 - Do not attach or link a calendar file to the invitation email\n - 1 - Attach a calendar file to the invitation email\n - 2 - Add a link to the calendar file to the invitation email\n | \n
| \n | description (text) | \nDescription of the session. | \n
| \n | agenda (text) | \nAgenda of the session. | \n
| \n | display_custom_instructions (bool) | \nSet to true to display custom instructions for participants. | \n
| \n | custom_instructions (text) | \nCustom instructions for participants, these will be displayed on the session login page. | \n
| \n | guests_join_as (int) | \nSet the default role for guests that have not been specifically invited and given a role then: \n - 1 - Speaker, \n - 2 - Audience, \n - 3 - Cutom Role (available with v 5.25.0). \n Default is Audience.\n | \n
| \n | access_enable_lobby (bool) | \nThis option puts non-moderators in a lobby until moderators allow them to enter the session. Not available when the teleconference option is selected | \n
| \n | access_enable_breakout_rooms (bool) | \nAllow participants to disperse into smaller groups while in session. Not available when the teleconference option is selected | \n
| \n | access_allow_everyone_to_broadcast(bool) | \nAllow all users to broadcast on Breakout Room start; otherwise inherit permissions as set in the Main Room (available with v 5.32.0) | \n
| \n | access_allow_choose_breakout_room (bool) | \nAllow audience users to freely move around breakout rooms (available with v 5.36.0) | \n
| \n | access_guest_login_fields (array) | \nList of optional fields on session login form. Allowed fields: email, company. Format: [\"email\",\"company\"](available with v 5.0.2) | \n
| \n | access_before_start (numeric) | \nRestrict early access. (available with v 5.1.5) | \n
| \n | access_public_visibity (numeric) | \nMake visible on your public page. Users will be able to join and/or register for your sessions through a public page (available with v 5.1.5).\n Allowed values:\n - 0 - Session isn't visible on public pages\n - 1 - Session is visible on your public page\n - 2 - Session is visible on company public page (for company accounts only)\n - 3 - Session is visible on both public pages (for company accounts only)\n | \n
| \n | access_chat_emoji_enabled (bool) | \nEnable chat emojis. (available with v 5.34.0) | \n
| \n | access_chat_emoji_reactions_enabled (bool) | \nEnable chat emoji reactions. (available with v 5.34.0) | \n
| \n | private_access (bool) | \nSet to true to allow access only to users who have registered or been invited. Default is false (any user with the URL may join, subject to knowing the session password, if defined) | \n
| \n | av_auto_broadcast_speakers (bool) | \nAutomatically start audio and video broadcast of Speakers when they enter, if they have broadcast permissions (available with v 5.5.0) | \n
| \n | av_auto_broadcast_audience (bool) | \nAutomatically start audio and video broadcast of Audience when they enter, if they have broadcast permissions \n (available with v 5.5.0) | \n
| \n | av_voip_audio (str) | \nSession Audio. Allowed values: phone, voip, hybrid. (available with v 4.3.2). Only \"voip\" session audio allowed when break-out rooms are enabled (access_enable_breakout_rooms param) | \n
| \n | av_allow_max_one_content_opened (bool) | \nAllow maximum one content opened. Thumbnail and Tiled modes will allow opening maximum one piece of content in the Stage. Fullscreen mode will not display content thumbnails to quickly access the previously open content. (available with v 5.30.0). | \n
| \n | av_e2ee_support_enabled (bool) | \nEnable/disable E2EE (available with v 5.38.0). | \n
| \n | register_require (bool) | \nSet to (0) no registration form (1) allow registration or (2) require registration | \n
| \n | register_friendly_url (str) | \nDefine the friendly URL segment of the registration page eg: www.domain.com/register/[username]/[friendlyurl] | \n
| \n | register_limit_register (int) | \nLimit number of users that can register to this session to this number. Default is unlimited. | \n
| \n | register_close_register (int) | \nTime, in minutes, before the start time of the session, at which to no longer accept registrations. Default is 0. | \n
| \n | register_password_to_registration (str) | \nSet to true to require users to enter a password before being able to register for the event. | \n
| \n | register_end_of_registration (str) | \nSet to true to show a custom message to users after they registered. | \n
| \n | register_end_of_registration_value (str) | \nCustom message to display to users after they registered (if previous param is true). | \n
| \n | register_fields (array) | \nJSON array of fields in registration form.\n Default fields: first_name, last_name and email\n Format:\n[\n { \n \"field_name\": \"phone\",\n \"show\": 1, \n \"required\": 1 \n },\n { \n \"field_name\": \"custom_field_2\",\n \"field_title\": \"custom radio\",\n \"field_type\": \"radio\",\n \"options\": [\"radio 1\", \"radio 2\"],\n \"selected\": 2\n }\n]field_name: name of field. you can you one of standard field names ('first_name, last_name, email, phone, job_title, company, address, city, postcode, country, website, industry) or add custom fields (custom_field_{number}).\n show: 1/0\n required: 1/0\n field_type: text, textarea, radio, checkbox or select (select type available with v 5.0.5 only)\n options: array of option titles (only for radio, checkbox or select fields)\n selected: number of selected option (only for radio or checkbox files)\n | \n
| \n | invitations_send_reminder_first (int) | \nSet to number of time units before the start of the event when the first reminder email should be sent. | \n
| \n | invitations_send_reminder_first_interval (str) | \nDefine time units for previous parameter, possible choices “minutes”, “hours”, “days”. | \n
| \n | invitations_send_reminder_second (int) | \nSet to number of time units before the start of the event when the second reminder email should be sent. | \n
| \n | invitations_send_reminder_second_interval (str) | \nDefine time units for previous parameter, possible choices “minutes”, “hours”, “days”. | \n
| \n | invitations_reminder_content_first (str) | \nTextual content of the first reminder email. This field supports placeholders. | \n
| \n | invitations_reminder_content_second (str) | \nTextual content of the second reminder email. This field supports placeholders. | \n
| \n | invitations_attendees_content (str) | \nTextual content of the email that is sent to attendees of the event. This field supports placeholders. | \n
| \n | invitations_absentees_content (str) | \nTextual content of the email that is sent to absentees of the event. This field supports placeholders. | \n
| \n | invitations_first_reminder_send_to_myself (bool) | \nSet to true to send yourself (= the Account Holder) a copy of the first reminder email. | \n
| \n | invitations_second_reminder_send_to_myself (bool) | \nSet to true to send yourself (= the Account Holder) a copy of the second reminder email. | \n
| \n | invitations_attendees_send_to_myself (bool) | \nSet to true to send yourself (= the Account Holder) a copy of the attendee email. | \n
| \n | invitations_absentees_send_to_myself (bool) | \nSet to true to send yourself (= the Account Holder) a copy of the absentee email. | \n
| \n | send_join_links_to_myself (bool) | \nSet to true to send yourself (= the Account Holder) a CSV file with the join links of all invitees (available with v 5.5.0). | \n
| \n | invitations_content (str) | \nCustom content of the invitation email (replaces the default invitation email).\n This field supports placeholders. | \n
| \n | caption_stream_event_id (str) | \nCaption event ID (available with v 5.0.4 when caption stream feature is enabled on the server level) | \n
| \n | live_stream_endpoint (str) | \nLive stream ffmpeg endpoint URL (available with v 5.3.0) | \n
| \n | menu_buttons (array) | \nMenu Buttons Available in Session (not available since v5.39.0). | \n
| \n | branding (array) | \nUpload a custom image to override the default image defined in the Branding area (available with v 4.3.9)\n Allowed values:\n - email_header - URL to Event Photo image. Dimensions: 240px wide, 180px high. Format: gif, jpg, png. Filesize: Max 1024KB.\n - email_footer - URL to Email Header image. Maximum dimensions: 600px wide, 600px high. Format: png (transparent background recommended). Filesize: Max 1024KB.\n - event_photo - URL to Email Footer image. Maximum dimensions: 600px wide, 600px high. Format: png (transparent background recommended). Filesize: Max 1024KB.\n | \n
| id (int) | \nThe id of the newly created session. | \n
| message (str) | \nText messsage. | \n
Create a new session
\n