swagger.yaml

swagger: '2.0'
info:
  title: BlueJeans Meetings REST API
  description: >
  
    ## Video That Works Where You Do.
  
    This site provides developers access to APIs from BlueJean's Meetings meeting service.  From here you will be able to make actual API calls to manage User Accounts, Meetings, and Recordings.  Also, you can pull analytical data and current state information.

    With these APIs you can quickly integrate **BlueJeans** video administration into your applications.  

    <hr>
    

    <h2 class="info"> What is a BlueJeans Meeting?</h2>
    
    <img src="./img/bjnmeeting.png" style="padding-left:20px; width:50%">
    
    
    A BlueJeans meeting is a collaboration session of 2 or more participants joining a virtual meeting-room in the cloud.  
    The first person to join is put into a waiting-room until other participant(s) join.  When the meeting starts, all participants will be connected over video & audio.

    
    <u>Types of Meeting Rooms</u>
    There are two types of Meeting Rooms available to a registered user.  They are described as:
    <ul>
    <li>Scheduled – A room created for a specific date and time.  It is assigned a randomized and unique numeric ID by BlueJeans.</li>
    <li>Personal – Every user is given a personal meeting room with a customized Meeting Identifier.  People typically use their mobile phone number as their Meeting ID.</li>
    </ul>

    <u>Meeting Room Security</u>
    A meeting room can <i>optionally</i> be protected by a randomized access code.  THe access code ensures security of participants who join.  Also the access code can specify a Moderator role whose user(s) have additional capabilities to administer a meeting.
    <ul>
    <li>When set, participants would be required to enter the access code in order to join.</li>
    <li>The scheduler's profile has a user-specified moderator passcode which can be input to allow designated user(s) greater privileges to help organize meetings.</li>
    </ul>
    
    <hr>
    

    <h2 id='gs' class="info" onclick="hideit('gs')"><span id="gsicon" class="glyphicon glyphicon-chevron-right"></span> Getting Started</h2>

    <div id="gsbody" style="display:none">
    Before you start using BlueJeans' APIs, you must first have a BlueJeans account enabled for API Access.  Contact <a href="mailto:Support@BlueJeans.com)">BlueJeans Support</a> for assistance.  <br /><br />Once you have an account, you may start writing application code to authenticate and make API calls.  *Alternatively*, you can use this developer site to test the BlueJeans' APIs and develop a level of familiarity before you write production code.  <br />
    
    
    ### To Make API Calls from This Site

    If you want to use this developer site to try various BlueJeans' APIs, here are the steps required to authenticate and enable your Developer Session to place API calls.

    1. Choose Method for Authenticating
         * Click on the desired Authentication method from below.
         * Click on the **Try It Out** button.
    1. Make Authentication request
         * Follow APIs instructions and input the API parameters.
         * Click on the blue **Execute** button.
         * If successful, the API returns with JSON data containing a field called **access_token**.  Copy/save this value.
    1. Authorize BlueJeans Developer Session.
         * Click on the green **Authorize button**. 
         * The site will show you a pop-up window for authorization.
         * Enter your access token in the field named **api_key**
         * Click on the **Authorize** button
    
    Your current BlueJeans developer session is now authenticated and ready to place API calls.  The web site will automatically include your access token on any API calls you make.

    </div>

    <hr>

    
    <h2 id='oauth' class="info" onclick="hideit('oauth')"><span id="oauthicon" class="glyphicon glyphicon-chevron-right"></span> About Meetings Authentication</h2>


    <div id="oauthbody" style="display:none">

    
    All API transactions (excluding Authentication) require an access token per **OAuth standards**.  BlueJeans provides multiple methods for obtaining an access token.  Additionally there are diffferent scopes of token access.

    ### Grant Types
    
    Bluejeans provides 4 different methods for users to Authenticate.  Successful authentication allows BlueJeans to grant an access token to perform API operations.
    
    * Password Credentials Grant – Authenticate with a username and password and receive an access token with user level permission. Known as two-legged OAuth.

    * Meeting Credentials Grant – Authenticate with a meeting ID and meeting passcode and receive an access token with meeting level permission. Known as two-legged OAuth.

    * Client Credentials Grant –  Authenticate with a client ID and client secret and receive an access token with enterprise level permission. Known as two-legged OAuth.

    * Authorization Code Grant – Authentication for your developer's application occurs through a redirection to a BlueJeans authentication page. The application receives an authorization code to be submitted, along with other tokens, to receive an access token. Known as three-legged OAuth. For more information please refer to the [OAuth specification](https://oauth.net/).

    ### Access & Permissions

    BlueJeans defines 3 levels of API access into the system.  When an access token is granted, it carries one of these 3 levels.  The scope of system functionality depends upon the token's access level.

    * Meeting-level – Scope of APIs is limited to individual meetings.

    * User-level – Scope depends on the requested permissions.

    * App-level – provisioned either by BlueJeans personnel, or the BlueJeans Enterprise Admin, an app, is issued a client key and secret key. These tokens then are used by the BlueJeans Authentication API to receive the token. The token's scope provides access to the entire enterprise and all of its users.

    All endpoints in this document that require **Enterprise Admin** access will be marked as such.
    
    </div>

    <hr>


  termsOfService: https://www.bluejeans.com/terms-of-service
  license:
    name: Commercial
    url: https://www.bluejeans.com/site/terms-and-conditions
  version: 1.0.0
  contact:
    name: Brandon Fuller
    url: http://bluejeans.com/
    email: brandon@bluejeans.com
externalDocs:
  description: >
    Find more info here
  url: https://swagger.io
host: api.bluejeans.com
securityDefinitions:
  access_token:
    type: apiKey
    name: access_token
    in: query
security:
  - access_token: []
schemes:
  - https
produces:
  - application/json
tags:
  -
    name: Authentication
    description:  Initiate a session with BlueJeans
  -
    name: User
    description:  Manage End User Accounts
  -
    name: Enterprise
    description:  Manage Enterprise User Accounts
  -
    name: Meeting
    description:  Manage Video Meetings and Endpoints
  -
    name: History
    description:  Access Historical Meeting Data
  -
    name: Recording
    description:  Manage Meeting Recordings
  -
    name: Command Center
    description:  Access Status of Current Meetings & Enterprise Usage Information
paths:
  /oauth2/token?Password:
    post:
      summary: Authentication via Password Grant Type
      description: This API performs an authentication based upon a username and password.   Call this API and provide a valid username and password. <br />**NOTE:** <br />&nbsp;&nbsp;When calling this API, you must set the field, **grant_type** to equal "**password**" (string).
      operationId: getTokenByPassword
      tags:
        - Authentication
      consumes:
        - application/json
      parameters:
        - name: GrantRequestPassword
          description: Contains information about the type of grant you are requesting.  **Remember**, the field *grant_type* must be set to *password*.
          in: body
          required: true
          schema:
            $ref: '#/definitions/GrantRequestPassword'
      responses:
        '200':
          description: The information about the grant.
          schema:
            $ref: '#/definitions/GrantPassword'
        default:
          description: Unexpected error
          schema:
            $ref: '#/definitions/Error'
  /oauth2/token?Meeting:
    post:
      summary: Authentication via Meeting Grant Type
      description: This API uses an OAuth-like grant/request method similar to the Password grant type.  The API returns an access token whose scope is limited to the meeting only. <br />Call this API with the meeting's numeric ID, and the meeting passcode (if one exists). <br />&nbsp;&nbsp;If you call the API with a Moderator passcode, moderator privileges are granted. <br />&nbsp;&nbsp;If an Attendee access code is passed, the access token will grant attendee abilities.<br />**NOTE:** <br />&nbsp;&nbsp;When calling this API, you must set the field, **grant_type** to equal "**meeting_passcode**" (string).
      operationId: getTokenByMeeting
      tags:
        - Authentication
      consumes:
        - application/json
      parameters:
        - name: GrantRequestMeeting
          description: Contains information about the type of grant you are requesting.  **Remember**, the field *grant_type* must be set to *meeting_passcode*.
          in: body
          required: true
          schema:
            $ref: '#/definitions/GrantRequestMeeting'
      responses:
        '200':
          description: The information about the grant.
          schema:
            $ref: '#/definitions/GrantMeeting'
        default:
          description: Unexpected error
          schema:
            $ref: '#/definitions/Error'
  /oauth2/token?Client:
    post:
      summary: Authentication via Client Grant Type
      description: This API is typically called from an application that needs to make API requests.  The values for the calling parameters, Client ID, and Secret, are provisioned within the BlueJeans Enterprise Administration console.  A BlueJeans administrator must generate these parameters and provide them to the customer/developer. <br />**NOTE:** <br />&nbsp;&nbsp;When calling this API, you must set the field, **grant_type** to equal "**client_credentials**" (string).
      operationId: getTokenByClient
      tags:
        - Authentication
      consumes:
        - application/json
      parameters:
        - name: GrantRequestClient
          description: Contains information about the type of grant you are requesting.  **Remember**, the field *grant_type* must be set to *client_credentials*.
          in: body
          required: true
          schema:
            $ref: '#/definitions/GrantRequestClient'
      responses:
        '200':
          description: The information about the grant.
          schema:
            $ref: '#/definitions/GrantClient'
        default:
          description: Unexpected error
          schema:
            $ref: '#/definitions/Error'
  /oauth2/token?Code:
    post:
      summary: Authentication via Code Grant Type
      description: This API is part of the 3-legged OAuth 2.0 authorization flow.  The user will be redirected to a BlueJeans page to authenticate.  You must pass to this API your OAuth client and secret keys as well as a *success URL* to which the user will be redirected upon successful authentication. <br />**NOTE:** <br />&nbsp;&nbsp;When calling this API, you must set the field, **grant_type** to equal "**authorization_code**" (string).
      operationId: getTokenByCode
      tags:
        - Authentication
      consumes:
        - application/json
      parameters:
        - name: GrantRequestCode
          description: Contains information about the type of grant you are requesting.  **Remember**, the field *grant_type* must be set to *authorization_code*.
          in: body
          required: true
          schema:
            $ref: '#/definitions/GrantRequestCode'
      responses:
        '200':
          description: The information about the grant.
          schema:
            $ref: '#/definitions/GrantCode'
        '401':
          description: The code token is invalid or has expired.  The code is only good for 30 seconds!
        default:
          description: Unexpected error
          schema:
            $ref: '#/definitions/Error'
  /oauth2/token?Refresh:
    post:
      summary: Authentication via Refresh Grant Type
      description: This API is part of the 3-legged OAuth 2.0 authorization flow.  It only works for access tokens obtained via /oauth2/token?Code endpoint. It allows an application to refresh an existing access token.  You must pass to this API your OAuth client and secret keys as well as the current access token being refreshed.  <br />**NOTE:** <br />&nbsp;&nbsp;When calling this API, you must set the field, **grant_type** to equal "**refresh_token**" (string).
      operationId: getTokenByRefresh
      tags:
        - Authentication
      consumes:
        - application/json
      parameters:
        - name: GrantRequestRefresh
          description: Contains information about the type of grant you are requesting.  **Remember**, the field *grant_type* must be set to *refresh_token*.
          in: body
          required: true
          schema:
            $ref: '#/definitions/GrantRequestRefresh'
      responses:
        '200':
          description: The information about the grant.
          schema:
            $ref: '#/definitions/GrantRefresh'
        default:
          description: Unexpected error
          schema:
            $ref: '#/definitions/Error'
  /oauth2/token?Revoke:
    delete:
      summary: Revoke Access Token
      description: This API is part of the 3-legged OAuth 2.0 authorization flow.
      operationId: revokeAccessToken
      tags:
        - Authentication
      consumes:
        - application/json
      parameters:
        - name: access_token
          type: string
          in: query
        - name: GrantRequestRevoke
          description: Contains information about the type of grant you are revoking.
          in: body
          required: true
          schema:
            $ref: '#/definitions/GrantRequestRevoke'
      responses:
        '204':
          description: The information about the grant.
        '400':
          description: Bad request. The access_token is probably already revoked and cannot be found. Use /oauth2/tokenInfo to query a token's validity if needed.
        default:
          description: Unexpected error
          schema:
            $ref: '#/definitions/Error'
  /oauth2/tokenInfo:
    get:
      summary: Validate a Token
      description: This endpoint will determine if a token is valid or not.  If the token is valid, it returns the user ID for the owner of the token.
      operationId: getTokenInfo
      tags:
        - Authentication
      consumes:
        - application/json
      parameters:
        - name: access_token
          type: string
          in: query
      responses:
        '200':
          description: Any information about the token.
          schema:
            type: object
            properties:
              user:
                type: integer
                description: The ID of the user who this token corresponds to.
        default:
          description: Unexpected error
          schema:
            $ref: '#/definitions/Error'
  /oauth2/authorize:
    get:
      summary: Get Authorization Code
      description: This is **not a true REST endpoint**. <br /> This URL should be used by a user's browser-client application to perform authorization. <br />Upon completion, the user will be redirected back to the client application with state and code return parameters. Use "bluejeans.com" as hostname. <br />**Note:**<br />&nbsp;&nbsp;The code returned is only valid for *30 seconds.*  Your application must call as soon as possible the /oauth2/token API to generate an access token from the returned code.
      operationId: getAuthorizationCode
      tags:
        - Authentication
      parameters:
        - name: clientId
          in: query
          description: The 32 character client ID generated when you created the client application.
          type: string
        - name: redirectUri
          in: query
          description: The URL where the authorization code will be returned via redirect.  The URL must match a URL registered with the client application.
          type: string
        - name: state
          in: query
          description: Client application specific state passed through and returned in the redirect URL. May be useful for identifying operations or users.
          type: string
        - name: scope
          in: query
          description: A comma delimited list of scopes requested. Scopes may be list_meetings, modify_meetings, user_info. Unfortunately, not all operations in the API are available via this authentication method at the current time.
          type: string
        - name: responseType
          in: query
          description: The type of authorization you are peforrming.  Set to "code".
          type: string
          default: code
        - name: appName
          in: query
          description: The name of the client application shown to user during authorization.
          type: string
        - name: appLogoUrl
          in: query
          description: URL to an 84x84 image shown to user during authorization.
          type: string
      responses:
        '200':
          description: This URL should be invoked by the user of the client application in a browser, not via API.
        default:
          description: Unexpected error
          schema:
            $ref: '#/definitions/Error'
  /v1/user/{user_id}:
    get:
      summary: Get User Account Details
      description: This endpoint retrieves the basic account details for a given user.
      operationId: getUser
      tags:
        - User
      security:
        - access_token: []
      parameters:
        - name: user_id
          in: path
          description: The ID of the user of interest. This value is an integer which can be retrieved for the current user via the Get User Account Details endpoint.
          required: true
          type: integer
      responses:
        '200':
          description: The settings for the user
          schema:
            $ref: "#/definitions/User"
        default:
          description: Unexpected error
          schema:
            $ref: '#/definitions/Error'
    put:
      summary: Update User Account Details
      description: This endpoint allows updating a user’s basic account details.
      operationId: updateUser
      tags:
        - User
      parameters:
        - name: user_id
          in: path
          description: The ID of the user of interest. This value is an integer which can be retrieved for the current user via the Get User Account Details endpoint.
          required: true
          type: integer
        - name: user
          in: body
          description: The user details that you wish to update.
          required: true
          schema:
            $ref: "#/definitions/User"
      responses:
        '200':
          description: The settings for the user
          schema:
            $ref: "#/definitions/User"
        default:
          description: Unexpected error
          schema:
            $ref: '#/definitions/Error'
  /v1/user/{user_id}/granted_applications:
    get:
      summary: Get Granted Applications
      description: This endpoint retrieves the granted applications associated with the user.
      operationId: getGrantedApplications
      tags:
        - User
      security:
        - access_token: []
      parameters:
        - name: user_id
          in: path
          description: The ID of the user of interest. This value is an integer which can be retrieved for the current user via the Get User Account Details endpoint.
          required: true
          type: integer
      responses:
        '200':
          description: The granted applications for the user.
          schema:
            $ref: "#/definitions/GrantedApplications"
        default:
          description: Unexpected error
          schema:
            $ref: '#/definitions/Error'
  /v1/user/{user_id}/granted_applications/{client_id}:
    delete:
      summary: Remoke Granted Application
      description: This endpoint revokes the granted application associated with the user.
      operationId: revokeGrantedApplication
      tags:
        - User
      security:
        - access_token: []
      parameters:
        - name: user_id
          in: path
          description: The ID of the user of interest. This value is an integer which can be retrieved for the current user via the Get User Account Details endpoint.
          required: true
          type: integer
        - name: client_id
          in: path
          description: The ID of the granted application.
          required: true
          type: string
      responses:
        '204':
          description: The granted applications for the user.
        default:
          description: Unexpected error
          schema:
            $ref: '#/definitions/Error'
  /v1/user/{user_id}/enterprise_profile:
    get:
      summary: Get Enterprise Profile
      description: This endpoint retrieves the enterprise profile associated with the user.
      operationId: getEnterpriseProfile
      tags:
        - User
      security:
        - access_token: []
      parameters:
        - name: user_id
          in: path
          description: The ID of the user of interest. This value is an integer which can be retrieved for the current user via the Get User Account Details endpoint.
          required: true
          type: integer
      responses:
        '200':
          description: The settings for the user's enterprise association.
          schema:
            $ref: "#/definitions/Enterprise"
        default:
          description: Unexpected error
          schema:
            $ref: '#/definitions/Error'
  /v1/user/{user_id}/groups:
    get:
      summary: Get User Feature Groups
      description: This endpoint retrieves the feature groups associated with the user.
      operationId: getGroups
      tags:
        - User
      security:
        - access_token: []
      parameters:
        - name: user_id
          in: path
          description: The ID of the user of interest. This value is an integer which can be retrieved for the current user via the Get User Account Details endpoint.
          required: true
          type: integer
      responses:
        '200':
          description: The feature groups the user belongs to.
          schema:
            type: array
            items:
              type: string
        default:
          description: Unexpected error
          schema:
            $ref: '#/definitions/Error'
    put:
      summary: Set User Feature Groups
      description: This endpoint sets the feature groups associated with the user.
      operationId: setGroups
      tags:
        - User
      security:
        - access_token: []
      parameters:
        - name: user_id
          in: path
          description: The ID of the user of interest. This value is an integer which can be retrieved for the current user via the Get User Account Details endpoint.
          required: true
          type: integer
        - name: enable
          in: query
          description: The feature group you want to enable.
          type: string
          enum:
            - record
            - extended_capacity
            - lync
            - jabber
            - telepresence
            - isdn
            - facetime
        - name: disable
          in: query
          description: The feature group you want to disable.
          type: string
          enum:
            - record
            - extended_capacity
            - lync
            - jabber
            - telepresence
            - isdn
            - facetime
      responses:
        '200':
          description: Empty response on success.
        default:
          description: Unexpected error
          schema:
            $ref: '#/definitions/Error'
  /v1/enterprise/{enterprise_id}/users:
    get:
      summary: List Enterprise Users
      description: This endpoint allows listing the users that are associated with an enterprise account. Requires enterprise admin access level.
      operationId: listUsers
      tags:
        - Enterprise
      security:
        - access_token: []
      parameters:
        - name: enterprise_id
          in: path
          description: The ID of the enterprise of interest. This value is an integer which can be retrieved for the current user via the Get Enterprise Profile endpoint.
          required: true
          type: integer
        - name: pageSize
          in: query
          description: Sets number of items returned per page.
          type: integer
        - name: pageNumber
          in: query
          description: Selects which page of results to return.
          type: integer
        - name: emailId
          in: query
          description: Allows filtering the response by a user’s email address.
          type: string
      responses:
        '200':
          description: The list of users in the enterprise.
          schema:
            $ref: "#/definitions/EnterpriseUserList"
        default:
          description: Unexpected error
          schema:
            $ref: '#/definitions/Error'
    post:
      summary: Create Enterprise User
      description: This endpoint allows adding a user to an existing enterprise. Requires enterprise admin access level.
      operationId: createUser
      tags:
        - Enterprise
      security:
        - access_token: []
      parameters:
        - name: enterprise_id
          in: path
          description: The ID of the enterprise of interest. This value is an integer which can be retrieved for the current user via the Get Enterprise Profile endpoint.
          required: true
          type: integer
        - name: forcePasswordChange
          in: query
          description: Forces the user to change his or her password on first log in.
          type: boolean
        - name: sendVerificationMail
          in: query
          description: Prevents welcome emails from being sent to the newly created user.
          type: boolean
        - name: user
          in: body
          description: The information about the new user.
          required: true
          schema:
            $ref: '#/definitions/User'
      responses:
        '201':
          description: The new user.
          schema:
            $ref: '#/definitions/UserId'
        default:
          description: Unexpected error
          schema:
            $ref: '#/definitions/Error'
  /v1/enterprise/{enterprise_id}/users/export:
    get:
      summary: Export Enterprise Users
      description: This endpoint exports existing users into a CSV file.
      operationId: exportUsers
      produces:
        - text/csv
      tags:
        - Enterprise
      security:
        - access_token: []
      parameters:
        - name: enterprise_id
          in: path
          description: The ID of the enterprise of interest. This value is an integer which can be retrieved for the current user via the Get Enterprise Profile endpoint.
          required: true
          type: integer
      responses:
        '404':
          description: Enterprise not found
        '406':
          description: Not acceptable. Usually, this is because you hava an accept header set to application/json and the server is trying to return you text/csv. So it is saying it cannot do what you want.
        '200':
          description: Returns a text/csv file. Not a JSON response.
        default:
          description: Unexpected error
          schema:
            $ref: '#/definitions/Error'
  /v1/enterprise/{enterprise_id}/users/{user_id}:
    delete:
      summary: Remove Enterprise User
      description: This endpoint allows removing a user from an enterprise; it does not delete the user. Requires enterprise admin access level.
      operationId: removeUser
      tags:
        - Enterprise
      security:
        - access_token: []
      parameters:
        - name: enterprise_id
          in: path
          description: The ID of the enterprise of interest. This value is an integer which can be retrieved for the current user via the Get Enterprise Profile endpoint.
          required: true
          type: integer
        - name: user_id
          in: path
          description: The ID of the user of interest. This value is an integer which can be retrieved for the current user via the Get User Account Details endpoint.
          required: true
          type: integer
      responses:
        '204':
          description: Empty response on success.
        default:
          description: Unexpected error
          schema:
            $ref: '#/definitions/Error'
  /v1/user/{user_id}/room:
    get:
      summary: Get User’s Default Meeting Settings
      description: This endpoint gets a user’s default meeting settings.
      operationId: getRoom
      tags:
        - User
      security:
        - access_token: []
      parameters:
        - name: user_id
          in: path
          description: The ID of the user of interest. This value is an integer which can be retrieved for the current user via the Get User Account Details endpoint.
          required: true
          type: integer
      responses:
        '200':
          description: The default meeting settings.
          schema:
            $ref: '#/definitions/Room'
        default:
          description: Unexpected error
          schema:
            $ref: '#/definitions/Error'
    put:
      summary: Update User’s Default Meeting Settings
      description: This endpoint allows updating a user’s default meeting settings.
      operationId: updateRoom
      tags:
        - User
      security:
        - access_token: []
      parameters:
        - name: user_id
          in: path
          description: The ID of the user of interest. This value is an integer which can be retrieved for the current user via the Get User Account Details endpoint.
          required: true
          type: integer
        - name: room
          in: body
          description: The user's room details that you wish to update.
          required: true
          schema:
            $ref: "#/definitions/Room"
      responses:
        '200':
          description: The default meeting settings.
          schema:
            $ref: '#/definitions/Room'
        default:
          description: Unexpected error
          schema:
            $ref: '#/definitions/Error'
  /v1/user/{user_id}/scheduled_meeting:
    get:
      summary: List Meetings
      description: This endpoint gets a list of the user's scheduled upcoming meetings.
      operationId: listMeetings
      tags:
        - Meeting
      security:
        - access_token: []
      parameters:
        - name: user_id
          in: path
          description: The ID of the user of interest. This value is an integer which can be retrieved for the current user via the Get User Account Details endpoint.
          required: true
          type: integer
        - name: numericMeetingId
          description: Filter the results by the meeting ID that participants will see and use to join the conference.
          type: string
          in: query
      responses:
        '200':
          description: A list of meetings. 
          schema:
            type: array
            items:
              $ref: '#/definitions/Meeting'
        default:
          description: Unexpected error
          schema:
            $ref: '#/definitions/Error'
    post:
      summary: Create Meeting
      description: This endpoint will create a scheduled meeting.
      operationId: createMeeting
      tags:
        - Meeting
      security:
        - access_token: []
      parameters:
        - name: user_id
          in: path
          description: The ID of the user of interest. This value is an integer which can be retrieved for the current user via the Get User Account Details endpoint.
          required: true
          type: integer
        - name: email
          in: query
          description: If set to true, sends invitation emails to all listed participants.
          type: boolean
        - name: meeting
          in: body
          description: The details of the meeting.
          required: true
          schema:
            $ref: "#/definitions/Meeting"
      responses:
        '201':
          description: The settings for the meeting.
          schema:
            $ref: '#/definitions/Meeting'
        default:
          description: Unexpected error
          schema:
            $ref: '#/definitions/Error'
  /v1/user/{user_id}/scheduled_meeting/{meeting_id}:
    get:
      summary: Get Meeting
      description: This endpoint gets the settings for a user's meeting.
      operationId: getMeeting
      tags:
        - Meeting
      security:
        - access_token: []
      parameters:
        - name: user_id
          in: path
          description: The ID of the user of interest. This value is an integer which can be retrieved for the current user via the Get User Account Details endpoint.
          required: true
          type: integer
        - name: meeting_id
          in: path
          description: The ID of the meeting you want to view. This is an integer value. You can find this ID by doing a list of meetings and referencing the "id" property. This is not the numeric meeting ID visible to users.
          required: true
          type: integer
      responses:
        '200':
          description: The settings for the meeting.
          schema:
            $ref: '#/definitions/Meeting'
        default:
          description: Unexpected error
          schema:
            $ref: '#/definitions/Error'
    put:
      summary: Update Meeting
      description: This endpoint changes the settings for a user's meeting. For example, use for rescheduling.
      operationId: updateMeeting
      tags:
        - Meeting
      security:
        - access_token: []
      parameters:
        - name: user_id
          in: path
          description: The ID of the user of interest.  This value is an integer which can be retrieved for the current user via the Get User Account Details endpoint.
          required: true
          type: integer
        - name: meeting_id
          in: path
          description: The ID of the meeting you want to view. This is an integer value. You can find this ID by doing a list of meetings and referencing the "id" property.
          required: true
          type: integer
        - name: meeting
          in: body
          description: The user's room details that you wish to update.
          required: true
          schema:
            $ref: "#/definitions/Meeting"
      responses:
        '200':
          description: The settings for the meeting.
          schema:
            $ref: '#/definitions/Meeting'
        default:
          description: Unexpected error
          schema:
            $ref: '#/definitions/Error'
    delete:
      summary: Cancel Meeting
      description: This endpoint deletes a scheuled meeting.
      operationId: cancelMeeting
      tags:
        - Meeting
      security:
        - access_token: []
      parameters:
        - name: user_id
          in: path
          description: The ID of the user of interest. This value is an integer which can be retrieved for the current user via the Get User Account Details endpoint.
          required: true
          type: integer
        - name: meeting_id
          in: path
          description: The ID of the meeting you want to view. This is an integer value. You can find this ID by doing a list of meetings and referencing the "id" property.
          required: true
          type: integer
      responses:
        '200':
          description: No content.
        default:
          description: Unexpected error
          schema:
            $ref: '#/definitions/Error'
  /v1/user/{user_id}/scheduled_meeting/{meeting_id}/emails:
    get:
      summary: Get Meeting Email
      description: This endpoint retrieves the email object for a scheduled meeting.
      operationId: getMeetingEmails
      tags:
        - Meeting
      security:
        - access_token: []
      parameters:
        - name: user_id
          in: path
          description: The ID of the user of interest. This value is an integer which can be retrieved for the current user via the Get User Account Details endpoint.
          required: true
          type: integer
        - name: meeting_id
          in: path
          description: The ID of the meeting you want to view. This is an integer value. You can find this ID by doing a list of meetings and referencing the "id" property.
          required: true
          type: integer
        - name: type
          in: query
          description: TEXT, ICS, HTML
          type: string
          enum:
            - TEXT
            - ICS
            - HTML
        - name: role
          in: query
          description: moderator, participant
          type: string
          enum:
            - moderator
            - participant
        - name: action
          in: query
          description: create, edit, delete
          type: string
          enum:
            - create
            - edit
            - delete
      responses:
        '200':
          description: The settings for the email.
          schema:
            $ref: '#/definitions/Meeting'
        default:
          description: Unexpected error
          schema:
            $ref: '#/definitions/Error'
  /v1/user/{user_id}/meetings/{meeting_id}/numbers:
    get:
      summary: Get Meeting Join Info
      description: This endpoint retrieves the join information for a scheduled meeting.
      operationId: getMeetingNumbers
      tags:
        - Meeting
      security:
        - access_token: []
      parameters:
        - name: user_id
          in: path
          description: The ID of the user of interest. This value is an integer which can be retrieved for the current user via the Get User Account Details endpoint.
          required: true
          type: integer
        - name: meeting_id
          in: path
          description: The ID of the meeting you want to view. This is an integer value. You can find this ID by doing a list of meetings and referencing the "id" property.
          required: true
          type: integer
      responses:
        '200':
          description: The settings for the join information.
          schema:
            $ref: '#/definitions/Numbers'
        default:
          description: Unexpected error
          schema:
            $ref: '#/definitions/Error'
  /v1/user/{user_id}/live_meetings/{numeric_meeting_id}:
    get:
      summary: Get Meeting State
      description: This endpoint’s purpose is to return whether the meeting is in progress or not.
      operationId: getMeetingState
      tags:
        - Meeting
      security:
        - access_token: []
      parameters:
        - name: user_id
          in: path
          description: The ID of the user of interest. This value is an integer which can be retrieved for the current user via the Get User Account Details endpoint.
          required: true
          type: integer
        - name: numeric_meeting_id
          in: path
          description: The meeting ID that participants will see and use to join the conference. When joining via phone, this is the code they enter via DTMF to join.
          required: true
          type: integer
      responses:
        '200':
          description: The settings for the meeting state.
          schema:
            $ref: '#/definitions/MeetingState'
        '401':
          description: The access token is invalid or does not have permission.
        '404':
          description: THe meeting was not found.
        default:
          description: Unexpected error
          schema:
            $ref: '#/definitions/Error'
    put:
      summary: Update Meeting State
      description: This endpoint’s purpose is to be able to modify a meeting. Actions include locking the meeting, or terminating the meeting.
      operationId: updateMeetingState
      tags:
        - Meeting
      security:
        - access_token: []
      parameters:
        - name: user_id
          in: path
          description: The ID of the user of interest. This value is an integer which can be retrieved for the current user via the Get User Account Details endpoint.
          required: true
          type: integer
        - name: numeric_meeting_id
          in: path
          description: The meeting ID that participants will see and use to join the conference. When joining via phone, this is the code they enter via DTMF to join.
          required: true
          type: integer
        - name: delay
          in: query
          description: Number of seconds to delay the end meeting operation.
          type: integer
        - name: PayloadMeetingState
          in: body
          description: The meeting properties that you wish to update.
          required: true
          schema:
            type: object
            properties:
              locked:
                type: boolean
                description: True to lock, false to unlock.
              status:
                type: string
                description: Set to "terminated" to end the meeting.
                enum:
                  - terminated
      responses:
        '200':
          description: The results for this meeting.
          schema:
            $ref: '#/definitions/Meeting'
        '401':
          description: The access token is invalid or does not have permission.
        '404':
          description: THe meeting was not found.
        default:
          description: Unexpected error
          schema:
            $ref: '#/definitions/Error'
  /v1/user/{user_id}/live_meetings/{numeric_meeting_id}/endpoints:
    get:
      summary: List Meeting Endpoints
      description: This endpoint returns an array of all endpoints in the current meeting.
      operationId: getMeetingEndpoints
      tags:
        - Meeting
      security:
        - access_token: []
      parameters:
        - name: user_id
          in: path
          description: The ID of the user of interest. This value is an integer which can be retrieved for the current user via the Get User Account Details endpoint.
          required: true
          type: integer
        - name: numeric_meeting_id
          in: path
          description: The meeting ID that participants will see and use to join the conference. When joining via phone, this is the code they enter via DTMF to join.
          required: true
          type: integer
      responses:
        '200':
          description: The list of endpoints.
          schema:
            $ref: '#/definitions/Endpoints'
        '401':
          description: The access token is invalid or does not have permission.
        '404':
          description: THe meeting was not found.
        default:
          description: Unexpected error
          schema:
            $ref: '#/definitions/Error'
    put:
      summary: Update Meeting Endpoints State
      description: This endpoint’s purpose is to be able to modify the endpoints in a meeting. Seems to require a Meeting-level access token.
      operationId: updateMeetingEndpoints
      tags:
        - Meeting
      security:
        - access_token: []
      parameters:
        - name: user_id
          in: path
          description: The ID of the user of interest. This value is an integer which can be retrieved for the current user via the Get User Account Details endpoint.
          required: true
          type: integer
        - name: numeric_meeting_id
          in: path
          description: The meeting ID that participants will see and use to join the conference. When joining via phone, this is the code they enter via DTMF to join.
          required: true
          type: integer
        - name: mute
          in: query
          description: Allows you to mute/unmute all participants in a meeting. Set mute to true to mute.  Set mute to false to unmute.
          type: boolean
        - name: media
          in: query
          description: Specify the type of media you which to mute/unmute.
          type: string
          enum:
            - audio
            - video
      responses:
        '204':
          description: There is no body conent.
        '401':
          description: The access token is invalid or does not have permission.
        '404':
          description: THe meeting was not found.
        default:
          description: Unexpected error
          schema:
            $ref: '#/definitions/Error'
  /v1/user/{user_id}/live_meetings/{numeric_meeting_id}/endpoints/{endpoint_guid}:
    get:
      summary: Get Endpoint Information
      description: This endpoint allows you to retrieve information about an endpoint in the meeting.
      operationId: getMeetingEndpoint
      tags:
        - Meeting
      security:
        - access_token: []
      parameters:
        - name: user_id
          in: path
          description: The ID of the user of interest. This value is an integer which can be retrieved for the current user via the Get User Account Details endpoint.
          required: true
          type: integer
        - name: numeric_meeting_id
          in: path
          description: The meeting ID that participants will see and use to join the conference. When joining via phone, this is the code they enter via DTMF to join.
          required: true
          type: integer
        - name: endpoint_guid
          in: path
          description: The GUID of an endpoint.  Usually retrieved from the List Meeting Endpoints endpoint.
          required: true
          type: string
      responses:
        '200':
          description: The settings for the endpoint.
          schema:
            $ref: '#/definitions/Endpoint'
        '401':
          description: The access token is invalid or does not have permission.
        '404':
          description: THe meeting was not found.
        default:
          description: Unexpected error
          schema:
            $ref: '#/definitions/Error'
    put:
      summary: Update Endpoint Video/Audio State
      description: This endpoint allows you to update an individual endpoint’s ability to send audio or video, and also allows removing an endpoint from the meeting.
      operationId: updateMeetingEndpoint
      tags:
        - Meeting
      security:
        - access_token: []
      parameters:
        - name: user_id
          in: path
          description: The ID of the user of interest. This value is an integer which can be retrieved for the current user via the Get User Account Details endpoint.
          required: true
          type: integer
        - name: numeric_meeting_id
          in: path
          description: The meeting ID that participants will see and use to join the conference. When joining via phone, this is the code they enter via DTMF to join.
          required: true
          type: integer
        - name: endpoint_guid
          in: path
          description: The GUID of an endpoint.  Usually retrieved from the List Meeting Endpoints endpoint.
          required: true
          type: string
        - name: muteAudio
          in: query
          description: Toggle the audio source mute.
          type: boolean
        - name: muteVideo
          in: query
          description: Toggle the video source mute.
          type: boolean
        - name: leaveMeeting
          in: query
          description: Remove the user from the meeting.
          type: boolean
      responses:
        '200':
          description: The settings for the enpoint.
          schema:
            $ref: '#/definitions/Endpoint'
        '401':
          description: The access token is invalid or does not have permission.
        '404':
          description: THe meeting was not found.
        default:
          description: Unexpected error
          schema:
            $ref: '#/definitions/Error'
  /v1/user/{user_id}/live_meetings/{numeric_meeting_id}/endpoints/{endpoint_guid}/layout:
    get:
      summary: Get Endpoint Layout
      description: This endpoint allows you to retrieve an individual endpoint’s current layout setting.
      operationId: getEndpointLayout
      tags:
        - Meeting
      security:
        - access_token: []
      parameters:
        - name: user_id
          in: path
          description: The ID of the user of interest. This value is an integer which can be retrieved for the current user via the Get User Account Details endpoint.
          required: true
          type: integer
        - name: numeric_meeting_id
          in: path
          description: The meeting ID that participants will see and use to join the conference. When joining via phone, this is the code they enter via DTMF to join.
          required: true
          type: integer
        - name: endpoint_guid
          in: path
          description: The GUID of an endpoint.  Usually retrieved from the List Meeting Endpoints endpoint.
          required: true
          type: string
      responses:
        '200':
          description: The settings for the endpoint's layout.
          schema:
            $ref: '#/definitions/Layout'
        '401':
          description: The access token is invalid or does not have permission.
        '404':
          description: THe meeting was not found.
        default:
          description: Unexpected error
          schema:
            $ref: '#/definitions/Error'
    put:
      summary: Update Endpoint Layout
      description: This endpoint allows you to update an individual endpoint’s current layout setting.
      operationId: updateEndpointLayout
      tags:
        - Meeting
      security:
        - access_token: []
      parameters:
        - name: user_id
          in: path
          description: The ID of the user of interest. This value is an integer which can be retrieved for the current user via the Get User Account Details endpoint.
          required: true
          type: integer
        - name: numeric_meeting_id
          in: path
          description: The meeting ID that participants will see and use to join the conference. When joining via phone, this is the code they enter via DTMF to join.
          required: true
          type: integer
        - name: endpoint_guid
          in: path
          description: The GUID of an endpoint.  Usually retrieved from the List Meeting Endpoints endpoint.
          required: true
          type: string
        - name: isLeader
          in: query
          type: boolean
        - name: push
          in: query
          type: boolean
      responses:
        '200':
          description: The settings for the endpoint's layout.
          schema:
            $ref: '#/definitions/Layout'
        '401':
          description: The access token is invalid or does not have permission.
        '404':
          description: THe meeting was not found.
        default:
          description: Unexpected error
          schema:
            $ref: '#/definitions/Error'
  /v1/user/{user_id}/live_meetings/{numeric_meeting_id}/pairing_code/SIP:
    post:
      summary: Generate Pairing Code (SIP)
      description: This endpoint generates a SIP pairing code that can be used to connect to a meeting.
      operationId: generatePairingCodeSip
      tags:
        - Meeting
      security:
        - access_token: []
      parameters:
        - name: user_id
          in: path
          description: The ID of the user of interest. This value is an integer which can be retrieved for the current user via the Get User Account Details endpoint.
          required: true
          type: integer
        - name: numeric_meeting_id
          in: path
          description: The meeting ID that participants will see and use to join the conference. When joining via phone, this is the code they enter via DTMF to join.
          required: true
          type: integer
        - name: PayloadPairingCodeSIP
          in: body
          required: true
          description: Information about the device that will be joining via SIP.
          schema:
            type: object
            properties:
              endpointType:
                type: integer
                description: 1:GENERIC 2:LYNC 3:JABBER 4:BluejeansBrowser 5:BluejeansMobile
                default: 1
              userId:
                type: integer
                description: Optional database id of user associated with endpoint
              languageCode:
                type: string
                description: Optional language code
                default: en
                enum:
                  - en
                  - en-us
                  - en-gb
                  - de
              endpointName:
                type: string
                description: Optional name of endpoint
                default: My Test Endpoint
            required:
              - endpointType
      responses:
        '200':
          description: The pairing code information.
          schema:
            $ref: '#/definitions/PairingCodeSIP'
        '401':
          description: The access token is invalid or does not have permission.
        '404':
          description: THe meeting was not found.
        default:
          description: Unexpected error
          schema:
            $ref: '#/definitions/Error'
  /v1/user/{user_id}/live_meetings/{numeric_meeting_id}/pairing_code/webrtc:
    post:
      summary: Generate Pairing Code (WebRTC)
      description: This endpoint generates a WebRTC pairing code that can be used to connect to a meeting.
      operationId: generatePairingCodeWebRtc
      tags:
        - Meeting
      security:
        - access_token: []
      parameters:
        - name: user_id
          in: path
          description: The ID of the user of interest. This value is an integer which can be retrieved for the current user via the Get User Account Details endpoint.
          required: true
          type: integer
        - name: numeric_meeting_id
          in: path
          description: The meeting ID that participants will see and use to join the conference. When joining via phone, this is the code they enter via DTMF to join.
          required: true
          type: integer
        - name: role
          in: query
          type: string
          default: USER
        - name: PayloadPairingCodeWebRTC
          in: body
          required: true
          schema:
            type: object
            properties:
              endpointType:
                type: integer
              userId:
                type: integer
              languageCode:
                type: string
                enum:
                  - en
              capabilities:
                type: array
                description: Reserved for future use. Pass just an empty array for now. No parameters are currently accepted.
                items:
                  type: string
      responses:
        '200':
          description: The pairing code information.
          schema:
            $ref: '#/definitions/PairingCodeWebRTC'
        '401':
          description: The access token is invalid or does not have permission.
        '404':
          description: THe meeting was not found.
        default:
          description: Unexpected error
          schema:
            $ref: '#/definitions/Error'
  /v1/user/{user_id}/live_meetings/{numeric_meeting_id}/pairing_code/PSTN:
    post:
      summary: Generate Pairing Code (PSTN)
      description: This endpoint generates a PSTN pairing code that can be used to connect to a meeting via telephone.
      operationId: generatePairingCodePstn
      tags:
        - Meeting
      security:
        - access_token: []
      parameters:
        - name: user_id
          in: path
          description: The ID of the user of interest. This value is an integer which can be retrieved for the current user via the Get User Account Details endpoint.
          required: true
          type: integer
        - name: numeric_meeting_id
          in: path
          description: The meeting ID that participants will see and use to join the conference. When joining via phone, this is the code they enter via DTMF to join.
          required: true
          type: integer
        - name: role
          in: query
          type: string
          default: USER
        - name: PayloadPairingCodePstn
          in: body
          required: true
          schema:
            type: object
            properties:
              endpointName:
                type: string
                description: Typically, the first and last name of the user.
              endpointType:
                type: string
                enum:
                  - PSTN
              userId:
                type: integer
              languageCode:
                type: string
                enum:
                  - en
              capabilities:
                type: array
                description: Send a single element set to AUDIO at this time.
                items:
                  type: string
      responses:
        '200':
          description: The pairing code information.
          schema:
            $ref: '#/definitions/PairingCodeWebRTC'
        '401':
          description: The access token is invalid or does not have permission.
        '404':
          description: THe meeting was not found.
        default:
          description: Unexpected error
          schema:
            $ref: '#/definitions/Error'
  /v1/user/{user_id}/live_meetings/{numeric_meeting_id}/dialout/pstn:
    post:
      summary: Dialout via PSTN
      description: Places a PSTN call to a user to join meeting.
      operationId: dialoutPstn
      tags:
        - Meeting
      security:
        - access_token: []
      parameters:
        - name: user_id
          in: path
          description: The ID of the user of interest. This value is an integer which can be retrieved for the current user via the Get User Account Details endpoint.
          required: true
          type: integer
        - name: numeric_meeting_id
          in: path
          description: The meeting ID that participants will see and use to join the conference. When joining via phone, this is the code they enter via DTMF to join.
          required: true
          type: integer
        - name: PayloadDialout
          in: body
          required: true
          schema:
            type: object
            properties:
              connectionGuid:
                type: string
              countryCode:
                type: integer
              pairedParticipantGuid:
                type: string
              phoneNumber:
                type: string
      responses:
        '200':
          description: Response with connection information.
          schema:
            type: array
            items:
              $ref: '#/definitions/DialoutPstn'
        '401':
          description: The access token is invalid or does not have permission.
        '404':
          description: THe meeting was not found.
        default:
          description: Unexpected error
          schema:
            $ref: '#/definitions/Error'
  /v1/user/{user_id}/live_meetings/{numeric_meeting_id}/invite:
    post:
      summary: Send Email Invite
      description: This endpoint generates an email invite to the specified meeting.
      operationId: sendMeetingInvite
      tags:
        - Meeting
      security:
        - access_token: []
      parameters:
        - name: user_id
          in: path
          description: The ID of the user of interest. This value is an integer which can be retrieved for the current user via the Get User Account Details endpoint.
          required: true
          type: integer
        - name: numeric_meeting_id
          in: path
          description: The meeting ID that participants will see and use to join the conference. When joining via phone, this is the code they enter via DTMF to join.
          required: true
          type: integer
        - name: PayloadInvite
          in: body
          required: true
          schema:
            type: object
            properties:
              invitees:
                type: array
                items:
                  type: string
      responses:
        '202':
          description: Empty response on success.
        '401':
          description: The access token is invalid or does not have permission.
        '404':
          description: THe meeting was not found.
        default:
          description: Unexpected error
          schema:
            $ref: '#/definitions/Error'
  /v1/user/{user_id}/meeting_history:
    get:
      summary: List History by User
      description: This endpoint retrieves a list of meeting histories by the given user.
      operationId: listHistoryByUser
      tags:
        - History
      security:
        - access_token: []
      parameters:
        - name: user_id
          in: path
          description: The ID of the user of interest. This value is an integer which can be retrieved for the current user via the Get User Account Details endpoint.
          required: true
          type: integer
        - name: meetingId
          in: query
          description: Return only meetings with the specified meeting numeric ID.
          type: string
        - name: startDate
          in: query
          description: Return meetings starting from the specified date. MM/DD/YYYY
          type: string
        - name: endDate
          in: query
          description: Return meetings up until the specified date. MM/DD/YYYY
          type: string
        - name: pageSize
          in: query
          description: Sets number of items returned per page.
          type: integer
        - name: pageNumber
          in: query
          description: Selects which page of results to return.
          type: integer
        - name: order
          in: query
          description: Puts results in ascending or descending order. asc/desc
          type: string
      responses:
        '200':
          description: List of meeting history objects.
          schema:
            type: array
            items:
              $ref: '#/definitions/MeetingHistory'
        '404':
          description: No matches found.
        default:
          description: Unexpected error
          schema:
            $ref: '#/definitions/Error'
  /v1/enterprise/{enterprise_id}/meeting_history:
    get:
      summary: List History by Enterprise
      description: This endpoint retrieves a list of meeting histories by the given enterprise.
      operationId: listHistoryByEnterprise
      tags:
        - History
      security:
        - access_token: []
      parameters:
        - name: enterprise_id
          in: path
          description: The ID of the enterprise of interest. This value is an integer which can be retrieved for the current user via the Get Enterprise Profile endpoint.
          required: true
          type: integer
      responses:
        '200':
          description: List of meeting history objects.
          schema:
            type: array
            items:
              $ref: '#/definitions/MeetingHistory'
        default:
          description: Unexpected error
          schema:
            $ref: '#/definitions/Error'
  /v1/user/{user_id}/meeting_history/recordings:
    get:
      summary: List Meeting Recordings
      description: This endpoint retrieves a list of meeting recordings.
      operationId: listRecordings
      tags:
        - History
      security:
        - access_token: []
      parameters:
        - name: user_id
          in: path
          description: The ID of the user of interest. This value is an integer which can be retrieved for the current user via the Get User Account Details endpoint.
          required: true
          type: integer
        - name: pageSize
          in: query
          description: Sets number of items returned per page.
          default: 10
          type: integer
        - name: pageNumber
          in: query
          description: Selects which page of results to return.
          default: 1
          type: integer
        - name: sortBy
          in: query
          description: Selects which page of results to return.
          default: start_time
          type: string
        - name: order
          in: query
          description: Puts results in ascending or descending order.
          default: desc
          enum:
            - asc
            - desc
          type: string
      responses:
        '200':
          description: The results for the request.
          schema:
            type: array
            items:
              $ref: '#/definitions/RecordingSummary'
        default:
          description: Unexpected error
          schema:
            $ref: '#/definitions/Error'
  /v1/user/{user_id}/meeting_history/recordings/{recording_entity_id}:
    get:
      summary: Get Recording
      description: This endpoint retrieves the details about a meeting recording.
      operationId: getRecording
      tags:
        - History
      security:
        - access_token: []
      parameters:
        - name: user_id
          in: path
          description: The ID of the user of interest. This value is an integer which can be retrieved for the current user via the Get User Account Details endpoint.
          required: true
          type: integer
        - name: recording_entity_id
          in: path
          description: The ID of the meeting recording. This value is shown in meeting recording lists as recordingEntityId.
          required: true
          type: integer
      responses:
        '200':
          description: The results for the request.
          schema:
              $ref: '#/definitions/Recording'
        default:
          description: Unexpected error
          schema:
            $ref: '#/definitions/Error'
  /v1/user/{user_id}/meeting_history/{meeting_guid}:
    get:
      summary: Get Meeting History by User
      description: This endpoint retrieves the meeting history for a specific instance of a meeting.
      operationId: getHistoryByUser
      tags:
        - History
      security:
        - access_token: []
      parameters:
        - name: user_id
          in: path
          description: The ID of the user of interest. This value is an integer which can be retrieved for the current user via the Get User Account Details endpoint.
          required: true
          type: integer
        - name: meeting_guid
          in: path
          description: The globally unique identifier (GUID) of the meeting of interest. This value is a string which contains the numeric meeting id, followed by a colon, followed by a 128-bit integer number formatted as 5 alphanumeric segments separated by dashes. Since a given numeric meeting ID can have multiple instantiations over time, the GUID helps identify the instance of interest.
          required: true
          type: string
      responses:
        '200':
          description: The meeting history object.
          schema:
            $ref: '#/definitions/Meeting'
        default:
          description: Unexpected error
          schema:
            $ref: '#/definitions/Error'
  /v1/enterprise/{enterprise_id}/meeting_history/{meeting_guid}:
    get:
      summary: Get Meeting History by Enterprise
      description: This endpoint retrieves the meeting history for a specific instance of a meeting.
      operationId: getHistoryByEnterprise
      tags:
        - History
      security:
        - access_token: []
      parameters:
        - name: enterprise_id
          in: path
          description: The ID of the enterprise of interest. This value is an integer which can be retrieved for the current user via the Get Enterprise Profile endpoint.
          required: true
          type: integer
        - name: meeting_guid
          in: path
          description: The globally unique identifier (GUID) of the meeting of interest. This value is a string which contains the numeric meeting id, followed by a colon, followed by a 128-bit integer number formatted as 5 alphanumeric segments separated by dashes. Since a given numeric meeting ID can have multiple instantiations over time, the GUID helps identify the instance of interest.
          required: true
          type: string
      responses:
        '200':
          description: The meeting history object.
          schema:
            $ref: '#/definitions/Meeting'
        default:
          description: Unexpected error
          schema:
            $ref: '#/definitions/Error'
  /v1/user/{user_id}/meeting_history/{meeting_guid}/sharing:
    get:
      summary: Get Meeting History Sharing by User
      description: This endpoint retrieves the meeting history sharing for a specific instance of a meeting.
      operationId: getHistorySharingByUser
      tags:
        - History
      security:
        - access_token: []
      parameters:
        - name: user_id
          in: path
          description: The ID of the user of interest. This value is an integer which can be retrieved for the current user via the Get User Account Details endpoint.
          required: true
          type: integer
        - name: meeting_guid
          in: path
          description: The globally unique identifier (GUID) of the meeting of interest. This value is a string which contains the numeric meeting id, followed by a colon, followed by a 128-bit integer number formatted as 5 alphanumeric segments separated by dashes. Since a given numeric meeting ID can have multiple instantiations over time, the GUID helps identify the instance of interest.
          required: true
          type: string
      responses:
        '200':
          description: The meeting history sharing object.
          schema:
            $ref: '#/definitions/MeetingHistorySharing'
        '404':
          description: Sharing is not allowed. Recording marked private.
        default:
          description: Unexpected error
          schema:
            $ref: '#/definitions/Error'
  /v1/user/{user_id}/live_meetings/{meeting_id}/recordings:
    post:
      summary: Start Recording
      description: This endpoint starts recording for a meeting in progress. Note that this is a POST operation. Stop is a PUT operation.
      operationId: startRecording
      tags:
        - Recording
      security:
        - access_token: []
      parameters:
        - name: user_id
          in: path
          description: The ID of the user of interest. This value is an integer which can be retrieved for the current user via the Get User Account Details endpoint.
          required: true
          type: integer
        - name: meeting_id
          in: path
          description: The ID of the meeting you want to view. This is an integer value. You can find this ID by doing a list of meetings and referencing the "id" property.
          required: true
          type: integer
        - name: action
          in: query
          required: true
          type: string
          enum:
          - start
          default: start
          description: Always set to "start" in order to start recording.
      responses:
        '204':
          description: Empty response on success.
        default:
          description: Unexpected error
          schema:
            $ref: '#/definitions/Error'
    put:
      summary: Stop Recording
      description: This endpoint stops recording for a meeting in progress. Note that this is a PUT operation. Start is a POST operation.
      operationId: stopRecording
      tags:
        - Recording
      security:
        - access_token: []
      parameters:
        - name: user_id
          in: path
          description: The ID of the user of interest. This value is an integer which can be retrieved for the current user via the Get User Account Details endpoint.
          required: true
          type: integer
        - name: meeting_id
          in: path
          description: The ID of the meeting you want to view. This is an integer value. You can find this ID by doing a list of meetings and referencing the "id" property.
          required: true
          type: integer
        - name: action
          in: query
          required: true
          type: string
          enum:
          - stop
          default: stop
          description: Always set to "stop" in order to stop recording.
      responses:
        '204':
          description: Empty response on success.
        default:
          description: Unexpected error
          schema:
            $ref: '#/definitions/Error'
  /v1/user/{user_id}/meeting_history/{meeting_id}/recordings:
    get:
      summary: Get All Recordings for a Specified Meeting ID
      description: This endpoint lists the recordings for a meeting.
      operationId: getMeetingRecordings
      tags:
        - Recording
      security:
        - access_token: []
      parameters:
        - name: user_id
          in: path
          description: The ID of the user of interest. This value is an integer which can be retrieved for the current user via the Get User Account Details endpoint.
          required: true
          type: integer
        - name: meeting_id
          in: path
          description: The ID of the meeting you want to view. This is an integer value. You can find this ID by doing a list of meetings and referencing the "id" property.
          required: true
          type: integer
        - name: meetingGuid
          in: query
          description: The globally unique identifier (GUID) of the meeting of interest. This value is a string which contains the numeric meeting id, followed by a colon, followed by a 128-bit integer number formatted as 5 alphanumeric segments separated by dashes. Since a given numeric meeting ID can have multiple instantiations over time, the GUID helps identify the instance of interest.
          required: false
          type: string
      responses:
        '200':
          description: The results for this meeting.
          schema:
            $ref: '#/definitions/RecordingHistoryList'
        default:
          description: Unexpected error
          schema:
            $ref: '#/definitions/Error'
  /v1/user/{user_id}/meeting_history/{meeting_guid}/recordings/:
    delete:
      summary: Delete All Recordings for a Specified Meeting GUID
      description: >
        This endpoint stops recording for a meeting in progress.
      tags:
        - Recording
      security:
        - access_token: []
      parameters:
        - name: user_id
          in: path
          description: The ID of the user of interest. This value is an integer which can be retrieved for the current user via the Get User Account Details endpoint.
          required: true
          type: integer
        - name: meeting_guid
          in: path
          description: The globally unique identifier (GUID) of the meeting of interest. This value is a string which contains the numeric meeting id, followed by a colon, followed by a 128-bit integer number formatted as 5 alphanumeric segments separated by dashes. Since a given numeric meeting ID can have multiple instantiations over time, the GUID helps identify the instance of interest.
          required: true
          type: string
      responses:
        '200':
          description: The results for this meeting.
          schema:
            $ref: '#/definitions/Meeting'
        default:
          description: Unexpected error
          schema:
            $ref: '#/definitions/Error'
  /v1/user/{user_id}/meeting_history/{meeting_id}/recordings/{recording_chapter_id}/:
    delete:
      summary: Delete a Specified Recording Chapter
      description: This endpoint stops recording for a meeting in progress.
      tags:
        - Recording
      security:
        - access_token: []
      parameters:
        - name: user_id
          in: path
          description: The ID of the user of interest. This value is an integer which can be retrieved for the current user via the Get User Account Details endpoint.
          required: true
          type: integer
        - name: meeting_id
          in: path
          description: The ID of the meeting you want to view. This is an integer value. You can find this ID by doing a list of meetings and referencing the "id" property.
          required: true
          type: integer
        - name: recording_chapter_id
          in: path
          description: The ID of the meeting you want to view. This is an integer value. You can find this ID by doing a list of meetings and referencing the "id" property.
          required: true
          type: integer
      responses:
        '200':
          description: The results for this meeting.
          schema:
            $ref: '#/definitions/Meeting'
        default:
          description: Unexpected error
          schema:
            $ref: '#/definitions/Error'
  /v1/user/{user_id}/cms/{content_id}:
    get:
      summary: Get Recording Download Link
      description: This endpoint retrieves properties about the recording chapter.
      operationId: getRecordingContent
      tags:
        - Recording
      security:
        - access_token: []
      parameters:
        - name: user_id
          in: path
          description: The ID of the user of interest. This value is an integer which can be retrieved for the current user via the Get User Account Details endpoint.
          required: true
          type: integer
        - name: content_id
          in: path
          description: The recording properties fetched with other API endpoints will return a compositeContentId or a contentId. That value can be used for this argument.
          required: true
          type: integer
        - name: isDownloadable
          in: query
          required: true
          type: boolean
          description: Set to true.
          default: true
      responses:
        '200':
          description: The results for this content item.
          schema:
            $ref: '#/definitions/Content'
        default:
          description: Unexpected error
          schema:
            $ref: '#/definitions/Error'
  /v1/enterprise/{enterprise_id}/indigo/meetings/live:
    get:
      summary: Live Meetings Summary by Enterprise
      description: This endpoint lists meetings in progress by enterprise. Requires /oauth2/token?Password authentication.
      operationId: getMeetingsLiveByEnterprise
      tags:
        - Command Center
      security:
        - access_token: []
      parameters:
        - name: enterprise_id
          in: path
          description: The ID of the enterprise of interest. This value is an integer which can be retrieved for the current user via the Get Enterprise Profile endpoint.
          required: true
          type: integer
      responses:
        '200':
          description: The results for this meeting.
          schema:
            $ref: '#/definitions/MeetingIndigoList'
        default:
          description: Unexpected error
          schema:
            $ref: '#/definitions/Error'
  /v1/enterprise/{enterprise_id}/indigo/meetings/live/{meeting_uuid}/endpoints/:
    get:
      summary: List Live Meeting Endpoints by Enterprise
      description: This endpoint lists endpoints for a given meeting in progress. Requires /oauth2/token?Password authentication.
      operationId: getMeetingLiveByEnterprise
      tags:
        - Command Center
      security:
        - access_token: []
      parameters:
        - name: enterprise_id
          in: path
          description: The ID of the enterprise of interest. This value is an integer which can be retrieved for the current user via the Get Enterprise Profile endpoint.
          required: true
          type: integer
        - name: meeting_uuid
          in: path
          description: The universally unique identifier (UUID) of the meeting of interest. This value is a string which contains 6 alphanumeric segments separated by dashes.
          required: true
          type: string
      responses:
        '200':
          description: The results for this enterprise.
          schema:
            $ref: '#/definitions/MeetingExtendedIndigo'
        default:
          description: Unexpected error
          schema:
            $ref: '#/definitions/Error'
  /v1/enterprise/{enterprise_id}/indigo/meetings:
    get:
      summary: List Past Meetings by Enterprise
      description: This endpoint lists completed meetings by enterprise. Requires /oauth2/token?Password authentication.
      operationId: getMeetingsPastByEnterprise
      tags:
        - Command Center
      security:
        - access_token: []
      parameters:
        - name: enterprise_id
          in: path
          description: The ID of the enterprise of interest. This value is an integer which can be retrieved for the current user via the Get Enterprise Profile endpoint.
          required: true
          type: integer
        - name: offset
          in: query
          description: Page Number
          type: integer
        - name: limit
          in: query
          description: Per page
          type: integer
        - name: filter
          in: query
          description: URL-encoded JSON string
          type: string
      responses:
        '200':
          description: The results for this enterprise.
          schema:
            $ref: '#/definitions/MeetingIndigoList'
        default:
          description: Unexpected error
          schema:
            $ref: '#/definitions/Error'
  /v1/user/{user_id}/indigo/meetings:
    get:
      summary: List Past Meetings by User
      description: This endpoint lists completed meetings by user. Requires /oauth2/token?Password authentication.
      operationId: getMeetingsPastByUser
      tags:
        - Command Center
      security:
        - access_token: []
      parameters:
        - name: user_id
          in: path
          description: The ID of the user of interest. This value is an integer which can be retrieved for the current user via the Get User Account Details endpoint.
          required: true
          type: integer
      responses:
        '200':
          description: The results for this user.
          schema:
            $ref: '#/definitions/MeetingIndigoList'
        default:
          description: Unexpected error
          schema:
            $ref: '#/definitions/Error'
  /v1/enterprise/{enterprise_id}/indigo/meetings/{meeting_uuid}:
     get:
      summary: List Meeting Endpoints & Stats by Enterprise
      description: This endpoint lists meeting endpoints for completed meetings by enterprise. Requires /oauth2/token?Password authentication.
      operationId: getMeetingPastByEnterprise
      tags:
        - Command Center
      security:
        - access_token: []
      parameters:
        - name: enterprise_id
          in: path
          description: The ID of the enterprise of interest. This value is an integer which can be retrieved for the current user via the Get Enterprise Profile endpoint.
          required: true
          type: integer
        - name: meeting_uuid
          in: path
          description: The universally unique identifier (UUID) of the meeting of interest. This value is a string which contains 6 alphanumeric segments separated by dashes.
          required: true
          type: string
        - name: includeEndpoints
          in: query
          description: Option to include detailed data on endpoints
          type: boolean
      responses:
        '200':
          description: The results for this enterprise.
          schema:
            $ref: '#/definitions/MeetingExtendedIndigo'
        default:
          description: Unexpected error
          schema:
            $ref: '#/definitions/Error'
  /v1/user/{user_id}/indigo/meetings/{meeting_uuid}:
     get:
      summary: List Meeting Endpoints & Stats by User
      description: This endpoint lists meeting endpoints for completed meetings by user. Requires /oauth2/token?Password authentication.
      operationId: getMeetingPastByUser
      tags:
        - Command Center
      security:
        - access_token: []
      parameters:
        - name: user_id
          in: path
          description: The ID of the user of interest. This value is an integer which can be retrieved for the current user via the Get User Account Details endpoint.
          required: true
          type: integer
        - name: meeting_uuid
          in: path
          description: The universally unique identifier (UUID) of the meeting of interest. This value is a string which contains 6 alphanumeric segments separated by dashes.
          required: true
          type: string
      responses:
        '200':
          description: The results for this user.
          schema:
            $ref: '#/definitions/MeetingExtendedIndigo'
        default:
          description: Unexpected error
          schema:
            $ref: '#/definitions/Error'
  /v1/enterprise/{enterprise_id}/indigo/analytics/users/usage:
     get:
      summary: Top Users
      description: This endpoint retrieves the top users by usage for an enterprise. Requires /oauth2/token?Password authentication.
      operationId: getTopUsers
      tags:
        - Command Center
      security:
        - access_token: []
      parameters:
        - name: enterprise_id
          in: path
          description: The ID of the enterprise of interest. This value is an integer which can be retrieved for the current user via the Get Enterprise Profile endpoint.
          required: true
          type: integer
        - name: filter
          in: query
          description: URL-encoded JSON string
          default: "[{\"type\":\"date\",\"comparison\":\"gt\",\"value\":\"2017-01-16T00:00:00-07:00\",\"field\":\"start_time\"},{\"type\":\"date\",\"comparison\":\"lt\",\"value\":\"2017-01-23T23:59:59-07:00\",\"field\":\"end_time\"}]"
          type: string
      responses:
        '200':
          description: The results for this enterprise.
          schema:
            $ref: '#/definitions/AnalyticsTopUsers'
        default:
          description: Unexpected error
          schema:
            $ref: '#/definitions/Error'
  /v1/enterprise/{enterprise_id}/indigo/analytics/endpoints/distribution:
     get:
      summary: Endpoint Distribution
      description: This endpoint retrieves endpoint connection type distribution by enterprise. Requires /oauth2/token?Password authentication.
      operationId: getEndpointDistribution
      tags:
        - Command Center
      security:
        - access_token: []
      parameters:
        - name: enterprise_id
          in: path
          description: The ID of the enterprise of interest. This value is an integer which can be retrieved for the current user via the Get Enterprise Profile endpoint.
          required: true
          type: integer
        - name: filter
          in: query
          description: URL-encoded JSON string
          default: "[{\"type\":\"date\",\"comparison\":\"gt\",\"value\":\"2017-01-16T00:00:00-07:00\",\"field\":\"creation_time\"},{\"type\":\"date\",\"comparison\":\"lt\",\"value\":\"2017-01-23T23:59:59-07:00\",\"field\":\"creation_time\"}]"
          type: string
      responses:
        '200':
          description: The results for this enterprise.
          schema:
            $ref: '#/definitions/AnalyticsEndpointDistribution'
        default:
          description: Unexpected error
          schema:
            $ref: '#/definitions/Error'
  /v1/enterprise/{enterprise_id}/indigo/analytics/meetings/usage:
     get:
      summary: Meeting Usage Over Time
      description: This endpoint reports on meeting usage. Requires /oauth2/token?Password authentication.
      operationId: getMeetingUsage
      tags:
        - Command Center
      security:
        - access_token: []
      parameters:
        - name: enterprise_id
          in: path
          description: The ID of the enterprise of interest. This value is an integer which can be retrieved for the current user via the Get Enterprise Profile endpoint.
          required: true
          type: integer
        - name: clientTZ
          in: query
          description: Based on standard TZ code.
          default: America/Denver
          type: string
        - name: filter
          in: query
          description: URL-encoded JSON string
          default: "[{\"type\":\"string\",\"comparison\":\"eq\",\"value\":\"DAY\",\"field\":\"groupInterval\"},{\"type\":\"date\",\"comparison\":\"eq\",\"value\":\"2017-01-16T00:00:00-07:00\",\"field\":\"lowts\"},{\"type\":\"date\",\"comparison\":\"eq\",\"value\":\"2017-01-23T23:59:59-07:00\",\"field\":\"hights\"}]"
          type: string
      responses:
        '200':
          description: The results for this enterprise.
          schema:
            $ref: '#/definitions/AnalyticsUsage'
        default:
          description: Unexpected error
          schema:
            $ref: '#/definitions/Error'
  /v1/enterprise/{enterprise_id}/indigo/analytics/roi_ranges:
     get:
      summary: ROI Data
      description: This endpoint lists return on investment (ROI) data for meetings. Requires /oauth2/token?Password authentication.
      operationId: getRoiRanges
      tags:
        - Command Center
      security:
        - access_token: []
      parameters:
        - name: enterprise_id
          in: path
          description: The ID of the enterprise of interest. This value is an integer which can be retrieved for the current user via the Get Enterprise Profile endpoint.
          required: true
          type: integer
        - name: filter
          in: query
          description: URL-encoded JSON string
          default: "[{\"type\":\"date\",\"comparison\":\"gt\",\"value\":\"2017-01-16T00:00:00-07:00\",\"field\":\"startTime\"},{\"type\":\"date\",\"comparison\":\"lt\",\"value\":\"2017-01-23T23:59:59-07:00\",\"field\":\"startTime\"}]"
          required: true
          type: string
      responses:
        '200':
          description: The results for this enterprise.
          schema:
            $ref: '#/definitions/AnalyticsRoiData'
        default:
          description: Unexpected error
          schema:
            $ref: '#/definitions/Error'
  /v1/enterprise/{enterprise_id}/indigo/feedback/count:
     get:
      summary: Survey Feedback Scores
      description: This endpoint lists end of meeting survey scores by enterprise by time period. Requires /oauth2/token?Password authentication.
      operationId: getFeedbackCount
      tags:
        - Command Center
      security:
        - access_token: []
      parameters:
        - name: enterprise_id
          in: path
          description: The ID of the enterprise of interest. This value is an integer which can be retrieved for the current user via the Get Enterprise Profile endpoint.
          required: true
          type: integer
        - name: start
          in: query
          description: Date and time in an [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format.
          default: "2017-01-01T00:00:00-00:00"
          required: true
          type: string
        - name: end
          in: query
          description: Date and time in an [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format.
          default: "2018-01-01T00:00:00-00:00"
          required: true
          type: string
      responses:
        '200':
          description: The results for this enterprise.
          schema:
            $ref: '#/definitions/AnalyticsFeedbackScores'
        default:
          description: Unexpected error
          schema:
            $ref: '#/definitions/Error'
  /v1/enterprise/{enterprise_id}/indigo/analytics/feedback/comments:
     get:
      summary: Survey Feedback Comments
      description: This endpoint lists end of meeting survey comments by enterprise by time period. Requires /oauth2/token?Password authentication.
      operationId: getFeedbackComments
      tags:
        - Command Center
      security:
        - access_token: []
      parameters:
        - name: enterprise_id
          in: path
          description: The ID of the enterprise of interest. This value is an integer which can be retrieved for the current user via the Get Enterprise Profile endpoint.
          required: true
          type: integer
        - name: start
          in: query
          description: Date and time in an [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format.
          default: "2017-01-01T00:00:00-00:00"
          required: true
          type: string
        - name: end
          in: query
          description: Date and time in an [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format.
          default: "2018-01-01T00:00:00-00:00"
          required: true
          type: string
      responses:
        '200':
          description: The results for this enterprise.
          schema:
            $ref: '#/definitions/AnalyticsFeedbackComments'
        default:
          description: Unexpected error
          schema:
            $ref: '#/definitions/Error'
  /v1/user/{user_id}/developer_applications:
    post:
      summary: Create Client Application
      description: This endpoint creates a client application for use in 3-legged OAuth2 authorization.
      operationId: createClientApplication
      tags:
        - Application
      security:
        - access_token: []
      parameters:
        - name: user_id
          in: path
          description: The ID of the user of interest. This value is an integer which can be retrieved for the current user via the Get User Account Details endpoint.
          required: true
          type: integer
        - name: application
          in: body
          description: The information about the new client application.
          required: true
          schema:
            $ref: '#/definitions/Application'
      responses:
        '201':
          description: The new application.
          schema:
            $ref: '#/definitions/Application'
        '401':
          description: The access token is invalid or does not have permission.
        default:
          description: Unexpected error
          schema:
            $ref: '#/definitions/Error'
  /v1/user/{user_id}/developer_applications/{client_id}:
    put:
      summary: Update Client Application
      description: This endpoint updates a client application for use in 3-legged OAuth2 authorization.
      operationId: updateClientApplication
      tags:
        - Application
      security:
        - access_token: []
      parameters:
        - name: user_id
          in: path
          description: The ID of the user of interest. This value is an integer which can be retrieved for the current user via the Get User Account Details endpoint.
          required: true
          type: integer
        - name: client_id
          in: path
          description: The ID of the client application of interest. This value was given as a response during client application creation.
          required: true
          type: string
        - name: application
          in: body
          description: The information about the new client application.
          required: true
          schema:
            $ref: '#/definitions/Application'
      responses:
        '200':
          description: The new application.
          schema:
            $ref: '#/definitions/Application'
        '401':
          description: The access token is invalid or does not have permission.
        default:
          description: Unexpected error
          schema:
            $ref: '#/definitions/Error'
  /v1/user/{user_id}/developer_applications/{client_id}/secret:
    put:
      summary: Regenerate Client Application Secret
      description: This endpoint forces the regeneration of a client application secret for use in 3-legged OAuth2 authorization.
      operationId: regenerateClientApplicationSecret
      tags:
        - Application
      security:
        - access_token: []
      parameters:
        - name: user_id
          in: path
          description: The ID of the user of interest. This value is an integer which can be retrieved for the current user via the Get User Account Details endpoint.
          required: true
          type: integer
        - name: client_id
          in: path
          description: The ID of the client application of interest. This value was given as a response during client application creation.
          required: true
          type: string
      responses:
        '200':
          description: The new application secret.
          schema:
            $ref: '#/definitions/ApplicationSecret'
        '401':
          description: The access token is invalid or does not have permission.
        default:
          description: Unexpected error
          schema:
            $ref: '#/definitions/Error'
definitions:
  GrantRequestPassword:
    type: object
    properties:
      grant_type:
        type: string
        default: password
        description: The type of access token you are requesting.
      username:
        type: string
        description: Your user name that you use to login to our site.
      password:
        type: string
        description: Your user password that you use to login to our site.
        format: password
    required:
      - grant_type
      - username
      - password
  GrantPassword:
    type: object
    properties:
      access_token:
        type: string
        description: The access token acts as a kind of "valet key" that the application can include with its requests to the identity provider, which prove that it has permission from the user to access those APIs.
      expires_in:
        type: integer
        description: Seconds that access token is valid for from now.
      refresh_token:
        type: string
      scope:
        type: object
        properties:
          user:
            type: integer
            description: The ID of your user.
          partitionName:
            type: string
            description: The name of the partition you are on.
          partition:
            $ref: '#/definitions/Partition'
  GrantRequestMeeting:
    type: object
    properties:
      grant_type:
        type: string
        default: meeting_passcode
        description: The type of access token you are requesting.
      meetingNumericId:
        type: string
        description: Meeting ID
      meetingPasscode:
        type: string
        description: Pin
    required:
      - grant_type
      - meetingNumericId
      - meetingPasscode
  GrantMeeting:
    type: object
    properties:
      access_token:
        type: string
        description: The access token acts as a kind of "valet key" that the application can include with its requests to the identity provider, which prove that it has permission from the user to access those APIs.
      expires_in:
        type: integer
        description: Seconds that access token is valid for from now.
      scope:
        type: object
        properties:
          meeting:
            type: object
            properties:
              id:
                type: integer
              leaderId:
                type: integer
              meetingNumericId:
                type: string
              meetingUri:
                type: string
              isModerator:
                type: boolean
              endpointUriSet:
                type: array
                items:
                  type: object
              meetingId:
                type: string
          partitionName:
            type: string
            description: The name of the partition you are on.
          partition:
            $ref: '#/definitions/Partition'
  GrantRequestClient:
    type: object
    properties:
      grant_type:
        type: string
        default: client_credentials
        description: The type of access token you are requesting.
      client_id:
        type: string
        description: The value given within the BlueJeans Enterprise Administration console.
      client_secret:
        type: string
        description: The value given within the BlueJeans Enterprise Administration console.
    required:
      - grant_type
      - client_id
      - client_secret
  GrantClient:
    type: object
    properties:
      access_token:
        type: string
        description: The access token acts as a kind of "valet key" that the application can include with its requests to the identity provider, which prove that it has permission from the user to access those APIs.
      expires_in:
        type: integer
        description: Seconds that access token is valid for from now.
      scope:
        type: object
        properties:
          enterprise:
            type: integer
            description: The ID of your enterprise.
          partitionName:
            type: string
            description: The name of the partition you are on.
          partition:
            $ref: '#/definitions/Partition'
  GrantRequestCode:
    type: object
    properties:
      grant_type:
        type: string
        default: authorization_code
        description: The type of access token you are requesting. Use "authorization_code".
      client_id:
        type: string
        description: The client ID will be generated on creation of the application. Normally, a 32 character hexadecimal numeric string.
      client_secret:
        type: string
        description: The client secret will be generated on creation of the application. Retain this value as it will only be revealed one time. If lost, you will need to regenerate.
      redirectUri:
        type: string
        description: One of the registered url or sub-url of registered urls.
      code:
        type: string
        description: Code obtained after /oauth2/authorize redirect.
    required:
      - grant_type
      - client_id
      - client_secret
      - redirectUri
      - code
  GrantCode:
    type: object
    properties:
      access_token:
        type: string
        description: The access token acts as a kind of "valet key" that the application can include with its requests to the identity provider, which prove that it has permission from the user to access those APIs.
      refresh_token:
        type: string
        description: A longer lasting token that may be used to retrieve new access tokens upon access token expiration.
      expires_in:
        type: integer
        description: Seconds that access token is valid for from now.
      scope:
        type: object
        properties:
          user:
            type: integer
            description: The ID of your user.
          appPermissions:
            type: array
            items:
              type: object
              properties:
                method:
                  type: string
                allowedRegex:
                  type: string
          partitionName:
            type: string
            description: The name of the partition you are on.
          partition:
            $ref: '#/definitions/Partition'
          bearerPermissions:
            type: string
            description: Comma-delimited list of scopes authorized by this token.
          clientId:
            type: string
            description: The client ID will be generated on creation of the application. Normally, a 32 character hexadecimal numeric string.
  GrantRequestRefresh:
    type: object
    properties:
      grant_type:
        type: string
        default: refresh_token
        description: The type of access token you are requesting.
      client_id:
        type: string
        description: The client ID will be generated on creation of the application. Normally, a 32 character hexadecimal numeric string.
      client_secret:
        type: string
        description: The client secret will be generated on creation of the application. Retain this value as it will only be revealed one time. If lost, you will need to regenerate.
      refresh_token:
        type: string
        description: Refresh token obtained after token authorization.
    required:
      - grant_type
      - client_id
      - client_secret
      - refresh_token
  GrantRefresh:
    type: object
    properties:
      access_token:
        type: string
        description: The access token acts as a kind of "valet key" that the application can include with its requests to the identity provider, which prove that it has permission from the user to access those APIs.
      refresh_token:
        type: string
        description: A longer lasting token that may be used to retrieve new access tokens upon access token expiration.
      expires_in:
        type: integer
        description: Seconds that access token is valid for from now.
      scope:
        type: object
        properties:
          user:
            type: integer
            description: The ID of your user.
          appPermissions:
            type: array
            items:
              type: object
              properties:
                method:
                  type: string
                allowedRegex:
                  type: string
          partitionName:
            type: string
            description: The name of the partition you are on.
          partition:
            $ref: '#/definitions/Partition'
          bearerPermissions:
            type: string
            description: Comma-delimited list of scopes authorized by this token.
  GrantRequestRevoke:
    type: object
    properties:
      client_id:
        type: string
        description: The client ID will be generated on creation of the application. Normally, a 32 character hexadecimal numeric string.
      client_secret:
        type: string
        description: The client secret will be generated on creation of the application. Retain this value as it will only be revealed one time. If lost, you will need to regenerate.
    required:
      - client_id
      - client_secret
  Partition:
    type: object
    properties:
      id:
        type: integer
      name:
        type: string
  User:
    type: object
    properties:
      id:
        type: integer
        description: Unique identifier for the user.
        readOnly: true
      username:
        type: string
        description: User's username
      firstName:
        type: string
        description: User's first name
      middleName:
        type: string
        description: User's middle name
      lastName:
        type: string
        description: User's last name
      emailId:
        type: string
        description: User's email address
      company:
        type: string
        description: User's company name
      title:
        type: string
        description: User's title
      phone:
        type: string
        description: User's phone
      profilePicture:
        type: string
        description: Path to user's profile picture
      timezone:
        type: string
        description: User's timezone
      timeFormat:
        type: integer
        description: User's preference of 12 or 24 hour time display
      language:
        type: string
        description: User's language code
  Enterprise:
    type: object
    properties:
      id:
        type: integer
        description: Unique identifier for the user.
        readOnly: true
      enterprise:
        type: integer
        description: Unique identifier for the enterprise.
        readOnly: true
      enterpriseAdmin:
        type: boolean
        description: Is this user an administrator for this enterprise?
      joinDate:
        type: integer
        description: Date of enterprise join
      expiryDate:
        type: integer
        description: Date of expiration; null if not set
  EnterpriseUserList:
    type: object
    properties:
      count:
        type: integer
        description: The number of users in the result.
      users:
        type: array
        items:
          type: object
          properties:
            id:
              type: integer
              description: The ID of this user.
            uri:
              type: string
              description: The URI of this user in order to fetch further details.
  UserId:
    type: object
    properties:
      id:
        type: integer
        description: The ID of the user.
  Room:
    type: object
    properties:
      id:
        type: integer
        description: Unique identifier for room.
        readOnly: true
      numericId:
        type: string
        description: Unique identifier for room.
      name:
        type: string
        description: Name of the room.
      originPopId:
        type: integer
      isLargeMeeting:
        type: boolean
      showVideoAnimations:
        type: boolean
      backgroundImage:
        type: string
      isModeratorLess:
        type: boolean
      welcomeMessage:
        type: string
      disallowChat:
        type: boolean
      encryptionType:
        type: string
      showAllParticipantsInIcs:
        type: boolean
      participantPasscode:
        type: string
      publishMeeting:
        type: boolean
      moderatorLess:
        type: boolean
      videoBestFit:
        type: boolean
      muteParticipantsOnEntry:
        type: boolean
      enforceMeetingEncryption:
        type: boolean
      enforceMeetingEncryptionAllowPSTN:
        type: boolean
      idleTimeout:
        type: integer
      defaultLayout:
        type: string
      playAudioAlerts:
        type: boolean
      personalMeetingId:
        type: integer
      moderatorPasscode:
        type: string
  Meeting:
    type: object
    required:
      - title
      - start
      - end
      - endPointVersion
      - endPointType
    properties:
      id:
        type: integer
        description: Unique identifier for meeting.
        readOnly: true
      title:
        type: string
        default: My Test Meeting
      description:
        type: string
      start:
        type: integer
        format: int64
        description: A [UNIX Timestamp](https://currentmillis.com/) in milliseconds
      end:
        type: integer
        format: int64
        description: A [UNIX Timestamp](https://currentmillis.com/) in milliseconds
      timezone:
        type: string
        default: America/New_York
      numericMeetingId:
        type: string
        description: The meeting ID that participants will see and use to join the conference. When joining via phone, this is the code they enter via DTMF to join.
        readOnly: true
      attendeePasscode:
        type: string
        readOnly: true
      addAttendeePasscode:
        type: boolean
        description: Indicate if you want the attendees to be forced to enter a passcode on entry for extra security. The passcode will be randomly generated at schedule and will be returned in attendeePasscode property of the meeting.
      endPointVersion:
        type: string
        default: "2.10"
      endPointType:
        type: string
        default: "WEB_APP"
      attendees:
        type: array
        items:
          $ref: '#/definitions/Attendee'
      advancedMeetingOptions:
        type: object
        properties:
          autoRecord:
            type: boolean
          muteParticipantsOnEntry:
            type: boolean
          encryptionType:
            type: string
            enum:
              - NO_ENCRYPTION
              - ENCRYPTED_ONLY
              - ENCRYPTED_OR_PSTN_ONLY
          moderatorLess:
            type: boolean
          videoBestFit:
            type: boolean
          disallowChat:
            type: boolean
          publishMeeting:
            type: boolean
          showAllAttendeesInMeetingInvite:
            type: boolean
  Attendee:
    type: object
    properties:
      email:
        type: string
  Numbers:
    type: object
    properties:
      meetingId:
        type: string
      allowDirectDial:
        type: boolean
      useAttendeePasscode:
        type: boolean
      pstnNumbersUrl:
        type: string
      moderatorPasscode:
        type: string
      precision:
        type: string
      pstnLocalizationSupported:
        type: boolean
      partnerIntegratedMeeting:
        type: boolean
      numbers:
        type: array
        items:
          type: object
          properties:
            id:
              type: integer
            number:
              type: string
            tollfree:
              type: boolean
            premium:
              type: boolean
            custom:
              type: boolean
            country:
              type: string
            countryName:
              type: string
            state:
              type: string
            city:
              type: string
            label:
              type: object
              properties:
                default:
                  type: string
            defaultSettingsInherited:
              type: boolean
            default:
              type: boolean
  PairingCodeSIP:
    type: object
    properties:
      endpointGuid:
        type: string
      forceTURN:
        type: boolean
      pairingCode:
        type: string
      turnservers:
        type: array
        items:
          type: object
          properties:
            credential:
              type: string
            urls:
              type: string
            username:
              type: string
      uri:
        type: string
      seamEndpointGuid:
        type: string
      connectionGuid:
        type: string
  PairingCodeWebRTC:
    type: object
    properties:
      callguid:
        type: string
      endpointGuid:
        type: string
      forceTURN:
        type: boolean
      pairingCode:
        type: string
      status:
        type: integer
      statusText:
        type: string
        enum:
          - OK
      turnservers:
        type: array
        items:
          type: object
          properties:
            credential:
              type: string
            urls:
              type: string
            username:
              type: string
      uri:
        type: string
      seamEndpointGuid:
        type: string
      connectionGuid:
        type: string
      endpointName:
        type: string
  DialoutPstn:
    type: object
    properties:
      connectionGuid:
        type: string
      endpointGuid:
        type: string
  MeetingState:
    type: object
    properties:
      meetingId:
        type: string
      meetingGuid:
        type: string
      meetingState:
        type: string
        enum:
          - MeetingStarted
      status:
        type: string
        enum:
          - active
      isContentSharingActive:
        type: boolean
      bridged:
        type: boolean
      locked:
        type: boolean
      audioMuteOnEntry:
        type: boolean
      videoMuteOnEntry:
        type: boolean
      moderatorLess:
        type: boolean
      title:
        type: string
      chatEnabled:
        type: boolean
      pinnedEndpointGuid:
        type: string
      audioEndpointCount:
        type: integer
      videoEndpointCount:
        type: integer
      recordingEnabled:
        type: boolean
      participantWebJoinURL:
        type: string
      isLargeMeeting:
        type: string
      features:
        type: array
        items:
          type: string
      delayedMeetingEndTime:
        type: integer
      smStreams:
        type: string
      inactiveMeetingStatus:
        type: string
      meetingMarkedForDelayedTermination:
        type: boolean
      recordinginfo:
        type: object
        properties:
          contentStatus:
            type: string
          recordingStartTime:
            type: integer
          active:
            type: boolean
          recorded:
            type: boolean
  Endpoints:
    type: array
    items:
      type: object
      properties:
        meetingid:
          type: string
        name:
          type: string
        CallQuality:
          type: string
        Leader:
          type: string
        callguid:
          type: string
        endpoint:
          type: string
        TalkDetected:
          type: string
        SecureCall:
          type: string
        Layout:
          type: string
        SubLayout:
          type: string
        VideoRecv:
          type: string
        VideoRecvLocalMute:
          type: string
        VideoRecvRemoteMute:
          type: string
        AudioRecv:
          type: string
        AudioRecvLocalMute:
          type: string
        AudioRecvRemoteMute:
          type: string
        AudioRecvCodec:
          type: string
        AudioSendCodec:
          type: string
        VideoRecvCodec:
          type: string
        VideoRecvHeight:
          type: string
        VideoRecvWidth:
          type: string
        VideoSendCodec:
          type: string
        VideoSendHeight:
          type: string
        VideoSendWidth:
          type: string
        visibility:
          type: string
        chatEndpointGuid:
          type: string
        endpointGuid:
          type: string
        RDCVersion:
          type: string
        RDCControllerCapable:
          type: string
        RDCControlleeCapable:
          type: string
        connections:
          type: array
          items:
            type: object
            properties:
              connectionGuid:
                type: string
              capabilities:
                type: array
                items:
                  type: string
              endpoint:
                type: string
              callGuid:
                type: string
  Endpoint:
    type: object
    properties:
      EcMode:
        type: string
      creationtime:
        type: string
      audio.remote.rtcpAddress:
        type: string
      VideoSendCodec:
        type: string
      AudioPlayID:
        type: string
      CallQualityRecv:
        type: string
      SessionOut:
        type: string
      audio.local.address:
        type: string
      meetingid:
        type: string
      VideoSendWidth:
        type: string
      CallQualitySend:
        type: string
      mhaddress:
        type: string
      RDCControlleeCapable:
        type: string
      AudioCapName:
        type: string
      ProxyInfo:
        type: string
      AudioSendCodec:
        type: string
      vendor:
        type: string
      VideoRecvWidth:
        type: string
      conaddress:
        type: string
      TalkDetected:
        type: string
      SubLayout:
        type: string
      AudioRtcpRelay:
        type: string
      AudioRecvLocalMute:
        type: string
      name:
        type: string
      video.local.address:
        type: string
      audio.local.rtcpAddress:
        type: string
      ContentRtpRelay:
        type: string
      content.local.rtcpAddress:
        type: string
      RemoteConnectionCount:
        type: string
      callrate:
        type: string
      MixerGuid:
        type: string
      transport:
        type: string
      AudioCapSelectID:
        type: string
      CountryCode:
        type: string
      RDCControllerCapable:
        type: string
      pairedname:
        type: string
      VideoRtcpRelay:
        type: string
      EndpointCpuParams:
        type: string
      video.remote.address:
        type: string
      version:
        type: string
      ContentRecv:
        type: string
      localName:
        type: string
      BJNUserId:
        type: string
      content.remote.address:
        type: string
      AudioSend:
        type: string
      ParticipantDTMFMenus:
        type: string
      VideoRtcpTranspor:
        type: string
      AudioRtcpTransport:
        type: string
      RelayNodeId:
        type: string
      content.remote.rtcpAddress:
        type: string
      AudioRtpRelay:
        type: string
      VideoRtpTransport:
        type: string
      ContentRecvLocalMute:
        type: string
      Layout:
        type: string
      ContentSend:
        type: string
      remoteaddress:
        type: string
      MeetingGuid:
        type: string
      connecttime:
        type: string
      localaddress:
        type: string
      audio.remote.address:
        type: string
      BondedAudioGuid:
        type: string
      AudioRecvRemoteMute:
        type: string
      SessionOutRelay:
        type: string
      Leader:
        type: string
      content.local.address:
        type: string
      MovieCapable:
        type: string
      VideoRecvLocalMute:
        type: string
      ContentRtpTransport:
        type: string
      RDCVersion:
        type: string
      AudioRecv:
        type: string
      ContentRelayServer:
        type: string
      VideoRecv:
        type: string
      visibility:
        type: string
      sessionid:
        type: string
      ContentRtcpRelay:
        type: string
      locales:
        type: string
      medaddress:
        type: string
      HtmlLayoutGuid:
        type: string
      endpoint:
        type: string
      VideoDrop:
        type: string
      ContentRtcpTransport:
        type: string
      video.remote.rtcpAddress:
        type: string
      VideoRtpRelay:
        type: string
      mixaddress:
        type: string
      SIPHTTPProxyTransport:
        type: string
      VideoRecvCodec:
        type: string
      AudioRecvCodec:
        type: string
      SessionIn:
        type: string
      BondedVideoGuid:
        type: string
      CallQuality:
        type: string
      meetingjointime:
        type: string
      SessionInRelay:
        type: string
      pairedremoteaddress:
        type: string
      VideoSendHeight:
        type: string
      VideoRecvHeight:
        type: string
      SecureCall:
        type: string
      video.local.rtcpAddress:
        type: string
      AudioPlayName:
        type: string
      VideoCapID:
        type: string
      AudioRtpTransport:
        type: string
      MeetingInfoMode:
        type: string
      callhostname:
        type: string
      callguid:
        type: string
      AudioCapID:
        type: string
      VideoSend:
        type: string
      ContentRecvCodec:
        type: string
      SessionRelay:
        type: string
      VideoRecvRemoteMute:
        type: string
      Id:
        type: string
      BondedVideoName:
        type: string
      isInRoster:
        type: boolean
  RecordingSummary:
    type: object
    properties:
      recordingEntityId:
        type: integer
      recordingName:
        type: string
      meetingGuid:
        type: string
      chapterCount:
        type: integer
      totalSize:
        type: integer
      totalDuration:
        type: integer
      lastRecordingDate:
        type: string
      aggregatedStatus:
        type: string
      recordingThumbnail:
        type: string
      created:
        type: integer
      isPremiumRecording:
        type: boolean
      showPremiumRecordingTag:
        type: boolean
  Layout:
    type: object
    properties:
      layoutMode:
        type: string
        enum:
          - Video
      subLayoutMode:
        type: string
        description: Misspelling in value.
        enum:
          - VideoContiniousPresence
  RecordingHistoryList:
    type: array
    items:
      $ref: '#/definitions/RecordingHistory'
  RecordingHistory:
    type: object
    properties:
      chapterId:
        type: string
      id:
        type: integer
      startTimeOffset:
        type: integer
      endTimeOffset:
        type: integer
      chapterName:
        type: string
      totalSize:
        type: integer
      compositeContentId:
        type: integer
      compositeContentStatus:
        type: string
        enum:
        - PROCESSED
      parentRecordingId:
        type: integer
      viewCount:
        type: integer
      recordingSessions:
        type: array
        items:
          $ref: '#/definitions/RecordingSession'
  RecordingSession:
    type: object
    properties:
      id:
        type: integer
      contentStatus:
        type: string
      recordingType:
        type: string
      contentId:
        type: integer
      thumbnailUrl:
        type: string
      startTimeOffset:
        type: integer
      endTimeOffset:
        type: integer
      duration:
        type: integer
      startedBy:
        type: object
        properties:
          endpointName:
            type: string
          endpointGuid:
            type: string
      stoppedBy:
        type: object
        properties:
          endpointName:
            type: string
          endpointGuid:
            type: string
  Recording:
    type: object
    properties:
      recordingEntityId:
        type: integer
      recordingEntityGuid:
        type: string
      recordingName:
        type: string
      meetingGuid:
        type: string
      chapterCount:
        type: integer
      totalSize:
        type: integer
      totalDuration:
        type: integer
      lastRecordingDate:
        type: integer
      aggregatedStatus:
        type: string
      recordingThumbnail:
        type: string
      created:
        type: integer
      aggregatedViewCount:
        type: integer
      isPremiumRecording:
        type: boolean
      showPremiumRecordingTag:
        type: boolean
      recordingChapters:
        type: array
        items:
          type: object
          properties:
            chapterId:
              type: string
            id:
              type: integer
            startTimeOffset:
              type: integer
            endTimeOffset:
              type: integer
            chapterName:
              type: string
            totalSize:
              type: integer
            compositeContentId:
              type: integer
            compositeContentStatus:
              type: string
            parentRecordingId:
              type: integer
            viewCount:
              type: integer
            recordingSessions:
              type: array
              items:
                $ref: '#/definitions/RecordingSession'
  MeetingHistory:
      type: object
      properties:
        meetingGuid:
          type: string
        meetingNumericId:
          type: string
        title:
          type: string
        description:
          type: string
        leaderInfo:
          type: object
          properties:
            leaderId:
              type: integer
            firstName:
              type: string
            lastName:
              type: string
            userName:
              type: string
            email:
              type: string
        userId:
          type: integer
        meetingDuration:
          type: integer
        maxParticipantCount:
          type: integer
        totalParticipantMinutes:
          type: integer
        maxParticipantMinutes:
          type: integer
        extraParticipantMinutes:
          type: integer
        isdnEndpoints:
          type: integer
        totalDialoutMinutes:
          type: integer
        totalTollFreeMinutes:
          type: integer
        callDIDMinutes:
          type: integer
        startTime:
          type: integer
        endTime:
          type: integer
        meetingStatus:
          type: string
          enum:
            - Complete
        meetingThumbnail:
          type: string
        startTimeZone:
          type: string
        processingStatus:
          type: string
          enum:
            - PROCESSED
        concurrentCalls:
          type: string
        uploadStatus:
          type: string
        pstnonly:
          type: boolean
        participantList:
          type: array
          items:
            type: object
            properties:
              endpointName:
                type: string
              joinTime:
                type: integer
              minutes:
                type: integer
              deviceType:
                type: string
                enum:
                  - Carmel
                  - WebRTC
              email:
                type: string
              remoteAddress:
                type: string
              isEncrypted:
                type: boolean
              disconnectTime:
                type: integer
              isModerator:
                type: boolean
              userId:
                type: integer
              tags:
                type: string
              participantGuid:
                type: string
  MeetingHistorySharing:
    type: object
    properties:
      id:
        type: integer
      meetingGuid:
        type: string
      ownerId:
        type: integer
        description: Numeric user ID for the meeting owner.
      sharingUrl:
        type: string
      recepientType:
        type: string
        enum:
          - ENTERPRISE
          - PUBLIC
      properties:
        type: string
      status:
        type: string
        enum:
          - ACTIVE
      downloadable:
        type: boolean
      passcode:
        type: string
      validity:
        type: string
      created:
        type: integer
        format: int64
        description: A [UNIX Timestamp](https://currentmillis.com/) in milliseconds
      lastmodified:
        type: integer
        format: int64
        description: A [UNIX Timestamp](https://currentmillis.com/) in milliseconds
  MeetingIndigoList:
    type: object
    properties:
      meetings:
        type: array
        items:
          $ref: '#/definitions/MeetingIndigo'
  MeetingIndigo:
    type: object
    properties:
      meetingId:
        type: string
        description: This is the same as the numericMeetingId found elsewhere. We should have been more consistent.
      meetingUUID:
        type: string
        description: The universally unique identifier (UUID) of the meeting. This value is a string which contains 6 alphanumeric segments separated by dashes.
      userName:
        type: string
      email:
        type: string
      encryptionType:
        type: integer
      title:
        type: string
      userFullName:
        type: string
      phoneNumber:
        type: string
      userFeatures:
        type: string
      scheduledFrom:
        type: string
        enum:
        - WEB_APP
      inviteeCount:
        type: integer
      personal:
        type: boolean
      muteOnEntry:
        type: boolean
      autoRecord:
        type: boolean
      enterpriseName:
        type: string
      moderatorLess:
        type: boolean
      startTime:
        type: integer
        format: int64
      endTime:
        type: integer
        format: int64
      totalCallSeconds:
        type: integer
      createTime:
        type: integer
        format: int64
      endpointsCount:
        type: integer
      concurrentEndpoints:
        type: integer
      liveVisibleEndpointsCount:
        type: integer
      qualarooRating:
        type: integer
      qualarooCount:
        type: integer
      meetingRecording:
        type: boolean
      videoShare:
        type: boolean
      contentShare:
        type: boolean
      liveRecording:
        type: boolean
      liveVideoShare:
        type: boolean
      liveContentShare:
        type: boolean
      largeMeeting:
        type: boolean
      roiDistance:
        type: number
        format: float
      mpls:
        type: boolean
      id:
        type: string
        description: Same as the meetingUUID property in this object.
  MeetingExtendedIndigo:
    allOf:
    - $ref: '#/definitions/MeetingIndigo'
    - type: object
      properties:
        endpoints:
          type: array
          items:
            $ref: '#/definitions/EndpointIndigo'
  EndpointIndigo:
    type: object
    properties:
      id:
        type: integer
      callguid:
        type: string
      name:
        type: string
      endpoint:
        type: string
      vendor:
        type: string
      version:
        type: string
      uniqId:
        type: string
      remoteAddress:
        type: string
      leader:
        type: boolean
      secureCall:
        type: boolean
      natDetected:
        type: boolean
      proxy:
        type: boolean
      roiDistance:
        type: number
        format: float
      mpls:
        type: boolean
      videoShare:
        type: boolean
      recording:
        type: boolean
      creationTime:
        type: integer
        format: int64
      meetingJoinTime:
        type: integer
        format: int64
      meetingLeaveTime:
        type: integer
        format: int64
      didNumber:
        type: string
      location:
        type: object
        properties:
          id:
            type: integer
          countryCode:
            type: string
          countryName:
            type: string
          latitude:
            type: number
          longitude:
            type: number
      summaryStats:
        type: object
        properties:
          audioRecvCodec:
            type: string
          audioSendCodec:
            type: string
          contentRecv:
            type: boolean
          contentSend:
            type: boolean
          talkDetected:
            type: boolean
          sessionRelay:
            type: boolean
          sessionInRelay:
            type: boolean
          sessionOutRelay:
            type: boolean
          audioRtpRelay:
            type: boolean
          callRate:
            type: integer
          cumulLoss_Percent_AI:
            type: number
          cumulLoss_Percent_AO:
            type: number
          cumulLoss_Percent_VI:
            type: number
          cumulLoss_Percent_VO:
            type: number
          cumulLoss_Percent_VIC:
            type: number
          cumulLoss_Percent_VOC:
            type: number
          cumulLoss_AI:
            type: number
          cumulLoss_AO:
            type: number
          cumulLoss_VI:
            type: number
          cumulLoss_VO:
            type: number
          cumulLoss_VIC:
            type: number
          cumulLoss_VOC:
            type: number
          discontinuityCount:
            type: number
          droppedPackets_AI:
            type: number
          droppedPackets_VI:
            type: number
          droppedPackets_VIC:
            type: number
          mixUnderRuns_AI:
            type: number
          networkAvgLoss_AI:
            type: number
          networkAvgLoss_AO:
            type: number
          networkAvgLoss_VI:
            type: number
          networkAvgLoss_VO:
            type: number
          networkCumulLoss_AI:
            type: number
          networkCumulLoss_AO:
            type: number
          networkCumulLoss_VI:
            type: number
          networkCumulLoss_VO:
            type: number
          networkLoss_AI:
            type: number
          networkLoss_AO:
            type: number
          networkLoss_VI:
            type: number
          networkLoss_VO:
            type: number
          callQuality_Min:
            type: number
          callQuality_Max:
            type: number
          callQuality_Avg:
            type: number
          fps_Min_VI:
            type: number
          fps_Min_VO:
            type: number
          fps_Min_VIC:
            type: number
          fps_Min_VOC:
            type: number
          fps_Max_VI:
            type: number
          fps_Max_VO:
            type: number
          fps_Max_VIC:
            type: number
          fps_Max_VOC:
            type: number
          fps_Avg_VI:
            type: number
          fps_Avg_VO:
            type: number
          fps_Avg_VIC:
            type: number
          fps_Avg_VOC:
            type: number
          bitrate_Min_AI:
            type: number
          bitrate_Min_AO:
            type: number
          bitrate_Min_VI:
            type: number
          bitrate_Min_VO:
            type: number
          bitrate_Min_VIC:
            type: number
          bitrate_Min_VOC:
            type: number
          bitrate_Max_AI:
            type: number
          bitrate_Max_AO:
            type: number
          bitrate_Max_VI:
            type: number
          bitrate_Max_VO:
            type: number
          bitrate_Max_VIC:
            type: number
          bitrate_Max_VOC:
            type: number
          bitrate_Avg_AI:
            type: number
          bitrate_Avg_AO:
            type: number
          bitrate_Avg_VI:
            type: number
          bitrate_Avg_VO:
            type: number
          bitrate_Avg_VIC:
            type: number
          bitrate_Avg_VOC:
            type: number
          jitter_Min_AI:
            type: number
          jitter_Min_AO:
            type: number
          jitter_Min_VI:
            type: number
          jitter_Min_VO:
            type: number
          jitter_Min_VIC:
            type: number
          jitter_Min_VOC:
            type: number
          jitter_Max_AI:
            type: number
          jitter_Max_AO:
            type: number
          jitter_Max_VI:
            type: number
          jitter_Max_VO:
            type: number
          jitter_Max_VIC:
            type: number
          jitter_Max_VOC:
            type: number
          jitter_Avg_AI:
            type: number
          jitter_Avg_AO:
            type: number
          jitter_Avg_VI:
            type: number
          jitter_Avg_VO:
            type: number
          jitter_Avg_VIC:
            type: number
          jitter_Avg_VOC:
            type: number
          maxJitter_Min_AI:
            type: number
          maxJitter_Min_VI:
            type: number
          maxJitter_Min_VIC:
            type: number
          maxJitter_Max_AI:
            type: number
          maxJitter_Max_VI:
            type: number
          maxJitter_Max_VIC:
            type: number
          maxJitter_Avg_AI:
            type: number
          maxJitter_Avg_VI:
            type: number
          maxJitter_Avg_VIC:
            type: number
          videoRecvHeight_Min:
            type: number
          videoRecvHeight_Max:
            type: number
          videoRecvWidth_Min:
            type: number
          videoRecvWidth_Max:
            type: number
          videoSendHeight_Min:
            type: number
          videoSendHeight_Max:
            type: number
          videoSendWidth_Min:
            type: number
          videoSendWidth_Max:
            type: number
          contentRecvHeight_Min:
            type: number
          contentRecvHeight_Max:
            type: number
          contentRecvWidth_Min:
            type: number
          contentRecvWidth_Max:
            type: number
          contentSendHeight_Min:
            type: number
          contentSendHeight_Max:
            type: number
          contentSendWidth_Min:
            type: number
          contentSendWidth_Max:
            type: number
          roundTripDelay_Min:
            type: number
          roundTripDelay_Max:
            type: number
          roundTripDelay_Avg:
            type: number
          rfactor_Min:
            type: number
          rfactor_Max:
            type: number
          rfactor_Avg:
            type: number
          processCpuLoad_Min:
            type: number
          processCpuLoad_Max:
            type: number
          processCpuLoad_Avg:
            type: number
          systemCpuLoad_Min:
            type: number
          systemCpuLoad_Max:
            type: number
          systemCpuLoad_Avg:
            type: number
          wifiRecvStrength_Min:
            type: number
          wifiRecvStrength_Max:
            type: number
          wifiRecvStrength_Avg:
            type: number
          keyFrameRate_Avg_VI:
            type: number
          keyFrameRate_Avg_VO:
            type: number
          keyFrameRate_Avg_VIC:
            type: number
          keyFrameRate_Avg_VOC:
            type: number
          keyFrameRate_Min_VI:
            type: number
          keyFrameRate_Min_VO:
            type: number
          keyFrameRate_Min_VIC:
            type: number
          keyFrameRate_Min_VOC:
            type: number
          keyFrameRate_Max_VI:
            type: number
          keyFrameRate_Max_VO:
            type: number
          keyFrameRate_Max_VIC:
            type: number
          keyFrameRate_Max_VOC:
            type: number
          roundTripDelay_Avg_VO:
            type: number
          roundTripDelay_Avg_VOC:
            type: number
          roundTripDelay_Avg_AO:
            type: number
      endpointAttributes1:
        type: object
        properties:
          reIceCount:
            type: integer
          remoteConnectionCount:
            type: integer
      traceroute:
        type: object
        properties:
          tracePath:
            type: array
            items:
              type: object
              properties:
                name:
                  type: string
                ip:
                  type: string
                delay1:
                  type: number
                delay2:
                  type: number
                delay3:
                  type: number
                asapath:
                  type: string
      mhtaskStopped:
        type: boolean
  Content:
    type: object
    properties:
      id:
        type: integer
      contentType:
        type: string
      contentDescription:
        type: string
      contentUrl:
        type: string
      userId:
        type: integer
      contentLocation:
        type: string
      created:
        type: integer
      modified:
        type: integer
      contentStatus:
        type: string
      contentName:
        type: string
      contentCategory:
        type: string
      contentSize:
        type: integer
      contentDuration:
        type: integer
      contentProperties:
        type: object
        properties:
          duration:
            type: integer
          thumbnail:
            type: string
          thumbnailSprite:
            type: string
          hdsUrl:
            type: string
          thumbnailCount:
            type: integer
          thumbnailWidth:
            type: integer
          thumbnailHeight:
            type: integer
          thumbnailInterval:
            type: integer
          hlsUrl:
            type: string
          levels:
            type: array
            items:
              type: object
              properties:
                file:
                  type: string
                width:
                  type: integer
                bitrate:
                  type: integer
                height:
                  type: integer
  AnalyticsTopUsers:
    type: object
    properties:
      usage:
        type: array
        items:
          type: object
          properties:
            lastMeetingTime:
              type: integer
            participantMinutes:
              type: number
            last_name:
              type: string
            userName:
              type: string
            userId:
              type: integer
            first_name:
              type: string
  AnalyticsEndpointDistribution:
    type: object
    properties:
      distribution:
        type: array
        items:
          type: object
          properties:
            Google:
              type: integer
            Telepresence:
              type: integer
            Lync:
              type: integer
            iOS:
              type: integer
            H323:
              type: integer
            InterCall:
              type: integer
            Jabber:
              type: integer
            Android:
              type: integer
            Skype:
              type: integer
            ISDN:
              type: integer
            PSTN:
              type: integer
            Level3:
              type: integer
            SIP:
              type: integer
            BlueJeansApp:
              type: integer
            Browser:
              type: integer
            WebRTC:
              type: integer
  AnalyticsUsage:
    type: object
    properties:
      usage:
        type: array
        items:
          type: object
          properties:
            endpointMinutes:
              type: integer
            numEndpoints:
              type: integer
            numMeetings:
              type: integer
            Date:
              type: integer
  AnalyticsRoiData:
    type: object
    properties:
      roi_ranges:
        type: array
        items:
          type: object
          properties:
            distance:
              type: number
            distance_range:
              type: string
  AnalyticsFeedbackScores:
    type: object
    properties:
      Great:
        type: integer
      Okay:
        type: integer
      Bad:
        type: integer
      Poor:
        type: integer
      Good:
        type: integer
  AnalyticsFeedbackComments:
    type: object
    properties:
      comments:
        type: array
        items:
          type: object
          properties:
            qualaroo_feedback:
              description: The comment rating left by the user.
              type: string
            meeting_uuid:
              description: The UUID of the meeting.
              type: string
            callguid:
              type: string
            qualaroo_comments:
              description: The comment left by the user.
              type: string
  Application:
    type: object
    properties:
      description:
        type: string
        description: A summary of the client application.
      appName:
        type: string
        description: The name of the client application.
      appLogoUrl:
        type: string
        description: A URL of an image that will be displayed to users during authorization.
      redirectUrls:
        type: array
        items:
          type: string
          description: A list of URLs that the actual redirect URL in the authorization process will contain.
      clientId:
        type: string
        description: The client ID will be generated on creation of the application. Normally, a 32 character hexadecimal numeric string.
        readOnly: true
      clientSecret:
        type: string
        description: The client secret will be generated on creation of the application. Retain this value as it will only be revealed one time. If lost, you will need to regenerate.
        readOnly: true
  ApplicationSecret:
    type: object
    properties:
      clientId:
        type: string
        description: The client ID will be generated on creation of the application. Normally, a 32 character hexadecimal numeric string.
        readOnly: true
      client_secret:
        type: string
        description: The client secret will be generated on creation of the application. Retain this value as it will only be revealed one time. If lost, you will need to regenerate.
        readOnly: true
  GrantedApplications:
    type: object
    properties:
      appName:
        description: Name of the Application
        type: string
      appDescription:
        type: string
        description: A summary of the client application.
      clientId:
        type: string
        description: The client ID will be generated on creation of the application. Normally, a 32 character hexadecimal numeric string.
      userId:
        type: integer
        description: Same user ID as passed in path parameter.
      scope:
        type: string
        description: Comma-delimited list of granted permissions to the application.
  Error:
    type: object
    properties:
      message:
        type: string