{"info":{"_postman_id":"5a628ba8-8a4f-4cb5-8da6-97004e0084e7","name":"KeyMeeting REST API v1","description":"

API Documentation For KeyMeeting

\n\n

Quickstart

\n\n

The KeyMeeting API is a RESTful Web Service.

\n\n

It 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\n

Examples given here are provided for the PHP programming language and uses cURL to make the HTTP requests.

\n\n

Important points:

\n\n
  1. According to the HTTP specification, when making GET requests, all parameters must be passed as URL/querystring parameters.
  2. 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.
  3. The data format of the request body must either:
    a. contain name/value pairs such as id=1&var2=val2 or,

    b. 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 as
    input_type=json&rest_data={\"id\":\"1\",\"var2\":\"val2\"}
    Most developers will find the JSON approach more 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.
    We are working to 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.
  4. All special characters (+, $, <, >, ect) in rest_data array should be urlencoded. You can use urlencode PHP function, or similar.
\n\n

How to use HTTP Basic Auth while developing and debugging

\n\n


To access the KeyMeeting 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:

\n\n

Authorization: Basic bWF0dGhpYXM6YWWtaW4=

\n\n

The encrypted string must be a base64 encoded combination of username and password in the following format:

\n\n

myUsername:myPassword

\n\n

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.

\n\n

Essential Tools:

\n\n \n

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

Essential Reading:

\n\n \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

General Definitions

\n\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

\n\n


[username] - The username of the account which is making the API requests.
Example: GET http://domain.com/api/[ver]/johndoe/authverify

\n\n

HTTP Error Codes

\n\n

400 “Bad Request”

\n\n


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.

\n\n \n

Example: Providing an alphabetic value of “abcd” for an integer parameter, such as “offset”.

\n

401 “Unauthorized”

\n\n

Returned 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

404 “Not Found”

\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.

\n\n


Example: Trying to retrieve a non-existing user.

\n\n

405 “Method Not Allowed”

\n\n

Returned when the client tries to use an HTTP method which this particular resource doesn’t support.

\n\n

Example: Trying to PUT or DELETE a read-only resource.

\n\n

409 “Conflict”

\n\n

Returned when providing input during a PUT operation which would cause the resource state to conflict with some other resource.

\n\n

Example: Trying to change your username to a name that’s already taken. Trying to delete a folder that is not empty.

\n\n

410 “Gone”

\n\n

Returned 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\n

500 “Internal Server Error”

\n\n

There is a problem on the server side.

\n\n

HTTP Success Codes

\n\n

200 “OK”

\n\n

Returned 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\n

201 “Created”

\n\n

When 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\n

301 “Moved Permanently”

\n\n

Sometimes 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\n

Return Formatting

\n\n

The KeyMeeting API supports a number of different return formats.

\n\n

By 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.

\n\n

Available formats and how to request them:

\n\n
Format
URL Parameter
Sample return
xml
none (default) or /format/xml
\n
<xml>\n
  <item>\n
    <id>1</id>\n
    <login>username</login>\n
    <email>email@domain.com</email>\n
    <first_name>First Name</first_name>\n
    <last_name>Last Name</last_name>\n
    [...]\n
  </item>\n
</xml>\n
json
/format/json
[\n
      {\n
            \"id\": \"1\",\n
            \"login\": \"username\",\n
            \"email\": \"email@domain.com\",\n
            \"first_name\": \"First Name\",\n
            \"last_name\": \"Last Name\",\n
            [...]\n
      }\n
]\n
serialize
/format/serialize
a:1:\n
{\n
    i:0;a:5:\n
    {\n
        s:2:\"id\";\n
        s:1:\"1\";\n
        s:5:\"login\";\n
        s:8:\"username\";\n
        s:5:\"email\";\n
        s:16:\"email@domain.com\";\n
        s:10:\"first_name\";\n
        s:10:\"First Name\";\n
        s:9:\"last_name\";\n
        s:9:\"Last Name\";\n
        [...]\n
    }\n
}\n
php
(can be used in eval)
/format/php
array (\n
  0 =>\n
  array (\n
    'id' => '1',\n
    'login' => 'username',\n
    'email' => 'email@domain.com',\n
    'first_name' => 'First Name',\n
    'last_name' => 'Last Name',\n
    [...]\n
  )\n
)\n
html
/format/html
<table border=\"0\" cellpadding=\"4\" cellspacing=\"0\">\n
    <tr>\n
        <th>id</th>\n
        <th>login</th>\n
        <th>email</th>\n
        <th>first_name</th>\n
        <th>last_name</th>\n
        <th>[...]</th>\n
    </tr>\n
    <tr>\n
        <td>1</td>\n
        <td>username</td>\n
        <td>email@domain.com</td>\n
        <td>First Name</td>\n
        <td>Last Name</td>\n
        <td>[...]</td>\n
    </tr>\n
</table>\n
csv
/format/csv
id,login,email,first_name,last_name,[...]\n
1,\"username\",\"email@domain.com\",\"First Name\",\"Last Name\",[...]\n
","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"8252734","collectionId":"5a628ba8-8a4f-4cb5-8da6-97004e0084e7","publishedId":"SVfUrmif","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2019-09-04T13:46:50.000Z"},"item":[{"name":"Authentication","item":[{"name":"/authverify","id":"4e8f6644-4d16-4716-85ef-b43a850058a6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}],"advancedConfig":[{"key":"saveHelperData","value":""},{"key":"showPassword","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Basic YWRtaW46c2FtYmEyMDAy"}],"url":"{{API_EndPoint}}/api/2/{{user_name}}/authverify","description":"

Use to test if the auth credentials passed with HTTP Basic are valid.

\n\n

Return Arguments

\n\n \n \n \n \n
authenticated (bool)If 1/true, credentials are valid..
","urlObject":{"path":["api","2","{{user_name}}","authverify"],"host":["{{API_EndPoint}}"],"query":[],"variable":[]}},"response":[{"id":"687a33d4-dd67-4008-b9cd-b6e5eeab42f8","name":"Response","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic YWRtaW46c2FtYmEyMDAy","warning":""}],"url":"{{API_EndPoint}}/api/2/{{user_name}}/authverify"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate, post-check=0, pre-check=0","name":"Cache-Control","description":""},{"key":"Connection","value":"keep-alive","name":"Connection","description":""},{"key":"Content-Encoding","value":"gzip","name":"Content-Encoding","description":""},{"key":"Content-Type","value":"application/xml","name":"Content-Type","description":""},{"key":"Date","value":"Tue, 06 Jun 2017 17:08:50 GMT","name":"Date","description":""},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT","name":"Expires","description":""},{"key":"Pragma","value":"no-cache","name":"Pragma","description":""},{"key":"Server","value":"nginx/1.10.3","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""},{"key":"X-Powered-By","value":"PHP/5.4.30","name":"X-Powered-By","description":""}],"cookie":[],"responseTime":null,"body":"\n\n 1\n You are authorized to use the API\n"}],"_postman_id":"4e8f6644-4d16-4716-85ef-b43a850058a6"}],"id":"b266dbfa-6464-45c8-a7ae-18af12ebea8b","_postman_id":"b266dbfa-6464-45c8-a7ae-18af12ebea8b","description":""},{"name":"Branding","item":[{"name":"branding/id/[int]","id":"48c52222-1ae5-4c98-be7d-51cddc1cdd1e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}],"advancedConfig":[{"key":"saveHelperData","value":""},{"key":"showPassword","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Basic YWRtaW46c2FtYmEyMDAy"}],"url":"{{API_EndPoint}}/api/2/{{user_name}}/branding/id/1","description":"

Get branding options by provides user ID #

\n

Arguments

\n\n \n \n \n \n \n
Requiredid (int)ID# of user account.
\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
Requireduser_id (str)ID# of user account.
Optionalsession_login (str)URL to Session Login Page image.\n Dimensions: 275px wide, 46px high. Format: gif, jpg, png (transparent background recommended). Filesize: Max 256KB.\n
 top_of_account (str)URL to Top of Account Center image. Dimensions: 264px wide, 51px high. Format: gif, jpg, png (transparent background recommended). Filesize: Max 256KB.\n
  intro_screen (ttr)URL to Dashboard Welcome Image. Dimensions: 156px wide, 156px high. Format: gif, jpg, png. Filesize: Max 256KB. (Available in v4.4.5)\n
 in_room_logo (str)\n URL to In Room Logo image.\n Dimensions: 200px wide, 28px high. Format: png (transparent background recommended). Filesize: Max 256KB.\n
 in_room_logo_html5 (str)URL 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
 mobile_landing_logo (str)URL to the Mobile Landing Page image. Dimensions: 420px wide, 100px high. Format: png (transparent background recommended). Filesize: Max 512KB.\n
 splash_screen (str)URL to Splash Screen image.\n Dimensions: 728px wide, 216px high. Format: png (transparent background recommended). Filesize: Max 512KB.\n
 background (str)URL to Background image.\n No restrictions. Format: gif, jpg, png. Filesize: Max 1024KB\n
 event_header (str)URL to event header image.\n Maximum Dimensions: 300px wide, 50px high. Format: gif, jpg, png. Filesize: Max 512KB. (Available in v5.0.2)\n
 event_photo (str)URL to event Photo image.\n Dimensions: 240px wide, 180px high. Format: gif, jpg, png. Filesize: Max 1024KB.\n
 sharing_logo (str)URL 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
 email_header (int)URL to Email Header image.\n Maximum dimensions: 600px wide, 600px high. Format: png (transparent background recommended). Filesize: Max 1024KB.\n
 email_footer (str)URL to Email Footer image.\n Maximum dimensions: 600px wide, 600px high. Format: png (transparent background recommended). Filesize: Max 1024KB.\n
 moderator_redirect_url (str)Moderator Redirect URL. At the end of the session, moderators are redirected to this URL.
 guest_redirect_url (str)Guest Redirect URL. At the end of the session, guest participants are redirected to this URL.\n
 lobby_image (str)URL to inroom lobby image (Available in v4.3.9).\n Maximum dimensions: 800px wide, 430px high. Format: png (transparent background recommended). Filesize: Max 1024KB.\n
 lobby_music (str)URL to inroom lobby music (Available in v4.3.9)\n Format: MP3.\n Filesize: Max 3MB.\n
 lobby_text (str)Lobby text (Available in v4.3.9). Maximum 200 letters\n
\n

Return Arguments

","urlObject":{"path":["api","2","{{user_name}}","branding","id","1"],"host":["{{API_EndPoint}}"],"query":[],"variable":[]}},"response":[{"id":"9fbb77da-a6a6-4dea-8b28-f4e6d81cb0ef","name":"Responce","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic YWRtaW46c2FtYmEyMDAy"}],"url":"{{API_EndPoint}}/api/2/{{user_name}}/branding/id/[int]"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate, post-check=0, pre-check=0","name":"Cache-Control","description":""},{"key":"Connection","value":"keep-alive","name":"Connection","description":""},{"key":"Content-Encoding","value":"gzip","name":"Content-Encoding","description":""},{"key":"Content-Type","value":"application/xml","name":"Content-Type","description":""},{"key":"Date","value":"Tue, 09 May 2017 08:45:03 GMT","name":"Date","description":""},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT","name":"Expires","description":""},{"key":"Pragma","value":"no-cache","name":"Pragma","description":""},{"key":"Server","value":"nginx/1.10.3","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""},{"key":"X-Powered-By","value":"PHP/5.4.30","name":"X-Powered-By","description":""}],"cookie":[],"responseTime":null,"body":"\n\n 1\n http://domain.com/storage/users/1/flat_ui_branding_session_login.png\n http://domain.com/themes/flat_ui/images/no_branding/top_of_account.png\n http://domain.com/themes/flat_ui/images/no_branding/intro_screen.png\n http://domain.com/storage/users/1/flat_ui_branding_in_room_logo.png\n http://domain.com/themes/flat_ui/images/custom_branding/in_room_logo_retina.png\n http://domain.com/themes/flat_ui/images/no_branding/mobile_landing_logo.png\n http://domain.com/themes/flat_ui/images/custom_branding/splash_screen.png\n http://domain.com/themes/flat_ui/images/no_branding/background.png\n http://domain.com/themes/flat_ui/images/custom_branding/event_header.png\n http://domain.com/themes/flat_ui/images/custom_branding/event_photo.png\n http://domain.com/themes/flat_ui/images/custom_branding/sharing_logo.png\n http://domain.com/storage/users/1/flat_ui_branding_email_header.png\n http://domain.com/themes/flat_ui/images/no_branding/emails/footer.png\n http://domain.com/themes/flat_ui/images/no_branding/lobby_image.png\n \n http://www.domain.com/moderator-thank-you-for-attending\n http://www.domain.com/guest-thank-you-for-attending\n tl\n \n"}],"_postman_id":"48c52222-1ae5-4c98-be7d-51cddc1cdd1e"},{"name":"/branding","id":"da7395d1-f734-403a-bab0-def20b3328e3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","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.keymeeting.it/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

\n

Arguments

\n

See POST /branding

","urlObject":{"path":["api","2","{{user_name}}","branding"],"host":["{{API_EndPoint}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"da7395d1-f734-403a-bab0-def20b3328e3"},{"name":"/branding","id":"d02ff8b7-8ec3-492a-a220-cfbc65e0a133","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.keymeeting.it/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

\n

NOTE: This method is alias of PUT /branding.

\n

Arguments

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
Requireduser_id (str)ID# of user account.
Optionalsession_login (str)URL to Session Login Page image.\n Dimensions: 275px wide, 46px high. Format: gif, jpg, png (transparent background recommended). Filesize: Max 256KB.\n
 top_of_account (str)URL to Top of Account Center image. Dimensions: 264px wide, 51px high. Format: gif, jpg, png (transparent background recommended). Filesize: Max 256KB.\n
  intro_screen (ttr)URL to Dashboard Welcome Image. Dimensions: 156px wide, 156px high. Format: gif, jpg, png. Filesize: Max 256KB. (Available in v4.4.5)\n
 in_room_logo (str)\n URL to In Room Logo image.\n Dimensions: 200px wide, 28px high. Format: png (transparent background recommended). Filesize: Max 256KB.\n
 in_room_logo_retina (str)URL to In Room Logo image (retina).\n Dimensions: 400px wide, 56px high. Format: png (transparent background recommended). Filesize: Max 512KB. (Deprecated in v5.1.5)\n
 in_room_logo_html5 (str)URL 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
 mobile_landing_logo (str)URL to the Mobile Landing Page image. Dimensions: 420px wide, 100px high. Format: png (transparent background recommended). Filesize: Max 512KB.\n
 splash_screen (str)URL to Splash Screen image.\n Dimensions: 728px wide, 216px high. Format: png (transparent background recommended). Filesize: Max 512KB.\n
 background (str)URL to Background image.\n No restrictions. Format: gif, jpg, png. Filesize: Max 1024KB\n
 event_header (str)URL to event header image.\n Maximum Dimensions: 300px wide, 50px high. Format: gif, jpg, png. Filesize: Max 512KB. (Available in v5.0.2)\n
 event_photo (str)URL to event Photo image.\n Dimensions: 240px wide, 180px high. Format: gif, jpg, png. Filesize: Max 1024KB.\n
 sharing_logo (str)URL 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
 email_header (int)URL to Email Header image.\n Maximum dimensions: 600px wide, 600px high. Format: png (transparent background recommended). Filesize: Max 1024KB.\n
 email_footer (str)URL to Email Footer image.\n Maximum dimensions: 600px wide, 600px high. Format: png (transparent background recommended). Filesize: Max 1024KB.\n
 moderator_redirect_url (str)Moderator Redirect URL. At the end of the session, moderators are redirected to this URL.\n
 guest_redirect_url (str)Guest Redirect URL. At the end of the session, guest participants are redirected to this URL.\n
 lobby_image (str)URL to inroom lobby image (Available in v4.3.9).\n Maximum dimensions: 800px wide, 430px high. Format: png (transparent background recommended). Filesize: Max 1024KB.\n
 lobby_music (str)URL to inroom lobby music (Available in v4.3.9)\n Format: MP3.\n Filesize: Max 3MB.\n
 lobby_text (str)Lobby text (Available in v4.3.9). Maximum 200 letters\n
\n

Return Arguments

\n\n \n \n \n \n \n \n \n \n
id (int)The id of the user account.
message (str)Text messsage.
","urlObject":{"path":["api","2","{{user_name}}","branding"],"host":["{{API_EndPoint}}"],"query":[],"variable":[]}},"response":[{"id":"0e6a7ce6-1350-4323-8c4f-27e905908f90","name":"Response","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Basic YWRtaW46c2FtYmEyMDAy"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"input_type=json&rest_data={\n\t\"user_id\":1,\n\t\"moderator_redirect_url\":\"http://moderator_redirect_url.com\",\n\t\"guest_redirect_url\":\"http://guest_redirect_url.com\"\n}"},"url":"{{API_EndPoint}}/api/2/{{user_name}}/branding"},"status":"Created","code":201,"_postman_previewlanguage":"xml","header":[{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate, post-check=0, pre-check=0","name":"Cache-Control","description":""},{"key":"Connection","value":"keep-alive","name":"Connection","description":""},{"key":"Content-Type","value":"application/xml","name":"Content-Type","description":""},{"key":"Date","value":"Mon, 29 May 2017 13:18:23 GMT","name":"Date","description":""},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT","name":"Expires","description":""},{"key":"Pragma","value":"no-cache","name":"Pragma","description":""},{"key":"Server","value":"nginx/1.10.3","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""},{"key":"X-Powered-By","value":"PHP/5.4.30","name":"X-Powered-By","description":""}],"cookie":[],"responseTime":null,"body":"\n\n\t1\n\tUser branding updated\n"}],"_postman_id":"d02ff8b7-8ec3-492a-a220-cfbc65e0a133"},{"name":"/branding","id":"6f233f10-17b9-424f-946b-2157ddaabb2d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Authorization","value":"Basic YWRtaW46c2FtYmEyMDAy"}],"body":{"mode":"raw","raw":"input_type=json&rest_data={\n \"id\":1\n}"},"url":"{{API_EndPoint}}/api/2/{{user_name}}/branding/id/1","description":"

Reset the user account branding settings. Available in v4.3.4

\n

Arguments

\n\n \n \n \n \n \n \n \n \n \n \n
Requiredid (str)ID# of user account.
Optional--
\n

Return Arguments

\n\n \n \n \n \n \n \n \n \n
id (int)The id of the user account.
message (str)Text messsage.
","urlObject":{"path":["api","2","{{user_name}}","branding","id","1"],"host":["{{API_EndPoint}}"],"query":[],"variable":[]}},"response":[{"id":"560dd7a9-4843-43b2-bbae-dce54c056e86","name":"Response","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Basic YWRtaW46c2FtYmEyMDAy"}],"body":{"mode":"raw","raw":"input_type=json&rest_data={\n\t\"id\":1\n}"},"url":"{{API_EndPoint}}/api/2/{{user_name}}/branding/id/1"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate, post-check=0, pre-check=0","name":"Cache-Control","description":""},{"key":"Connection","value":"keep-alive","name":"Connection","description":""},{"key":"Content-Encoding","value":"gzip","name":"Content-Encoding","description":""},{"key":"Content-Type","value":"application/xml","name":"Content-Type","description":""},{"key":"Date","value":"Mon, 29 May 2017 13:18:31 GMT","name":"Date","description":""},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT","name":"Expires","description":""},{"key":"Pragma","value":"no-cache","name":"Pragma","description":""},{"key":"Server","value":"nginx/1.10.3","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""},{"key":"X-Powered-By","value":"PHP/5.4.30","name":"X-Powered-By","description":""}],"cookie":[],"responseTime":null,"body":"\n\n\t1\n\tUser branding has been deleted\n"}],"_postman_id":"6f233f10-17b9-424f-946b-2157ddaabb2d"}],"id":"8b22eb01-dff3-4bdd-befe-1b1bd1c80fba","description":"

User branding settings (available with v 4.3.4)

\n","_postman_id":"8b22eb01-dff3-4bdd-befe-1b1bd1c80fba"},{"name":"Company user limits","item":[{"name":"/company_user_limits/id/[int]","id":"28b8ffdb-8b4a-4e78-9cfb-60bbae8e6584","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}],"advancedConfig":[{"key":"saveHelperData","value":""},{"key":"showPassword","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Basic YWRtaW46c2FtYmEyMDAy"}],"url":"{{API_EndPoint}}/api/2/{{user_name}}/company_user_limits/id/[int]","description":"

Get company user limits. Requires admin access rights. Available in v5.0.2

\n

Arguments

\n\n \n \n \n \n \n
Requiredid (int)ID# of company user account.
\n

Return Arguments

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
id (int)ID# of comapny user account.
company_sim_bcaster (int)Number of broadcasters that can broadcast at the same time across all account holders in this company.
company_session_user_limit (int)Number of sessions that can run at the same time in this company.
company_account_user_limit (int)Number of attendees that can be in sessions at the same time across all account holders in this company.
company_filesize_limit (int)The limit on total filesize (in KB) of all files of all account holders in this company (Available in v5.0.4).
company_service_plans (array)Company Accounts Limits.\nservice_plan_id: ID# of parent service plan\nqty: Number of accounts which this company may assign to the service plan\n
enforce_expiry_date (bool)Apply the expiry date to all account holders in this company (Available in v5.1.5).
","urlObject":{"path":["api","2","{{user_name}}","company_user_limits","id","[int]"],"host":["{{API_EndPoint}}"],"query":[],"variable":[]}},"response":[{"id":"c2cd5edf-80ee-467e-91fa-92d5ecd4019d","name":"Response","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic YWRtaW46c2FtYmEyMDAy"}],"url":"{{API_EndPoint}}/api/2/{{user_name}}/company_user_limits/id/[int]"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate, post-check=0, pre-check=0","name":"Cache-Control","description":""},{"key":"Connection","value":"keep-alive","name":"Connection","description":""},{"key":"Content-Encoding","value":"gzip","name":"Content-Encoding","description":""},{"key":"Content-Type","value":"application/xml","name":"Content-Type","description":""},{"key":"Date","value":"Wed, 31 May 2017 07:39:09 GMT","name":"Date","description":""},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT","name":"Expires","description":""},{"key":"Pragma","value":"no-cache","name":"Pragma","description":""},{"key":"Server","value":"nginx/1.10.3","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""},{"key":"X-Powered-By","value":"PHP/5.4.30","name":"X-Powered-By","description":""}],"cookie":[],"responseTime":null,"body":"\n\n 1\n 150\n 100\n 100\n 5000\n \n \n 1\n 1\n \n \n 589\n 1\n \n \n 830\n 1\n \n \n"}],"_postman_id":"28b8ffdb-8b4a-4e78-9cfb-60bbae8e6584"},{"name":"/company_user_limits","id":"3fc5ab68-22bd-410b-9f19-adf2fae6e147","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}],"advancedConfig":[{"key":"saveHelperData","value":""},{"key":"showPassword","value":""}]},"isInherited":false},"method":"PUT","header":[{"key":"Authorization","value":"Basic YWRtaW46c2FtYmEyMDAy"}],"body":{"mode":"raw","raw":"input_type=json&rest_data={\n\t\"user_id\":1,\n\t\"company_sim_bcaster\":100,\n\t\"company_session_user_limit\":50,\n\t\"company_account_user_limit\":50,\n\t\"company_service_plans\":[\n\t\t{\"service_plan_id\":1,\"qty\":50}, \n\t\t{\"service_plan_id\":2,\"qty\":10}\n\t]\n}"},"url":"{{API_EndPoint}}/api/2/{{user_name}}/company_user_limits","description":"

Update company user limits. Requires admin access rights. Available in v5.0.2

\n

Arguments

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
Requiredid (int)ID# of comapny user account.
 company_sim_bcaster (int)Number of broadcasters that can broadcast at the same time across all account holders in this company.
 company_session_user_limit (int)Number of sessions that can run at the same time in this company.
 company_account_user_limit (int)Number of attendees that can be in sessions at the same time across all account holders in this company.
 company_filesize_limit (int)The limit on total filesize (in KB) of all files of all account holders in this company (Available in v5.0.4).
 company_service_plans (array)Company 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
 enforce_expiry_date (bool)Apply the expiry date to all account holders in this company (Available in v5.1.5).
\n

Return Arguments

\n\n \n \n \n \n \n \n \n \n
id (int)The id of company user account.
message (str)Text messsage.
","urlObject":{"path":["api","2","{{user_name}}","company_user_limits"],"host":["{{API_EndPoint}}"],"query":[],"variable":[]}},"response":[{"id":"fb19d8b0-ca9f-43dc-84a6-a22c74c4cbb6","name":"Response","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Basic YWRtaW46c2FtYmEyMDAy"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"input_type=json&rest_data={\n\t\"user_id\":503,\n\t\"company_sim_bcaster\":100,\n\t\"company_session_user_limit\":50,\n\t\"company_account_user_limit\":50,\n\t\"company_service_plans\":[\n\t\t{\"service_plan_id\":1,\"qty\":50}, \n\t\t{\"service_plan_id\":2,\"qty\":10}\n\t]\n}"},"url":"{{API_EndPoint}}/api/2/{{user_name}}/company_user_limits"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate, post-check=0, pre-check=0","name":"Cache-Control","description":""},{"key":"Connection","value":"keep-alive","name":"Connection","description":""},{"key":"Content-Encoding","value":"gzip","name":"Content-Encoding","description":""},{"key":"Content-Type","value":"application/xml","name":"Content-Type","description":""},{"key":"Date","value":"Wed, 31 May 2017 07:51:52 GMT","name":"Date","description":""},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT","name":"Expires","description":""},{"key":"Pragma","value":"no-cache","name":"Pragma","description":""},{"key":"Server","value":"nginx/1.10.3","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""},{"key":"X-Powered-By","value":"PHP/5.4.30","name":"X-Powered-By","description":""}],"cookie":[],"responseTime":null,"body":"\n\n\t1\n\tCompany user limits are updated\n"}],"_postman_id":"3fc5ab68-22bd-410b-9f19-adf2fae6e147"},{"name":"/company_user_limits","id":"c9db62a1-d880-4d8d-abb9-3a8b16596342","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}],"advancedConfig":[{"key":"saveHelperData","value":""},{"key":"showPassword","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Basic YWRtaW46c2FtYmEyMDAy"}],"body":{"mode":"raw","raw":"input_type=json&rest_data={\n\t\"user_id\":1,\n\t\"company_sim_bcaster\":100,\n\t\"company_session_user_limit\":50,\n\t\"company_account_user_limit\":50,\n\t\"company_service_plans\":[\n\t\t{\"service_plan_id\":1,\"qty\":50}, \n\t\t{\"service_plan_id\":2,\"qty\":10}\n\t]\n}"},"url":"{{API_EndPoint}}/api/2/{{user_name}}/company_user_limits","description":"

Update company user limits. Requires admin access rights. Available in v5.0.2

\n\n

Arguments

\n

See PUT /company_user_limits

","urlObject":{"path":["api","2","{{user_name}}","company_user_limits"],"host":["{{API_EndPoint}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"c9db62a1-d880-4d8d-abb9-3a8b16596342"},{"name":"/company_user_limits","id":"29fd9362-ce92-4f90-a566-76c036accf40","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}],"advancedConfig":[{"key":"saveHelperData","value":""},{"key":"showPassword","value":""}]},"isInherited":false},"method":"DELETE","header":[{"key":"Authorization","value":"Basic YWRtaW46c2FtYmEyMDAy"}],"body":{"mode":"raw","raw":"input_type=json&rest_data={\n\t\"id\":1\n}"},"url":"{{API_EndPoint}}/api/2/{{user_name}}/company_user_limits","description":"

Delete company user limits. Requires admin access rights. Available in v5.0.2

\n

Arguments

\n\n \n \n \n \n \n
Requiredid (str)ID# of company user account.
\n

Return Arguments

\n\n \n \n \n \n \n \n \n \n
id (int)The id of the company user account.
message (str)Text messsage.
","urlObject":{"path":["api","2","{{user_name}}","company_user_limits"],"host":["{{API_EndPoint}}"],"query":[],"variable":[]}},"response":[{"id":"f88c5380-a88d-41b7-a10b-442e38072012","name":"Response","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Basic YWRtaW46c2FtYmEyMDAy"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"input_type=json&rest_data={\n\t\"id\":1\n}"},"url":"{{API_EndPoint}}/api/2/{{user_name}}/company_user_limits"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate, post-check=0, pre-check=0","name":"Cache-Control","description":""},{"key":"Connection","value":"keep-alive","name":"Connection","description":""},{"key":"Content-Encoding","value":"gzip","name":"Content-Encoding","description":""},{"key":"Content-Type","value":"application/xml","name":"Content-Type","description":""},{"key":"Date","value":"Wed, 31 May 2017 08:10:50 GMT","name":"Date","description":""},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT","name":"Expires","description":""},{"key":"Pragma","value":"no-cache","name":"Pragma","description":""},{"key":"Server","value":"nginx/1.10.3","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""},{"key":"X-Powered-By","value":"PHP/5.4.30","name":"X-Powered-By","description":""}],"cookie":[],"responseTime":null,"body":"\n\n 1\n Company user limits are removed\n"}],"_postman_id":"29fd9362-ce92-4f90-a566-76c036accf40"}],"id":"30fd798c-5b2c-4e74-9d60-3d96f6b0a825","description":"

Manage Company user limits (available with v 5.0.2)

\n

Admin permissions required.

","_postman_id":"30fd798c-5b2c-4e74-9d60-3d96f6b0a825"},{"name":"Recordings","item":[{"name":"/recording/id/[int]","id":"6f5c46eb-f8a5-445c-a28d-059aa78a1570","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}],"advancedConfig":[{"key":"saveHelperData","value":""},{"key":"showPassword","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Basic YWRtaW46c2FtYmEyMDAy"}],"url":"{{API_EndPoint}}/api/2/{{user_name}}/recording/id/1","description":"

Get recording associated with this user account.

\n

Arguments

\n\n \n \n \n \n \n
Requiredid (int)The id of the recording.
\n

Return Arguments

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
id (int)The id of the recording.
session_id (int)The id of the session in which this recording was made.
title (str)The name or title of this recording.
description (str)Description of the recording.
password (str)Password required to view the recording. Inherited from it’s session, if set there, none, if empty (not allowed for mp4 recording).
duration (int)Length of recording, in milliseconds.
allow_anonymous_playback (bool)If true, users will not be prompted to provide a screenname when viewing a recording. If a password is set, they will be prompted regardless of this value (not allowed for mp4 recording).
show_copy_link (bool)Show/hide the copy link menu item when viewing a recording (available with version 4.4.2, not allowed for mp4 recording).
recording_link (str)Full link to the recording (only available with Flash)..
download_link (str)Flash: URL to zip file. HTML5: URL to mp4 file. (available with v 4.3.6).
make_offline_recording (bool)Set this param to TRUE to make request for recording download (available with v 4.3.6).
download_link_status (int)Status on the download recording request.\nPossible values:\n0 = not requested,\n1 = in progress,\n2 = ready,\n3 = failed (available with v 4.3.6, not allowed for mp4 recordings)
mp4_recording (bool)If true then recording allowed in MP4 format only. (available with v 4.4.5).
viewers (array)Recording viewers (not allowed for mp4 recordings).
invitations_content (text)Custom content to the initial invitation email (available with v 5.1.5).
csv_report_link (string)Link to recording summary CSV report (available with v 4.4.4, deprecated in 5.0.8, user “report” param) . not allowed for mp4 recordings.
report (array)Links to the recording summary reports. \n Array values:\ncsv_link - Link to report in CSV format\nexcel_link - Link to report in Excel format.\n(available with v 5.0.8)
creation_date (datetime)Datetime stamp when the recording was made.
","urlObject":{"path":["api","2","{{user_name}}","recording","id","1"],"host":["{{API_EndPoint}}"],"query":[],"variable":[]}},"response":[{"id":"6ba7f375-dbdd-4a9d-8b9b-bfb59f3a4455","name":"Response","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic YWRtaW46c2FtYmEyMDAy"}],"url":"{{API_EndPoint}}/api/2/{{user_name}}/recording/id/[int]"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate, post-check=0, pre-check=0","name":"Cache-Control","description":""},{"key":"Connection","value":"keep-alive","name":"Connection","description":""},{"key":"Content-Encoding","value":"gzip","name":"Content-Encoding","description":""},{"key":"Content-Type","value":"application/xml","name":"Content-Type","description":""},{"key":"Date","value":"Tue, 30 May 2017 10:22:24 GMT","name":"Date","description":""},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT","name":"Expires","description":""},{"key":"Pragma","value":"no-cache","name":"Pragma","description":""},{"key":"Server","value":"nginx/1.10.3","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""},{"key":"X-Powered-By","value":"PHP/5.4.30","name":"X-Powered-By","description":""}],"cookie":[],"responseTime":null,"body":"\n\n 1\n 2\n Recording Title\n More info about my recording\n some-password\n 180004\n http://domain.com/play/admin/1-recording-title\n http://domain.com/storage/recordings/download/1-80fab40837f57e1269554927ac3ac92d.zip\n 2\n 0\n 0\n \n \n http://domain.com/recordings/report/csv/1/6ab2349a0622f25c409f524f128ade37\n http://domain.com/recordings/report/xls/1/6ab2349a0622f25c409f524f128ade37\n \n 0\n 2017-03-24 08:06:58\n"},{"id":"724ef67e-4352-412e-82f5-51a92556259c","name":"404 Response","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic YWRtaW46c2FtYmEyMDAy"}],"url":"{{API_EndPoint}}/api/2/{{user_name}}/recording/id/[int]"},"status":"Not Found","code":404,"_postman_previewlanguage":"xml","header":[{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate, post-check=0, pre-check=0","name":"Cache-Control","description":""},{"key":"Connection","value":"keep-alive","name":"Connection","description":""},{"key":"Content-Encoding","value":"gzip","name":"Content-Encoding","description":""},{"key":"Content-Type","value":"application/xml","name":"Content-Type","description":""},{"key":"Date","value":"Wed, 31 May 2017 07:42:29 GMT","name":"Date","description":""},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT","name":"Expires","description":""},{"key":"Pragma","value":"no-cache","name":"Pragma","description":""},{"key":"Server","value":"nginx/1.10.3","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""},{"key":"X-Powered-By","value":"PHP/5.4.30","name":"X-Powered-By","description":""}],"cookie":[],"responseTime":null,"body":"\nNot found\n"}],"_postman_id":"6f5c46eb-f8a5-445c-a28d-059aa78a1570"},{"name":"/recordings","id":"5d865de6-e043-4b83-a3a5-5f745e1cae13","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}],"advancedConfig":[{"key":"saveHelperData","value":""},{"key":"showPassword","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Basic YWRtaW46c2FtYmEyMDAy"}],"url":"{{API_EndPoint}}/api/2/{{user_name}}/recordings/count/1","description":"

Get recordings associated with this user account.

\n

Arguments

\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
Optionalsession (int)Pass a session id to limit results to recordings made in that session only. Otherwise recordings made across all sessions are returned.\n
 count (int)Specify number of returned results. Default is 100.\n
 offset (int)Specify to move the cursor through the recordset. Default is 0.
 order (str)Return results in ascending or descending order of recording ID. Default is asc.
Accepted values: asc, desc\n
\n

Return Arguments

\nSee GET /recording/id/[int]","urlObject":{"path":["api","2","{{user_name}}","recordings","count","1"],"host":["{{API_EndPoint}}"],"query":[],"variable":[]}},"response":[{"id":"40d166f1-1784-4032-80ba-501d24fa82d3","name":"Response","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic YWRtaW46c2FtYmEyMDAy"}],"url":"{{API_EndPoint}}/api/2/{{user_name}}/recordings/count/1"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate, post-check=0, pre-check=0","name":"Cache-Control","description":""},{"key":"Connection","value":"keep-alive","name":"Connection","description":""},{"key":"Content-Encoding","value":"gzip","name":"Content-Encoding","description":""},{"key":"Content-Type","value":"application/xml","name":"Content-Type","description":""},{"key":"Date","value":"Tue, 30 May 2017 10:23:51 GMT","name":"Date","description":""},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT","name":"Expires","description":""},{"key":"Pragma","value":"no-cache","name":"Pragma","description":""},{"key":"Server","value":"nginx/1.10.3","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""},{"key":"X-Powered-By","value":"PHP/5.4.30","name":"X-Powered-By","description":""}],"cookie":[],"responseTime":null,"body":"\n\n \n 1\n 2\n Recording Title\n More info about my recording\n some-password\n 180004\n http://domain.com/play/login/1-recording-title\n http://domain.com/storage/recordings/download/1-80fab40837f57e1269554927ac3ac92d.zip\n 2\n 0\n 0\n \n \n http://domain.com/recordings/report/csv/1/6ab2349a0622f25c409f524f128ade37\n http://domain.com/recordings/report/xls/1/6ab2349a0622f25c409f524f128ade37\n \n 0\n 2017-03-24 08:06:58\n \n"}],"_postman_id":"5d865de6-e043-4b83-a3a5-5f745e1cae13"},{"name":"/recording","id":"989363b8-edb2-438c-bb04-2f20b2c041c4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}],"advancedConfig":[{"key":"saveHelperData","value":""},{"key":"showPassword","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Basic YWRtaW46c2FtYmEyMDAy"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"input_type=json&rest_data={\n\t\"id\":\t\t\t1,\n\t\"title\":\t\t\"My recording\",\n\t\"description\":\t\"More info about my recording\", \n\t\"password\":\t\t\"some-password\"\n}"},"url":"{{API_EndPoint}}/api/2/{{user_name}}/recording","description":"

Edit an existing recording.

\n

Arguments

\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
Requiredid (int)The id of the recording.
Optionaltitle (str)The title of the recording.
 description (str)The description of the recording.
 password (str)Set a password to view this recording. Leave empty, for open access (not allowed for mp4 recording).
 viewers (array)\n JSON array of users who should receive an email invitation to view recording, in the following format:\n 
\n[\n    {\n    \"id\": \"1\",\n    \"email\": \"email@domain.com\",\n    \"first_name\": \"First Name\",\n    \"last_name\": \"Last Name\",\n    \"send_email_invitation\": false\n    }\n]\n
\nsend_email_invitations (bool): Set 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 (not allowed for mp4 recording).\n
 invitations_content (text)Add your own content to the initial invitation email. Leave empty to send a pre-defined email (available with v 5.1.5).
 allow_anonymous_playback (bool)Set to true (or 1) to supress login screen to the recording. Ignored if password is set (not allowed for mp4 recording).
 show_copy_link (bool)Set to true (or 1) to show the copy link menu item when viewing a recording (available with version 4.4.2, not allowed for mp4 recording)
\n

Return Arguments

\n\n \n \n \n \n \n \n \n \n
id (int)The id of the edited recording.
message (str)Text messsage.
","urlObject":{"path":["api","2","{{user_name}}","recording"],"host":["{{API_EndPoint}}"],"query":[],"variable":[]}},"response":[{"id":"2ba75285-df22-4aac-abb0-2e03f14acac1","name":"Success Response","originalRequest":{"method":"POST","header":[{"key":"Authorization","type":"text","name":"Authorization","value":"Basic YWRtaW46c2FtYmEyMDAy"},{"key":"Content-Type","value":"application/json","description":"The mime type of this content"}],"body":{"mode":"raw","raw":"input_type=json&rest_data={\n\t\"id\":\t\t\t28,\n\t\"title\":\t\t\"My recording\",\n\t\"description\":\t\"More info about my recording\", \n\t\"password\":\t\t\"some-password\"\n}"},"url":"{{API_EndPoint}}/api/2/{{user_name}}/recording"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate, post-check=0, pre-check=0","name":"Cache-Control","description":""},{"key":"Connection","value":"keep-alive","name":"Connection","description":""},{"key":"Content-Encoding","value":"gzip","name":"Content-Encoding","description":""},{"key":"Content-Type","value":"application/xml","name":"Content-Type","description":""},{"key":"Date","value":"Tue, 30 May 2017 10:12:37 GMT","name":"Date","description":""},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT","name":"Expires","description":""},{"key":"Pragma","value":"no-cache","name":"Pragma","description":""},{"key":"Server","value":"nginx/1.10.3","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""},{"key":"X-Powered-By","value":"PHP/5.4.30","name":"X-Powered-By","description":""}],"cookie":[],"responseTime":null,"body":"\n28Recording updated\n"}],"_postman_id":"989363b8-edb2-438c-bb04-2f20b2c041c4"},{"name":"/recording/id/[int]","id":"3a3c672f-a4f9-4dff-9a93-f735887a2465","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}],"advancedConfig":[{"key":"saveHelperData","value":""},{"key":"showPassword","value":""}]},"isInherited":false},"method":"DELETE","header":[{"key":"Authorization","value":"Basic YWRtaW46c2FtYmEyMDAy"}],"body":{"mode":"formdata","formdata":[]},"url":"{{API_EndPoint}}/api/2/{{user_name}}/recording/id/1","description":"

Delete an existing recording.

\n

Arguments

\n\n \n \n \n \n \n
Requiredid (int)The 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

Return Arguments

\n\n \n \n \n \n \n \n \n \n
id (int)The id of the deleted recording.
message (str)Text messsage.
","urlObject":{"path":["api","2","{{user_name}}","recording","id","1"],"host":["{{API_EndPoint}}"],"query":[],"variable":[]}},"response":[{"id":"513ad9e0-bb26-45e8-95db-49ae57442a4d","name":"Response","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","type":"text","name":"Authorization","value":"Basic YWRtaW46c2FtYmEyMDAy"}],"body":{"mode":"formdata","formdata":[]},"url":"{{API_EndPoint}}/api/2/{{user_name}}/recording/id/1"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate, post-check=0, pre-check=0","name":"Cache-Control","description":""},{"key":"Connection","value":"keep-alive","name":"Connection","description":""},{"key":"Content-Encoding","value":"gzip","name":"Content-Encoding","description":""},{"key":"Content-Type","value":"application/xml","name":"Content-Type","description":""},{"key":"Date","value":"Tue, 30 May 2017 10:16:22 GMT","name":"Date","description":""},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT","name":"Expires","description":""},{"key":"Pragma","value":"no-cache","name":"Pragma","description":""},{"key":"Server","value":"nginx/1.10.3","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""},{"key":"X-Powered-By","value":"PHP/5.4.30","name":"X-Powered-By","description":""}],"cookie":[],"responseTime":null,"body":"\n58Recording was deleted\n"}],"_postman_id":"3a3c672f-a4f9-4dff-9a93-f735887a2465"}],"id":"3f817ad6-bbb8-4e66-9de1-147b90e62e84","_postman_id":"3f817ad6-bbb8-4e66-9de1-147b90e62e84","description":""},{"name":"Server Settings","item":[{"name":"/settings","id":"1c31632d-f6ff-4d16-a422-ba56e380819a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}],"advancedConfig":[{"key":"showPassword","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Basic YWRtaW46c2FtYmEyMDAy"}],"url":"{{API_EndPoint}}/api/2/{{user_name}}/settings","description":"

Get server settings. Requires admin access rights. Available in v4.4.3

\n

Return Arguments

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
allow_user_registration (bool)Enable/disable the free user registration
user_registration_link (str)Link to the free user registration
ldap_enabled (bool)Enable/disable LDAP connection (Deprecated in v5.1.5).
allow_modify_branding (bool)Allow account holders modify branding
maintenance_alert (bool)Enable/disable the maintenance alert
maintenance_message (str)Maintenance alert content
","urlObject":{"path":["api","2","{{user_name}}","settings"],"host":["{{API_EndPoint}}"],"query":[],"variable":[]}},"response":[{"id":"e8bd6551-f59c-423e-8bab-8f4801fa5d96","name":"Response","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic YWRtaW46c2FtYmEyMDAy"}],"url":"{{API_EndPoint}}/api/2/{{user_name}}/settings"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate, post-check=0, pre-check=0","name":"Cache-Control","description":""},{"key":"Connection","value":"keep-alive","name":"Connection","description":""},{"key":"Content-Encoding","value":"gzip","name":"Content-Encoding","description":""},{"key":"Content-Type","value":"application/xml","name":"Content-Type","description":""},{"key":"Date","value":"Sat, 08 Jul 2017 07:01:30 GMT","name":"Date","description":""},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT","name":"Expires","description":""},{"key":"Pragma","value":"no-cache","name":"Pragma","description":""},{"key":"Server","value":"nginx/1.10.3","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""},{"key":"X-Powered-By","value":"PHP/5.4.30","name":"X-Powered-By","description":""},{"key":"p3p","value":"CP=\"NOI ADM DEV PSAi COM NAV OUR OTR STP IND DEM\"","name":"p3p","description":""}],"cookie":[],"responseTime":null,"body":"\n\n 1\n http://www.test.com\n 1\n 1\n 1\n We will be performing routine maintenance on 2017-06-07 at 11:10 AM CET.\n"}],"_postman_id":"1c31632d-f6ff-4d16-a422-ba56e380819a"},{"name":"/settings","id":"2025ea5d-7dad-4bb3-9955-7baa5e244cf8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Basic YWRtaW46c2FtYmEyMDAy"}],"body":{"mode":"raw","raw":"input_type=json&rest_data={\n \"allow_user_registration\":\"1\",\n \"user_registration_link\":\"http://www.test.com\",\n \"ldap_enabled\":\"1\",\n \"maintenance_alert \":\"1\",\n \"maintenance_message \":\"Some message\"\n}"},"url":"{{API_EndPoint}}/api/2/{{user_name}}/settings","description":"

Set server settings. Requires admin access rights. Available in v4.4.3

\n

Arguments

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
Optionalallow_user_registration (bool)Enable/disable the free user registration
 user_registration_link (str)Link to the free user registration
 ldap_enabled (bool)Enable/disable LDAP connection (Deprecated in v5.1.5)
 allow_modify_branding (bool)Allow account holders modify branding
 maintenance_alert (bool)Enable/disable the maintenance alert
 maintenance_message (str)Maintenance alert content
","urlObject":{"path":["api","2","{{user_name}}","settings"],"host":["{{API_EndPoint}}"],"query":[],"variable":[]}},"response":[{"id":"b1b96c3f-cc46-4ec1-98bb-ded95d95a951","name":"Response","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Basic YWRtaW46c2FtYmEyMDAy"},{"key":"","value":"","warning":""}],"body":{"mode":"raw","raw":"input_type=json&rest_data={\n \"allow_user_registration\":\"1\",\n \"user_registration_link\":\"http://www.test.com\",\n \"ldap_enabled\":\"1\",\n \"maintenance_alert \":\"1\",\n \"maintenance_message \":\"Some message\"\n}"},"url":"{{API_EndPoint}}/api/2/{{user_name}}/settings"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate, post-check=0, pre-check=0","name":"Cache-Control","description":""},{"key":"Connection","value":"keep-alive","name":"Connection","description":""},{"key":"Content-Encoding","value":"gzip","name":"Content-Encoding","description":""},{"key":"Content-Type","value":"application/xml","name":"Content-Type","description":""},{"key":"Date","value":"Sat, 08 Jul 2017 07:01:53 GMT","name":"Date","description":""},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT","name":"Expires","description":""},{"key":"Pragma","value":"no-cache","name":"Pragma","description":""},{"key":"Server","value":"nginx/1.10.3","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""},{"key":"X-Powered-By","value":"PHP/5.4.30","name":"X-Powered-By","description":""},{"key":"p3p","value":"CP=\"NOI ADM DEV PSAi COM NAV OUR OTR STP IND DEM\"","name":"p3p","description":""}],"cookie":[],"responseTime":null,"body":"\n\n Settings updated\n"}],"_postman_id":"2025ea5d-7dad-4bb3-9955-7baa5e244cf8"}],"id":"c45c5a9d-6ac6-4752-b7a7-bd4b97bfc50e","description":"

Server Settings (available with v 4.4.3).

\n

Admin prmissions required.

","_postman_id":"c45c5a9d-6ac6-4752-b7a7-bd4b97bfc50e"},{"name":"Service Plans","item":[{"name":"/service_plan/id/[int]","id":"58efcc6a-942f-4bed-927f-28d1989f3f38","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

Arguments

\n\n\n \n \n \n \n \n
Requiredid (int)ID# of the service plan to be returned.
\n\n

Return Arguments

\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
id (int)The ID# of service plan.
name (str)Custom name of service plan.
fms_ip (str)The IP or FQDN of the Flash Media Server running the FMS application to which sessions of this account should connect.
app_name (str)The name of the FMS application to which sessions of this account should connect.
description (str)Brief description of service plan.
user_limit (int)The simultaneous user connection limit across all sessions in this account.
session_user_limit (int)The simultaneous user connection limit of any particular session in this account.
recording_limit (int)The limit on number of recordings this account may store.
filesize_limit (int)The limit on total filesize (in KB) of all files in this account's Media Library.
broadcasters_limit (int)Number of users in any session of this account who may broadcast at the same time.
modify_branding_enabled (bool)Allow account holders to modify branding.
modify_colors_enabled (bool)Allow account holders to modify theme colors. Available when new flat-ui theme is enabled (available with v 4.4.5).
advanced_sessions_enabled (bool)Enable advanced scheduling features.
pro_video_enabled (bool)The ID# of service planEnable pro & custom video options.
mobile_access_enabled (bool)Enable access from mobile applications.
api_enabled (bool)Enable access for API.
mp4_recording_enabled (bool)Enable MP4 recordings (available with v 4.4.3).
session_auto_recording_enabled (bool)Enable auto-record sessions, note this will impact disk space usage (available with v 5.1.5).
modify_permissions_enabled (bool)Allow account holders to modify session permissions (available with v 4.4.4).
password_protect_fast_session (bool)Password protect MeetNow meetings (available with v 5.1.5).
available_room_type (str)The Room type(s) which are made available to this account at session level. Possible values: flex, webrtc or both (available with v 5.1.3).
appshare_fit_to_screen (int)Default screenshare view mode (available with v 5.1.5).\nValues: \n- 0: Set default view for application sharing to \"100%\"\n- 1: Set default view for application sharing to \"Fit To Screen\"\n
menu_buttons (array)Menu Buttons Available in Session.
components (array)Components Available in Session (available with v 4.4.4).
permissions (array)Permissions Available in Session (available with v 4.4.4).
voip_session_audio (string)Default Session Audio. Allowed values: phone, voip. (available with v 4.3.2).
voip_available_session_audio (array)Available 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).
","urlObject":{"path":["api","2","{{user_name}}","service_plan","id","1"],"host":["{{API_EndPoint}}"],"query":[],"variable":[]}},"response":[{"id":"2f67e4bc-59b9-4d9a-ba5b-950818619def","name":"Response","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic YWRtaW46c2FtYmEyMDAy"}],"url":"{{API_EndPoint}}/api/2/{{user_name}}/service_plan/id/1"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate, post-check=0, pre-check=0","name":"Cache-Control","description":""},{"key":"Connection","value":"keep-alive","name":"Connection","description":""},{"key":"Content-Encoding","value":"gzip","name":"Content-Encoding","description":""},{"key":"Content-Type","value":"application/xml","name":"Content-Type","description":""},{"key":"Date","value":"Tue, 30 May 2017 11:20:57 GMT","name":"Date","description":""},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT","name":"Expires","description":""},{"key":"Pragma","value":"no-cache","name":"Pragma","description":""},{"key":"Server","value":"nginx/1.10.3","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""},{"key":"X-Powered-By","value":"PHP/5.4.30","name":"X-Powered-By","description":""}],"cookie":[],"responseTime":null,"body":"\n1Parent Service Plan Template10001101111voiphybridvoipphone11111111111111111111110110011001100110011001100110011001100110011101100111011001100111011101100110011001100110011001100110011001100110011001100110011001110111111001100110011101100110011001100\n"},{"id":"f7cf53c7-7bec-41e1-a961-f894d4e33a60","name":"404 Response","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic YWRtaW46c2FtYmEyMDAy"}],"url":"{{API_EndPoint}}/api/2/{{user_name}}/service_plan/id/1111"},"status":"Not Found","code":404,"_postman_previewlanguage":"xml","header":[{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate, post-check=0, pre-check=0","name":"Cache-Control","description":""},{"key":"Connection","value":"keep-alive","name":"Connection","description":""},{"key":"Content-Encoding","value":"gzip","name":"Content-Encoding","description":""},{"key":"Content-Type","value":"application/xml","name":"Content-Type","description":""},{"key":"Date","value":"Tue, 30 May 2017 11:20:39 GMT","name":"Date","description":""},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT","name":"Expires","description":""},{"key":"Pragma","value":"no-cache","name":"Pragma","description":""},{"key":"Server","value":"nginx/1.10.3","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""},{"key":"X-Powered-By","value":"PHP/5.4.30","name":"X-Powered-By","description":""}],"cookie":[],"responseTime":null,"body":"\nNot found\n"}],"_postman_id":"58efcc6a-942f-4bed-927f-28d1989f3f38"},{"name":"/service_plans","id":"3be10b0a-f433-49b6-816d-1209ef881931","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}],"advancedConfig":[{"key":"saveHelperData","value":""},{"key":"showPassword","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Basic YWRtaW46c2FtYmEyMDAy"}],"url":"{{API_EndPoint}}/api/2/{{user_name}}/service_plans","description":"

Get service plans.

\n

Arguments

\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
Optionalcount (int)Specify number of returned results. Default is 100.\n
 offset (int)Specify to move the cursor through the recordset. Default is 0.
 order (str)Return results in ascending or descending order of recording ID. Default is asc.
Accepted values: asc, desc\n
\n

Return Arguments

\nSee GET /service_plan/id/[int]","urlObject":{"path":["api","2","{{user_name}}","service_plans"],"host":["{{API_EndPoint}}"],"query":[],"variable":[]}},"response":[{"id":"f16789db-a96d-4386-93b4-c6e516a75e36","name":"Response","originalRequest":{"method":"GET","header":[{"key":"Authorization","type":"text","name":"Authorization","value":"Basic YWRtaW46c2FtYmEyMDAy"}],"url":"{{API_EndPoint}}/api/2/{{user_name}}/service_plans/count/1"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate, post-check=0, pre-check=0","name":"Cache-Control","description":""},{"key":"Connection","value":"keep-alive","name":"Connection","description":""},{"key":"Content-Encoding","value":"gzip","name":"Content-Encoding","description":""},{"key":"Content-Type","value":"application/xml","name":"Content-Type","description":""},{"key":"Date","value":"Tue, 30 May 2017 11:41:19 GMT","name":"Date","description":""},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT","name":"Expires","description":""},{"key":"Pragma","value":"no-cache","name":"Pragma","description":""},{"key":"Server","value":"nginx/1.10.3","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""},{"key":"X-Powered-By","value":"PHP/5.4.30","name":"X-Powered-By","description":""}],"cookie":[],"responseTime":null,"body":"\n589test2222100001qweqwe000000000000000000000000110000111100110011001100110011001100110011101100111011001100111011101100110011001100110011001100110011001100110011001100110011001110111111001100110011101100110011001100\n"}],"_postman_id":"3be10b0a-f433-49b6-816d-1209ef881931"},{"name":"/service_plan","id":"93202823-7c30-4758-b7d0-dbd7af0b36aa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}],"advancedConfig":[{"key":"saveHelperData","value":""},{"key":"showPassword","value":""}]},"isInherited":false},"method":"PUT","header":[{"key":"Authorization","value":"Basic YWRtaW46c2FtYmEyMDAy"}],"body":{"mode":"raw","raw":"input_type=json&rest_data={\n \"name\":\"Some Name\",\n \"description\":\"Some Description\",\n \"app_name\":\"Some APP Name\",\n \"fms_ip\":\"255.255.255.255\",\n \"user_limit\":\"100\",\n \"session_user_limit\":\"50\",\n \"recording_limit\":\"50\",\n \"filesize_limit\":\"500000\",\n \"broadcasters_limit\":\"10\",\n \"modify_branding_enabled\":\"1\",\n \"advanced_sessions_enabled\":\"1\",\n \"pro_video_enabled\":\"1\",\n \"mobile_access_enabled\": \"1\", \n \"api_enabled\": \"1\"\n}"},"url":"{{API_EndPoint}}/api/2/{{user_name}}/service_plan","description":"

Add new service plan

\n

Arguments

\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
Requiredname (str)The name of service plan.
Optionalfms_ip (str)The IP or FQDN of the Flash Media Server running the FMS application to which sessions of this account should connect.
 app_name (str)The name of the FMS application to which sessions of this account should connect.
 description (str)The brief description for this service plan.
 user_limit (int)The simultaneous user connection limit across all sessions in this account.
 session_user_limit (int)The simultaneous user connection limit of any particular session in this account.
 recording_limit (int)The limit on number of recordings this account may store.
 filesize_limit (int)The limit on total filesize (in KB) of all files in this account's Media Library.
 broadcasters_limit (int)Number of users in any session of this account who may broadcast at the same time.
 modify_branding_enabled (bool)Allow account holders to modify branding.
 modify_colors_enabled (bool)Allow account holders to modify theme colors. Available when new flat-ui theme is enabled (available with v 4.4.5).
 advanced_sessions_enabled (bool)Enable advanced scheduling features.
 pro_video_enabled (bool)Enable pro & custom video options.
 mobile_access_enabled (bool)Enable access from mobile applications.
 api_enabled (bool)Enable access for API.
 mp4_recording_enabled (bool)Enable MP4 recordings (available with v 4.4.3)
 session_auto_recording_enabled (bool)Enable auto-record sessions, note this will impact disk space usage (available with v 5.1.5).
 modify_permissions_enabled (bool)Allow account holders to modify session permissions (available with v 4.4.4)
 password_protect_fast_session (bool)Password protect MeetNow meetings (available with v 5.1.5).
 available_room_type (str)The Room type(s) which are made available to this account at session level (available with v 5.1.3).\n Values:\n - flex - classic flash room\n - webrtc - new HTML5 room (beta)\n - both - flash and HTML5 are allowed\n
 appshare_fit_to_screen (int)Set default screenshare view mode (available with v 5.1.5).\n Values:\n - 0 - Set default view for application sharing to \"100%\"\n - 1 - Set default view for application sharing to \"Fit To Screen\"\n
 menu_buttons (array)Menu 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 - pushtotalk (bool) - Show/Hide “Push to Talk ” ite. This item can be showed when Microphone is showed. (available with v 4.4.4)\n - requesttospeak (bool) - Show/Hide “Request To Speak” item\n - help (bool) - Show/Hide “About” item
 components (array)Components 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 - participants (bool) - Show/Hide “Participants” component\n - conference (bool) - Show/Hide “Conference” component\n - content_share_1 (bool) - Show/Hide “Content Share #1” component\n - content_share_2 (bool) - Show/Hide “Content Share #2” component\n - content_share_3 (bool) - Show/Hide “Content Share #3” 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 - Show/Hide “Caption Stream” component (available with v 5.0.4 when caption stream feature is enabled on the server level)
 permissions (array)\nPermissions Available in Session (available with v 4.4.4). Use following format to set permissions:
\n{\"allow_local_screen_share\": {\n    \"accountholder\": \"1\",\n    \"moderator\": \"1\",\n    \"participant\": \"0\",\n    \"observer\": \"1\"\n},\n\"allow_screen_inviting\": {\n    \"accountholder\": \"1\",\n    \"moderator\": \"1\",\n    \"participant\": \"1\",\n    \"observer\": \"1\"\n}}\n
Check “Session in-room permissions” table to see all possible permissions and default settings.\n
 voip_session_audio (string)Default Session Audio. Allowed values: phone, voip, hybrid. (available with v 4.3.2)
 voip_available_session_audio (array)Available 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

Return Arguments

\n\n \n \n \n \n \n \n \n \n
id (int)The id of the added entity.
message (str)Text messsage.
","urlObject":{"path":["api","2","{{user_name}}","service_plan"],"host":["{{API_EndPoint}}"],"query":[],"variable":[]}},"response":[{"id":"03a47915-6697-4a43-8367-70ff099bdee1","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":"formdata","formdata":[]},"url":"{{API_EndPoint}}/api/2/{{user_name}}/service_plan"},"status":"Created","code":201,"_postman_previewlanguage":"xml","header":[{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate, post-check=0, pre-check=0","name":"Cache-Control","description":""},{"key":"Connection","value":"keep-alive","name":"Connection","description":""},{"key":"Content-Type","value":"application/xml","name":"Content-Type","description":""},{"key":"Date","value":"Tue, 30 May 2017 11:48:24 GMT","name":"Date","description":""},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT","name":"Expires","description":""},{"key":"Pragma","value":"no-cache","name":"Pragma","description":""},{"key":"Server","value":"nginx/1.10.3","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""},{"key":"X-Powered-By","value":"PHP/5.4.30","name":"X-Powered-By","description":""}],"cookie":[],"responseTime":null,"body":"\n830Service plan added\n"}],"_postman_id":"93202823-7c30-4758-b7d0-dbd7af0b36aa"},{"name":"/service_plan","id":"0c339328-27ea-47f7-b5b9-13c0f3eb3c95","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}],"advancedConfig":[{"key":"saveHelperData","value":""},{"key":"showPassword","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Basic YWRtaW46c2FtYmEyMDAy"}],"body":{"mode":"raw","raw":"input_type=json&rest_data={\n \"id\": 830,\n \"name\":\"Some Name\",\n \"description\":\"Some Description\",\n \"app_name\":\"Some APP Name\",\n \"fms_ip\":\"255.255.255.255\",\n \"user_limit\":\"100\",\n \"session_user_limit\":\"50\",\n \"recording_limit\":\"50\",\n \"filesize_limit\":\"500000\",\n \"broadcasters_limit\":\"10\",\n \"modify_branding_enabled\":\"1\",\n \"advanced_sessions_enabled\":\"1\",\n \"pro_video_enabled\":\"1\",\n \"mobile_access_enabled\": \"1\", \n \"api_enabled\": \"1\"\n}"},"url":"{{API_EndPoint}}/api/2/{{user_name}}/service_plan","description":"

Update service plan settings

\n

Arguments

\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
Requiredid (int)The id of the service plan to be edited.
Optionalname (str)The name of service plan.
 fms_ip (str)The IP or FQDN of the Flash Media Server running the FMS application to which sessions of this account should connect.
 app_name (str)The name of the FMS application to which sessions of this account should connect.
 description (str)The brief description for this service plan.
 user_limit (int)The simultaneous user connection limit across all sessions in this account.
 session_user_limit (int)The simultaneous user connection limit of any particular session in this account.
 recording_limit (int)The limit on number of recordings this account may store.
 filesize_limit (int)The limit on total filesize (in KB) of all files in this account's Media Library.
 broadcasters_limit (int)Number of users in any session of this account who may broadcast at the same time.
 modify_branding_enabled (bool)Allow account holders to modify branding.
 modify_colors_enabled (bool)Allow account holders to modify theme colors. Available when new flat-ui theme is enabled (available with v 4.4.5).
 advanced_sessions_enabled (bool)Enable advanced scheduling features.
 pro_video_enabled (bool)Enable pro & custom video options.
 mobile_access_enabled (bool)Enable access from mobile applications.
 api_enabled (bool)Enable access for API.
 mp4_recording_enabled (bool)Enable MP4 recordings (available with v 4.4.3)
 session_auto_recording_enabled (bool)Enable auto-record sessions, note this will impact disk space usage (available with v 5.1.5).
 modify_permissions_enabled (bool)Allow account holders to modify session permissions (available with v 4.4.4)
 available_room_type (str)The Room type(s) which are made available to this account at session level (available with v 5.1.3).\n Values:\n - flex - classic flash room\n - webrtc - new HTML5 room (beta)\n - both - flash and HTML5 are allowed\n
 appshare_fit_to_screen (int)Set default screenshare view mode (available with v 5.1.5).\n Values:\n - 0 - Set default view for application sharing to \"100%\"\n - 1 - Set default view for application sharing to \"Fit To Screen\"\n
 menu_buttons (array)Menu 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 - pushtotalk (bool) - Show/Hide “Push to Talk ” ite. This item can be showed when Microphone is showed. (available with v 4.4.4)\n - requesttospeak (bool) - Show/Hide “Request To Speak” item\n - help (bool) - Show/Hide “About” item
 components (array)Components 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 - participants (bool) - Show/Hide “Participants” component\n - conference (bool) - Show/Hide “Conference” component\n - content_share_1 (bool) - Show/Hide “Content Share #1” component\n - content_share_2 (bool) - Show/Hide “Content Share #2” component\n - content_share_3 (bool) - Show/Hide “Content Share #3” 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 - Show/Hide “Caption Stream” component (available with v 5.0.4 when caption stream feature is enabled on the server level)
 permissions (array)\nPermissions Available in Session (available with v 4.4.4). Use following format to set permissions:
\n{\"allow_local_screen_share\": {\n    \"accountholder\": \"1\",\n    \"moderator\": \"1\",\n    \"participant\": \"0\",\n    \"observer\": \"1\"\n},\n\"allow_screen_inviting\": {\n    \"accountholder\": \"1\",\n    \"moderator\": \"1\",\n    \"participant\": \"1\",\n    \"observer\": \"1\"\n}}\n
Check “Session in-room permissions” table to see all possible permissions and default settings.\n
 voip_session_audio (string)Default Session Audio. Allowed values: phone, voip, hybrid. (available with v 4.3.2)
 voip_available_session_audio (array)Available 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

Return Arguments

\n\n \n \n \n \n \n \n \n \n
id (int)The id of the updated entity.
message (str)Text messsage.
","urlObject":{"path":["api","2","{{user_name}}","service_plan"],"host":["{{API_EndPoint}}"],"query":[],"variable":[]}},"response":[{"id":"8787f7af-5dcd-4ca7-97c2-b8f7965a8c7a","name":"Response","originalRequest":{"method":"POST","header":[{"key":"Authorization","type":"text","name":"Authorization","value":"Basic YWRtaW46c2FtYmEyMDAy"}],"body":{"mode":"formdata","formdata":[]},"url":"{{API_EndPoint}}/api/2/{{user_name}}/service_plan"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate, post-check=0, pre-check=0","name":"Cache-Control","description":""},{"key":"Connection","value":"keep-alive","name":"Connection","description":""},{"key":"Content-Encoding","value":"gzip","name":"Content-Encoding","description":""},{"key":"Content-Type","value":"application/xml","name":"Content-Type","description":""},{"key":"Date","value":"Tue, 30 May 2017 12:01:37 GMT","name":"Date","description":""},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT","name":"Expires","description":""},{"key":"Pragma","value":"no-cache","name":"Pragma","description":""},{"key":"Server","value":"nginx/1.10.3","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""},{"key":"X-Powered-By","value":"PHP/5.4.30","name":"X-Powered-By","description":""}],"cookie":[],"responseTime":null,"body":"\n830Service plan updated\n"}],"_postman_id":"0c339328-27ea-47f7-b5b9-13c0f3eb3c95"},{"name":"/service_plan/id/[int]","id":"8e6d8010-d10e-4078-804b-878b8f7fd3b0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}],"advancedConfig":[{"key":"saveHelperData","value":""},{"key":"showPassword","value":""}]},"isInherited":false},"method":"DELETE","header":[{"key":"Authorization","value":"Basic YWRtaW46c2FtYmEyMDAy"}],"body":{"mode":"formdata","formdata":[]},"url":"{{API_EndPoint}}/api/2/{{user_name}}/service_plan/id/1","description":"

Delete service plan.

\n

Arguments

\n\n \n \n \n \n \n
Requiredid (int)The 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

Return Arguments

\n\n \n \n \n \n \n \n \n \n
id (int)The id of the deleted entity.
message (str)Text messsage.
","urlObject":{"path":["api","2","{{user_name}}","service_plan","id","1"],"host":["{{API_EndPoint}}"],"query":[],"variable":[]}},"response":[{"id":"2aaf0459-62ee-4929-bdcb-f3a02ba2ceed","name":"Response","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","type":"text","name":"Authorization","value":"Basic YWRtaW46c2FtYmEyMDAy"}],"body":{"mode":"formdata","formdata":[]},"url":"{{API_EndPoint}}/api/2/{{user_name}}/service_plan/id/1"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate, post-check=0, pre-check=0","name":"Cache-Control","description":""},{"key":"Connection","value":"keep-alive","name":"Connection","description":""},{"key":"Content-Encoding","value":"gzip","name":"Content-Encoding","description":""},{"key":"Content-Type","value":"application/xml","name":"Content-Type","description":""},{"key":"Date","value":"Tue, 30 May 2017 11:13:39 GMT","name":"Date","description":""},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT","name":"Expires","description":""},{"key":"Pragma","value":"no-cache","name":"Pragma","description":""},{"key":"Server","value":"nginx/1.10.3","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""},{"key":"X-Powered-By","value":"PHP/5.4.30","name":"X-Powered-By","description":""}],"cookie":[],"responseTime":null,"body":"\n583Service plan was deleted\n"}],"_postman_id":"8e6d8010-d10e-4078-804b-878b8f7fd3b0"}],"id":"9f347b63-8280-48ce-bfcc-d3a67cc39b1d","description":"

Service Plans (available with v 4.3.1).

\n

Admin permissions required.

","_postman_id":"9f347b63-8280-48ce-bfcc-d3a67cc39b1d"},{"name":"Session invitees","item":[{"name":"/invitees/id/[int]","id":"9d8a3275-40fa-41cc-b552-d565c184a04c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}],"advancedConfig":[{"key":"saveHelperData","value":""},{"key":"showPassword","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Basic YWRtaW46c2FtYmEyMDAy"}],"url":"{{API_EndPoint}}/api/2/{{user_name}}/invitees/id/1","description":"

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.

\n

Arguments

\n\n \n \n \n \n \n \n \n \n \n \n
Requiredid (int)The id of the session for which invitees should be retrieved.
Optionalrole (string)Limit the returned invitees to users holding a particular role in the session. \nPossible values: all, moderators, participants, observers.
\n

Return Arguments

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
id (int)Account id of the invitee.
first_name (str)The first name of the invited user.
last_name (str)The last name of the invited user.
email (str)The email address of the invited user.
personal_session_link (string)A 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.
","urlObject":{"path":["api","2","{{user_name}}","invitees","id","1"],"host":["{{API_EndPoint}}"],"query":[],"variable":[]}},"response":[{"id":"db49de31-718e-43e3-9e73-12544aa35372","name":"Response","originalRequest":{"method":"GET","header":[{"key":"Authorization","type":"text","name":"Authorization","value":"Basic YWRtaW46c2FtYmEyMDAy"}],"url":"{{API_EndPoint}}/api/2/{{user_name}}/invitees/id/[int]"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate, post-check=0, pre-check=0","name":"Cache-Control","description":""},{"key":"Connection","value":"keep-alive","name":"Connection","description":""},{"key":"Content-Encoding","value":"gzip","name":"Content-Encoding","description":""},{"key":"Content-Type","value":"application/xml","name":"Content-Type","description":""},{"key":"Date","value":"Thu, 01 Jun 2017 10:11:02 GMT","name":"Date","description":""},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT","name":"Expires","description":""},{"key":"Pragma","value":"no-cache","name":"Pragma","description":""},{"key":"Server","value":"nginx/1.10.3","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""},{"key":"X-Powered-By","value":"PHP/5.4.30","name":"X-Powered-By","description":""}],"cookie":[],"responseTime":null,"body":"\n\n \n \n 1\n moderator@mail.com\n Moderator\n Name\n http://domain.com/join/NXUzdXN0aiwxNzMsMQ==\n \n \n \n \n 2\n participants@mail.com\n Participant\n Name\n http://domain.com/join/NXUzdXN0aiwxNzMsNDI3\n \n ...\n ...\n \n \n"}],"_postman_id":"9d8a3275-40fa-41cc-b552-d565c184a04c"},{"name":"/invitee/id/[int]/session_id/[int]","id":"8f74f8cf-75a0-4d4b-af2a-885e6972ec66","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}],"advancedConfig":[{"key":"saveHelperData","value":""},{"key":"showPassword","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Basic YWRtaW46c2FtYmEyMDAy"}],"url":"{{API_EndPoint}}/api/2/{{user_name}}/invitee/id/1/session_id/1","description":"

Get data of single person invited to a session. (available with version 4.2.9)

\n\n \n \n \n \n \n \n \n \n \n \n
Requiredid (int)The id of the user for which invitees should be retrieved.
 session_id (int)The id of the session for which invitees should be retrieved.
\n

Return Arguments

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
id (int)Account id of the invitee.
first_name (str)The first name of the invited user.
last_name (str)The last name of the invited user.
role (str)Role of invited person. Possible values: \n 1 => Moderator\n 2 => Participant\n 3 => Observer\n
email (str)The email address of the invited user.
personal_session_link (string)A 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.
","urlObject":{"path":["api","2","{{user_name}}","invitee","id","1","session_id","1"],"host":["{{API_EndPoint}}"],"query":[],"variable":[]}},"response":[{"id":"8a3355ff-ae78-4a6c-82f0-9a88062cba05","name":"Response","originalRequest":{"method":"GET","header":[{"key":"Authorization","type":"text","name":"Authorization","value":"Basic YWRtaW46c2FtYmEyMDAy"}],"url":"{{API_EndPoint}}/api/2/{{user_name}}/invitee/id/[int]/session_id/[int]"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate, post-check=0, pre-check=0","name":"Cache-Control","description":""},{"key":"Connection","value":"keep-alive","name":"Connection","description":""},{"key":"Content-Encoding","value":"gzip","name":"Content-Encoding","description":""},{"key":"Content-Type","value":"application/xml","name":"Content-Type","description":""},{"key":"Date","value":"Thu, 01 Jun 2017 10:26:41 GMT","name":"Date","description":""},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT","name":"Expires","description":""},{"key":"Pragma","value":"no-cache","name":"Pragma","description":""},{"key":"Server","value":"nginx/1.10.3","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""},{"key":"X-Powered-By","value":"PHP/5.4.30","name":"X-Powered-By","description":""}],"cookie":[],"responseTime":null,"body":"\n\n 427\n user@mail.com\n User\n Name\n 2\n http://domain.com/join/NXUzdXN0aiwxNzMsNDI3\n"}],"_postman_id":"8f74f8cf-75a0-4d4b-af2a-885e6972ec66"},{"name":"/invitee","id":"ea834696-a487-45cd-adfa-23d7c630c5fe","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}],"advancedConfig":[{"key":"saveHelperData","value":""},{"key":"showPassword","value":""}]},"isInherited":false},"method":"PUT","header":[{"key":"Authorization","value":"Basic YWRtaW46c2FtYmEyMDAy"}],"body":{"mode":"raw","raw":"input_type=json&rest_data={\n \"session_id\":1,\n \"email\":\"robin@arsenal.com\",\n \"first_name\":\"Robin\", \n \"last_name\":\"van Persie\",\n \"send_email_invitation\":false,\n \"role\":1\n}"},"url":"{{API_EndPoint}}/api/2/{{user_name}}/invitee","description":"

Add an invitee to a session.

\n

Arguments

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
Requredsession_id (int)ID of the session to which invitee is added.
 email (str)Email address of the invitee.
Optionalfirst_name (str)First name of the invitee.
 last_name (str)Last name of the invitee.
 send_email_invitation (bool)Set 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..
 role (int)Define role of the invitee in the session. Default is 2.\n1 = Moderator, \n2 = Participants, \n3 = Observer.
\n

Return Arguments

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
id (int)Account id of the invitee.
first_name (str)The first name of the invited user (Available in v5.1.7).
last_name (str)The last name of the invited user (Available in v5.1.7).
email (str)The email address of the invited user (Available in v5.1.7).
personal_session_link (string)A 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).
","urlObject":{"path":["api","2","{{user_name}}","invitee"],"host":["{{API_EndPoint}}"],"query":[],"variable":[]}},"response":[{"id":"fbf10fa0-c434-4ff1-ba66-171740f793f1","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":[{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate, post-check=0, pre-check=0","name":"Cache-Control","description":""},{"key":"Connection","value":"keep-alive","name":"Connection","description":""},{"key":"Content-Encoding","value":"gzip","name":"Content-Encoding","description":""},{"key":"Content-Type","value":"application/xml","name":"Content-Type","description":""},{"key":"Date","value":"Thu, 01 Jun 2017 10:49:41 GMT","name":"Date","description":""},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT","name":"Expires","description":""},{"key":"Pragma","value":"no-cache","name":"Pragma","description":""},{"key":"Server","value":"nginx/1.10.3","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""},{"key":"X-Powered-By","value":"PHP/5.4.30","name":"X-Powered-By","description":""}],"cookie":[],"responseTime":null,"body":"\n\n 1\n Invitee added\n"}],"_postman_id":"ea834696-a487-45cd-adfa-23d7c630c5fe"},{"name":"/invitee","id":"3f6efb1e-8b16-477d-8ec9-719481e4d7f0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}],"advancedConfig":[{"key":"saveHelperData","value":""},{"key":"showPassword","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Basic YWRtaW46c2FtYmEyMDAy"}],"body":{"mode":"raw","raw":"input_type=json&rest_data={\n \"session_id\":1,\n \"user_id\":1,\n \"send_email_invitation\":false,\n \"role\":1\n}"},"url":"{{API_EndPoint}}/api/2/{{user_name}}/invitee","description":"

Modify the role of an invitee to a session.

\n

Arguments

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
Requredsession_id (int)ID of the session to which invitee is added.
 user_id(int)User ID of the invitee. The PUT call returned this.
Optionalsend_email_invitation (bool)Set 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..
 role (int)Define role of the invitee in the session. Default is 2.\n1 = Moderator, \n2 = Participants, \n3 = Observer.
\n

Return Arguments

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
id (int)Account id of the invitee.
first_name (str)The first name of the invited user (Available in v5.1.7).
last_name (str)The last name of the invited user (Available in v5.1.7).
email (str)The email address of the invited user (Available in v5.1.7).
personal_session_link (string)A 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).
","urlObject":{"path":["api","2","{{user_name}}","invitee"],"host":["{{API_EndPoint}}"],"query":[],"variable":[]}},"response":[{"id":"eaed52da-4c83-4fef-9fa5-0fc876b4d964","name":"Response","originalRequest":{"method":"POST","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\"user_id\":1,\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":[{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate, post-check=0, pre-check=0","name":"Cache-Control","description":""},{"key":"Connection","value":"keep-alive","name":"Connection","description":""},{"key":"Content-Encoding","value":"gzip","name":"Content-Encoding","description":""},{"key":"Content-Type","value":"application/xml","name":"Content-Type","description":""},{"key":"Date","value":"Thu, 01 Jun 2017 10:56:16 GMT","name":"Date","description":""},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT","name":"Expires","description":""},{"key":"Pragma","value":"no-cache","name":"Pragma","description":""},{"key":"Server","value":"nginx/1.10.3","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""},{"key":"X-Powered-By","value":"PHP/5.4.30","name":"X-Powered-By","description":""}],"cookie":[],"responseTime":null,"body":"\n\n 1\n Invitation was updated\n"}],"_postman_id":"3f6efb1e-8b16-477d-8ec9-719481e4d7f0"},{"name":"/invitee","id":"399998e7-77cb-4ec3-a9b8-afc507944cda","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}],"advancedConfig":[{"key":"saveHelperData","value":""},{"key":"showPassword","value":""}]},"isInherited":false},"method":"DELETE","header":[{"key":"Authorization","value":"Basic YWRtaW46c2FtYmEyMDAy"}],"body":{"mode":"formdata","formdata":[]},"url":"{{API_EndPoint}}/api/2/{{user_name}}/invitee","description":"

Delete an invitee from a session.

\n

Arguments

\n\n \n \n \n \n \n \n \n \n \n \n
Requredsession_id (int)ID of the session to which invitee is added.
 user_id (int)User ID of the invitee.
\n

Return Arguments

\n\n \n \n \n \n \n \n \n \n
id (int)The id of deleted invitee.
message (str)Text messsage.
","urlObject":{"path":["api","2","{{user_name}}","invitee"],"host":["{{API_EndPoint}}"],"query":[],"variable":[]}},"response":[{"id":"b6453f21-0e03-4026-95eb-792b7d1d0916","name":"Response","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Basic YWRtaW46c2FtYmEyMDAy"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"input_type=json&rest_data={\n\t\"session_id\":1,\n\t\"user_id\":1\n}\t"},"url":"{{API_EndPoint}}/api/2/{{user_name}}/invitee"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"\n\n 1\n Invitee deleted\n"}],"_postman_id":"399998e7-77cb-4ec3-a9b8-afc507944cda"}],"id":"4cf24e6e-dba5-46a9-9b32-c783dfc20cb8","_postman_id":"4cf24e6e-dba5-46a9-9b32-c783dfc20cb8","description":""},{"name":"Session recurring","item":[{"name":"/session_recurring/session_id/[int]","id":"8000570a-bbcc-4ce1-b22c-b8c42656d369","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}],"advancedConfig":[{"key":"saveHelperData","value":""},{"key":"showPassword","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Basic YWRtaW46c2FtYmEyMDAy"}],"url":"{{API_EndPoint}}/api/2/{{user_name}}/session_recurring/session_id/1","description":"

Get session recurring settings (Available in v5.1.8).

\n

Arguments

\n\n \n \n \n \n \n
Requiredsession_id (int)The id of the recurring session (The main session in the series).
\n

Return Arguments

\n
shedule (array):
\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
session_id (int)The id of the recurring session (The main session in the series).
start_time (str)The start time of the first recurring session (series start time).
period (str)Recurring period: day, week or month.
frequency (int)Recurring frequency.
repeat_on (string)When repeat session in selected period. Days of week for week period, or day of the month for month period.
end_date (date)The series end date.
end_occurrences (int)Number of sessions in the series.
\n
sessions (array) - session IDs and start dates of all sessions in the series:
\n\n \n \n \n \n \n \n \n \n
id (int)The id of the recurring session.
start_date (date)The start date of the recurring session.
","urlObject":{"path":["api","2","{{user_name}}","session_recurring","session_id","1"],"host":["{{API_EndPoint}}"],"query":[],"variable":[]}},"response":[{"id":"bd3c313c-5403-404f-b32f-92740009d59e","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":[{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate, post-check=0, pre-check=0","name":"Cache-Control","description":""},{"key":"Connection","value":"keep-alive","name":"Connection","description":""},{"key":"Content-Encoding","value":"gzip","name":"Content-Encoding","description":""},{"key":"Content-Type","value":"application/xml","name":"Content-Type","description":""},{"key":"Date","value":"Thu, 01 Jun 2017 10:49:41 GMT","name":"Date","description":""},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT","name":"Expires","description":""},{"key":"Pragma","value":"no-cache","name":"Pragma","description":""},{"key":"Server","value":"nginx/1.10.3","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""},{"key":"X-Powered-By","value":"PHP/5.4.30","name":"X-Powered-By","description":""}],"cookie":[],"responseTime":null,"body":"\n\n 1\n Invitee added\n"}],"_postman_id":"8000570a-bbcc-4ce1-b22c-b8c42656d369"},{"name":"/session_recurring","id":"3fad5070-7521-46da-9bb5-5394b8fbe90f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}],"advancedConfig":[{"key":"saveHelperData","value":""},{"key":"showPassword","value":""}]},"isInherited":false},"method":"PUT","header":[{"key":"Authorization","value":"Basic YWRtaW46c2FtYmEyMDAy"}],"body":{"mode":"raw","raw":"input_type=json&rest_data={\n \"session_id\":1,\n \"email\":\"robin@arsenal.com\",\n \"first_name\":\"Robin\", \n \"last_name\":\"van Persie\",\n \"send_email_invitation\":false,\n \"role\":1\n}"},"url":"{{API_EndPoint}}/api/2/{{user_name}}//session_recurring","description":"

Make recurring session series (Available in v5.1.8).

\n

Arguments

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
Requiredsession_id (int)The id of the recurring session (The main session in the series).
 period (str)Recurring period: day, week or month.
 frequency (int)Recurring frequency. Repeat every [frequency] period. For example: set 2 to repeat every 2 week, or set 5 to repeat session onse in 5 days.
 end_date (date)The series end date. Should be date up to 6 months into the future.
Optionalend_occurrences (int)Number of sessions in the series (this argument required when end_date is empty).
 repeat_on (string)\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
 type (string)Possible values:\n - reuse: re-use same session (default)\n - duplicate: create new session for each \n (Available in v5.1.9)\n
\n

Return Arguments

\n
sessions (array) - session IDs and start dates of all sessions in the series:
\n\n \n \n \n \n \n \n \n \n
id (int)The id of the recurring session.
start_date (date)The start date of the recurring session.
","urlObject":{"path":["api","2","{{user_name}}","","session_recurring"],"host":["{{API_EndPoint}}"],"query":[],"variable":[]}},"response":[{"id":"ce744cd4-d88e-4550-b4ca-8d56d4ba9ab5","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":[{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate, post-check=0, pre-check=0","name":"Cache-Control","description":""},{"key":"Connection","value":"keep-alive","name":"Connection","description":""},{"key":"Content-Encoding","value":"gzip","name":"Content-Encoding","description":""},{"key":"Content-Type","value":"application/xml","name":"Content-Type","description":""},{"key":"Date","value":"Thu, 01 Jun 2017 10:49:41 GMT","name":"Date","description":""},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT","name":"Expires","description":""},{"key":"Pragma","value":"no-cache","name":"Pragma","description":""},{"key":"Server","value":"nginx/1.10.3","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""},{"key":"X-Powered-By","value":"PHP/5.4.30","name":"X-Powered-By","description":""}],"cookie":[],"responseTime":null,"body":"\n\n 1\n Invitee added\n"}],"_postman_id":"3fad5070-7521-46da-9bb5-5394b8fbe90f"},{"name":"/session_recurring","id":"963019e3-87ba-4f03-875e-eae9a676789e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}],"advancedConfig":[{"key":"saveHelperData","value":""},{"key":"showPassword","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Basic YWRtaW46c2FtYmEyMDAy"}],"body":{"mode":"raw","raw":"input_type=json&rest_data={\n \"session_id\":1,\n \"user_id\":1,\n \"send_email_invitation\":false,\n \"role\":1\n}"},"url":"{{API_EndPoint}}/api/2/{{user_name}}//session_recurring","description":"

Update recurring session shedule (Available in v5.1.8).

\n

Arguments

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
Requiredsession_id (int)The id of the recurring session (The main session in the series).
 period (str)Recurring period: day, week or month.
 frequency (int)Recurring frequency. Repeat every [frequency] period. For example: set 2 to repeat every 2 week, or set 5 to repeat session onse in 5 days.
 end_date (date)The series end date. Should be date up to 6 months into the future.
Optionalend_occurrences (int)Number of sessions in the series (this argument required when end_date is empty).
 repeat_on (string)\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
 type (string)Possible values:\n - reuse: re-use same session (default)\n - duplicate: create new session for each \n (Available in v5.1.9)\n
\n

Return Arguments

\n
sessions (array) - session IDs and start dates of all sessions in the series:
\n\n \n \n \n \n \n \n \n \n
id (int)The id of the recurring session.
start_date (date)The start date of the recurring session.
","urlObject":{"path":["api","2","{{user_name}}","","session_recurring"],"host":["{{API_EndPoint}}"],"query":[],"variable":[]}},"response":[{"id":"0165b0dc-04a9-4b44-84d2-04e38787a48a","name":"Response","originalRequest":{"method":"POST","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\"user_id\":1,\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":[{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate, post-check=0, pre-check=0","name":"Cache-Control","description":""},{"key":"Connection","value":"keep-alive","name":"Connection","description":""},{"key":"Content-Encoding","value":"gzip","name":"Content-Encoding","description":""},{"key":"Content-Type","value":"application/xml","name":"Content-Type","description":""},{"key":"Date","value":"Thu, 01 Jun 2017 10:56:16 GMT","name":"Date","description":""},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT","name":"Expires","description":""},{"key":"Pragma","value":"no-cache","name":"Pragma","description":""},{"key":"Server","value":"nginx/1.10.3","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""},{"key":"X-Powered-By","value":"PHP/5.4.30","name":"X-Powered-By","description":""}],"cookie":[],"responseTime":null,"body":"\n\n 1\n Invitation was updated\n"}],"_postman_id":"963019e3-87ba-4f03-875e-eae9a676789e"},{"name":"/session_recurring","id":"d1110152-b918-4a6a-a3ab-81d4546a1be5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}],"advancedConfig":[{"key":"saveHelperData","value":""},{"key":"showPassword","value":""}]},"isInherited":false},"method":"DELETE","header":[{"key":"Authorization","value":"Basic YWRtaW46c2FtYmEyMDAy"}],"body":{"mode":"formdata","formdata":[]},"url":"{{API_EndPoint}}/api/2/{{user_name}}/session_recurring","description":"

Delete recurring sessions and convert main session in the series to regular session (Available in v5.1.8).

\n

Arguments

\n\n \n \n \n \n \n
Requredsession_id (int)The id of the recurring session (The main session in the series).
\n

Return Arguments

\n\n \n \n \n \n \n \n \n \n
session_id (int)The id of the recurring session (The main session in the series).
message (str)Text messsage.
","urlObject":{"path":["api","2","{{user_name}}","session_recurring"],"host":["{{API_EndPoint}}"],"query":[],"variable":[]}},"response":[{"id":"23170697-3708-49fc-9ecd-d8e232fe99ef","name":"Response","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Basic YWRtaW46c2FtYmEyMDAy"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"input_type=json&rest_data={\n\t\"session_id\":1,\n\t\"user_id\":1\n}\t"},"url":"{{API_EndPoint}}/api/2/{{user_name}}/invitee"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"\n\n 1\n Invitee deleted\n"}],"_postman_id":"d1110152-b918-4a6a-a3ab-81d4546a1be5"}],"id":"3490881c-bc92-447a-872e-61b6fcc88d6b","_postman_id":"3490881c-bc92-447a-872e-61b6fcc88d6b","description":""},{"name":"Sessions","item":[{"name":"/session/id/[int]","id":"e2ae0b71-7c0f-4795-a493-1bc44adb5429","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}],"advancedConfig":[{"key":"saveHelperData","value":""},{"key":"showPassword","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Basic YWRtaW46c2FtYmEyMDAy"}],"url":"{{API_EndPoint}}/api/2/{{user_name}}/session/id/[int]","description":"

Return session data by given ID#.

\n

Arguments

\n\n \n \n \n \n \n
Requredid (int)id of the session to be returned.
\n

Return Arguments (Regular Session)

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
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.
password (str)The session’s access password, required to join. None, if empty.
session_access_code (int)Code to join the session via telephone. Only available if VOIP bridge module is purchased.
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.
","urlObject":{"path":["api","2","{{user_name}}","session","id","[int]"],"host":["{{API_EndPoint}}"],"query":[],"variable":[]}},"response":[{"id":"34cdae8a-0894-4ae5-acce-e72feeacec91","name":"Advanced Session","originalRequest":{"method":"GET","header":[{"key":"Authorization","type":"text","name":"Authorization","value":"Basic YWRtaW46c2FtYmEyMDAy"}],"url":"{{API_EndPoint}}/api/2/{{user_name}}/session/id/[int]"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate, post-check=0, pre-check=0","name":"Cache-Control","description":""},{"key":"Connection","value":"keep-alive","name":"Connection","description":""},{"key":"Content-Encoding","value":"gzip","name":"Content-Encoding","description":""},{"key":"Content-Type","value":"application/xml","name":"Content-Type","description":""},{"key":"Date","value":"Thu, 01 Jun 2017 11:54:26 GMT","name":"Date","description":""},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT","name":"Expires","description":""},{"key":"Pragma","value":"no-cache","name":"Pragma","description":""},{"key":"Server","value":"nginx/1.10.3","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""},{"key":"X-Powered-By","value":"PHP/5.4.30","name":"X-Powered-By","description":""}],"cookie":[],"responseTime":null,"body":"\n\n 173\n http://domain.com/go/admin/5u3ustj\n 1\n \n \n Advanced Session\n 2017-07-29 10:15:00\n 60\n \n Some text\n Some text\n 0\n \n 0\n \n \n \n \n \n 1\n moderator@mail.com\n Moderator\n Name\n http://domain.com/join/NXUzdXN0aiwxNzMsNDI3\n \n \n \n \n 2\n participant@mail.com\n Participant\n Name\n http://domain.com/join/NXUzdXN0aiwxNzMsNDQ1\n \n \n \n \n 0\n \n \n 0\n 2\n 0\n 0\n 0\n \n email\n company\n \n \n \n 0\n 0\n 0\n 1\n voip\n 0\n \n \n http://domain.com/register/admin/5u3ustj\n 0\n 0\n 2\n \n 1\n You have been registered to this event. Thank you!\n \n \n \n first_name\n text\n first_name\n 1\n 1\n \n \n last_name\n text\n last_name\n 1\n 1\n \n \n gender\n select\n gender\n 0\n 0\n \n male\n female\n \n 0\n \n \n email\n text\n email\n 1\n 1\n \n \n phone\n text\n phone\n 0\n 0\n \n \n job_title\n text\n job_title\n 0\n 0\n \n \n company\n text\n company\n 1\n 0\n \n \n address\n text\n address\n 0\n 0\n \n \n city\n text\n city\n 0\n 0\n \n \n state\n text\n state\n 0\n 0\n \n \n postcode\n text\n postcode\n 0\n 0\n \n \n country\n select\n country\n 0\n 0\n \n \n website\n text\n website\n 0\n 0\n \n \n industry\n text\n industry\n 0\n 0\n \n \n \n Content\n Content\n Content\n \n \n 0\n 0\n 0\n 0\n 60\n minutes\n 10\n minutes\n \n \n 1\n 1\n 1\n 1\n 1\n 1\n 1\n 1\n 1\n 1\n 1\n 1\n 1\n \n \n http://domain.com/sessions/report/csv/1/7fbd3ed58c9e4d258d1ce7c84f68f1ec\n http://domain.com/sessions/report/xls/1/7fbd3ed58c9e4d258d1ce7c84f68f1ec\n http://domain.com/sessions/polls_report/csv/1/7fbd3ed58c9e4d258d1ce7c84f68f1ec\n http://domain.com/sessions/polls_report/xls/1/7fbd3ed58c9e4d258d1ce7c84f68f1ec\n \n \n http://domian.com/themes/flat_ui/images/default_branding/event_photo.png\n http://domain.com/storage/users/1/branding_session_173_email_header.png\n http://domain.com/themes/flat_ui/images/default_branding/emails/footer.png\n \n"},{"id":"8019bde3-8478-4a90-b25d-84cc61117f78","name":"Regular Session","originalRequest":{"method":"GET","header":[{"key":"Authorization","type":"text","name":"Authorization","value":"Basic YWRtaW46c2FtYmEyMDAy"}],"url":"{{API_EndPoint}}/api/2/{{user_name}}/session/id/[int]"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate, post-check=0, pre-check=0","name":"Cache-Control","description":""},{"key":"Connection","value":"keep-alive","name":"Connection","description":""},{"key":"Content-Encoding","value":"gzip","name":"Content-Encoding","description":""},{"key":"Content-Type","value":"application/xml","name":"Content-Type","description":""},{"key":"Date","value":"Thu, 01 Jun 2017 11:59:27 GMT","name":"Date","description":""},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT","name":"Expires","description":""},{"key":"Pragma","value":"no-cache","name":"Pragma","description":""},{"key":"Server","value":"nginx/1.10.3","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""},{"key":"X-Powered-By","value":"PHP/5.4.30","name":"X-Powered-By","description":""}],"cookie":[],"responseTime":null,"body":"\n\n 2\n Regulart session\n 2017-06-01 12:05:00\n 60\n \n \n http://domain.com/go/admin/ncp2snq\n 0\n"}],"_postman_id":"e2ae0b71-7c0f-4795-a493-1bc44adb5429"},{"name":"/user_session/id/[int]","id":"7731eedc-c5af-43c7-b8f1-05684bba8b87","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}],"advancedConfig":[{"key":"saveHelperData","value":""},{"key":"showPassword","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Basic YWRtaW46c2FtYmEyMDAy"}],"url":"{{API_EndPoint}}/api/2/{{user_name}}/user_session/id/[int]","description":"

Return sub account session's data by given ID#. Available with version 5.2.1.

\n

Arguments

\n\n \n \n \n \n \n
Requredid (int)id of the session to be returned.
\n

Return Arguments (Regular Session)

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
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.
password (str)The session’s access password, required to join. None, if empty.
session_access_code (int)Code to join the session via telephone. Only available if VOIP bridge module is purchased.
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.
","urlObject":{"path":["api","2","{{user_name}}","user_session","id","[int]"],"host":["{{API_EndPoint}}"],"query":[],"variable":[]}},"response":[{"id":"1633bf71-24d7-4898-994d-b3628d362873","name":"Advanced Session","originalRequest":{"method":"GET","header":[{"key":"Authorization","type":"text","name":"Authorization","value":"Basic YWRtaW46c2FtYmEyMDAy"}],"url":"{{API_EndPoint}}/api/2/{{user_name}}/session/id/[int]"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate, post-check=0, pre-check=0","name":"Cache-Control","description":""},{"key":"Connection","value":"keep-alive","name":"Connection","description":""},{"key":"Content-Encoding","value":"gzip","name":"Content-Encoding","description":""},{"key":"Content-Type","value":"application/xml","name":"Content-Type","description":""},{"key":"Date","value":"Thu, 01 Jun 2017 11:54:26 GMT","name":"Date","description":""},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT","name":"Expires","description":""},{"key":"Pragma","value":"no-cache","name":"Pragma","description":""},{"key":"Server","value":"nginx/1.10.3","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""},{"key":"X-Powered-By","value":"PHP/5.4.30","name":"X-Powered-By","description":""}],"cookie":[],"responseTime":null,"body":"\n\n 173\n http://domain.com/go/admin/5u3ustj\n 1\n \n \n Advanced Session\n 2017-07-29 10:15:00\n 60\n \n Some text\n Some text\n 0\n \n 0\n \n \n \n \n \n 1\n moderator@mail.com\n Moderator\n Name\n http://domain.com/join/NXUzdXN0aiwxNzMsNDI3\n \n \n \n \n 2\n participant@mail.com\n Participant\n Name\n http://domain.com/join/NXUzdXN0aiwxNzMsNDQ1\n \n \n \n \n 0\n \n \n 0\n 2\n 0\n 0\n 0\n \n email\n company\n \n \n \n 0\n 0\n 0\n 1\n voip\n 0\n \n \n http://domain.com/register/admin/5u3ustj\n 0\n 0\n 2\n \n 1\n You have been registered to this event. Thank you!\n \n \n \n first_name\n text\n first_name\n 1\n 1\n \n \n last_name\n text\n last_name\n 1\n 1\n \n \n gender\n select\n gender\n 0\n 0\n \n male\n female\n \n 0\n \n \n email\n text\n email\n 1\n 1\n \n \n phone\n text\n phone\n 0\n 0\n \n \n job_title\n text\n job_title\n 0\n 0\n \n \n company\n text\n company\n 1\n 0\n \n \n address\n text\n address\n 0\n 0\n \n \n city\n text\n city\n 0\n 0\n \n \n state\n text\n state\n 0\n 0\n \n \n postcode\n text\n postcode\n 0\n 0\n \n \n country\n select\n country\n 0\n 0\n \n \n website\n text\n website\n 0\n 0\n \n \n industry\n text\n industry\n 0\n 0\n \n \n \n Content\n Content\n Content\n \n \n 0\n 0\n 0\n 0\n 60\n minutes\n 10\n minutes\n \n \n 1\n 1\n 1\n 1\n 1\n 1\n 1\n 1\n 1\n 1\n 1\n 1\n 1\n \n \n http://domain.com/sessions/report/csv/1/7fbd3ed58c9e4d258d1ce7c84f68f1ec\n http://domain.com/sessions/report/xls/1/7fbd3ed58c9e4d258d1ce7c84f68f1ec\n http://domain.com/sessions/polls_report/csv/1/7fbd3ed58c9e4d258d1ce7c84f68f1ec\n http://domain.com/sessions/polls_report/xls/1/7fbd3ed58c9e4d258d1ce7c84f68f1ec\n \n \n http://domian.com/themes/flat_ui/images/default_branding/event_photo.png\n http://domain.com/storage/users/1/branding_session_173_email_header.png\n http://domain.com/themes/flat_ui/images/default_branding/emails/footer.png\n \n"},{"id":"a75402bd-93ba-4a63-8c85-670a03bac5eb","name":"Regular Session","originalRequest":{"method":"GET","header":[{"key":"Authorization","type":"text","name":"Authorization","value":"Basic YWRtaW46c2FtYmEyMDAy"}],"url":"{{API_EndPoint}}/api/2/{{user_name}}/session/id/[int]"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate, post-check=0, pre-check=0","name":"Cache-Control","description":""},{"key":"Connection","value":"keep-alive","name":"Connection","description":""},{"key":"Content-Encoding","value":"gzip","name":"Content-Encoding","description":""},{"key":"Content-Type","value":"application/xml","name":"Content-Type","description":""},{"key":"Date","value":"Thu, 01 Jun 2017 11:59:27 GMT","name":"Date","description":""},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT","name":"Expires","description":""},{"key":"Pragma","value":"no-cache","name":"Pragma","description":""},{"key":"Server","value":"nginx/1.10.3","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""},{"key":"X-Powered-By","value":"PHP/5.4.30","name":"X-Powered-By","description":""}],"cookie":[],"responseTime":null,"body":"\n\n 2\n Regulart session\n 2017-06-01 12:05:00\n 60\n \n \n http://domain.com/go/admin/ncp2snq\n 0\n"}],"_postman_id":"7731eedc-c5af-43c7-b8f1-05684bba8b87"},{"name":"/sessions","id":"1884d74b-a681-4430-81fc-d0433fc2d63f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}],"advancedConfig":[{"key":"saveHelperData","value":""},{"key":"showPassword","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Basic YWRtaW46c2FtYmEyMDAy"}],"url":"{{API_EndPoint}}/api/2/{{user_name}}/sessions","description":"

Return list of sessions.

\n

Arguments

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
Optionalcount(int)Specify number of returned results. Default is 100.
 offset(int)Specify to move the cursor through the recordset. Default is 0.
 order(str)Return results in ascending or descending order of session ID. Default is asc. \nAccepted values: asc, desc.
\n\n

Return Arguments

\n

See GET /session/id/[int] method.

","urlObject":{"path":["api","2","{{user_name}}","sessions"],"host":["{{API_EndPoint}}"],"query":[],"variable":[]}},"response":[{"id":"a2836700-a31d-45c6-a2a3-ea45cfacb265","name":"Response","originalRequest":{"method":"GET","header":[{"key":"Authorization","type":"text","name":"Authorization","value":"Basic YWRtaW46c2FtYmEyMDAy"}],"url":"{{API_EndPoint}}/api/2/{{user_name}}/sessions"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate, post-check=0, pre-check=0","name":"Cache-Control","description":""},{"key":"Connection","value":"keep-alive","name":"Connection","description":""},{"key":"Content-Encoding","value":"gzip","name":"Content-Encoding","description":""},{"key":"Content-Type","value":"application/xml","name":"Content-Type","description":""},{"key":"Date","value":"Wed, 07 Jun 2017 06:46:18 GMT","name":"Date","description":""},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT","name":"Expires","description":""},{"key":"Pragma","value":"no-cache","name":"Pragma","description":""},{"key":"Server","value":"nginx/1.10.3","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""},{"key":"X-Powered-By","value":"PHP/5.4.30","name":"X-Powered-By","description":""}],"cookie":[],"responseTime":null,"body":"\n\n \n 1\n test\n 2017-03-13 13:15:00\n 60\n \n \n http://os4-dev.keymeeting.it/go/admin/uckolps\n 0\n \n ...\n ...\n ...\n"}],"_postman_id":"1884d74b-a681-4430-81fc-d0433fc2d63f"},{"name":"/user_sessions/user_id/[int]","id":"85df8bf0-3ba1-4fe6-b0d9-b30f83142f37","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}],"advancedConfig":[{"key":"saveHelperData","value":""},{"key":"showPassword","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Basic YWRtaW46c2FtYmEyMDAy"}],"url":"{{API_EndPoint}}/api/2/{{user_name}}/user_sessions/user_id/[int]","description":"

Return list of sessions related to sub account. Available with version 5.2.1.

\n

Arguments

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
Requireduser_id(int)ID of child user.
Optionalcount(int)Specify number of returned results. Default is 100.
 offset(int)Specify to move the cursor through the recordset. Default is 0.
 order(str)Return results in ascending or descending order of session ID. Default is asc. \nAccepted values: asc, desc.
\n\n

Return Arguments

\n

See GET /session/id/[int] method.

","urlObject":{"path":["api","2","{{user_name}}","user_sessions","user_id","[int]"],"host":["{{API_EndPoint}}"],"query":[],"variable":[]}},"response":[{"id":"3518f220-abe6-4803-8552-3741ceb0bdcc","name":"Response","originalRequest":{"method":"GET","header":[{"key":"Authorization","type":"text","name":"Authorization","value":"Basic YWRtaW46c2FtYmEyMDAy"}],"url":"{{API_EndPoint}}/api/2/{{user_name}}/sessions"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate, post-check=0, pre-check=0","name":"Cache-Control","description":""},{"key":"Connection","value":"keep-alive","name":"Connection","description":""},{"key":"Content-Encoding","value":"gzip","name":"Content-Encoding","description":""},{"key":"Content-Type","value":"application/xml","name":"Content-Type","description":""},{"key":"Date","value":"Wed, 07 Jun 2017 06:46:18 GMT","name":"Date","description":""},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT","name":"Expires","description":""},{"key":"Pragma","value":"no-cache","name":"Pragma","description":""},{"key":"Server","value":"nginx/1.10.3","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""},{"key":"X-Powered-By","value":"PHP/5.4.30","name":"X-Powered-By","description":""}],"cookie":[],"responseTime":null,"body":"\n\n \n 1\n test\n 2017-03-13 13:15:00\n 60\n \n \n http://os4-dev.keymeeting.it/go/admin/uckolps\n 0\n \n ...\n ...\n ...\n"}],"_postman_id":"85df8bf0-3ba1-4fe6-b0d9-b30f83142f37"},{"name":"/invited_sessions","id":"e88e8f66-cb18-4775-9549-bafe6e75ad63","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}],"advancedConfig":[{"key":"saveHelperData","value":""},{"key":"showPassword","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Basic YWRtaW46c2FtYmEyMDAy"}],"url":"{{API_EndPoint}}/api/2/{{user_name}}/invited_sessions","description":"

Get invited sessions associated with this user account. Available with version 4.2.4.

\n

Arguments

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
Optionalcount(int)Specify number of returned results. Default is 100.
 offset(int)Specify to move the cursor through the recordset. Default is 0.
 order(str)Return results in ascending or descending order of session ID. Default is asc. \nAccepted values: asc, desc.
\n\n

Return Arguments

\n

See GET /session/id/[int] method.

","urlObject":{"path":["api","2","{{user_name}}","invited_sessions"],"host":["{{API_EndPoint}}"],"query":[],"variable":[]}},"response":[{"id":"7e0940d1-62f1-4e57-9211-402c7d654cc5","name":"Response","originalRequest":{"method":"GET","header":[{"key":"Authorization","type":"text","name":"Authorization","value":"Basic YWRtaW46c2FtYmEyMDAy"}],"url":"{{API_EndPoint}}/api/2/{{user_name}}/invited_sessions"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate, post-check=0, pre-check=0","name":"Cache-Control","description":""},{"key":"Connection","value":"keep-alive","name":"Connection","description":""},{"key":"Content-Encoding","value":"gzip","name":"Content-Encoding","description":""},{"key":"Content-Type","value":"application/xml","name":"Content-Type","description":""},{"key":"Date","value":"Wed, 07 Jun 2017 07:30:30 GMT","name":"Date","description":""},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT","name":"Expires","description":""},{"key":"Pragma","value":"no-cache","name":"Pragma","description":""},{"key":"Server","value":"nginx/1.10.3","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""},{"key":"X-Powered-By","value":"PHP/5.4.30","name":"X-Powered-By","description":""}],"cookie":[],"responseTime":null,"body":"\n\n \n 310\n Invited session\n 2017-06-07 07:35:00\n 60\n \n \n http://domain.com/go/usename/zge17y2\n 0\n \n ......\n"}],"_postman_id":"e88e8f66-cb18-4775-9549-bafe6e75ad63"},{"name":"/session","id":"41d9ba55-84db-4270-a986-b4c769211bea","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}],"advancedConfig":[{"key":"saveHelperData","value":""},{"key":"showPassword","value":""}]},"isInherited":false},"method":"PUT","header":[{"key":"Authorization","value":"Basic YWRtaW46c2FtYmEyMDAy"}],"body":{"mode":"raw","raw":"input_type=json&rest_data={\n \"topic\": \"Test\",\n \"duration\": 60, \n \"start_time\": \"2017-09-10 12:00:00\", \n \"invited_participants\":[\n {\n \"email\":\"email@domain.com\",\n \"first_name\":\"First Name\",\n \"last_name\":\"Last Name\",\n \"role\":1,\n \"send_email_invitation\":0\n }\n ],\"custom_data\": [\n {\n \"custom1\":\"first custom value\", \n \"custom2\":\"second custom value\", \n \"custom3\":\"third custom value\",\n \"custom4\":\"fourth custom value\"\n }\n ]\n}"},"url":"{{API_EndPoint}}/api/2/{{user_name}}/session","description":"

Create a new session

\n

Arguments

\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n

\n
Requiredtopic (str)The title of the meeting.
 duration (int)Duration of the meeting, in minutes.
 start_time (datetime)Start time in datetime format eg \n“2010-08-31 11:05:00”. Will always default to the user’s timezone & DST settings.See the “Timezones” section for more info.
Optionalfriendly_url (str)Define a friendly URL segment to be used instead of auto-generated rather than encrypted meeting ID.
 password (str)To password protect the meeting define this.
 invited_participants (array)JSON 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: Moderator (1), Participant (2) or Observer (3)\n\n

send_email_invitations (bool): Set 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.

 custom_data (array)JSON 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.\nCustom value is varchar(200).
\n

Advanced Session Arguments

\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”.

\n

Advanced params are available in PUT and POST session API methods

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
Requiredadvanced_mode (bool)Set to true to enable advanced params for this session. Default is false..
Optionalprevent_user_count (bool)Set to true to hide the user count from participants and observers. Moderators can always see this number. Default is false.
 save_contacts_to_ab (bool)Set to true to save invitees to your Address Book. Default is false.
 all_day (bool)Set this param to true when session should take all day (available with v 5.1.5).
 attach_calendar_file (int)Select ICS attacments mode (available with v 5.1.5).\n \n

Allowed values:

\n
    \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
 description (text)Description of the session.
 agenda (text)Agenda of the session.
 type (str)The Session Room type (available with v 5.1.3).\n Possible values:\n - flash - classic flash room\n - html5 - new HTML5 room (beta)\n NOTE: Session type can only be defined when creating the session.\n
 display_custom_instructions (bool)Set to true to display custom instructions for participants.
 custom_instructions (text)Custom instructions for participants, these will be displayed on the session login page.
 enable_join_sound (bool)Play a sound every time a user joins this session.
 guests_join_as (int)Set the default role for guests that have not been specifically invited and given a role then: \n Moderator (1), \n Participant (2) \n Observer (3). \n Default is Participant.
 access_embed_widget_for_rec (bool)Set to true to allow recording viewers to see the embed code to integrate the recording elsewhere. Defaults is false.
 access_enable_lobby (bool)This option puts non-moderators in a lobby until moderators allow them to enter the session. Not available when the teleconference option is selected
 access_enable_breakout_rooms (bool)Allow participants to disperse into smaller groups while in session. Not available when the teleconference option is selected
 access_guest_login_fields (array)List of optional fields on session login form. Allowed fields: email, company.\n\n

Format: 

[\"email\",\"company\"]
(available with v 5.0.2)

\n
 access_before_start (numeric)Restrict early access. (available with v 5.1.5)
 access_public_visibity (numeric)Make 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 \n

Allowed values:

\n
    \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
 private_access (bool)Set 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)
 av_use_teleconference (bool)Set to true to allow users to dial-in to the session using conventional telephones. Default is false. Note: the dial-in module requires a seperate license and is not available by default.
 av_encrypt_streams (bool)Set to true to use RTMPE encryption for all streams, instead of the default RTMP.
 av_voip_conf_mode (int)Audio for participants and observers dialing in should be (0) not muted, (1) muted, may unmute or (2) muted, may not unmute. Default is 0 (not muted).
 av_autobroadcast (bool)Automatically start audio & video broadcast when entering the session (you and moderators only)
 av_fit_to_screen (bool)Default view for application sharing.\n\n

Set to true to use \"Fit To Screen\", set to false to use \"100%\".\n(available with v 4.4.3)

\n
 voip_session_audio (str)Session Audio. Allowed values: phone, voip, hybrid. (available with v 4.3.2)
 register_require (bool)Set to (0) no registration form (1) allow registration or (2) require registration
 register_friendly_url (str)Define the friendly URL segment of the registration page eg: www.domain.com/register/[username]/[friendlyurl]
 register_limit_register (int)Limit number of users that can register to this session to this number. Default is unlimited.
 register_close_register (int)Time, in minutes, before the start time of the session, at which to no longer accept registrations. Default is 0.
 register_password_to_registration (str)Set to true to require users to enter a password before being able to register for the event.
 register_end_of_registration (str)Set to true to show a custom message to users after they registered.
 register_end_of_registration_value (str)Custom message to display to users after they registered (if previous param is true).
 register_fields (array)JSON array of fields in registration form.\nDefault fields: first_name, last_name and email\nFormat:
\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, gender, email, phone, job_title, company, address, city, postcode, country, website, industry) or add custom fields (custom_field_{number}).\nshow: 1/0\nrequired: 1/0\nfield_type: text, textarea, radio, checkbox or select (select type available with v 5.0.5 only)\noptions: array of option titles (only for radio, checkbox or select fields)\nselected: number of selected option (only for radio or checkbox files)
 invitations_send_reminder_first (bool)Set to number of time units before the start of the event when the first reminder email should be sent.
 invitations_send_reminder_first_interval (int)Define time units for previous parameter, possible choices “minutes”, “hours”, “days”.
 invitations_send_reminder_second (bool)Set to number of time units before the start of the event when the second reminder email should be sent.
 invitations_send_reminder_second_interval (int)Define time units for previous parameter, possible choices “minutes”, “hours”, “days”.
 invitations_reminder_content_first (str)Textual content of the first reminder email. This field supports placeholders.
 invitations_reminder_content_second (str)Textual content of the second reminder email. This field supports placeholders.
 invitations_attendees_content (str)Textual content of the email that is sent to attendees of the event. This field supports placeholders.
 invitations_absentees_content (str)Textual content of the email that is sent to absentees of the event. This field supports placeholders.
 invitations_first_reminder_send_to_myself (bool)Set to true to send yourself (= the Account Holder) a copy of the first reminder email.
 invitations_second_reminder_send_to_myself (bool)Set to true to send yourself (= the Account Holder) a copy of the second reminder email.
 invitations_attendees_send_to_myself (bool)Set to true to send yourself (= the Account Holder) a copy of the attendee email.
 invitations_absentees_send_to_myself (bool)Set to true to send yourself (= the Account Holder) a copy of the absentee email.
 invitations_content (str)Custom content of the invitation email (replaces the default invitation email).\nThis field supports placeholders.
 caption_stream_event_id (str)Caption event ID (available with v 5.0.4 when caption stream feature is enabled on the server level)
 menu_buttons (array)Menu Buttons Available in Session. (available with v 4.3.9)\n \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
    \n
  • screensharing (bool) - Show/Hide “Screen Sharing” item
    • \n
  • inviteparticipants (bool) - Show/Hide “Invite Participants” item
    • \n
  • medialibrary (bool) - Show/Hide “Media Library” item
    • \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
  • pushtotalk (bool) - Show/Hide “Push to Talk ” ite. This item can be showed when Microphone is showed. (available with v 4.4.4)
    • \n
  • requesttospeak (bool) - Show/Hide “Request To Speak” item
    • \n
  • help (bool) - Show/Hide “About” item
 branding (array)Upload a custom image to override the default image defined in the Branding area (available with v 4.3.9)\n\n

Allowed values:

\n
    \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

Return Arguments

\n\n \n \n \n \n \n \n \n \n
id (int)The id of the newly created session.
message (str)Text messsage.
","urlObject":{"path":["api","2","{{user_name}}","session"],"host":["{{API_EndPoint}}"],"query":[],"variable":[]}},"response":[{"id":"5c5ae318-3fa8-4606-b4c7-9b1ae10fdebc","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\"topic\": \"Test\",\n\t\"duration\": 60, \n\t\"start_time\": \"2017-09-10 12:00:00\", \n\t\"invited_participants\":[\n\t\t{\n\t\t\t\"email\":\"email@domain.com\",\n\t\t\t\"first_name\":\"First Name\",\n\t\t\t\"last_name\":\"Last Name\",\n\t\t\t\"role\":1,\n\t\t\t\"send_email_invitation\":0\n\t\t}\n\t],\"custom_data\": [\n\t\t{\n\t\t\t\"custom1\":\"first custom value\", \n\t\t\t\"custom2\":\"second custom value\", \n\t\t\t\"custom3\":\"third custom value\",\n\t\t\t\"custom4\":\"fourth custom value\"\n\t\t}\n\t]\n}"},"url":"{{API_EndPoint}}/api/2/{{user_name}}/session"},"status":"Created","code":201,"_postman_previewlanguage":"xml","header":[{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate, post-check=0, pre-check=0","name":"Cache-Control","description":""},{"key":"Connection","value":"keep-alive","name":"Connection","description":""},{"key":"Content-Type","value":"application/xml","name":"Content-Type","description":""},{"key":"Date","value":"Wed, 07 Jun 2017 06:38:13 GMT","name":"Date","description":""},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT","name":"Expires","description":""},{"key":"Pragma","value":"no-cache","name":"Pragma","description":""},{"key":"Server","value":"nginx/1.10.3","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""},{"key":"X-Powered-By","value":"PHP/5.4.30","name":"X-Powered-By","description":""}],"cookie":[],"responseTime":null,"body":"\n307Session added\n"}],"_postman_id":"41d9ba55-84db-4270-a986-b4c769211bea"},{"name":"/user_session","id":"0fb16a09-8092-49ab-bff0-6ac886be814f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}],"advancedConfig":[{"key":"saveHelperData","value":""},{"key":"showPassword","value":""}]},"isInherited":false},"method":"PUT","header":[{"key":"Authorization","value":"Basic YWRtaW46c2FtYmEyMDAy"}],"body":{"mode":"raw","raw":"input_type=json&rest_data={\n \"topic\": \"Test\",\n \"duration\": 60, \n \"start_time\": \"2017-09-10 12:00:00\", \n \"invited_participants\":[\n {\n \"email\":\"email@domain.com\",\n \"first_name\":\"First Name\",\n \"last_name\":\"Last Name\",\n \"role\":1,\n \"send_email_invitation\":0\n }\n ],\"custom_data\": [\n {\n \"custom1\":\"first custom value\", \n \"custom2\":\"second custom value\", \n \"custom3\":\"third custom value\",\n \"custom4\":\"fourth custom value\"\n }\n ]\n}"},"url":"{{API_EndPoint}}/api/2/{{user_name}}/user_session","description":"

Create a new session

\n

Arguments

\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n

\n
Requireduser_id (int)ID of session owner.
Requiredtopic (str)The title of the meeting.
 duration (int)Duration of the meeting, in minutes.
 start_time (datetime)Start time in datetime format eg \n“2010-08-31 11:05:00”. Will always default to the user’s timezone & DST settings.See the “Timezones” section for more info.
Optionalfriendly_url (str)Define a friendly URL segment to be used instead of auto-generated rather than encrypted meeting ID.
 password (str)To password protect the meeting define this.
 invited_participants (array)JSON 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: Moderator (1), Participant (2) or Observer (3)\n\n

send_email_invitations (bool): Set 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.

 custom_data (array)JSON 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.\nCustom value is varchar(200).
\n

Advanced Session Arguments

\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”.

\n

Advanced params are available in PUT and POST session API methods

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
Requiredadvanced_mode (bool)Set to true to enable advanced params for this session. Default is false..
Optionalprevent_user_count (bool)Set to true to hide the user count from participants and observers. Moderators can always see this number. Default is false.
 save_contacts_to_ab (bool)Set to true to save invitees to your Address Book. Default is false.
 all_day (bool)Set this param to true when session should take all day (available with v 5.1.5).
 attach_calendar_file (int)Select ICS attacments mode (available with v 5.1.5).\n \n

Allowed values:

\n
    \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
 description (text)Description of the session.
 agenda (text)Agenda of the session.
 type (str)The Session Room type (available with v 5.1.3).\n Possible values:\n - flash - classic flash room\n - html5 - new HTML5 room (beta)\n NOTE: Session type can only be defined when creating the session.\n
 display_custom_instructions (bool)Set to true to display custom instructions for participants.
 custom_instructions (text)Custom instructions for participants, these will be displayed on the session login page.
 enable_join_sound (bool)Play a sound every time a user joins this session.
 guests_join_as (int)Set the default role for guests that have not been specifically invited and given a role then: \n Moderator (1), \n Participant (2) \n Observer (3). \n Default is Participant.
 access_embed_widget_for_rec (bool)Set to true to allow recording viewers to see the embed code to integrate the recording elsewhere. Defaults is false.
 access_enable_lobby (bool)This option puts non-moderators in a lobby until moderators allow them to enter the session. Not available when the teleconference option is selected
 access_enable_breakout_rooms (bool)Allow participants to disperse into smaller groups while in session. Not available when the teleconference option is selected
 access_guest_login_fields (array)List of optional fields on session login form. Allowed fields: email, company.\n\n

Format: 

[\"email\",\"company\"]
(available with v 5.0.2)

\n
 access_before_start (numeric)Restrict early access. (available with v 5.1.5)
 access_public_visibity (numeric)Make 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 \n

Allowed values:

\n
    \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
 private_access (bool)Set 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)
 av_use_teleconference (bool)Set to true to allow users to dial-in to the session using conventional telephones. Default is false. Note: the dial-in module requires a seperate license and is not available by default.
 av_encrypt_streams (bool)Set to true to use RTMPE encryption for all streams, instead of the default RTMP.
 av_voip_conf_mode (int)Audio for participants and observers dialing in should be (0) not muted, (1) muted, may unmute or (2) muted, may not unmute. Default is 0 (not muted).
 av_autobroadcast (bool)Automatically start audio & video broadcast when entering the session (you and moderators only)
 av_fit_to_screen (bool)Default view for application sharing.\n\n

Set to true to use \"Fit To Screen\", set to false to use \"100%\".\n(available with v 4.4.3)

\n
 voip_session_audio (str)Session Audio. Allowed values: phone, voip, hybrid. (available with v 4.3.2)
 register_require (bool)Set to (0) no registration form (1) allow registration or (2) require registration
 register_friendly_url (str)Define the friendly URL segment of the registration page eg: www.domain.com/register/[username]/[friendlyurl]
 register_limit_register (int)Limit number of users that can register to this session to this number. Default is unlimited.
 register_close_register (int)Time, in minutes, before the start time of the session, at which to no longer accept registrations. Default is 0.
 register_password_to_registration (str)Set to true to require users to enter a password before being able to register for the event.
 register_end_of_registration (str)Set to true to show a custom message to users after they registered.
 register_end_of_registration_value (str)Custom message to display to users after they registered (if previous param is true).
 register_fields (array)JSON array of fields in registration form.\nDefault fields: first_name, last_name and email\nFormat:
\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, gender, email, phone, job_title, company, address, city, postcode, country, website, industry) or add custom fields (custom_field_{number}).\nshow: 1/0\nrequired: 1/0\nfield_type: text, textarea, radio, checkbox or select (select type available with v 5.0.5 only)\noptions: array of option titles (only for radio, checkbox or select fields)\nselected: number of selected option (only for radio or checkbox files)
 invitations_send_reminder_first (bool)Set to number of time units before the start of the event when the first reminder email should be sent.
 invitations_send_reminder_first_interval (int)Define time units for previous parameter, possible choices “minutes”, “hours”, “days”.
 invitations_send_reminder_second (bool)Set to number of time units before the start of the event when the second reminder email should be sent.
 invitations_send_reminder_second_interval (int)Define time units for previous parameter, possible choices “minutes”, “hours”, “days”.
 invitations_reminder_content_first (str)Textual content of the first reminder email. This field supports placeholders.
 invitations_reminder_content_second (str)Textual content of the second reminder email. This field supports placeholders.
 invitations_attendees_content (str)Textual content of the email that is sent to attendees of the event. This field supports placeholders.
 invitations_absentees_content (str)Textual content of the email that is sent to absentees of the event. This field supports placeholders.
 invitations_first_reminder_send_to_myself (bool)Set to true to send yourself (= the Account Holder) a copy of the first reminder email.
 invitations_second_reminder_send_to_myself (bool)Set to true to send yourself (= the Account Holder) a copy of the second reminder email.
 invitations_attendees_send_to_myself (bool)Set to true to send yourself (= the Account Holder) a copy of the attendee email.
 invitations_absentees_send_to_myself (bool)Set to true to send yourself (= the Account Holder) a copy of the absentee email.
 invitations_content (str)Custom content of the invitation email (replaces the default invitation email).\nThis field supports placeholders.
 caption_stream_event_id (str)Caption event ID (available with v 5.0.4 when caption stream feature is enabled on the server level)
 menu_buttons (array)Menu Buttons Available in Session. (available with v 4.3.9)\n \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
    \n
  • screensharing (bool) - Show/Hide “Screen Sharing” item
    • \n
  • inviteparticipants (bool) - Show/Hide “Invite Participants” item
    • \n
  • medialibrary (bool) - Show/Hide “Media Library” item
    • \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
  • pushtotalk (bool) - Show/Hide “Push to Talk ” ite. This item can be showed when Microphone is showed. (available with v 4.4.4)
    • \n
  • requesttospeak (bool) - Show/Hide “Request To Speak” item
    • \n
  • help (bool) - Show/Hide “About” item
 branding (array)Upload a custom image to override the default image defined in the Branding area (available with v 4.3.9)\n\n

Allowed values:

\n
    \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

Return Arguments

\n\n \n \n \n \n \n \n \n \n \n \n \n \n
id (int)The id of the newly created session.
user_id (int)ID of session owner.
message (str)Text messsage.
","urlObject":{"path":["api","2","{{user_name}}","user_session"],"host":["{{API_EndPoint}}"],"query":[],"variable":[]}},"response":[{"id":"0d3b6d5d-75e3-4486-ab68-9954772e7161","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\"topic\": \"Test\",\n\t\"duration\": 60, \n\t\"start_time\": \"2017-09-10 12:00:00\", \n\t\"invited_participants\":[\n\t\t{\n\t\t\t\"email\":\"email@domain.com\",\n\t\t\t\"first_name\":\"First Name\",\n\t\t\t\"last_name\":\"Last Name\",\n\t\t\t\"role\":1,\n\t\t\t\"send_email_invitation\":0\n\t\t}\n\t],\"custom_data\": [\n\t\t{\n\t\t\t\"custom1\":\"first custom value\", \n\t\t\t\"custom2\":\"second custom value\", \n\t\t\t\"custom3\":\"third custom value\",\n\t\t\t\"custom4\":\"fourth custom value\"\n\t\t}\n\t]\n}"},"url":"{{API_EndPoint}}/api/2/{{user_name}}/session"},"status":"Created","code":201,"_postman_previewlanguage":"xml","header":[{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate, post-check=0, pre-check=0","name":"Cache-Control","description":""},{"key":"Connection","value":"keep-alive","name":"Connection","description":""},{"key":"Content-Type","value":"application/xml","name":"Content-Type","description":""},{"key":"Date","value":"Wed, 07 Jun 2017 06:38:13 GMT","name":"Date","description":""},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT","name":"Expires","description":""},{"key":"Pragma","value":"no-cache","name":"Pragma","description":""},{"key":"Server","value":"nginx/1.10.3","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""},{"key":"X-Powered-By","value":"PHP/5.4.30","name":"X-Powered-By","description":""}],"cookie":[],"responseTime":null,"body":"\n307Session added\n"}],"_postman_id":"0fb16a09-8092-49ab-bff0-6ac886be814f"},{"name":"/session","id":"ec682be8-e497-47fe-8e1f-fa9efa4a806f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}],"advancedConfig":[{"key":"saveHelperData","value":""},{"key":"showPassword","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Basic YWRtaW46c2FtYmEyMDAy"}],"body":{"mode":"formdata","formdata":[]},"url":"{{API_EndPoint}}/api/2/{{user_name}}/session","description":"

Edit an existing session.

\n

Arguments

\n\n \n \n \n \n \n \n \n \n \n \n
Requiredid (str)The id of the session.
OptionalSee Arguments of PUT /session method.
\n

Return Arguments

\n\n \n \n \n \n \n \n \n \n
id (int)The id of the updated session.
message (str)Text messsage.
","urlObject":{"path":["api","2","{{user_name}}","session"],"host":["{{API_EndPoint}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"ec682be8-e497-47fe-8e1f-fa9efa4a806f"},{"name":"/user_session","id":"7a11d450-7306-4919-b894-13f82be50d54","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}],"advancedConfig":[{"key":"saveHelperData","value":""},{"key":"showPassword","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Basic YWRtaW46c2FtYmEyMDAy"}],"body":{"mode":"formdata","formdata":[]},"url":"{{API_EndPoint}}/api/2/{{user_name}}/user_session","description":"

Edit an existing session related to sub user account. Available with version 5.2.1.

\n

Arguments

\n\n \n \n \n \n \n \n \n \n \n \n
Requiredid (str)The id of the session.
OptionalSee Arguments of PUT /session method.
\n

Return Arguments

\n\n \n \n \n \n \n \n \n \n \n \n \n \n
id (int)The id of the updated session.
user_id (int)ID of session owner.
message (str)Text messsage.
","urlObject":{"path":["api","2","{{user_name}}","user_session"],"host":["{{API_EndPoint}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"7a11d450-7306-4919-b894-13f82be50d54"},{"name":"/session","id":"1f9930fe-6bef-4816-89e1-e763b7a0545f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}],"advancedConfig":[{"key":"saveHelperData","value":""},{"key":"showPassword","value":""}]},"isInherited":false},"method":"DELETE","header":[{"key":"Authorization","value":"Basic YWRtaW46c2FtYmEyMDAy"}],"body":{"mode":"raw","raw":"input_type=json&rest_data={\n\t\"id\":\"1\"\n}"},"url":"{{API_EndPoint}}/api/2/{{user_name}}/session","description":"

Delete an existing session.

\n

Arguments

\n\n \n \n \n \n \n
Requiredid (str)The id of the session to be deleted. Note: the id may also be appended to the URL (.../id/xxx) instead of in the request body.
\n

Return Arguments

\n\n \n \n \n \n \n \n \n \n
id (int)The id of the deleted session.
message (str)Text messsage.
","urlObject":{"path":["api","2","{{user_name}}","session"],"host":["{{API_EndPoint}}"],"query":[],"variable":[]}},"response":[{"id":"e277a5b2-b301-4009-bc65-d53c2bce6a67","name":"Response","originalRequest":{"method":"DELETE","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\"id\":\"1\"\n}"},"url":"{{API_EndPoint}}/api/2/{{user_name}}/session"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate, post-check=0, pre-check=0","name":"Cache-Control","description":""},{"key":"Connection","value":"keep-alive","name":"Connection","description":""},{"key":"Content-Encoding","value":"gzip","name":"Content-Encoding","description":""},{"key":"Content-Type","value":"application/xml","name":"Content-Type","description":""},{"key":"Date","value":"Wed, 07 Jun 2017 07:37:08 GMT","name":"Date","description":""},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT","name":"Expires","description":""},{"key":"Pragma","value":"no-cache","name":"Pragma","description":""},{"key":"Server","value":"nginx/1.10.3","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""},{"key":"X-Powered-By","value":"PHP/5.4.30","name":"X-Powered-By","description":""}],"cookie":[],"responseTime":null,"body":"\n\n 1\n Session was deleted\n"}],"_postman_id":"1f9930fe-6bef-4816-89e1-e763b7a0545f"}],"id":"0bab5ae8-c617-4008-bc29-7d12c891e0c0","_postman_id":"0bab5ae8-c617-4008-bc29-7d12c891e0c0","description":""},{"name":"Statistics","item":[{"name":"/statistics","id":"6b2a2638-0421-41da-89fc-9cd110db6a45","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}],"advancedConfig":[{"key":"saveHelperData","value":""},{"key":"showPassword","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Basic YWRtaW46c2FtYmEyMDAy"}],"url":"{{API_EndPoint}}/api/2/{{user_name}}/statistics","description":"

GET statistics and GET admin_statistics can potentially return a very large amount of date. In addition to limiting the /days parameter, we recommend that you:

\n1. limit type of data by using the /return option to define a subset of data fields, \n2. use the /count and /offset options to page through the results.\n\n

Arguments

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
Requireddays (int)Number of days to retrieve stats for. A high number may yield a very large return set.
Optionalcount (int)Specify number of returned results. Default is 100.\n
 offset (int)Specify to move the cursor through the recordset. Default is 0.
 return(str)Choose which fields should be returned by adding a list of semi-colon delimited field names eg \n
.../statistics/days/5/return/id;login;email;last_name
\nIf not defined, a pre-defined subset of fields is returned
\n

Return Arguments

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
aid (int)Account ID.
ahfn (str)Account Holder First Name.
ahln (str)Account Holder Last Name.
ahl (str)Account Holder Login.
sid (int)Session ID.
sn (str)Session Name.
pfn (str)Participant First Name.
pln (str)Participant Last Name.
pe (int)Participant Email.
jt (datetime)Join Time.
lt (datetime)Leave Time.
d (time)Duration.
st (str)Session Timezone.
sp (str)Session Password.
sac (int)Session Access Code (for phone dial-in).
","urlObject":{"path":["api","2","{{user_name}}","statistics"],"host":["{{API_EndPoint}}"],"query":[],"variable":[]}},"response":[{"id":"066e27ab-72b3-4e88-9b0f-8b0052d901f1","name":"Response","originalRequest":{"method":"GET","header":[{"key":"Authorization","type":"text","name":"Authorization","value":"Basic YWRtaW46c2FtYmEyMDAy"}],"url":"{{API_EndPoint}}/api/2/{{user_name}}/statistics"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate, post-check=0, pre-check=0","name":"Cache-Control","description":""},{"key":"Connection","value":"keep-alive","name":"Connection","description":""},{"key":"Content-Encoding","value":"gzip","name":"Content-Encoding","description":""},{"key":"Content-Type","value":"application/xml","name":"Content-Type","description":""},{"key":"Date","value":"Thu, 01 Jun 2017 12:20:12 GMT","name":"Date","description":""},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT","name":"Expires","description":""},{"key":"Pragma","value":"no-cache","name":"Pragma","description":""},{"key":"Server","value":"nginx/1.10.3","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""},{"key":"X-Powered-By","value":"PHP/5.4.30","name":"X-Powered-By","description":""}],"cookie":[],"responseTime":null,"body":"\n\n \n 1\n 1\n Owner\n Name\n owner_login\n 1\n Session Name\n Guest\n Name\n user@gmail.com\n 0\n 2017-05-05 09:54:45\n 2017-05-05 10:01:42\n 00:06:57\n UTC\n 2\n \n \n ...\n ...\n"}],"_postman_id":"6b2a2638-0421-41da-89fc-9cd110db6a45"},{"name":"/admin_statistics","id":"fe37955e-38a6-4fbc-a7ab-37da3d77e8e4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}],"advancedConfig":[{"key":"saveHelperData","value":""},{"key":"showPassword","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Basic YWRtaW46c2FtYmEyMDAy"}],"url":"{{API_EndPoint}}/api/2/{{user_name}}/admin_statistics","description":"

Get connection statistics for all user accounts belonging to [username]. Requires admin rights.

\n

Arguments

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
Requireddays (int)Number of days to retrieve stats for. A high number may yield a very large return set.
Optionalcount (int)Specify number of returned results. Default is 100.\n
 offset (int)Specify to move the cursor through the recordset. Default is 0.
 return(str)Choose which fields should be returned by adding a list of semi-colon delimited field names eg \n
.../statistics/days/5/return/id;login;email;last_name
\nIf not defined, a pre-defined subset of fields is returned
\n

Return Arguments

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
aid (int)Account ID.
ahfn (str)Account Holder First Name.
ahln (str)Account Holder Last Name.
ahl (str)Account Holder Login.
sid (int)Session ID.
sn (str)Session Name.
pfn (str)Participant First Name.
pln (str)Participant Last Name.
pe (int)Participant Email.
pr (int)Participant Role (available with version 4.3.6)\nPossible values:\n0 - Session owner\n1 - Moderator\n2 - Participant\n3 - Observer\n.
jt (datetime)Join Time.
lt (datetime)Leave Time.
d (time)Duration.
st (str)Session Timezone.
sp (str)Session Password.
sac (int)Session Access Code (for phone dial-in).
","urlObject":{"path":["api","2","{{user_name}}","admin_statistics"],"host":["{{API_EndPoint}}"],"query":[],"variable":[]}},"response":[{"id":"27647ff9-8f89-45fd-9271-34a19b217cc0","name":"Response","originalRequest":{"method":"GET","header":[{"key":"Authorization","type":"text","name":"Authorization","value":"Basic YWRtaW46c2FtYmEyMDAy"}],"url":"{{API_EndPoint}}/api/2/{{user_name}}/admin_statistics"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate, post-check=0, pre-check=0","name":"Cache-Control","description":""},{"key":"Connection","value":"keep-alive","name":"Connection","description":""},{"key":"Content-Encoding","value":"gzip","name":"Content-Encoding","description":""},{"key":"Content-Type","value":"application/xml","name":"Content-Type","description":""},{"key":"Date","value":"Thu, 01 Jun 2017 12:38:07 GMT","name":"Date","description":""},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT","name":"Expires","description":""},{"key":"Pragma","value":"no-cache","name":"Pragma","description":""},{"key":"Server","value":"nginx/1.10.3","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""},{"key":"X-Powered-By","value":"PHP/5.4.30","name":"X-Powered-By","description":""}],"cookie":[],"responseTime":null,"body":"\n\n \n 1\n 3\n Owner\n Name\n owner_login\n 3\n Session Name\n Guest\n Name\n guest@mail.com\n 2\n 2017-05-02 07:39:27\n 2017-05-02 07:40:36\n 00:01:09\n UTC\n 1\n 131233\n \n ...\n ...\n...\n\n"}],"_postman_id":"fe37955e-38a6-4fbc-a7ab-37da3d77e8e4"},{"name":"/statistics_live","id":"4c06b4ed-1a15-435d-8727-89675dcfdea2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}],"advancedConfig":[{"key":"saveHelperData","value":""},{"key":"showPassword","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Basic YWRtaW46c2FtYmEyMDAy"}],"url":"{{API_EndPoint}}/api/2/{{user_name}}/statistics_live","description":"

Get live connection statistics for the user’s account. (Available in v4.3.7)

\n

Arguments

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
Optionalcount (int)Specify number of returned results. Default is 100.\n
 offset (int)Specify to move the cursor through the recordset. Default is 0.
 return(str)Choose which fields should be returned by adding a list of semi-colon delimited field names eg \n
.../statistics_live/days/5/return/id;login;email;last_name
\nIf not defined, a pre-defined subset of fields is returned
\n

Return Arguments

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
aid (int)Account ID.
ahfn (str)Account Holder First Name.
ahln (str)Account Holder Last Name.
ahl (str)Account Holder Login.
sid (int)Session ID.
sn (str)Session Name.
pfn (str)Participant First Name.
pln (str)Participant Last Name.
pe (int)Participant Email.
jt (datetime)Join Time.
lpt (datetime)Last Ping Time.
d (time)Duration.
st (str)Session Timezone.
sp (str)Session Password.
sac (int)Session Access Code (for phone dial-in).
","urlObject":{"path":["api","2","{{user_name}}","statistics_live"],"host":["{{API_EndPoint}}"],"query":[],"variable":[]}},"response":[{"id":"484a3e18-c615-4eba-b496-b1c591fbbb67","name":"Response","originalRequest":{"method":"GET","header":[{"key":"Authorization","type":"text","name":"Authorization","value":"Basic YWRtaW46c2FtYmEyMDAy"}],"url":"{{API_EndPoint}}/api/2/{{user_name}}/statistics_live"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate, post-check=0, pre-check=0","name":"Cache-Control","description":""},{"key":"Connection","value":"keep-alive","name":"Connection","description":""},{"key":"Content-Encoding","value":"gzip","name":"Content-Encoding","description":""},{"key":"Content-Type","value":"application/xml","name":"Content-Type","description":""},{"key":"Date","value":"Thu, 01 Jun 2017 12:51:21 GMT","name":"Date","description":""},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT","name":"Expires","description":""},{"key":"Pragma","value":"no-cache","name":"Pragma","description":""},{"key":"Server","value":"nginx/1.10.3","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""},{"key":"X-Powered-By","value":"PHP/5.4.30","name":"X-Powered-By","description":""}],"cookie":[],"responseTime":null,"body":"\n\n \n 1\n 1\n Owner\n Name\n owner_login\n 15\n Session Name\n Guest\n Name\n guest@mail.com\n 0\n 2017-06-01 12:51:21\n 2017-06-01 12:51:21\n 00:20:30\n UTC\n 8hmLTtpnik\n \n \n "}],"_postman_id":"4c06b4ed-1a15-435d-8727-89675dcfdea2"},{"name":"/admin_statistics_live","id":"9138d405-f52e-4ab0-9a5e-9e1057f40715","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}],"advancedConfig":[{"key":"saveHelperData","value":""},{"key":"showPassword","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Basic YWRtaW46c2FtYmEyMDAy"}],"url":"{{API_EndPoint}}/api/2/{{user_name}}/admin_statistics_live","description":"

Get live connection statistics for all user accounts belonging to [username]. Requires admin rights. (Available in v4.3.7)

\n

Arguments

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
Optionalcount (int)Specify number of returned results. Default is 100.\n
 offset (int)Specify to move the cursor through the recordset. Default is 0.
 return(str)Choose which fields should be returned by adding a list of semi-colon delimited field names eg \n
.../statistics_live/days/5/return/id;login;email;last_name
\nIf not defined, a pre-defined subset of fields is returned
\n

Return Arguments

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
aid (int)Account ID.
ahfn (str)Account Holder First Name.
ahln (str)Account Holder Last Name.
ahl (str)Account Holder Login.
sid (int)Session ID.
sn (str)Session Name.
pfn (str)Participant First Name.
pln (str)Participant Last Name.
pe (int)Participant Email.
pr (int)Participant Role (available with version 4.3.6)\nPossible values:\n0 - Session owner\n1 - Moderator\n2 - Participant\n3 - Observer.
jt (datetime)Join Time.
lpt (datetime)Last Ping Time.
d (time)Duration.
st (str)Session Timezone.
sp (str)Session Password.
sac (int)Session Access Code (for phone dial-in).
","urlObject":{"path":["api","2","{{user_name}}","admin_statistics_live"],"host":["{{API_EndPoint}}"],"query":[],"variable":[]}},"response":[{"id":"d9c3f2e4-08ef-423b-9d6f-4dec76bf3d97","name":"Response","originalRequest":{"method":"GET","header":[{"key":"Authorization","type":"text","name":"Authorization","value":"Basic YWRtaW46c2FtYmEyMDAy"}],"url":"{{API_EndPoint}}/api/2/{{user_name}}/admin_statistics_live"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate, post-check=0, pre-check=0","name":"Cache-Control","description":""},{"key":"Connection","value":"keep-alive","name":"Connection","description":""},{"key":"Content-Encoding","value":"gzip","name":"Content-Encoding","description":""},{"key":"Content-Type","value":"application/xml","name":"Content-Type","description":""},{"key":"Date","value":"Thu, 01 Jun 2017 12:57:54 GMT","name":"Date","description":""},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT","name":"Expires","description":""},{"key":"Pragma","value":"no-cache","name":"Pragma","description":""},{"key":"Server","value":"nginx/1.10.3","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""},{"key":"X-Powered-By","value":"PHP/5.4.30","name":"X-Powered-By","description":""}],"cookie":[],"responseTime":null,"body":"\n\n \n 2522\n 1\n Owner\n Name\n owner_login\n 12\n Session Name\n Guest\n Name\n guest@mail.com\n 0\n 2017-06-01 12:51:21\n 2017-06-01 12:57:51\n 00:06:30\n UTC\n 8hmLTtpnik\n \n \n"}],"_postman_id":"9138d405-f52e-4ab0-9a5e-9e1057f40715"}],"id":"d9061f57-de8e-4e8c-ada8-f571ea4feead","description":"

Get usage statistics

\n","_postman_id":"d9061f57-de8e-4e8c-ada8-f571ea4feead"},{"name":"Users","item":[{"name":"/user/id/[int]","id":"eee5cb60-96fb-4b7a-84d0-5099ad714df3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}],"advancedConfig":[{"key":"saveHelperData","value":""},{"key":"showPassword","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Basic YWRtaW46c2FtYmEyMDAy"}],"url":"{{API_EndPoint}}/api/2/{{user_name}}/user/id/1","description":"

Get user account info by given ID#.

\n

Arguments

\n\n\n \n \n \n \n \n
Requiredid (int)The user account ID number.
\n\n

Return Arguments

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
id (int)User account ID number.
login (str)The username of the user, used to login.
email (str)The email address of the user.
first_name (int)The first name of the user.
last_name (str)The last name of the user.
company (str)The company of the user.
country (str)The user’s country of residence.
timezone (str)The timezone of the user. See section “Timezones” below for more.
afid_key (str)The user’s affiliate key, pass this to signup pages to associate any new user signups with the user owning the afid_key.
language (str)The language chosen by the user.
last_login (datetime)The datetime string the user logged in the last time.
paid_signup_date (datetime)The datetime string when the user signed up to a paid service plan .
activated (bool)Boolean whether the user account is enabled or not.
parent_id (int)The ID of the user to which the current user belongs. (Available in v4.2.3).
is_guest(bool)Boolean whether the user account is a guest account or a registered account.
expiry_date (date)The date when the account expires.
role (str)User role.
api_enabled (bool)Boolean whether the user may use the API or not.
password_protect_fast_session (bool)Password protect MeetNow meetings (available with v 5.1.5).
sim_bcaster (int)Limit simultaneous broadcasters in sessions belonging to this user. (available with v 4.2.8).
session_user_limit (int)The user connection limit per session. (available with v 4.2.8).
account_user_limit (int)The simultaneous user connection limit across all sessions in this account. (available with v 4.2.8).
company_sim_bcaster (int)Number of broadcasters that can broadcast at the same time across all account holders in this company. (available with v 4.2.8). Please check GET company_user_limits method.
company_session_user_limit (int)Number of sessions that can run at the same time in this company. (available with v 4.2.8). Please check GET company_user_limits method.
company_account_user_limit (int)Number of attendees that can be in sessions at the same time across all account holders in this company. (available with v 4.2.8). Please check GET company_user_limits method.
rec_limit (int)Recording limit to this user. \nSet to -1 for unlimited, set to empty string to use the parent product value.\n(available with v 4.2.6).
ml_limit (int)Total media library size limit (KB). \nSet to -1 for unlimited, set to empty string to use the parent product value. (available with v 4.2.6).
ml_used (int)Media library size used (KB). \n(available with v 4.3.5).
user_service_plan_id (int)ID# of the current user service plan (available with v 4.3.1).
parent_service_plan_id (int)ID# of the current user service plan template (available with v 4.3.1).
fms_server_ip (str)The IP or FQDN of the Flash Media Server running the FMS application to which sessions of this account should connect. (available with v 4.3.1).
fms_application_name (str)The name of the FMS application to which sessions of this account should connect. (available with v 4.3.1).
serviceplan_name (str)Custom name for user service plan. (available with v 4.3.1).
serviceplan_description (str)The service plan description. (available with v 4.3.1).
modify_branding_enabled (bool)Allow account holders to modify branding. (available with v 4.3.1).
modify_colors_enabled (bool)Allow account holders to modify theme colors. Available when new flat-ui theme is enabled (available with v 4.4.5).
advanced_sessions_enabled (bool)Enable advanced scheduling features. (available with v 4.3.1).
pro_video_enabled (bool)Enable pro & custom video options. (available with v 4.3.1).
mobile_access_enabled (bool)Enable access from mobile applications. (available with v 4.3.1).
mp4_recording_enabled (bool)Enable MP4 recordings (available with v 4.4.3).
modify_permissions_enabled (bool)Allow account holders to modify session permissions (available with v 4.4.4).
session_auto_recording_enabled (bool)Enable auto-record sessions, note this will impact disk space usage (available with v 5.1.5).
available_room_type (str)The Room type(s) which are made available to this account at session level. Possible values: flex, webrtc or both (available with v 5.1.3).
appshare_fit_to_screen (int)Default screenshare view mode (available with v 5.1.5).\nValues: \n- 0: Set default view for application sharing to \"100%\"\n- 1: Set default view for application sharing to \"Fit To Screen\"\n
voip_available_session_audio (str)Available 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).
components (array)Components Available in Session (available with v 4.4.4).
permissions (array)Permissions Available in Session (available with v 4.4.4).
menu_buttons (array)Menu Buttons Available in Session.
custom_data (array)An array of objects containing custom fields in the form of custom1, custom2 etc.
profile_pic_url (str)URL to user profile image (available with v 4.3.4).
","urlObject":{"path":["api","2","{{user_name}}","user","id","1"],"host":["{{API_EndPoint}}"],"query":[],"variable":[]}},"response":[{"id":"7371eca9-c430-4d14-9a14-774a4a7153bf","name":"Response","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic YWRtaW46c2FtYmEyMDAy","warning":""},{"key":"Response","value":"","warning":""}],"url":"{{API_EndPoint}}/api/2/{{user_name}}/user/id/[int]"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate, post-check=0, pre-check=0","name":"Cache-Control","description":""},{"key":"Connection","value":"keep-alive","name":"Connection","description":""},{"key":"Content-Encoding","value":"gzip","name":"Content-Encoding","description":""},{"key":"Content-Type","value":"application/xml","name":"Content-Type","description":""},{"key":"Date","value":"Mon, 05 Jun 2017 15:09:36 GMT","name":"Date","description":""},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT","name":"Expires","description":""},{"key":"Pragma","value":"no-cache","name":"Pragma","description":""},{"key":"Server","value":"nginx/1.10.3","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""},{"key":"X-Powered-By","value":"PHP/5.4.30","name":"X-Powered-By","description":""}],"cookie":[],"responseTime":null,"body":"\n\n 1\n login\n email@mail.com\n First Name\n Last Name\n 50\n \n US\n en-US\n UTC\n 2017-06-05 14:11:08\n 1\n 0\n \n \n \n \n \n http://domain.com/storage/users/1/myprofile/1.jpg\n 10480\n \n \n \n \n 1000\n 2\n 1\n 255.255.255.255\n \n Service Plan Template\n Service Plan Description\n 1\n 1\n 1\n 1\n 1\n 1\n 1\n 0\n voip\n \n hybrid\n voip\n phone\n \n \n 1\n 1\n 1\n 1\n 1\n 1\n 1\n 1\n 1\n 1\n 1\n 1\n 1\n \n \n 1\n 1\n 1\n 1\n 1\n 1\n 1\n 1\n 1\n 0\n \n \n \n 1\n 1\n 0\n 0\n \n \n 1\n 1\n 0\n 0\n \n \n 1\n 1\n 0\n 0\n \n \n 1\n 1\n 0\n 0\n \n \n 1\n 1\n 0\n 0\n \n \n 1\n 1\n 0\n 0\n \n \n 1\n 1\n 0\n 0\n \n \n 1\n 1\n 0\n 0\n \n \n 1\n 1\n 0\n 0\n \n \n 1\n 1\n 0\n 0\n \n \n 1\n 1\n 1\n 0\n \n \n 1\n 1\n 0\n 0\n \n \n 1\n 1\n 1\n 0\n \n \n 1\n 1\n 0\n 0\n \n \n 1\n 1\n 0\n 0\n \n \n 1\n 1\n 1\n 0\n \n \n 1\n 1\n 1\n 0\n \n \n 1\n 1\n 0\n 0\n \n \n 1\n 1\n 0\n 0\n \n \n 1\n 1\n 0\n 0\n \n \n 1\n 1\n 0\n 0\n \n \n 1\n 1\n 0\n 0\n \n \n 1\n 1\n 0\n 0\n \n \n 1\n 1\n 0\n 0\n \n \n 1\n 1\n 0\n 0\n \n \n 1\n 1\n 0\n 0\n \n \n 1\n 1\n 0\n 0\n \n \n 1\n 1\n 0\n 0\n \n \n 1\n 1\n 0\n 0\n \n \n 1\n 1\n 0\n 0\n \n \n 1\n 1\n 0\n 0\n \n \n 1\n 1\n 0\n 0\n \n \n 1\n 1\n 1\n 0\n \n \n 1\n 1\n 1\n 1\n \n \n 1\n 1\n 0\n 0\n \n \n 1\n 1\n 0\n 0\n \n \n 1\n 1\n 0\n 0\n \n \n 1\n 1\n 1\n 0\n \n \n 1\n 1\n 0\n 0\n \n \n 1\n 1\n 0\n 0\n \n \n 1\n 1\n 0\n 0\n \n \n 1\n 1\n 0\n 0\n \n \n"}],"_postman_id":"eee5cb60-96fb-4b7a-84d0-5099ad714df3"},{"name":"/users","id":"edbd96f8-7620-4244-88a9-6d4c679697a2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}],"advancedConfig":[{"key":"saveHelperData","value":""},{"key":"showPassword","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Basic YWRtaW46c2FtYmEyMDAy"}],"url":"{{API_EndPoint}}/api/2/{{user_name}}/users","description":"

Get list of user accounts.

\n

Arguments

\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
Optionalcount (int)Specify number of returned results. Default is 100.\n
 offset (int)Specify to move the cursor through the recordset. Default is 0.
 order (str)Return results in ascending or descending order of recording ID. Default is asc.
Accepted values: asc, desc\n
\n

Return Arguments

\nSee GET /user/id/[int]","urlObject":{"path":["api","2","{{user_name}}","users"],"host":["{{API_EndPoint}}"],"query":[],"variable":[]}},"response":[{"id":"f6ac076e-679d-4460-b734-0d9dc6c0b63f","name":"Response","originalRequest":{"method":"GET","header":[{"key":"Authorization","type":"text","name":"Authorization","value":"Basic YWRtaW46c2FtYmEyMDAy"}],"url":"{{API_EndPoint}}/api/2/{{user_name}}/users"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate, post-check=0, pre-check=0","name":"Cache-Control","description":""},{"key":"Connection","value":"keep-alive","name":"Connection","description":""},{"key":"Content-Encoding","value":"gzip","name":"Content-Encoding","description":""},{"key":"Content-Type","value":"application/xml","name":"Content-Type","description":""},{"key":"Date","value":"Mon, 05 Jun 2017 15:28:19 GMT","name":"Date","description":""},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT","name":"Expires","description":""},{"key":"Pragma","value":"no-cache","name":"Pragma","description":""},{"key":"Server","value":"nginx/1.10.3","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""},{"key":"X-Powered-By","value":"PHP/5.4.30","name":"X-Powered-By","description":""}],"cookie":[],"responseTime":null,"body":"\n\n \n 1\n login\n email@mail.com\n First Name\n Last Name\n 50\n \n US\n en-US\n UTC\n 2017-06-05 14:11:08\n 1\n 0\n \n \n \n \n \n http://domain.com/storage/users/1/myprofile/1.jpg\n 2778\n \n \n \n \n 1000\n 2\n 1\n \n \n Service Plan Template\n \n 1\n 1\n 1\n 1\n 1\n 1\n 1\n 0\n voip\n \n hybrid\n voip\n phone\n \n \n 1\n 1\n 1\n 1\n 1\n 1\n 1\n 1\n 1\n 1\n 1\n 1\n 1\n \n \n 1\n 1\n 1\n 1\n 1\n 1\n 1\n 1\n 1\n 0\n \n \n \n 1\n 1\n 0\n 0\n \n \n 1\n 1\n 0\n 0\n \n \n 1\n 1\n 0\n 0\n \n \n 1\n 1\n 0\n 0\n \n \n 1\n 1\n 0\n 0\n \n \n 1\n 1\n 0\n 0\n \n \n 1\n 1\n 0\n 0\n \n \n 1\n 1\n 0\n 0\n \n \n 1\n 1\n 0\n 0\n \n \n 1\n 1\n 0\n 0\n \n \n 1\n 1\n 1\n 0\n \n \n 1\n 1\n 0\n 0\n \n \n 1\n 1\n 1\n 0\n \n \n 1\n 1\n 0\n 0\n \n \n 1\n 1\n 0\n 0\n \n \n 1\n 1\n 1\n 0\n \n \n 1\n 1\n 1\n 0\n \n \n 1\n 1\n 0\n 0\n \n \n 1\n 1\n 0\n 0\n \n \n 1\n 1\n 0\n 0\n \n \n 1\n 1\n 0\n 0\n \n \n 1\n 1\n 0\n 0\n \n \n 1\n 1\n 0\n 0\n \n \n 1\n 1\n 0\n 0\n \n \n 1\n 1\n 0\n 0\n \n \n 1\n 1\n 0\n 0\n \n \n 1\n 1\n 0\n 0\n \n \n 1\n 1\n 0\n 0\n \n \n 1\n 1\n 0\n 0\n \n \n 1\n 1\n 0\n 0\n \n \n 1\n 1\n 0\n 0\n \n \n 1\n 1\n 0\n 0\n \n \n 1\n 1\n 1\n 0\n \n \n 1\n 1\n 1\n 1\n \n \n 1\n 1\n 0\n 0\n \n \n 1\n 1\n 0\n 0\n \n \n 1\n 1\n 0\n 0\n \n \n 1\n 1\n 1\n 0\n \n \n 1\n 1\n 0\n 0\n \n \n 1\n 1\n 0\n 0\n \n \n 1\n 1\n 0\n 0\n \n \n 1\n 1\n 0\n 0\n \n \n \n \n 2\n rkudinov\n roman.kudinov@novelapp.com\n Free\n Account\n 10\n \n US\n en-US\n UTC\n 2017-05-30 11:29:09\n 1\n 0\n \n \n \n \n \n http://os4-dev.skymeeting.net/storage/users/2/myprofile/2.jpg\n 45968\n \n \n \n \n 1000\n 3\n 1\n \n \n Parent Service Plan Template\n \n 1\n 1\n 1\n 1\n 1\n \n 1\n 0\n voip\n \n hybrid\n voip\n phone\n \n \n 1\n 1\n 1\n 1\n 1\n 1\n 1\n 1\n 1\n 1\n 1\n 1\n 1\n \n \n 1\n 1\n 1\n 1\n 1\n 1\n 1\n 1\n 1\n 0\n \n \n \n 1\n 1\n 0\n 0\n \n \n 1\n 1\n 0\n 0\n \n \n 1\n 1\n 0\n 0\n \n \n 1\n 1\n 0\n 0\n \n \n 1\n 1\n 0\n 0\n \n \n 1\n 1\n 0\n 0\n \n \n 1\n 1\n 0\n 0\n \n \n 1\n 1\n 0\n 0\n \n \n 1\n 1\n 0\n 0\n \n \n 1\n 1\n 0\n 0\n \n \n 1\n 1\n 1\n 0\n \n \n 1\n 1\n 0\n 0\n \n \n 1\n 1\n 1\n 0\n \n \n 1\n 1\n 0\n 0\n \n \n 1\n 1\n 0\n 0\n \n \n 1\n 1\n 1\n 0\n \n \n 1\n 1\n 1\n 0\n \n \n 1\n 1\n 0\n 0\n \n \n 1\n 1\n 0\n 0\n \n \n 1\n 1\n 0\n 0\n \n \n 1\n 1\n 0\n 0\n \n \n 1\n 1\n 0\n 0\n \n \n 1\n 1\n 0\n 0\n \n \n 1\n 1\n 0\n 0\n \n \n 1\n 1\n 0\n 0\n \n \n 1\n 1\n 0\n 0\n \n \n 1\n 1\n 0\n 0\n \n \n 1\n 1\n 0\n 0\n \n \n 1\n 1\n 0\n 0\n \n \n 1\n 1\n 0\n 0\n \n \n 1\n 1\n 0\n 0\n \n \n 1\n 1\n 0\n 0\n \n \n 1\n 1\n 1\n 0\n \n \n 1\n 1\n 1\n 1\n \n \n 1\n 1\n 0\n 0\n \n \n 1\n 1\n 0\n 0\n \n \n 1\n 1\n 0\n 0\n \n \n 1\n 1\n 1\n 0\n \n \n 1\n 1\n 0\n 0\n \n \n 1\n 1\n 0\n 0\n \n \n 1\n 1\n 0\n 0\n \n \n 1\n 1\n 0\n 0\n \n \n \n ......\n"}],"_postman_id":"edbd96f8-7620-4244-88a9-6d4c679697a2"},{"name":"/user_id","id":"c4384bc2-809b-4680-bcea-f344208bd801","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}],"advancedConfig":[{"key":"saveHelperData","value":""},{"key":"showPassword","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Basic YWRtaW46c2FtYmEyMDAy"}],"url":"{{API_EndPoint}}/api/2/{{user_name}}/user_id/login/admin","description":"

Get one or many user id(s) by given email address or account username

\n\n

Arguments

\n\n\n \n \n \n \n \n
Requiredemail (str) or login (str)Email address or username (login) of specific user.
\n

Return Arguments

\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
id (int)The id of this resource (session id).
activated (bool)Boolean whether the user account is enabled or not.
is_guest(bool)Boolean whether the user account is guest or not.
deleted (bool)Boolean whether the user account is deleted or not.
","urlObject":{"path":["api","2","{{user_name}}","user_id","login","admin"],"host":["{{API_EndPoint}}"],"query":[],"variable":[]}},"response":[{"id":"0ce27e5f-6ad8-44ed-b38d-e77b479c676f","name":"Response","originalRequest":{"method":"GET","header":[{"key":"Authorization","type":"text","name":"Authorization","value":"Basic YWRtaW46c2FtYmEyMDAy"}],"url":"{{API_EndPoint}}/api/2/{{user_name}}/user_id/login/[string]"},"status":"Created","code":201,"_postman_previewlanguage":"xml","header":[{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate, post-check=0, pre-check=0","name":"Cache-Control","description":""},{"key":"Connection","value":"keep-alive","name":"Connection","description":""},{"key":"Content-Type","value":"application/xml","name":"Content-Type","description":""},{"key":"Date","value":"Mon, 05 Jun 2017 15:50:08 GMT","name":"Date","description":""},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT","name":"Expires","description":""},{"key":"Pragma","value":"no-cache","name":"Pragma","description":""},{"key":"Server","value":"nginx/1.10.3","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""},{"key":"X-Powered-By","value":"PHP/5.4.30","name":"X-Powered-By","description":""}],"cookie":[],"responseTime":null,"body":"\n1010\n"}],"_postman_id":"c4384bc2-809b-4680-bcea-f344208bd801"},{"name":"/user","id":"d510d8dc-620a-434b-9902-2f605a1535f6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}],"advancedConfig":[{"key":"saveHelperData","value":""},{"key":"showPassword","value":""}]},"isInherited":false},"method":"PUT","header":[{"key":"Authorization","value":"Basic YWRtaW46c2FtYmEyMDAy"}],"body":{"mode":"raw","raw":"input_type=json&rest_data={\n \"login\":\"some-username\",\n \"password\":\"some-password\",\n \"email\":\"email@domain.com\",\n \"first_name\":\"First Name\",\n \"last_name\":\"Last Name\",\n \"company\":\"Company Inc.\",\n \"city\":\"Some City\",\n \"phone\":\"123 456 789\",\n \"industry\":\"IT Services\",\n \"birthday\":\"1976-09-10 12:00:00\",\n \"api_enabled\":\"1\",\n \"service_plan_id\":\"4\",\n \"custom_data\": [{\n \"custom1\":\"first custom value\", \n \"custom2\":\"second custom value\", \n \"custom3\":\"third custom value\",\n \"custom4\":\"fourth custom value\"\n }]\n}"},"url":"{{API_EndPoint}}/api/2/{{user_name}}/user","description":"

Create a new user. Requires admin access rights.

\n

Arguments

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
Requiredlogin (int)The username of the user, used to login.
 password (str)The password for this user’s account.
 email (str)The email address of the user.
 first_name (str)The first name of the user.
 last_name (str)The last name of the user.
Optionalcompany (str)The company of the user.
 country (str)The country of the user.
 tax_number (str)The user company’s tax number.
 afid_key (str)The user’s affiliate key, pass this to signup pages to associate any new user signups with the user owning the afid_key. (Available in v4.2.3).
 role (int)User role. (Available in v4.2.6)\n10 = Moderator\n20 = Affiliate\n30 = Distributor\n40 = Admin\nFrom v4.2.8: \n10 = Moderator\n20 = Company\n30 = Affiliate\n40 = Distributor\n50 = Admin.
 language (str)The language chosen by the user.
 title (str)Possible values: mr, mrs, ms.
 gender (str)Possible values: male, female.
 address (str)The address of the user.
 city (str)The city the user resides in.
 state (str)The state the user resides in.
 postcode (str)The post or zipcode of the user.
 phone (str)The phone number of the user.
 industry (str)The industry of the user.
 birthday (datetime)The birthday of the user in datetime format eg 1976-10-09 09:00:00.
 activated (bool)Whether the user account is activated. \nBy default this is 1.
 parent_id (int)The ID of the user to which the current user belongs. (Available in v4.2.3).
 service_plan_id (int)This controls various limits and parameters applied to the user. If empty, the default service plan is used.
 expiry_date (datetime)Set the day and time you want access to this account to expire. All data will be retained after that time, but access will be prevented. Typically used in conjunction with a payment app. Sample value: 2011-12-24 09:00:00.
 paid_signup_date (datetime)Set the day and time this user converted from a free trial to a paying customer.
 api_enabled (bool)Whether the user may access the API or not. By default this is 0.
 mp4_recording_enabled (bool)Enable MP4 recordings (available with v 4.4.3).
 password_protect_fast_session (bool)Password protect MeetNow meetings (available with v 5.1.5).
 sim_bcaster (int)Limit simultaneous broadcasters in sessions belonging to this user. \nSet to -1 for unlimited, set to 0 to disable audio & video broadcasting, set to empty string to use the parent product value.
 session_user_limit (int)The user connection limit per session. \nSet to -1 for unlimited, set to empty string to use the parent product value.\n(available with v 4.2.6)\n
 account_user_limit (int)The simultaneous user connection limit across all sessions in this account.\nSet to -1 for unlimited, set to empty string to use the parent product value.\n(available with v 4.2.8)\n
 company_sim_bcaster (int)Number of broadcasters that can broadcast at the same time across all account holders in this company.\nSet to -1 for unlimited, set to empty string to use the parent product value.\n(available with v 4.2.8). Please check POST/PUT company_user_limits method.
 company_session_user_limit (int)Number of sessions that can run at the same time in this company.\nSet to -1 for unlimited, set to empty string to use the parent product value.\n(available with v 4.2.8). Please check POST/PUT company_user_limits method.
 company_account_user_limit (int)Number of attendees that can be in sessions at the same time across all account holders in this company.\nSet to -1 for unlimited, set to empty string to use the parent product value.\n(available with v 4.2.8). Please check POST/PUT company_user_limits method.
 rec_limit (int)Recording limit to this user. \nSet to -1 for unlimited, set to empty string to use the parent product value.\n(available with v 4.2.6)\n
 ml_limit (int)Total media library size limit (KB). \nSet to -1 for unlimited, set to empty string to use the parent product value. (available with v 4.2.6)
 fms_server_ip (str)The IP or FQDN of the Flash Media Server running the FMS application to which sessions of this account should connect. (available with v 4.3.1)
 fms_application_name (str)The name of the FMS application to which sessions of this account should connect. (available with v 4.3.1)
 serviceplan_name (str)Custom name for user service plan. (available with v 4.3.1)
 serviceplan_description (str)Define a brief description for user service plan. (available with v 4.3.1)
 modify_branding_enabled (bool)Allow account holders to modify branding. (available with v 4.3.1)
 modify_colors_enabled (bool)Allow account holders to modify theme colors. Available when new flat-ui theme is enabled (available with v 4.4.5)
 advanced_sessions_enabled (bool)Enable advanced scheduling features. (available with v 4.3.1)
 pro_video_enabled (bool)Enable pro & custom video options. (available with v 4.3.1)
 mobile_access_enabled (bool)Enable access from mobile applications. (available with v 4.3.1)
 modify_permissions_enabled (bool)Allow account holders to modify session permissions (available with v 4.4.4)
 session_auto_recording_enabled (bool)Enable auto-record sessions, note this will impact disk space usage (available with v 5.1.5).
 appshare_fit_to_screen (int)Set default screenshare view mode (available with v 5.1.5).\n Values:\n - 0 - Set default view for application sharing to \"100%\"\n - 1 - Set default view for application sharing to \"Fit To Screen\"\n
 available_room_type (str)The Room type(s) which are made available to this account at session level (available with v 5.1.3).\n Possible values:\n - flex - classic flash room\n - webrtc - new HTML5 room (beta)\n - both - flash and HTML5 are allowed\n
 menu_buttons (array)Menu Buttons Available in Session. Set one of allowed values to TRUE to show menu button, or to FALSE to hide that one.\nAllowed values:\n - screensharing (bool) - Show/Hide “Screen Sharing” item\n - inviteparticipants (bool) - Show/Hide “Invite Participants” item\n - medialibrary (bool) - Show/Hide “Media Library” item\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- pushtotalk (bool) - Show/Hide “Push to Talk ” ite. This item can be showed when Microphone is showed. (available with v 4.4.4)\n - requesttospeak (bool) - Show/Hide “Request To Speak” item\nhelp (bool) - Show/Hide “About” item\n(available with v 4.3.1)\n
 components (array)Components 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 - participants (bool) - Show/Hide “Participants” component\n - conference (bool) - Show/Hide “Conference” component\n - content_share_1 (bool) - Show/Hide “Content Share #1” component\n - content_share_2 (bool) - Show/Hide “Content Share #2” component\n - content_share_3 (bool) - Show/Hide “Content Share #3” 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 - Show/Hide “Caption Stream” component (available with v 5.0.4 when caption stream feature is enabled on the server level)
 permissions (array)Permissions Available in Session (available with v 4.4.4). Use following format to set permissions:\n
\n{\"allow_local_screen_share\": {\n    \"accountholder\": \"1\",\n    \"moderator\": \"1\",\n    \"participant\": \"0\",\n    \"observer\": \"1\"\n},\n\"allow_screen_inviting\": {\n    \"accountholder\": \"1\",\n    \"moderator\": \"1\",\n    \"participant\": \"1\",\n    \"observer\": \"1\"\n}}\n
\nCheck “Session in-room permissions” table to see all possible permissions and default settings.\n
 voip_session_audio (str)Default Session Audio. Allowed values: phone, voip, hybrid. (available with v 4.3.2)
 voip_available_session_audio (str)Available 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
 custom_data (array)JSON array of custom data, in the following formats:\n
\n[\n   {\n   \"custom1\": \"custom value 1\",\n   \"custom2\": \"custom value 2\",\n   \"custom3\": \"custom value 3\"\n   }\n]\n
\nYou 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.\nCustom value is varchar(200).
 profile_pic_url (str)Set URL to upload user profile image.\nFile conditions:\nType: jpg, png, gif. Size: 2.5MB maximum allowed. \nDimensions: 320px x 240px recommended , 3400px x 2400px maximum allowed. (available with v 4.3.4)
\n\n

Return Arguments

\n\n \n \n \n \n \n \n \n \n
id (int)The id of the added entity.
message (str)Text messsage.
","urlObject":{"path":["api","2","{{user_name}}","user"],"host":["{{API_EndPoint}}"],"query":[],"variable":[]}},"response":[{"id":"0af44db4-9267-49f2-8154-ad4372efa1ae","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\"login\":\"some-username\",\n\t\"password\":\"some-password\",\n\t\"email\":\"email@domain.com\",\n\t\"first_name\":\"First Name\",\n\t\"last_name\":\"Last Name\",\n\t\"company\":\"Company Inc.\",\n\t\"city\":\"Some City\",\n\t\"phone\":\"123 456 789\",\n\t\"industry\":\"IT Services\",\n\t\"birthday\":\"1976-09-10 12:00:00\",\n\t\"api_enabled\":\"1\",\n\t\"service_plan_id\":\"4\",\n\t\"custom_data\": [{\n\t\t\"custom1\":\"first custom value\", \n\t\t\"custom2\":\"second custom value\", \n\t\t\"custom3\":\"third custom value\",\n\t\t\"custom4\":\"fourth custom value\"\n\t}]\n}"},"url":"{{API_EndPoint}}/api/2/{{user_name}}/user"},"status":"Created","code":201,"_postman_previewlanguage":"xml","header":[{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate, post-check=0, pre-check=0","name":"Cache-Control","description":""},{"key":"Connection","value":"keep-alive","name":"Connection","description":""},{"key":"Content-Type","value":"application/xml","name":"Content-Type","description":""},{"key":"Date","value":"Mon, 05 Jun 2017 16:44:27 GMT","name":"Date","description":""},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT","name":"Expires","description":""},{"key":"Pragma","value":"no-cache","name":"Pragma","description":""},{"key":"Server","value":"nginx/1.10.3","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""},{"key":"X-Powered-By","value":"PHP/5.4.30","name":"X-Powered-By","description":""}],"cookie":[],"responseTime":null,"body":"\n822User added\n"}],"_postman_id":"d510d8dc-620a-434b-9902-2f605a1535f6"},{"name":"/user","id":"2a2bb5dc-8765-4564-9f14-deb62ee471e3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}],"advancedConfig":[{"key":"saveHelperData","value":""},{"key":"showPassword","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Basic YWRtaW46c2FtYmEyMDAy"}],"body":{"mode":"raw","raw":"input_type=json&rest_data={\n\t\"id\":\"1\",\n\t\"login\":\"some-username\",\n\t\"password\":\"some-password\",\n\t\"email\":\"email@domain.com\",\n\t\"first_name\":\"First Name\",\n\t\"last_name\":\"Last Name\",\n\t\"company\":\"Company Inc.\",\n\t\"city\":\"Some City\",\n\t\"phone\":\"123 456 789\",\n\t\"industry\":\"IT Services\",\n\t\"birthday\":\"1976-09-10\",\n\t\"api_enabled\":\"1\",\n\t\"service_plan_id\":\"4\",\n\t\"custom_data\": [\n\t\t{\n\t\t\t\"custom1\":\"first custom value\", \n\t\t\t\"custom2\":\"second custom value\", \n\t\t\t\"custom3\":\"third custom value\",\n\t\t\t\"custom4\":\"fourth custom value\"\n\t\t}\n\t]\n}"},"url":"{{API_EndPoint}}/api/2/{{user_name}}/user","description":"

Edit an existing user. Requires admin access rights.

\n\n\n \n \n \n \n \n \n \n \n \n \n
Requiredid (int)The id of the user to be edited..
OptionalSee params of PUT /user method.
\n\n

Return Arguments

\n\n \n \n \n \n \n \n \n \n
id (int)The id of the updated entity.
message (str)Text messsage.
","urlObject":{"path":["api","2","{{user_name}}","user"],"host":["{{API_EndPoint}}"],"query":[],"variable":[]}},"response":[{"id":"b42d12e9-454b-4dc7-9d31-08bf203bd0ad","name":"Response","originalRequest":{"method":"POST","header":[{"key":"Authorization","type":"text","name":"Authorization","value":"Basic YWRtaW46c2FtYmEyMDAy"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"input_type=json&rest_data={\n\t\"id\":\"1\",\n\t\"login\":\"some-username\",\n\t\"password\":\"some-password\",\n\t\"email\":\"email@domain.com\",\n\t\"first_name\":\"First Name\",\n\t\"last_name\":\"Last Name\",\n\t\"company\":\"Company Inc.\",\n\t\"city\":\"Some City\",\n\t\"phone\":\"123 456 789\",\n\t\"industry\":\"IT Services\",\n\t\"birthday\":\"1976-09-10\",\n\t\"api_enabled\":\"1\",\n\t\"service_plan_id\":\"4\",\n\t\"custom_data\": [\n\t\t{\n\t\t\t\"custom1\":\"first custom value\", \n\t\t\t\"custom2\":\"second custom value\", \n\t\t\t\"custom3\":\"third custom value\",\n\t\t\t\"custom4\":\"fourth custom value\"\n\t\t}\n\t]\n}"},"url":"{{API_EndPoint}}/api/2/{{user_name}}/user"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate, post-check=0, pre-check=0","name":"Cache-Control","description":""},{"key":"Connection","value":"keep-alive","name":"Connection","description":""},{"key":"Content-Encoding","value":"gzip","name":"Content-Encoding","description":""},{"key":"Content-Type","value":"application/xml","name":"Content-Type","description":""},{"key":"Date","value":"Tue, 06 Jun 2017 16:59:11 GMT","name":"Date","description":""},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT","name":"Expires","description":""},{"key":"Pragma","value":"no-cache","name":"Pragma","description":""},{"key":"Server","value":"nginx/1.10.3","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""},{"key":"X-Powered-By","value":"PHP/5.4.30","name":"X-Powered-By","description":""}],"cookie":[],"responseTime":null,"body":"\n503User was modified\n"}],"_postman_id":"2a2bb5dc-8765-4564-9f14-deb62ee471e3"},{"name":"/user","id":"9f090762-26a6-42e8-8ee8-971c73a29e19","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}],"advancedConfig":[{"key":"saveHelperData","value":""},{"key":"showPassword","value":""}]},"isInherited":false},"method":"DELETE","header":[{"key":"Authorization","value":"Basic YWRtaW46c2FtYmEyMDAy"}],"body":{"mode":"raw","raw":"input_type=json&rest_data={\n\t\"id\":\"1\"\n}"},"url":"{{API_EndPoint}}/api/2/{{user_name}}/user","description":"

Delete user account.

\n

Arguments

\n\n \n \n \n \n \n
Requireduser_id (int)The id of the user account to be deleted. Note: the id may also be appended to the URL (.../id/xxx) instead of in the request body.
\n\n

Return Arguments

\n\n \n \n \n \n \n \n \n \n
id (int)ID# of user account.
message (str)Text message.
","urlObject":{"path":["api","2","{{user_name}}","user"],"host":["{{API_EndPoint}}"],"query":[],"variable":[]}},"response":[{"id":"cbadd862-febf-4c25-bd36-ce424776b647","name":"Response","originalRequest":{"method":"DELETE","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\"id\":\"111\"\n}"},"url":"{{API_EndPoint}}/api/2/{{user_name}}/user"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate, post-check=0, pre-check=0","name":"Cache-Control","description":""},{"key":"Connection","value":"keep-alive","name":"Connection","description":""},{"key":"Content-Encoding","value":"gzip","name":"Content-Encoding","description":""},{"key":"Content-Type","value":"application/xml","name":"Content-Type","description":""},{"key":"Date","value":"Mon, 05 Jun 2017 16:01:44 GMT","name":"Date","description":""},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT","name":"Expires","description":""},{"key":"Pragma","value":"no-cache","name":"Pragma","description":""},{"key":"Server","value":"nginx/1.10.3","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""},{"key":"X-Powered-By","value":"PHP/5.4.30","name":"X-Powered-By","description":""}],"cookie":[],"responseTime":null,"body":"\n485User was deleted\n"}],"_postman_id":"9f090762-26a6-42e8-8ee8-971c73a29e19"}],"id":"e8a59b68-1695-48f2-a22e-66d920272f7f","_postman_id":"e8a59b68-1695-48f2-a22e-66d920272f7f","description":""}],"event":[{"listen":"prerequest","script":{"id":"7c193cfe-4320-4024-b1f4-a303cf3e6189","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"4d072bf8-9b10-4a19-884f-8e8551b6ca81","type":"text/javascript","exec":[""]}}]}