github.com/grokify/go-ringcentral-client@v0.3.31/codegen/swagger_spec.yaml

---
  swagger: "2.0"
  info:
    description: "<p>This is a beta interactive API explorer for the RingCentral Connect Platform. To use this service, you will need to have an account with the proper credentials to generate an OAuth2 access token.</p><p><h2>Quick Start</h2></p><ol><li>1) Go to <b>Authentication > /oauth/token</b></li><li>2) Enter <b>app_key, app_secret, username, password</b> fields and then click \"Try it out!\"</li><li>3) Upon success, your access_token is loaded and you can access any form requiring authorization.</li></ol><h2>Links</h2><ul><li><a href=\"https://github.com/ringcentral\" target=\"_blank\">RingCentral SDKs on Github</a></li><li><a href=\"mailto:devsupport@ringcentral.com\">RingCentral Developer Support Email</a></li></ul>"
    version: "1.0"
    title: "RingCentral Connect Platform API Explorer"
    termsOfService: "https://developer.ringcentral.com"
  host: "platform.devtest.ringcentral.com"
  basePath: "/"
  tags:
    -
      name: "Overview"
      description: " "
    -
      name: "OAuth 2.0 Authentication & Authorization"
      description: " "
    -
      name: "API Info"
      description: " "
    -
      name: "Call Log"
      description: " "
    -
      name: "Phone Numbers"
      description: " "
    -
      name: "Messages"
      description: " "
    -
      name: "RingOut"
      description: " "
    -
      name: "User Contacts"
      description: " "
    -
      name: "Company Contacts"
      description: " "
    -
      name: "Presence"
      description: " "
    -
      name: "Glip"
      description: " "
    -
      name: "Meetings"
      description: " "
    -
      name: "Push Notifications"
      description: " "
    -
      name: "Roles and Permissions"
      description: " "
    -
      name: "Call Handling Settings"
      description: " "
    -
      name: "Application Settings"
      description: " "
    -
      name: "User Settings"
      description: " "
    -
      name: "Company Settings"
      description: " "
    -
      name: "Regional Settings"
      description: " "
    -
      name: "Account Provisioning"
      description: " "
    -
      name: "SCIM"
      description: " "
    -
      name: "Reporting"
      description: " "
  schemes:
    - "https"
  securityDefinitions:
    OAuth2:
      type: "oauth2"
      flow: "accessCode"
      authorizationUrl: "https://platform.devtest.ringcentral.com/restapi/oauth/authorize"
      tokenUrl: "https://platform.devtest.ringcentral.com/restapi/oauth/token"
      scopes: {}
  security:
    - OAuth2: []
  paths:
    /restapi:
      get:
        tags:
          - "API Info"
        summary: "Get API Versions"
        description: "<p style='font-style:italic;'>Since 1.0.0</p><p>Returns current API version(s) and server info.</p><h4>Usage Plan Group</h4><p>Light</p>"
        operationId: "getAPIVersion"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters: []
        responses:
          default:
            description: "Success"
            schema:
              $ref: "#/definitions/GetVersionsResponse"
        x-api-group: "restapi"
        x-auth-required: false
        x-throttling-group: "NoThrottling"
        x-metered-api: true
        x-metering-group: "Free"
        x-access-level: "Public"
    /restapi/{apiVersion}:
      get:
        tags:
          - "API Info"
        summary: "Get Version Info"
        description: "<p style='font-style:italic;'>Since 1.0.0</p><p>Returns current API version info by apiVersion.</p><h4>Usage Plan Group</h4><p>Light</p>"
        operationId: "getVersionInfo"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "apiVersion"
            in: "path"
            description: "API version to be requested, for example 'v1.0'"
            required: true
            type: "string"
        responses:
          default:
            description: "Success"
            schema:
              $ref: "#/definitions/GetVersionResponse"
        x-api-group: "restapi/version"
        x-auth-required: false
        x-throttling-group: "NoThrottling"
        x-metered-api: true
        x-metering-group: "Free"
        x-access-level: "Public"
    /restapi/v1.0/status:
      get:
        tags:
          - "API Info"
        summary: "Get Status"
        description: "<p style='font-style:italic;'>Since 1.0.27 (Release 8.3)</p><p>Returns the API status; status '200' means the API is working fine, and '503' means it is temporary unavailable.</p><h4>API Group</h4><p>Light</p>"
        operationId: "loadAPIStatus"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters: []
        responses:
          default:
            description: "Success"
        x-api-group: "restapi/status"
        x-auth-required: false
        x-throttling-group: "NoThrottling"
        x-metered-api: true
        x-metering-group: "Free"
        x-access-level: "Public"
    /restapi/v1.0/account/{accountId}/extension/{extensionId}/call-log:
      get:
        tags:
          - "Call Log"
        summary: "Get Call Log Records by Filter"
        description: "<p style='font-style:italic;'>Since 1.0.3 (Release 5.11)</p><p>Returns call log records filtered by the specified parameters.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadCallLog</td><td>Viewing user call logs</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Heavy</p>"
        operationId: "loadExtensionCallLog"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "accountId"
            in: "path"
            description: "Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"
            required: true
            type: "string"
            default: "~"
          -
            name: "extensionId"
            in: "path"
            description: "Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session"
            required: true
            type: "string"
            default: "~"
          -
            name: "extensionNumber"
            in: "query"
            description: "Extension number of a user. If specified, returns call log for a particular extension only. Cannot be specified together with the phoneNumber filter"
            required: false
            type: "string"
          -
            name: "showBlocked"
            in: "query"
            type: "boolean"
            description: "If 'True' then calls from/to blocked numbers are returned. The default value is 'True'"
            required: false
          -
            name: "phoneNumber"
            in: "query"
            description: "Phone number of a caller/call recipient. If specified, returns all calls (both incoming and outcoming) with the mentioned phone number. Cannot be specified together with the extensionNumber filter"
            required: false
            type: "string"
          -
            name: "direction"
            in: "query"
            description: "The direction for the result records. It is allowed to specify more than one direction. If not specified, both inbound and outbound records are returned. Multiple values are accepted"
            required: false
            type: "array"
            items:
              type: "string"
            collectionFormat: "multi"
            enum:
              - "Inbound"
              - "Outbound"
          -
            name: "sessionId"
            in: "query"
            required: false
            type: "string"
          -
            name: "type"
            in: "query"
            description: "Call type of a record. It is allowed to specify more than one type. If not specified, all call types are returned. Multiple values are accepted"
            required: false
            type: "array"
            items:
              type: "string"
            collectionFormat: "multi"
            enum:
              - "Voice"
              - "Fax"
          -
            name: "transport"
            in: "query"
            description: "Call transport type. 'PSTN' specifies that a call leg is initiated from the PSTN network provider; 'VoIP' - from an RC phone. By default this filter is disabled"
            required: false
            type: "array"
            items:
              type: "string"
            collectionFormat: "multi"
            enum:
              - "PSTN"
              - "VoIP"
          -
            name: "view"
            in: "query"
            description: "The default value is 'Simple' for both account and extension call log"
            required: false
            type: "array"
            items:
              type: "string"
            collectionFormat: "multi"
            enum:
              - "Simple"
              - "Detailed"
          -
            name: "withRecording"
            in: "query"
            description: "'True' if only recorded calls have to be returned"
            required: false
            type: "boolean"
          -
            name: "dateTo"
            in: "query"
            description: "The end datetime for resulting records in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z. The default value is current time"
            required: false
            type: "string"
            format: "date-time"
          -
            name: "dateFrom"
            in: "query"
            description: "The start datetime for resulting records in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z. The default value is dateTo minus 24 hours"
            required: false
            type: "string"
            format: "date-time"
          -
            name: "page"
            in: "query"
            description: "Indicates the page number to retrieve. Only positive number values are allowed. Default value is '1'"
            required: false
            type: "integer"
          -
            name: "perPage"
            in: "query"
            description: "Indicates the page size (number of items). If not specified, the value is '100' by default"
            required: false
            type: "integer"
        responses:
          default:
            description: "Success"
            schema:
              $ref: "#/definitions/ExtensionCallLogResponse"
        x-api-group: "extension/call-log"
        x-throttling-group: "Heavy"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "ReadCallLog"
        x-user-permission: "ReadCallLog"
        x-access-level: "Public"
      delete:
        tags:
          - "Call Log"
        summary: "Delete Call Log Records by Filter"
        description: "<p style='font-style:italic;'></p><p></p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>EditCallLog</td><td>Viewing and updating user call logs</td></tr><tr><td class='code'>ReadCallLog</td><td>Viewing user call logs</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Heavy</p>"
        operationId: "deleteExtensionCallLog"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "accountId"
            in: "path"
            description: "Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"
            required: true
            type: "string"
            default: "~"
          -
            name: "extensionId"
            in: "path"
            description: "Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session"
            required: true
            type: "string"
            default: "~"
          -
            name: "dateTo"
            in: "query"
            description: "The end datetime for records deletion in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z. The default value is current time"
            required: false
            type: "string"
          -
            name: "phoneNumber"
            in: "query"
            required: false
            type: "string"
          -
            name: "extensionNumber"
            in: "query"
            required: false
            type: "string"
          -
            name: "type"
            in: "query"
            required: false
            type: "array"
            items:
              type: "string"
              enum:
                - "Voice"
                - "Fax"
            collectionFormat: "multi"
          -
            name: "direction"
            in: "query"
            required: false
            type: "array"
            items:
              type: "string"
              enum:
                - "Inbound"
                - "Outbound"
            collectionFormat: "multi"
          -
            name: "dateFrom"
            in: "query"
            required: false
            type: "string"
            format: "date-time"
        responses:
          default:
            description: "Success"
        x-api-group: "extension/call-log"
        x-throttling-group: "Heavy"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "EditCallLog"
        x-user-permission: "EditCallLog"
        x-access-level: "Advanced"
    /restapi/v1.0/account/{accountId}/extension/{extensionId}/call-log-sync:
      get:
        tags:
          - "Call Log"
        summary: "Call Log Synchronization"
        description: "<p style='font-style:italic;'></p><p></p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadCallLog</td><td>Viewing user call logs</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Heavy</p>"
        operationId: "syncExtensionCallLog"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "accountId"
            in: "path"
            description: "Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"
            required: true
            type: "string"
            default: "~"
          -
            name: "extensionId"
            in: "path"
            description: "Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session"
            required: true
            type: "string"
            default: "~"
          -
            name: "syncType"
            in: "query"
            description: "Type of synchronization. 'FSync' is a default value"
            required: false
            type: "array"
            items:
              type: "string"
            collectionFormat: "multi"
            enum:
              - "FSync"
              - "ISync"
          -
            name: "syncToken"
            in: "query"
            description: "Value of syncToken property of last sync request response"
            required: false
            type: "string"
          -
            name: "dateFrom"
            in: "query"
            description: "The start datetime for resulting records in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z. The default value is the current moment"
            required: false
            type: "string"
          -
            name: "recordCount"
            in: "query"
            description: "ForT?FSync the parameter is mandatory, it limits the number of records to be returned in response. For ISync it specifies with how many records to extend sync Frame to the past, the maximum number of records is 250"
            required: false
            type: "integer"
          -
            name: "statusGroup"
            in: "query"
            description: "Type of calls to be returned. The default value is 'All'"
            required: false
            type: "array"
            items:
              type: "string"
            collectionFormat: "multi"
            enum:
              - "Missed"
              - "All"
        responses:
          default:
            description: "Success"
            schema:
              $ref: "#/definitions/CallLogSync"
        x-api-group: "extension/call-log-sync"
        x-throttling-group: "Heavy"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "ReadCallLog"
        x-user-permission: "ReadCallLog"
        x-access-level: "Advanced"
    /restapi/v1.0/account/{accountId}/extension/{extensionId}/call-log/{callRecordId}:
      get:
        tags:
          - "Call Log"
        summary: "Get Call Records by ID"
        operationId: "getCallRecords"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "callRecordId"
            in: "path"
            required: true
            type: "array"
            items:
              type: "string"
            collectionFormat: "csv"
          -
            name: "view"
            in: "query"
            required: false
            type: "string"
            enum:
              - "Simple"
              - "Detailed"
          -
            name: "extensionId"
            in: "path"
            required: true
            type: "string"
          -
            name: "accountId"
            in: "path"
            required: true
            type: "string"
        responses:
          default:
            description: "successful operation"
            schema:
              $ref: "#/definitions/UserCallLogRecord"
        x-api-group: "extension/call-log"
        x-throttling-group: "Heavy"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "ReadCallLog"
        x-user-permission: "ReadCallLog"
        x-access-level: "Public"
    /restapi/v1.0/account/{accountId}/extension/{extensionId}/active-calls:
      get:
        tags:
          - "Call Log"
        summary: "Get User Active Calls"
        description: "<p style='font-style:italic;'>Since 1.0.13 (Release 6.5)</p><p>Returns records of all extension calls that are in progress, ordered by start time in descending order.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadCallLog</td><td>Viewing user call logs</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Heavy</p>"
        operationId: "listExtensionActiveCalls"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "accountId"
            in: "path"
            description: "Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"
            required: true
            type: "string"
            default: "~"
          -
            name: "extensionId"
            in: "path"
            description: "Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session"
            required: true
            type: "string"
            default: "~"
          -
            name: "direction"
            in: "query"
            description: "The direction for the result records. It is allowed to specify more than one direction. If not specified, both inbound and outbound records are returned. Multiple values are accepted"
            required: false
            type: "array"
            items:
              type: "string"
            collectionFormat: "multi"
            enum:
              - "Inbound"
              - "Outbound"
          -
            name: "type"
            in: "query"
            description: "Call type of a record. It is allowed to specify more than one type. If not specified, all call types are returned. Multiple values are accepted"
            required: false
            type: "array"
            items:
              type: "string"
            collectionFormat: "multi"
            enum:
              - "Voice"
              - "Fax"
          -
            name: "page"
            in: "query"
            description: "Indicates the page number to retrieve. Only positive number values are allowed. Default value is '1'"
            required: false
            type: "integer"
          -
            name: "perPage"
            in: "query"
            description: "Indicates the page size (number of items). If not specified, the value is '100' by default"
            required: false
            type: "integer"
        responses:
          default:
            description: "Success"
            schema:
              $ref: "#/definitions/ExtensionActiveCallsResponse"
        x-api-group: "extension/active-calls"
        x-throttling-group: "Heavy"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "ReadCallLog"
        x-user-permission: "ReadCallLog"
        x-access-level: "Public"
    /restapi/v1.0/account/{accountId}/call-log:
      get:
        tags:
          - "Call Log"
        summary: "Get Call Log Records by Filter"
        description: "<p style='font-style:italic;'>Since 1.0.3 (Release 5.11)</p><p>Returns call log records filtered by the specified parameters.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadCallLog</td><td>Viewing user call logs</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Heavy</p>"
        operationId: "loadAccountCallLog"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "accountId"
            in: "path"
            description: "Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"
            required: true
            type: "string"
            default: "~"
          -
            name: "extensionNumber"
            in: "query"
            description: "Extension number of a user. If specified, returns call log for a particular extension only. Cannot be specified together with the phoneNumber filter"
            required: false
            type: "string"
          -
            name: "phoneNumber"
            in: "query"
            description: "Phone number of a caller/call recipient. If specified, returns all calls (both incoming and outcoming) with the mentioned phone number. Cannot be specified together with the extensionNumber filter"
            required: false
            type: "string"
          -
            name: "direction"
            in: "query"
            description: "The direction for the result records. It is allowed to specify more than one direction. If not specified, both inbound and outbound records are returned. Multiple values are accepted"
            required: false
            type: "array"
            items:
              type: "string"
            collectionFormat: "multi"
            enum:
              - "Inbound"
              - "Outbound"
          -
            name: "type"
            in: "query"
            description: "Call type of a record. It is allowed to specify more than one type. If not specified, all call types are returned. Multiple values are accepted"
            required: false
            type: "array"
            items:
              type: "string"
            collectionFormat: "multi"
            enum:
              - "Voice"
              - "Fax"
          -
            name: "view"
            in: "query"
            description: "The default value is 'Simple' for both account and extension call log"
            required: false
            type: "array"
            items:
              type: "string"
            collectionFormat: "multi"
            enum:
              - "Simple"
              - "Detailed"
          -
            name: "withRecording"
            in: "query"
            description: "'True' if only recorded calls have to be returned"
            required: false
            type: "boolean"
          -
            name: "dateFrom"
            in: "query"
            description: "The start datetime for resulting records in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z. The default value is dateTo minus 24 hours"
            required: false
            type: "string"
            format: "date-time"
          -
            name: "dateTo"
            in: "query"
            description: "The end datetime for resulting records in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z. The default value is current time"
            required: false
            type: "string"
            format: "date-time"
          -
            name: "page"
            in: "query"
            description: "Indicates the page number to retrieve. Only positive number values are allowed. The default value is '1'"
            required: false
            type: "integer"
          -
            name: "perPage"
            in: "query"
            description: "Indicates the page size (number of items). If not specified, the value is '100' by default."
            required: false
            type: "integer"
          -
            name: "sessionId"
            in: "query"
            required: false
            type: "string"
        responses:
          default:
            description: "Success"
            schema:
              $ref: "#/definitions/AccountCallLogResponse"
        x-api-group: "account/call-log"
        x-throttling-group: "Heavy"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "ReadCallLog"
        x-user-permission: "FullCompanyCallLog"
        x-access-level: "Public"
      delete:
        tags:
          - "Call Log"
        summary: "Delete Call Log Records by Filter"
        description: "<p style='font-style:italic;'></p><p></p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>EditCallLog</td><td>Viewing and updating user call logs</td></tr><tr><td class='code'>ReadCallLog</td><td>Viewing user call logs</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Heavy</p>"
        operationId: "deleteAccountCallLog"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "accountId"
            in: "path"
            description: "Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"
            required: true
            type: "string"
            default: "~"
          -
            name: "dateTo"
            in: "query"
            description: "The end datetime for records deletion in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z. The default value is current time"
            required: false
            type: "string"
        responses:
          default:
            description: "Success"
        x-api-group: "account/call-log"
        x-throttling-group: "Heavy"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "EditCallLog"
        x-user-permission: "FullCompanyCallLog"
        x-access-level: "Internal"
    /restapi/v1.0/account/{accountId}/call-log-sync:
      get:
        tags:
          - "Call Log"
        summary: "Call Log Synchronization"
        operationId: "syncAccountCallLog"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "accountId"
            in: "path"
            description: "Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"
            required: true
            type: "string"
            default: "~"
          -
            name: "syncType"
            in: "query"
            description: "Type of synchronization. 'FSync' is a default value"
            required: false
            type: "array"
            items:
              type: "string"
            collectionFormat: "multi"
            enum:
              - "FSync"
              - "ISync"
          -
            name: "syncToken"
            in: "query"
            description: "Value of syncToken property of last sync request response"
            required: false
            type: "string"
          -
            name: "dateFrom"
            in: "query"
            description: "The start datetime for resulting records in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z. The default value is the current moment"
            required: false
            type: "string"
          -
            name: "recordCount"
            in: "query"
            description: "ForT?FSync the parameter is mandatory, it limits the number of records to be returned in response. For ISync it specifies with how many records to extend sync Frame to the past, the maximum number of records is 250"
            required: false
            type: "integer"
          -
            name: "statusGroup"
            in: "query"
            description: "Type of calls to be returned. The default value is 'All'"
            required: false
            type: "array"
            items:
              type: "string"
            collectionFormat: "multi"
            enum:
              - "Missed"
              - "All"
        responses:
          default:
            description: "Success"
        x-api-group: "account/call-log-sync"
        x-throttling-group: "Heavy"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "ReadCallLog"
        x-user-permission: "ReadCallLog"
        x-access-level: "Internal"
    /restapi/v1.0/account/{accountId}/call-log/{callRecordId}:
      get:
        tags:
          - "Call Log"
        summary: "Get Account Call Log Record(s) by ID"
        description: "<p style='font-style:italic;'>Since 1.0.3 (Release 5.11)</p><p>Returns individual call log record(s) by ID(s). Batch request is supported, see Batch Requests for details.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadCallLog</td><td>Viewing user call logs</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Heavy</p>"
        operationId: "loadAccountCallLogRecord"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "accountId"
            in: "path"
            description: "Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"
            required: true
            type: "string"
            default: "~"
          -
            name: "callRecordId"
            in: "path"
            description: "Internal identifier of a call log record"
            required: true
            type: "integer"
        responses:
          default:
            description: "Success"
            schema:
              $ref: "#/definitions/GetAccountCallLogRecordResponse"
        x-api-group: "account/call-log"
        x-throttling-group: "Heavy"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "ReadCallLog"
        x-user-permission: "FullCompanyCallLog"
        x-access-level: "Advanced"
      delete:
        tags:
          - "Call Log"
        summary: "Delete Account Call Log Record(s) by ID"
        operationId: "deleteAccountCallLogRecord"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "accountId"
            in: "path"
            description: "Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"
            required: true
            type: "string"
            default: "~"
          -
            name: "callRecordId"
            in: "path"
            description: "Internal identifier of a call log record"
            required: true
            type: "integer"
        responses:
          default:
            description: "Success"
        x-api-group: "account/call-log"
        x-throttling-group: "Heavy"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "EditCallLog"
        x-user-permission: "FullCompanyCallLog"
    /restapi/v1.0/account/{accountId}/active-calls:
      get:
        tags:
          - "Call Log"
        summary: "Get User Active Calls"
        description: "<p style='font-style:italic;'>Since 1.0.13 (Release 6.5)</p><p>Returns records of all calls that are in progress, ordered by start time in descending order</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadCallLog</td><td>Viewing user call logs</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Heavy</p>"
        operationId: "listCompanyActiveCalls"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "accountId"
            in: "path"
            description: "Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"
            required: true
            type: "string"
            default: "~"
          -
            name: "direction"
            in: "query"
            description: "The direction for the result records. It is allowed to specify more than one direction. If not specified, both inbound and outbound records are returned. Multiple values are accepted"
            required: false
            type: "array"
            items:
              type: "string"
            collectionFormat: "multi"
            enum:
              - "Inbound"
              - "Outbound"
          -
            name: "type"
            in: "query"
            description: "Call type of a record. It is allowed to specify more than one type. If not specified, all call types are returned. Multiple values are accepted"
            required: false
            type: "array"
            items:
              type: "string"
            collectionFormat: "multi"
            enum:
              - "Voice"
              - "Fax"
          -
            name: "transport"
            in: "query"
            description: "Call transport type. 'PSTN' specifies that a call leg is initiated from the PSTN network provider; 'VoIP' - from an RC phone. By default this filter is disabled"
            required: false
            type: "array"
            items:
              type: "string"
            collectionFormat: "multi"
            enum:
              - "PSTN"
              - "VoIP"
          -
            name: "page"
            in: "query"
            description: "Indicates the page number to retrieve. Only positive number values are allowed. Default value is '1'"
            required: false
            type: "integer"
          -
            name: "perPage"
            in: "query"
            description: "Indicates the page size (number of items). If not specified, the value is '100' by default"
            required: false
            type: "integer"
        responses:
          default:
            description: "Success"
            schema:
              $ref: "#/definitions/ExtensionActiveCallsResponse"
        x-api-group: "company/active-calls"
        x-throttling-group: "Heavy"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "ReadCallLog"
        x-user-permission: "ReadCallLog"
        x-access-level: "Advanced"
    /restapi/v1.0/account/{accountId}/recording/{recordingId}:
      get:
        tags:
          - "Call Log"
        summary: "Get Call Recordings"
        description: "<p style='font-style:italic;'>Since 1.0.18 (Release 6.5)</p><p>Returns call recording metadata.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadCallRecording</td><td>Downloading call recording content</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Heavy</p>"
        operationId: "listCallRecordings"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "accountId"
            in: "path"
            description: "Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"
            required: true
            type: "string"
            default: "~"
          -
            name: "recordingId"
            in: "path"
            description: "Internal identifier of a recording (returned in Call Log)"
            required: true
            type: "string"
        responses:
          default:
            description: "Success"
            schema:
              $ref: "#/definitions/GetCallRecordingResponse"
        x-api-group: "account/recordings"
        x-throttling-group: "Heavy"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "ReadCallRecording"
        x-user-permission: "ReadCallRecording"
        x-access-level: "Public"
    /restapi/v1.0/account/{accountId}/recording/{recordingId}/content:
      get:
        tags:
          - "Call Log"
        summary: "Get Call Recordings Data"
        description: "<p style='font-style:italic;'>Since 1.0.16 (Release 7.1)</p><p>Returns call recording metadata.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadCallRecording</td><td>Downloading call recording content</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Heavy</p>"
        operationId: "listCallRecordingData"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "accountId"
            in: "path"
            description: "Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"
            required: true
            type: "string"
            default: "~"
          -
            name: "recordingId"
            in: "path"
            description: "Internal identifier of a recording (returned in Call Log)"
            required: true
            type: "string"
        responses:
          default:
            description: "Success"
            schema:
              $ref: "#/definitions/Binary"
        x-api-group: "account/recordings"
        x-throttling-group: "Heavy"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "ReadCallRecording"
        x-user-permission: "ReadCallRecording"
        x-access-level: "Public"
    /restapi/v1.0/account/{accountId}/extension/{extensionId}/phone-number:
      get:
        tags:
          - "Phone Numbers"
        summary: "Get Extension Phone Number List"
        description: "<p style='font-style:italic;'>Since 1.0.2</p><p>Returns the list of phone numbers that are used by a particular extension, and can be filtered by the phone number type. The returned list contains all numbers which are directly mapped to a given extension plus the features and also company-level numbers which may be used when performing different operations on behalf of this extension.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadAccounts</td><td>Viewing user account info (including name, business name, address and phone number/account number)</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Light</p>"
        operationId: "listExtensionPhoneNumbers"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "accountId"
            in: "path"
            description: "Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"
            required: true
            type: "string"
            default: "~"
          -
            name: "extensionId"
            in: "path"
            description: "Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session"
            required: true
            type: "string"
            default: "~"
          -
            name: "usageType"
            in: "query"
            description: "Usage type of the phone number"
            required: false
            type: "array"
            items:
              type: "string"
            collectionFormat: "multi"
            enum:
              - "MainCompanyNumber"
              - "AdditionalCompanyNumber"
              - "CompanyNumber"
              - "DirectNumber"
              - "CompanyFaxNumber"
              - "ForwardedNumber"
          -
            name: "page"
            in: "query"
            description: "Indicates the page number to retrieve. Only positive number values are allowed. Default value is '1'"
            required: false
            type: "integer"
          -
            name: "perPage"
            in: "query"
            description: "Indicates the page size (number of items). If not specified, the value is '100' by default"
            required: false
            type: "integer"
        responses:
          default:
            description: "Success"
            schema:
              $ref: "#/definitions/GetExtensionPhoneNumbersResponse"
        x-api-group: "extension/phone-number"
        x-throttling-group: "Light"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "ReadAccounts"
        x-user-permission: "ReadUserPhoneNumbers"
        x-access-level: "Public"
    /restapi/v1.0/account/{accountId}/extension/{extensionId}/sms:
      post:
        tags:
          - "Messages"
        summary: "Create SMS Message"
        description: "<p style='font-style:italic;'>Since 1.0.2</p><p>Creates and sends new SMS message. Sending SMS messages simultaneously to different recipients is limited up to 50 requests per minute; relevant for all client applications.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>SMS</td><td>Sending and receiving SMS (text) messages</td></tr><tr><td class='code'>ReadMessages</td><td>Viewing user messages</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Medium</p>"
        operationId: "sendSMS"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "accountId"
            in: "path"
            description: "Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"
            required: true
            type: "string"
            default: "~"
          -
            name: "extensionId"
            in: "path"
            description: "Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session"
            required: true
            type: "string"
            default: "~"
          -
            in: "body"
            name: "body"
            description: "JSON body"
            required: true
            schema:
              $ref: "#/definitions/CreateSMSMessage"
        responses:
          default:
            description: "Success"
            schema:
              $ref: "#/definitions/GetMessageInfoResponseIntId"
        x-api-group: "extension/sms"
        x-throttling-group: "Medium"
        x-metered-api: true
        x-metering-group: "Messaging"
        x-app-permission: "SMS"
        x-user-permission: "OutboundSMS"
        x-access-level: "Public"
    /restapi/v1.0/account/{accountId}/extension/{extensionId}/company-pager:
      post:
        tags:
          - "Messages"
        summary: "Create Pager Message"
        description: "<p style='font-style:italic;'>Since 1.0.2</p><p>Creates and sends a pager message.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>InternalMessages</td><td>Sending and receiving intra-company text messages</td></tr><tr><td class='code'>ReadMessages</td><td>Viewing user messages</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Medium</p>"
        operationId: "sendInternalMessage"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "accountId"
            in: "path"
            description: "Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"
            required: true
            type: "string"
            default: "~"
          -
            name: "extensionId"
            in: "path"
            description: "Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session"
            required: true
            type: "string"
            default: "~"
          -
            in: "body"
            name: "body"
            description: "JSON body"
            required: true
            schema:
              $ref: "#/definitions/CreatePagerMessageRequest"
        responses:
          default:
            description: "Success"
            schema:
              $ref: "#/definitions/GetMessageInfoResponse"
        x-api-group: "extension/company-pager"
        x-throttling-group: "Medium"
        x-metered-api: true
        x-metering-group: "Messaging"
        x-app-permission: "InternalMessages"
        x-user-permission: "InternalSMS"
        x-access-level: "Public"
    /restapi/v1.0/account/{accountId}/extension/{extensionId}/fax:
      post:
        tags:
          - "Messages"
        summary: "Create Fax Message"
        operationId: "sendFaxMessage"
        description: "<p style='font-style:italic;'>Since 1.0.2</p><p>Creates and sends/resends new fax message. Resend can be done if sending failed.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>Faxes</td><td>Sending and receiving faxes</td></tr><tr><td class='code'>ReadMessages</td><td>Viewing user messages</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Heavy</p>"
        consumes:
          - "multipart/form-data"
        produces:
          - "application/json"
        parameters:
          -
            name: "accountId"
            in: "path"
            description: "Internal identifier of a RingCentral account (integer) or tilde (~) to indicate the account which was logged-in within the current session."
            required: true
            type: "string"
            default: "~"
          -
            name: "extensionId"
            in: "path"
            description: "Internal identifier of an extension (integer) or tilde (~) to indicate the extension assigned to the account logged-in within the current session"
            required: true
            type: "string"
            default: "~"
          -
            name: "to"
            in: "formData"
            description: "To Phone Number"
            required: true
            type: "array"
            items:
              type: "string"
          -
            name: "attachment"
            in: "formData"
            description: "File to upload"
            required: false
            type: "file"
          -
            name: "faxResolution"
            in: "formData"
            description: "Resolution of Fax"
            required: false
            type: "string"
            enum:
             - High
             - Low
          -
            name: "sendTime"
            in: "formData"
            description: "Optional. Timestamp to send fax at. If not specified (current or the past), the fax is sent immediately"
            required: false
            type: "string"
            format: date-time
          -
            name: "isoCode"
            in: "formData"
            description: "ISO Code. e.g UK"
            required: false
            type: "string"
          -
            name: "coverIndex"
            in: "formData"
            description: "Cover page identifier. For the list of available cover page identifiers please call the method Fax Cover Pages. If not specified, the default cover page which is configured in 'Outbound Fax Settings' is attached"
            required: false
            type: "integer"
          -
            name: "coverPageText"
            in: "formData"
            description: "Cover page text, entered by the fax sender and printed on the cover page. Maximum length is limited to 1024 symbols"
            required: false
            type: "string"
        responses:
          default:
            description: "successful operation"
            schema:
              $ref: "#/definitions/FaxResponse"
        x-api-group: "extension/fax"
        x-throttling-group: "Heavy"
        x-metered-api: true
        x-metering-group: "Time-based"
        x-app-permission: "Faxes"
        x-user-permission: "OutboundFaxes"
        x-access-level: "Public"
    /restapi/v1.0/dictionary/fax-cover-page:
      get:
        tags:
          - "Messages"
        summary: "Get Fax Cover Pages"
        operationId: "getFaxCoverPages"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "page"
            in: "query"
            description: "Indicates the page number to retrieve. Only positive number values are allowed. Default value is '1'"
            required: false
            type: "integer"
          -
            name: "perPage"
            in: "query"
            description: "Indicates the page size (number of items). If not specified, the value is '100' by default"
            required: false
            type: "integer"
        responses:
          default:
            description: "successful operation"
        x-api-group: "dictionary/fax-cover-page"
        x-throttling-group: "Light"
        x-metered-api: true
        x-metering-group: "System"
        x-access-level: "Public"
    /restapi/v1.0/account/{accountId}/extension/{extensionId}/message-store:
      get:
        tags:
          - "Messages"
        summary: "Get Message List"
        description: "<p style='font-style:italic;'>Since 1.0.2</p><p>Returns the list of messages from an extension mailbox.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadMessages</td><td>Viewing user messages</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Light</p>"
        operationId: "listMessages"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "accountId"
            in: "path"
            description: "Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"
            required: true
            type: "string"
            default: "~"
          -
            name: "extensionId"
            in: "path"
            description: "Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session"
            required: true
            type: "string"
            default: "~"
          -
            name: "availability"
            in: "query"
            description: "Specifies the availability status for the resulting messages. Default value is 'Alive'. Multiple values are accepted"
            required: false
            type: "array"
            items:
              type: "string"
            collectionFormat: "multi"
            enum:
              - "Alive"
              - "Deleted"
              - "Purged"
          -
            name: "conversationId"
            in: "query"
            description: "Specifies the conversation identifier for the resulting messages"
            required: false
            type: "integer"
          -
            name: "dateFrom"
            in: "query"
            description: "The start datetime for resulting messages in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z. The default value is dateTo minus 24 hours"
            required: false
            type: "string"
            format: "date-time"
          -
            name: "dateTo"
            in: "query"
            description: "The end datetime for resulting messages in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z. The default value is current time"
            required: false
            type: "string"
            format: "date-time"
          -
            name: "direction"
            in: "query"
            description: "The direction for the resulting messages. If not specified, both inbound and outbound messages are returned. Multiple values are accepted"
            required: false
            type: "array"
            items:
              type: "string"
            collectionFormat: "multi"
            enum:
              - "Inbound"
              - "Outbound"
          -
            name: "distinctConversations"
            in: "query"
            description: "If 'True', then the latest messages per every conversation ID are returned"
            required: false
            type: "boolean"
          -
            name: "messageType"
            in: "query"
            description: "The type of the resulting messages. If not specified, all messages without message type filtering are returned. Multiple values are accepted"
            required: false
            type: "array"
            items:
              type: "string"
            collectionFormat: "multi"
            enum:
              - "Fax"
              - "SMS"
              - "VoiceMail"
              - "Pager"
              - "Text"
          -
            name: "readStatus"
            in: "query"
            description: "The read status for the resulting messages. Multiple values are accepted"
            required: false
            type: "array"
            items:
              type: "string"
            collectionFormat: "multi"
            enum:
              - "Read"
              - "Unread"
          -
            name: "page"
            in: "query"
            description: "Indicates the page number to retrieve. Only positive number values are allowed. Default value is '1'"
            required: false
            type: "integer"
          -
            name: "perPage"
            in: "query"
            description: "Indicates the page size (number of items). If not specified, the value is '100' by default"
            required: false
            type: "integer"
          -
            name: "phoneNumber"
            in: "query"
            description: "The phone number. If specified, messages are returned for this particular phone number only"
            required: false
            type: "string"
        responses:
          default:
            description: "Success"
            schema:
              $ref: "#/definitions/GetMessageList"
        x-api-group: "extension/message-store"
        x-throttling-group: "Light"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "ReadMessages"
        x-user-permission: "ReadMessages"
        x-access-level: "Public"
      delete:
        tags:
          - "Messages"
        summary: "Delete Conversations by ID's"
        operationId: "deleteMessagesByFilter"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "conversationId"
            in: "query"
            required: false
            type: "array"
            items:
              type: "string"
            collectionFormat: "multi"
          -
            name: "extensionId"
            in: "path"
            required: true
            type: "string"
          -
            name: "accountId"
            in: "path"
            required: true
            type: "string"
        responses:
          default:
            description: "successful operation"
        x-api-group: "extension/message-store"
        x-throttling-group: "Medium"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "EditMessages"
        x-user-permission: "EditMessages"
        x-access-level: "Public"
    /restapi/v1.0/account/{accountId}/extension/{extensionId}/message-store/{messageId}:
      get:
        tags:
          - "Messages"
        summary: "Get Message(s) by ID"
        description: "<p style='font-style:italic;'>Since 1.0.2</p><p>Returns individual message record(s) by the given message ID(s). The length of inbound messages is unlimited. Batch request is supported, see Batch Requests for details.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadMessages</td><td>Viewing user messages</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Light</p>"
        operationId: "loadMessage"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "accountId"
            in: "path"
            description: "Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"
            required: true
            type: "string"
            default: "~"
          -
            name: "extensionId"
            in: "path"
            description: "Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session"
            required: true
            type: "string"
            default: "~"
          -
            name: "messageId"
            in: "path"
            description: "Internal identifier of a message"
            required: true
            type: "integer"
        responses:
          default:
            description: "Success"
            schema:
              $ref: "#/definitions/GetMessageInfoResponse"
        x-api-group: "extension/message-store"
        x-throttling-group: "Light"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "ReadMessages"
        x-user-permission: "ReadMessages"
        x-access-level: "Public"
      put:
        tags:
          - "Messages"
        summary: "Update Message(s) by ID"
        description: "<p style='font-style:italic;'>Since 1.0.2</p><p>Updates message(s) by ID(s). Batch request is supported, see Batch Requests for details. Currently, only the message read status updating is supported.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>EditMessages</td><td>Viewing and updating user messages</td></tr><tr><td class='code'>ReadMessages</td><td>Viewing user messages</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Medium</p>"
        operationId: "updateMessage"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "accountId"
            in: "path"
            description: "Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"
            required: true
            type: "string"
            default: "~"
          -
            name: "extensionId"
            in: "path"
            description: "Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session"
            required: true
            type: "string"
            default: "~"
          -
            name: "messageId"
            in: "path"
            description: "Internal identifier of a message"
            required: true
            type: "integer"
          -
            in: "body"
            name: "body"
            description: "JSON body"
            required: true
            schema:
              $ref: "#/definitions/UpdateMessageRequest"
        responses:
          default:
            description: "Success"
            schema:
              $ref: "#/definitions/GetMessageInfoResponse"
        x-api-group: "extension/message-store"
        x-throttling-group: "Medium"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "EditMessages"
        x-user-permission: "EditMessages"
        x-access-level: "Public"
      delete:
        tags:
          - "Messages"
        summary: "Delete Message(s) by ID"
        description: "<p style='font-style:italic;'></p><p>Deletes message(s) by the given message ID(s). The first call of this method transfers the message to the 'Delete' status. The second call transfers the deleted message to the 'Purged' status. If it is required to make the message 'Purged' immediately (from the first call), then set the query parameter purge to 'True'.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>EditMessages</td><td>Viewing and updating user messages</td></tr><tr><td class='code'>ReadMessages</td><td>Viewing user messages</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Medium</p>"
        operationId: "deleteMessage"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "accountId"
            in: "path"
            description: "Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"
            required: true
            type: "string"
            default: "~"
          -
            name: "extensionId"
            in: "path"
            description: "Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session"
            required: true
            type: "string"
            default: "~"
          -
            name: "messageId"
            in: "path"
            description: "Internal identifier of a message"
            required: true
            type: "integer"
          -
            name: "purge"
            in: "query"
            description: "If the value is 'True', then the message is purged immediately with all the attachments. The default value is 'False'"
            required: false
            type: "boolean"
          -
            name: "conversationId"
            in: "query"
            description: "Internal identifier of a message thread"
            required: false
            type: "integer"
        responses:
          default:
            description: "Success"
        x-api-group: "extension/message-store"
        x-throttling-group: "Medium"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "EditMessages"
        x-user-permission: "EditMessages"
        x-access-level: "Public"
    /restapi/v1.0/account/{accountId}/extension/{extensionId}/message-store/{messageId}/content/{attachmentId}:
      get:
        tags:
          - "Messages"
        summary: "Get Message Attachment"
        description: "<p style='font-style:italic;'>Since 1.0.4 (Release 5.13)</p><p>Returns particular message attachment data as a media stream.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadMessages</td><td>Viewing user messages</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Medium</p>"
        operationId: "loadMessageAttachment"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "accountId"
            in: "path"
            description: "Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"
            required: true
            type: "string"
            default: "~"
          -
            name: "extensionId"
            in: "path"
            description: "Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session"
            required: true
            type: "string"
            default: "~"
          -
            name: "attachmentId"
            in: "path"
            description: "Internal identifier of a message attachment"
            required: true
            type: "integer"
          -
            name: "messageId"
            in: "path"
            description: "Internal identifier of a message"
            required: true
            type: "integer"
          -
            name: "Range"
            in: "header"
            required: false
            type: "string"
        responses:
          default:
            description: "Success"
        x-api-group: "extension/message-store/content"
        x-throttling-group: "Medium"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "ReadMessages"
        x-user-permission: "ReadMessageContent"
        x-access-level: "Public"
    /restapi/v1.0/account/{accountId}/extension/{extensionId}/message-sync:
      get:
        tags:
          - "Messages"
        summary: "Get Message Sync"
        description: "<p style='font-style:italic;'>Since 1.0.4 (Release 5.13)</p><p>Provides facilities to synchronize mailbox content stored externally with server state.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadMessages</td><td>Viewing user messages</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Light</p>"
        operationId: "syncMessages"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "accountId"
            in: "path"
            description: "Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"
            required: true
            type: "string"
            default: "~"
          -
            name: "extensionId"
            in: "path"
            description: "Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session"
            required: true
            type: "string"
            default: "~"
          -
            name: "conversationId"
            in: "query"
            description: "Conversation identifier for the resulting messages. Meaningful for SMS and Pager messages only."
            required: false
            type: "integer"
          -
            name: "dateFrom"
            in: "query"
            description: "The start datetime for resulting messages in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z. The default value is dateTo minus 24 hours"
            required: false
            type: "string"
          -
            name: "dateTo"
            in: "query"
            description: "The end datetime for resulting messages in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z. The default value is current time"
            required: false
            type: "string"
          -
            name: "direction"
            in: "query"
            description: "Direction for the resulting messages. If not specified, both inbound and outbound messages are returned. Multiple values are accepted"
            required: false
            type: "array"
            items:
              type: "string"
            collectionFormat: "multi"
            enum:
              - "Inbound"
              - "Outbound"
          -
            name: "distinctConversations"
            in: "query"
            description: "If 'True', then the latest messages per every conversation ID are returned"
            required: false
            type: "boolean"
          -
            name: "messageType"
            in: "query"
            description: "Type for the resulting messages. If not specified, all types of messages are returned. Multiple values are accepted"
            required: false
            type: "array"
            items:
              type: "string"
            collectionFormat: "multi"
            enum:
              - "Fax"
              - "SMS"
              - "VoiceMail"
              - "Pager"
              - "Text"
          -
            name: "recordCount"
            in: "query"
            description: "Limits the number of records to be returned (works in combination with dateFrom and dateTo if specified)"
            required: false
            type: "integer"
          -
            name: "syncToken"
            in: "query"
            description: "Value of syncToken property of last sync request response"
            required: false
            type: "string"
          -
            name: "syncType"
            in: "query"
            description: "Type of message synchronization"
            required: false
            type: "array"
            items:
              type: "string"
            collectionFormat: "multi"
            enum:
              - "FSync"
              - "ISync"
        responses:
          default:
            description: "Success"
            schema:
              $ref: "#/definitions/GetMessageSyncResponse"
        x-api-group: "extension/message-sync"
        x-throttling-group: "Light"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "ReadMessages"
        x-user-permission: "ReadMessages"
        x-access-level: "Public"
    /restapi/v1.0/account/{accountId}/extension/{extensionId}/ringout:
      post:
        tags:
          - "RingOut"
        summary: "Make RingOut Call"
        deprecated: true
        description: "<p style='font-style:italic;'>Since 1.0.7 (Release 5.16)</p><p>Makes a 2-leg RingOut call.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>RingOut</td><td>Performing two-legged ring-out phone calls</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Heavy</p>"
        operationId: "makeRingOutCall"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "accountId"
            in: "path"
            description: "Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"
            required: true
            type: "string"
            default: "~"
          -
            name: "extensionId"
            in: "path"
            description: "Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session"
            required: true
            type: "string"
            default: "~"
          -
            in: "body"
            name: "body"
            description: "JSON body"
            required: true
            schema:
              $ref: "#/definitions/MakeRingOutRequest"
        responses:
          default:
            description: "Success"
            schema:
              $ref: "#/definitions/GetRingOutStatusResponseIntId"
        x-api-group: "extension/ringout"
        x-throttling-group: "Heavy"
        x-metered-api: true
        x-metering-group: "Time-based"
        x-app-permission: "RingOut"
        x-access-level: "Public"
    /restapi/v1.0/account/{accountId}/extension/{extensionId}/ringout/direct:
      post:
        tags:
          - "RingOut"
        deprecated: true
        operationId: "createDirectRingOut"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "accountId"
            in: "path"
            required: true
            type: "string"
          -
            name: "extensionId"
            in: "path"
            required: true
            type: "string"
          -
            in: "body"
            name: "body"
            required: true
            schema:
              $ref: "#/definitions/RingOutResource"
        responses:
          default:
            description: "successful operation"
        x-api-group: "extension/ringout/direct"
        x-throttling-group: "Heavy"
        x-metered-api: true
        x-metering-group: "Time-based"
        x-app-permission: "DirectRingOut"
        x-access-level: "Internal"
    /restapi/v1.0/account/{accountId}/extension/{extensionId}/ringout/{ringoutId}:
      get:
        tags:
          - "RingOut"
        deprecated: true
        summary: "Get Status of RingOut Call"
        description: "<p style='font-style:italic;'>Since 1.0.7 (Release 5.16)</p><p>Returns the status of a 2-leg RingOut call.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>RingOut</td><td>Performing two-legged ring-out phone calls</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Light</p>"
        operationId: "getRingOutCallStatus"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "accountId"
            in: "path"
            description: "Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"
            required: true
            type: "string"
            default: "~"
          -
            name: "extensionId"
            in: "path"
            description: "Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session"
            required: true
            type: "string"
            default: "~"
          -
            name: "ringoutId"
            in: "path"
            description: "Internal identifier of a RingOut call"
            required: true
            type: "integer"
        responses:
          default:
            description: "Success"
            schema:
              $ref: "#/definitions/GetRingOutStatusResponse"
        x-api-group: "extension/ringout"
        x-throttling-group: "Light"
        x-metered-api: true
        x-metering-group: "Time-based"
        x-app-permission: "RingOut"
        x-access-level: "Public"
      delete:
        tags:
          - "RingOut"
        deprecated: true
        summary: "Cancel RingOut Call"
        description: "<p style='font-style:italic;'></p><p>Cancels the 2-leg RingOut call.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>RingOut</td><td>Performing two-legged ring-out phone calls</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Heavy</p>"
        operationId: "cancelRingOutCall"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "accountId"
            in: "path"
            description: "Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"
            required: true
            type: "string"
            default: "~"
          -
            name: "extensionId"
            in: "path"
            description: "Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session"
            required: true
            type: "string"
            default: "~"
          -
            name: "ringoutId"
            in: "path"
            description: "Internal identifier of a RingOut call"
            required: true
            type: "integer"
        responses:
          default:
            description: "Success"
        x-api-group: "extension/ringout"
        x-throttling-group: "Heavy"
        x-metered-api: true
        x-metering-group: "Time-based"
        x-app-permission: "RingOut"
        x-access-level: "Public"
    /restapi/v1.0/account/{accountId}/extension/{extensionId}/ring-out:
      post:
        tags:
          - "RingOut"
        summary: "Make RingOut Call"
        description: "<p style='font-style:italic;'>Since 1.0.7 (Release 5.16)</p><p>Makes a 2-leg RingOut call.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>RingOut</td><td>Performing two-legged ring-out phone calls</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Heavy</p>"
        operationId: "makeRingOutCallNew"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "accountId"
            in: "path"
            description: "Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"
            required: true
            type: "string"
            default: "~"
          -
            name: "extensionId"
            in: "path"
            description: "Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session"
            required: true
            type: "string"
            default: "~"
          -
            in: "body"
            name: "body"
            description: "JSON body"
            required: true
            schema:
              $ref: "#/definitions/MakeRingOutRequest"
        responses:
          default:
            description: "Success"
            schema:
              $ref: "#/definitions/GetRingOutStatusResponse"
        x-api-group: "extension/ringout"
        x-throttling-group: "Heavy"
        x-metered-api: true
        x-metering-group: "Time-based"
        x-app-permission: "RingOut"
        x-access-level: "Public"
    /restapi/v1.0/account/{accountId}/extension/{extensionId}/direct-ring-out:
      post:
        tags:
          - "RingOut"
        summary: "Make Direct RingOut Call"
        operationId: "createDirectRingOutNew"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "accountId"
            in: "path"
            required: true
            type: "string"
          -
            name: "extensionId"
            in: "path"
            required: true
            type: "string"
          -
            in: "body"
            name: "body"
            required: true
            schema:
              $ref: "#/definitions/RingOutResource"
        responses:
          default:
            description: "successful operation"
        x-api-group: "extension/ringout/direct"
        x-throttling-group: "Heavy"
        x-metered-api: true
        x-metering-group: "Time-based"
        x-app-permission: "DirectRingOut"
        x-access-level: "Internal"
    /restapi/v1.0/account/{accountId}/extension/{extensionId}/ring-out/{ringoutId}:
      get:
        tags:
          - "RingOut"
        summary: "Get Status of RingOut Call"
        description: "<p style='font-style:italic;'>Since 1.0.7 (Release 5.16)</p><p>Returns the status of a 2-leg RingOut call.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>RingOut</td><td>Performing two-legged ring-out phone calls</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Light</p>"
        operationId: "getRingOutCallStatusNew"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "accountId"
            in: "path"
            description: "Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"
            required: true
            type: "string"
            default: "~"
          -
            name: "extensionId"
            in: "path"
            description: "Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session"
            required: true
            type: "string"
            default: "~"
          -
            name: "ringoutId"
            in: "path"
            description: "Internal identifier of a RingOut call"
            required: true
            type: "integer"
        responses:
          default:
            description: "Success"
            schema:
              $ref: "#/definitions/GetRingOutStatusResponse"
        x-api-group: "extension/ringout"
        x-throttling-group: "Light"
        x-metered-api: true
        x-metering-group: "Time-based"
        x-app-permission: "RingOut"
        x-access-level: "Public"
      delete:
        tags:
          - "RingOut"
        summary: "Cancel RingOut Call"
        description: "<p style='font-style:italic;'></p><p>Cancels the 2-leg RingOut call.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>RingOut</td><td>Performing two-legged ring-out phone calls</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Heavy</p>"
        operationId: "cancelRingOutCallNew"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "accountId"
            in: "path"
            description: "Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"
            required: true
            type: "string"
            default: "~"
          -
            name: "extensionId"
            in: "path"
            description: "Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session"
            required: true
            type: "string"
            default: "~"
          -
            name: "ringoutId"
            in: "path"
            description: "Internal identifier of a RingOut call"
            required: true
            type: "integer"
        responses:
          default:
            description: "Success"
        x-api-group: "extension/ringout"
        x-throttling-group: "Heavy"
        x-metered-api: true
        x-metering-group: "Time-based"
        x-app-permission: "RingOut"
        x-access-level: "Public"
    /restapi/v1.0/account/{accountId}/extension/{extensionId}/address-book/contact:
      get:
        tags:
          - "User Contacts"
        summary: "Get Contacts"
        description: "<p style='font-style:italic;'></p><p></p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadContacts</td><td>Viewing user personal contacts</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Heavy</p>"
        operationId: "listContacts"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "accountId"
            in: "path"
            description: "Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"
            required: true
            type: "string"
            default: "~"
          -
            name: "extensionId"
            in: "path"
            description: "Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session"
            required: true
            type: "string"
            default: "~"
          -
            name: "startsWith"
            in: "query"
            description: "If specified, only contacts whose First name or Last name start with the mentioned substring are returned. Case-insensitive"
            required: false
            type: "string"
          -
            name: "sortBy"
            in: "query"
            description: "Sorts results by the specified property. The default is 'First Name'"
            required: false
            type: "array"
            items:
              type: "string"
            collectionFormat: "multi"
            enum:
              - "FirstName"
              - "LastName"
              - "Company"
          -
            name: "page"
            in: "query"
            description: "Indicates the page number to retrieve. Only positive number values are allowed. Default value is '1'"
            required: false
            type: "integer"
          -
            name: "perPage"
            in: "query"
            description: "Indicates the page size (number of items). If not specified, the value is '100' by default"
            required: false
            type: "integer"
          -
            name: "phoneNumber"
            in: "query"
            required: false
            type: "array"
            items:
              type: "string"
            collectionFormat: "multi"
        responses:
          default:
            description: "Success"
            schema:
              $ref: "#/definitions/ContactList"
        x-api-group: "extension/address-book/contact"
        x-throttling-group: "Heavy"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "ReadContacts"
        x-user-permission: "ReadPersonalContacts"
        x-access-level: "Public"
      post:
        tags:
          - "User Contacts"
        summary: "Create Contact"
        description: "<p style='font-style:italic;'></p><p></p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>Contacts</td><td>Creating, viewing, editing and deleting user personal contacts</td></tr><tr><td class='code'>ReadContacts</td><td>Viewing user personal contacts</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Heavy</p>"
        operationId: "createContact"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "accountId"
            in: "path"
            description: "Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"
            required: true
            type: "string"
            default: "~"
          -
            name: "extensionId"
            in: "path"
            description: "Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session"
            required: true
            type: "string"
            default: "~"
          -
            in: "body"
            name: "body"
            required: false
            schema:
              $ref: "#/definitions/PersonalContactResource"
        responses:
          default:
            description: "Success"
            schema:
              $ref: "#/definitions/PersonalContactResource"
        x-api-group: "extension/address-book/contact"
        x-throttling-group: "Heavy"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "Contacts"
        x-user-permission: "EditPersonalContacts"
        x-access-level: "Public"
    /restapi/v1.0/account/{accountId}/extension/{extensionId}/address-book/contact/{contactId}:
      get:
        tags:
          - "User Contacts"
        summary: "Get Contact(s) by ID"
        description: "<p style='font-style:italic;'></p><p></p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadContacts</td><td>Viewing user personal contacts</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Heavy</p>"
        operationId: "loadContact"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "accountId"
            in: "path"
            description: "Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"
            required: true
            type: "string"
            default: "~"
          -
            name: "extensionId"
            in: "path"
            description: "Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session"
            required: true
            type: "string"
            default: "~"
          -
            name: "contactId"
            in: "path"
            description: "Internal identifier of a contact record in the RingCentral database"
            required: true
            type: "integer"
        responses:
          default:
            description: "Success"
            schema:
              $ref: "#/definitions/PersonalContactResource"
        x-api-group: "extension/address-book/contact"
        x-throttling-group: "Heavy"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "ReadContacts"
        x-user-permission: "ReadPersonalContacts"
        x-access-level: "Public"
      put:
        tags:
          - "User Contacts"
        summary: "Update Contact(s) by ID"
        description: "<p style='font-style:italic;'></p><p></p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>Contacts</td><td>Creating, viewing, editing and deleting user personal contacts</td></tr><tr><td class='code'>ReadContacts</td><td>Viewing user personal contacts</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Heavy</p>"
        operationId: "updateContact"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "accountId"
            in: "path"
            description: "Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"
            required: true
            type: "string"
            default: "~"
          -
            name: "extensionId"
            in: "path"
            description: "Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session"
            required: true
            type: "string"
            default: "~"
          -
            name: "contactId"
            in: "path"
            description: "Internal identifier of a contact record in the RingCentral database"
            required: true
            type: "integer"
          -
            in: "body"
            name: "body"
            required: false
            schema:
              $ref: "#/definitions/PersonalContactResource"
        responses:
          default:
            description: "Success"
            schema:
              $ref: "#/definitions/PersonalContactResource"
        x-api-group: "extension/address-book/contact"
        x-throttling-group: "Heavy"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "Contacts"
        x-user-permission: "EditPersonalContacts"
        x-access-level: "Public"
      delete:
        tags:
          - "User Contacts"
        summary: "Delete Contact(s) by ID"
        description: "<p style='font-style:italic;'></p><p></p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>Contacts</td><td>Creating, viewing, editing and deleting user personal contacts</td></tr><tr><td class='code'>ReadContacts</td><td>Viewing user personal contacts</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Heavy</p>"
        operationId: "deleteContact"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "accountId"
            in: "path"
            description: "Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"
            required: true
            type: "string"
            default: "~"
          -
            name: "extensionId"
            in: "path"
            description: "Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session"
            required: true
            type: "string"
            default: "~"
          -
            name: "contactId"
            in: "path"
            description: "Internal identifier of a contact record in the RingCentral database"
            required: true
            type: "integer"
        responses:
          default:
            description: "Success"
        x-api-group: "extension/address-book/contact"
        x-throttling-group: "Heavy"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "Contacts"
        x-user-permission: "EditPersonalContacts"
        x-access-level: "Public"
    /restapi/v1.0/account/{accountId}/extension/{extensionId}/address-book-sync:
      get:
        tags:
          - "User Contacts"
        summary: "Address Book Synchronization"
        description: "<p style='font-style:italic;'></p><p></p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadContacts</td><td>Viewing user personal contacts</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Heavy</p>"
        operationId: "syncAddressBook"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "accountId"
            in: "path"
            description: "Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"
            required: true
            type: "string"
            default: "~"
          -
            name: "extensionId"
            in: "path"
            description: "Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session"
            required: true
            type: "string"
            default: "~"
          -
            name: "syncType"
            in: "query"
            description: "Type of synchronization. The default value is 'FSync'"
            required: false
            type: "array"
            items:
              type: "string"
            collectionFormat: "multi"
            enum:
              - "FSync"
              - "ISync"
          -
            name: "syncToken"
            in: "query"
            description: "Value of syncToken property of the last sync request response"
            required: false
            type: "string"
          -
            name: "perPage"
            in: "query"
            description: "Number of records per page to be returned. The max number of records is 250, which is also the default. For FSync ??? if the number of records exceeds the parameter value (either specified or default), all of the pages can be retrieved in several requests. For ISync ??? if the number of records exceeds the page size, the number of incoming changes to this number is limited"
            required: false
            type: "integer"
          -
            name: "pageId"
            in: "query"
            description: "Internal identifier of a page. It can be obtained from the 'nextPageId' parameter passed in response body"
            required: false
            type: "integer"
        responses:
          default:
            description: "Success"
            schema:
              $ref: "#/definitions/AddressBookSync"
        x-api-group: "extension/address-book-sync"
        x-throttling-group: "Heavy"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "ReadContacts"
        x-user-permission: "ReadPersonalContacts"
        x-access-level: "Advanced"
    /restapi/v1.0/account/{accountId}/extension/{extensionId}/favorite:
      get:
        tags:
          - "User Contacts"
        summary: "Get Favorite Contacts"
        operationId: "contactFavorite"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "accountId"
            in: "path"
            description: "Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"
            required: true
            type: "string"
            default: "~"
          -
            name: "extensionId"
            in: "path"
            description: "Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session"
            required: true
            type: "string"
            default: "~"
        responses:
          default:
            description: "successful operation"
        x-api-group: "extension/favorite"
        x-throttling-group: "Light"
        x-metered-api: true
        x-metering-group: "System"
        x-user-permission: "ReadPersonalContacts"
        x-app-permission: "ReadContacts"
        x-access-level: "Public"
      put:
        tags:
          - "User Contacts"
        summary: "Update Favorite Contacts"
        operationId: "createContacts"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "accountId"
            in: "path"
            description: "Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"
            required: true
            type: "string"
            default: "~"
          -
            name: "extensionId"
            in: "path"
            description: "Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session"
            required: true
            type: "string"
            default: "~"
          -
            in: "body"
            name: "body"
            required: false
            schema:
              $ref: "#/definitions/FavoriteCollection"
        responses:
          default:
            description: "successful operation"
        x-api-group: "extension/favorite"
        x-throttling-group: "Medium"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "Contacts"
        x-user-permission: "EditPersonalContacts"
        x-access-level: "Public"
    /restapi/v1.0/account/{accountId}/directory/contacts:
      get:
        tags:
          - "Company Contacts"
        summary: "Get Company Directory"
        operationId: "listCompanyDirectoryContacts"
        description: "<p style='font-style:italic;'></p><p>Returns contact information on corporate users of federated accounts. Please note: 1. User, DigitalUser, VirtualUser and FaxUser types are returned as User type. 2.ApplicationExtension type is not returned. 3. Only extensions in Enabled, Disabled and NotActivated state are returned.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadAccounts</td><td>Viewing user account info (including name, business name, address and phone number/account number)</td></tr></tbody></table><h4>API Group</h4><p>Medium</p>"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "accountId"
            type: "string"
            in: "path"
            description: "Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"
            required: true
            default: "~"
          -
            name: "page"
            type: "integer"
            format: "int64"
            in: "query"
            description: "Indicates the page number to retrieve. Only positive number values are allowed. Default value is '1'"
            required: false
          -
            name: "perPage"
            type: "integer"
            format: "int64"
            in: "query"
            description: "Indicates the page size (number of items). The possible values are: Max, all or a numeric value. If not specified, all records are returned on one page"
            required: false
          -
            name: "excludeFederatedContacts"
            type: "boolean"
            in: "query"
            description: "If 'True' then only contacts of current account are returned, if 'False' then all contacts of all federation accounts are returned"
            required: false
        responses:
          default:
            description: "Success"
            schema:
              $ref: "#/definitions/CompanyDirectoryContacts"
        x-api-group: "directory/contacts"
        x-throttling-group: "Medium"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "ReadContacts"
        x-user-permission: "AddRemoveContacts"
        x-access-level: "Advanced"
    /restapi/v1.0/account/{accountId}/directory/contacts/{contactId}:
      get:
        tags:
          - "Company Contacts"
        summary: "Get Company Directory Contact"
        operationId: "loadCompanyDirectoryContact"
        description: "<p style='font-style:italic;'></p><p>Returns contact information on a particular corporate user of a federated account.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadAccounts</td><td>Viewing user account info (including name, business name, address and phone number/account number)</td></tr></tbody></table><h4>API Group</h4><p>Medium</p>"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "accountId"
            type: "string"
            in: "path"
            description: "Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"
            required: true
            default: "~"
          -
            name: "contactId"
            type: "string"
            in: "path"
            description: "Internal identifier of an extension"
            required: true
        responses:
          default:
            description: "Success"
            schema:
              $ref: "#/definitions/ContactInfo"
        x-api-group: "directory/contacts"
        x-throttling-group: "Medium"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "ReadContacts"
        x-user-permission: "AddRemoveContacts"
        x-access-level: "Advanced"
    /restapi/v1.0/account/{accountId}/directory/federation:
      get:
        tags:
          - "Company Contacts"
        summary: "Get Account Federation"
        operationId: "loadCompanyDirectoryFederation"
        description: "<p style='font-style:italic;'></p><p>Returns information on a federation and associated accounts.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadAccounts</td><td>Viewing user account info (including name, business name, address and phone number/account number)</td></tr></tbody></table><h4>API Group</h4><p>Medium</p>"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "accountId"
            type: "string"
            in: "path"
            description: "Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"
            required: true
            default: "~"
        responses:
          default:
            description: "Success"
            schema:
              $ref: "#/definitions/FederationInfo"
        x-api-group: "directory/federation"
        x-throttling-group: "Medium"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "ReadContacts"
        x-user-permission: "AddRemoveContacts"
        x-access-level: "Advanced"
    /restapi/v1.0/account/{accountId}/directory/federation-conflicts:
      get:
        tags:
          - "Company Contacts"
        summary: "Get Account Federation Conflicts"
        operationId: "loadCompanyDirectoryFederationConflicts"
        description: "<p style='font-style:italic;'></p><p>Returns the list of federation extensions which numbers are conflicting with extension numbers of the requested account.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadAccounts</td><td>Viewing user account info (including name, business name, address and phone number/account number)</td></tr></tbody></table><h4>API Group</h4><p>Heavy</p>"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "accountId"
            type: "string"
            in: "path"
            description: "Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"
            required: true
            default: "~"
        responses:
          default:
            description: "Success"
            schema:
              $ref: "#/definitions/FederationConflicts"
        x-api-group: "directory/FederationConflicts"
        x-throttling-group: "Medium"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "ReadContacts"
        x-user-permission: "AddRemoveContacts"
        x-access-level: "Internal"
    /restapi/v1.0/account/{accountId}/directory/extension-numbers:
      get:
        tags:
          - "Company Contacts"
        summary: "Get Existing Extension Numbers"
        operationId: "loadCompanyDirectoryExtensionNumbers"
        description: "<p style='font-style:italic;'></p><p>Returns the list of account federation extensions.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadAccounts</td><td>Viewing user account info (including name, business name, address and phone number/account number)</td></tr></tbody></table><h4>API Group</h4><p>Heavy</p>"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "accountId"
            type: "string"
            in: "path"
            description: "Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"
            required: true
            default: "~"
        responses:
          default:
            description: "Success"
            schema:
              $ref: "#/definitions/FederationExtensionNumbers"
        x-api-group: "directory/extension-numbers"
        x-throttling-group: "Medium"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "ReadContacts"
        x-user-permission: "AddRemoveContacts"
        x-access-level: "Internal"
    /restapi/v1.0/account/{accountId}/extension:
      get:
        tags:
          - "Company Contacts"
        summary: "Get Extensions"
        operationId: "listExtensions"
        description: "<p style='font-style:italic;'>Since 1.0.0</p><p>Returns the list of extensions created for a particular account. All types of extensions are included in this list.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadAccounts</td><td>Viewing user account info (including name, business name, address and phone number/account number)</td></tr></tbody></table><h4>API Group</h4><p>Medium</p>"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "accountId"
            type: "string"
            in: "path"
            description: "Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"
            required: true
            default: "~"
          -
            name: "page"
            type: "integer"
            format: "int64"
            in: "query"
            description: "Indicates the page number to retrieve. Only positive number values are allowed. Default value is '1'"
            required: false
          -
            name: "perPage"
            type: "integer"
            format: "int64"
            in: "query"
            description: "Indicates the page size (number of items). If not specified, the value is '100' by default."
            required: false
          -
            name: "status"
            type: "array"
            items:
              type: "string"
            collectionFormat: "multi"
            allowEmptyValue: true
            enum:
              - "Enabled"
              - "Disabled"
              - "NotActivated"
              - "Unassigned"
            in: "query"
            description: "Extension current state. Multiple values are supported. If 'Unassigned' is specified, then extensions without extensionNumber are returned. If not specified, then all extensions are returned"
            required: false
          -
            name: "type"
            type: "array"
            items:
              type: "string"
            collectionFormat: "multi"
            allowEmptyValue: true
            enum:
              - "User"
              - "FaxUser"
              - "VirtualUser"
              - "DigitalUser"
              - "Department"
              - "Announcement"
              - "Voicemail"
              - "SharedLinesGroup"
              - "PagingOnly"
              - "IvrMenu"
              - "ApplicationExtension"
              - "ParkLocation"
              - "Limited"
              - "Bot"
            in: "query"
            description: "Extension type. Multiple values are supported"
            required: false
        responses:
          default:
            description: "Success"
            schema:
              $ref: "#/definitions/GetExtensionListResponse"
        x-api-group: "extension"
        x-throttling-group: "Medium"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "ReadAccounts"
        x-user-permission: "ReadExtensions"
        x-access-level: "Public"
      post:
        tags:
          - "Company Contacts"
        summary: "Create Extension"
        operationId: "createExtension"
        description: "<p style='font-style:italic;'>Since 1.0.10 (Release 6.2)</p><p>Creates an extension.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>EditAccounts</td><td>Viewing and updating user account info (including name, business name, address and phone number/account number)</td></tr></tbody></table><h4>API Group</h4><p>Medium</p>"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "accountId"
            type: "string"
            in: "path"
            description: "Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"
            required: true
            default: "~"
          -
            name: "body"
            in: "body"
            description: "JSON body"
            schema:
              $ref: "#/definitions/ExtensionCreationRequest"
            required: true
        responses:
          default:
            description: "Success"
            schema:
              $ref: "#/definitions/ExtensionInfo"
        x-api-group: "extension"
        x-throttling-group: "Medium"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "EditAccounts"
        x-user-permission: "AddRemoveUsers"
        x-access-level: "Advanced"
    /restapi/v1.0/account/{accountId}/bot:
      post:
        tags:
          - "Company Contacts"
        summary: "Create Bot Extension"
        operationId: "createBotExtension"
        description: "<p style='font-style:italic;'>Since 1.0.32 (Release 9.3)</p><p>Creates a bot extension. Please note: Bot extension is always created in Enabled status, no welcome email is sent.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>EditAccounts</td><td>Viewing and updating user account info (including name, business name, address and phone number/account number)</td></tr></tbody></table><h4>API Group</h4><p>Medium</p>"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "accountId"
            type: "string"
            in: "path"
            description: "Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"
            required: true
            default: "~"
          -
            name: "body"
            in: "body"
            description: "JSON body"
            schema:
              $ref: "#/definitions/BotExtensionCreationRequest"
            required: true
        responses:
          default:
            description: "Success"
            schema:
              $ref: "#/definitions/BotExtensionCreation"
        x-api-group: "bot"
        x-throttling-group: "Medium"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "EditAccounts"
        x-user-permission: "AddRemoveUsers"
        x-access-level: "Advanced"
    /restapi/v1.0/account/{accountId}/presence:
      get:
        tags:
          - "Presence"
        summary: "Get all user statuses"
        operationId: "accountPresence"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "accountId"
            in: "path"
            required: true
            type: "string"
        responses:
          default:
            description: "successful operation"
            schema:
              $ref: "#/definitions/AccountPresenceInfo"
        x-api-group: "account/presence"
        x-throttling-group: "Heavy"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "ReadPresence"
        x-user-permission: "ReadPresenceStatus"
        x-access-level: "Advanced"
    /restapi/v1.0/account/{accountId}/extension/{extensionId}/presence:
      get:
        tags:
          - "Presence"
        summary: "Get User Status"
        description: "<p style='font-style:italic;'>Since 1.0.2</p><p>Returns presence status of an extension or several extensions by their ID(s). Batch request is supported, see Batch Requests for details.The presenceStatus is returned as Offline (the parameters telephonyStatus, message, userStatus and dndStatus are not returned at all) for the following extension types: Department/Announcement Only/Take Messages Only (Voicemail)/Fax User/Paging Only Group/Shared Lines Group/IVR Menu/Application Extension/Park Location.If the user requests his/her own presence status, the response contains actual presence status even if the status publication is turned off.Batch request is supported. For batch requests the number of extensions in one request is limited to 30. If more extensions are included in the request, the error code 400 Bad Request is returned with the logical error code InvalidMultipartRequest and the corresponding message 'Extension Presence Info multipart request is limited to 30 extensions'.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadPresence</td><td>Getting user presence information</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Light</p>"
        operationId: "getPresenceStatus"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "accountId"
            in: "path"
            description: "Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"
            required: true
            type: "string"
            default: "~"
          -
            name: "extensionId"
            in: "path"
            description: "Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session"
            required: true
            type: "string"
            default: "~"
        responses:
          default:
            description: "Success"
            schema:
              $ref: "#/definitions/GetPresenceInfo"
        x-api-group: "extension/presence"
        x-throttling-group: "Light"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "ReadPresence"
        x-user-permission: "ReadPresenceStatus"
        x-access-level: "Public"
      put:
        tags:
          - "Presence"
        summary: "Update User Status"
        operationId: "updatePresenceStatus"
        consumes:
          - "multipart/mixed"
          - "application/json"
        produces:
          - "multipart/mixed"
          - "application/json"
        parameters:
          -
            name: "accountId"
            in: "path"
            description: "Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"
            required: true
            type: "string"
            default: "~"
          -
            name: "extensionId"
            in: "path"
            description: "Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session"
            required: true
            type: "string"
            default: "~"
          -
            in: "body"
            name: "body"
            required: true
            schema:
              $ref: "#/definitions/PresenceInfoResource"
        responses:
          default:
            description: "successful operation"
            schema:
              $ref: "#/definitions/PresenceInfoResource"
        x-api-group: "extension/presence"
        x-throttling-group: "Medium"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "EditPresence"
        x-access-level: "Public"
    /restapi/v1.0/account/{accountId}/extension/{extensionId}/presence/line:
      get:
        tags:
          - "Presence"
        summary: "Get Monitored Extensions"
        description: "<p style='font-style:italic;'>Since 1.0.13 (Release 6.5)</p><p>Returns list of lines - extensions which presence status can be indicated and monitored on BLF-enabled (Busy Lamp Field) devices.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadPresence</td><td>Getting user presence information</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Light</p>"
        operationId: "listMonitoredExtensions"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "accountId"
            in: "path"
            description: "Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"
            required: true
            type: "string"
            default: "~"
          -
            name: "extensionId"
            in: "path"
            description: "Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session"
            required: true
            type: "string"
            default: "~"
        responses:
          default:
            description: "Success"
            schema:
              $ref: "#/definitions/GetMonitoredExtensionsResponse"
        x-api-group: "extension/presence/line"
        x-throttling-group: "Light"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "ReadPresence"
        x-user-permission: "ReadPresenceSettings"
        x-access-level: "Internal"
      put:
        tags:
          - "Presence"
        summary: "Update Monitored Extensions"
        operationId: "updatePresenceLines"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "accountId"
            in: "path"
            description: "Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"
            required: true
            type: "string"
            default: "~"
          -
            name: "extensionId"
            in: "path"
            description: "Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session"
            required: true
            type: "string"
            default: "~"
          -
            in: "body"
            name: "body"
            required: true
            schema:
              $ref: "#/definitions/UpdatePresenceLinesRequest"
        responses:
          default:
            description: "successful operation"
            schema:
              $ref: "#/definitions/UpdatePresenceLinesResponse"
        x-api-group: "extension/presence/line"
        x-throttling-group: "Medium"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "EditPresence"
        x-user-permission: "EditPresenceSettings"
        x-access-level: "Internal"
    /restapi/v1.0/account/{accountId}/extension/{extensionId}/presence/line/{lineId}:
      get:
        tags:
          - "Presence"
        summary: "Get Monitored Extensions by Id"
        operationId: "getPresenceLine"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "lineId"
            in: "path"
            required: true
            type: "string"
          -
            name: "extensionId"
            in: "path"
            description: "Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session"
            required: true
            type: "string"
            default: "~"
          -
            name: "accountId"
            in: "path"
            description: "Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"
            required: true
            type: "string"
            default: "~"
        responses:
          default:
            description: "successful operation"
            schema:
              $ref: "#/definitions/PresenceLineResource"
        x-api-group: "extension/presence/line"
        x-throttling-group: "Light"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "ReadPresence"
        x-user-permission: "ReadPresenceSettings"
        x-access-level: "Internal"
    /restapi/v1.0/account/{accountId}/extension/{extensionId}/presence/permission:
      get:
        tags:
          - "Presence"
        summary: "Get User Presence Permissions"
        operationId: "getMonitoringExtensions"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "extensionId"
            in: "path"
            description: "Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session"
            required: true
            type: "string"
            default: "~"
          -
            name: "accountId"
            in: "path"
            required: true
            type: "string"
        responses:
          default:
            description: "successful operation"
            schema:
              $ref: "#/definitions/MonitoringExtensionsResource"
        x-api-group: "extension/presence/permission"
        x-throttling-group: "Light"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "ReadPresence"
        x-user-permission: "ReadPresenceSettings"
        x-access-level: "Internal"
      put:
        tags:
          - "Presence"
        summary: "Update User Presence Permissions"
        operationId: "putMonitoringExtensions"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "extensionId"
            in: "path"
            description: "Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session"
            required: true
            type: "string"
            default: "~"
          -
            name: "accountId"
            in: "path"
            required: true
            type: "string"
          -
            name: "body"
            in: "body"
            required: true
            schema:
              $ref: "#/definitions/UserPresencePermissionsUpdateRequest"
        responses:
          default:
            description: "successful operation"
            schema:
              $ref: "#/definitions/MonitoringExtensionsResource"
        x-api-group: "extension/presence/permission"
        x-throttling-group: "Light"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "ReadPresence"
        x-user-permission: "ReadPresenceSettings"
        x-access-level: "Internal"
    /restapi/v1.0/glip/companies/{companyId}:
      get:
        tags:
          - "Glip"
        summary: "Get Company Info"
        operationId: "loadCompany"
        description: "<p style='font-style:italic;'>Since 1.0.28 (Release 8.4)</p><p>Returns a company by ID.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>Glip</td><td>Availability of Glip</td></tr></tbody></table><h4>API Group</h4><p>Light</p>"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "companyId"
            type: "string"
            in: "path"
            description: "Internal identifier of an RC account/Glip company, or tilde (~) to indicate a company the current user belongs to"
            required: true
        responses:
          default:
            description: "Success"
            schema:
              $ref: "#/definitions/GlipCompany"
        x-api-group: "Glip"
        x-throttling-group: "Light"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "Glip"
        x-user-permission: "Glip"
        x-access-level: "PublicBeta"
    /restapi/v1.0/glip/groups:
      get:
        tags:
          - "Glip"
        summary: "Get User Groups"
        operationId: "loadGroupList"
        description: "<p style='font-style:italic;'>Since 1.0.28 (Release 8.4)</p><p>Returns the list of groups associated with the user.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>Glip</td><td>Availability of Glip</td></tr></tbody></table><h4>API Group</h4><p>Medium</p>"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "type"
            type: "array"
            items:
              type: "string"
            collectionFormat: "multi"
            allowEmptyValue: true
            enum:
              - "PrivateChat"
              - "Group"
              - "Team"
            in: "query"
            description: "Type of a group. 'PrivateChat' is a group of 2 members. 'Group' is a chat of 2 and more participants, the membership cannot be changed after group creation. 'Team' is a chat of 1 and more participants, the membership can be modified in future"
            required: false
          -
            name: "pageToken"
            type: "string"
            in: "query"
            description: "Token of a page to be returned, see Glip Navigation Info"
            required: false
          -
            name: "recordCount"
            type: "integer"
            format: "int64"
            in: "query"
            description: "Max numbers of records to be returned. The default/maximum value is 250"
            required: false
        responses:
          default:
            description: "Success"
            schema:
              $ref: "#/definitions/GlipGroupList"
        x-api-group: "Glip"
        x-throttling-group: "Medium"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "Glip"
        x-user-permission: "Glip"
        x-access-level: "PublicBeta"
      post:
        tags:
          - "Glip"
        summary: "Create Group"
        operationId: "createGroup"
        description: "<p style='font-style:italic;'>Since 1.0.28 (Release 8.4)</p><p>Creates a group.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>Glip</td><td>Availability of Glip</td></tr></tbody></table><h4>API Group</h4><p>Medium</p>"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "body"
            in: "body"
            description: "JSON body"
            schema:
              $ref: "#/definitions/GlipCreateGroup"
            required: true
        responses:
          default:
            description: "Success"
            schema:
              $ref: "#/definitions/GlipGroupInfo"
        x-api-group: "Glip"
        x-throttling-group: "Medium"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "Glip"
        x-user-permission: "Glip"
        x-access-level: "PublicBeta"
    /restapi/v1.0/glip/groups/{groupId}:
      get:
        tags:
          - "Glip"
        summary: "Get Group"
        operationId: "loadGroup"
        description: "<p style='font-style:italic;'>Since 1.0.28 (Release 8.4)</p><p>Returns a group or few groups by ID(s). Batch request is supported.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>Glip</td><td>Availability of Glip</td></tr></tbody></table><h4>API Group</h4><p>Light</p>"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "groupId"
            type: "string"
            in: "path"
            description: "Internal identifier of a group to be returned, the maximum number of IDs is 30"
            required: true
        responses:
          default:
            description: "Success"
            schema:
              $ref: "#/definitions/GlipGroupInfo"
        x-api-group: "Glip"
        x-throttling-group: "Light"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "Glip"
        x-user-permission: "Glip"
        x-access-level: "PublicBeta"
    /restapi/v1.0/glip/groups/{groupId}/bulk-assign:
      post:
        tags:
          - "Glip"
        summary: "Edit Group Members"
        operationId: "updateGroup"
        description: "<p style='font-style:italic;'>Since 1.0.28 (Release 8.4)</p><p>Updates group members. Please note: Only groups of 'Team' type can be updated. Currently only one operation at a time (either adding or removal) is supported.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>Glip</td><td>Availability of Glip</td></tr></tbody></table><h4>API Group</h4><p>Medium</p>"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "groupId"
            type: "string"
            in: "path"
            description: "Internal identifier of a group to be edited"
            required: true
          -
            name: "body"
            in: "body"
            description: "JSON body"
            schema:
              $ref: "#/definitions/EditGroupRequest"
            required: true
        responses:
          default:
            description: "Success"
            schema:
              $ref: "#/definitions/GlipGroupInfo"
        x-api-group: "Glip"
        x-throttling-group: "Medium"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "Glip"
        x-user-permission: "Glip"
        x-access-level: "PublicBeta"
    /restapi/v1.0/glip/persons/{personId}:
      get:
        tags:
          - "Glip"
        summary: "Get Person"
        operationId: "loadPerson"
        description: "<p style='font-style:italic;'>Since 1.0.28 (Release 8.4)</p><p>Returns a user or few users by ID(s). Batch request is supported.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>Glip</td><td>Availability of Glip</td></tr></tbody></table><h4>API Group</h4><p>Light</p>"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "personId"
            type: "string"
            in: "path"
            description: "Internal identifier of a user to be returned, the maximum number of IDs is 30"
            required: true
        responses:
          default:
            description: "Success"
            schema:
              $ref: "#/definitions/GlipPersonInfo"
        x-api-group: "Glip"
        x-throttling-group: "Light"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "Glip"
        x-user-permission: "Glip"
        x-access-level: "PublicBeta"
    /restapi/v1.0/glip/groups/{groupId}/posts:
      get:
        tags:
          - "Glip"
        summary: "Get Posts"
        operationId: "loadPosts"
        description: "<p style='font-style:italic;'>Since 1.0.28 (Release 8.4)</p><p>Returns list of posts.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>Glip</td><td>Availability of Glip</td></tr></tbody></table><h4>API Group</h4><p>Light</p>"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "groupId"
            type: "string"
            in: "path"
            description: "Identifier of a group to filter posts"
            required: true
          -
            name: "pageToken"
            type: "string"
            in: "query"
            description: "Token of a page to be returned, see Glip Navigation Info"
            required: false
          -
            name: "recordCount"
            type: "integer"
            format: "int64"
            in: "query"
            description: "Max numbers of records to be returned. The default/maximum value is 250"
            required: false
        responses:
          default:
            description: "Success"
            schema:
              $ref: "#/definitions/GlipPosts"
        x-api-group: "Glip"
        x-throttling-group: "Light"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "Glip"
        x-user-permission: "Glip"
        x-access-level: "PublicBeta"
      post:
        tags:
          - "Glip"
        summary: "Create Post"
        operationId: "createPost"
        description: "<p style='font-style:italic;'>Since 1.0.28 (Release 8.4)</p><p>Creates a post.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>Glip</td><td>Availability of Glip</td></tr></tbody></table><h4>API Group</h4><p>Light</p>"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "groupId"
            type: "string"
            in: "path"
            description: "Id of a group to send post"
            required: true
          -
            name: "body"
            in: "body"
            description: "JSON body"
            schema:
              $ref: "#/definitions/GlipCreatePost"
            required: true
        responses:
          default:
            description: "Success"
            schema:
              $ref: "#/definitions/GlipPostInfo"
        x-api-group: "Glip"
        x-throttling-group: "Light"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "Glip"
        x-user-permission: "Glip"
        x-access-level: "PublicBeta"
    /restapi/v1.0/glip/files:
      post:
        tags:
          - "Glip"
        summary: "Upload File"
        operationId: "createGlipFile"
        description: "<p style='font-style:italic;'>Since 1.0.31 (Release 9.2)</p><p>Posts a file.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>Glip</td><td>Availability of Glip</td></tr></tbody></table><h4>API Group</h4><p>Heavy</p>"
        consumes:
          - "multipart/form-data"
        produces:
          - "application/json"
        parameters:
          -
            name: "groupId"
            type: "string"
            in: "query"
            description: "Internal identifier of a group the post with file attached will be added to"
            required: false
          -
            name: "body"
            in: "formData"
            type: "file"
            required: true
            description: "The file to upload"
          -
            name: "name"
            type: "string"
            in: "formData"
            description: "Name of a file attached"
            required: false
        responses:
          default:
            description: "Success"
            schema:
              $ref: "#/definitions/PostGlipFile"
        x-api-group: "Glip"
        x-throttling-group: "Heavy"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "Glip"
        x-user-permission: "Glip"
        x-access-level: "PublicBeta"
    /restapi/v1.0/glip/files/{fileId}:
      get:
        tags:
          - "Glip"
        summary: "Get File Info"
        operationId: "loadGlipFile"
        description: "<p style='font-style:italic;'>Since 1.0.31 (Release 9.2)</p><p>Returns a file.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>Glip</td><td>Availability of Glip</td></tr></tbody></table><h4>API Group</h4><p>Medium</p>"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "fileId"
            type: "string"
            in: "path"
            description: "Internal identifier of file."
            required: true
        responses:
          default:
            description: "Success"
            schema:
              $ref: "#/definitions/PostGlipFile"
        x-api-group: "Glip"
        x-throttling-group: "Medium"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "Glip"
        x-user-permission: "Glip"
        x-access-level: "PublicBeta"
    /restapi/v1.0/glip/profile:
      get:
        tags:
          - "Glip"
        summary: "Glip Unread Message Count"
        operationId: "loadUnreadMessageCount"
        description: "<p style='font-style:italic;'>Since 1.0.30 (Release 9.1)</p><p>Returns Glip unread message count.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>Glip</td><td>Availability of Glip</td></tr></tbody></table><h4>API Group</h4><p>Light</p>"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "fields"
            type: "string"
            in: "query"
            description: "List of attributes to be returned. To return unread message count 'unreadPostsCount' and 'tooManyUnreadPosts' should be specified"
            required: false
        responses:
          default:
            description: "Success"
            schema:
              $ref: "#/definitions/GlipUnreadMessageCount"
        x-api-group: "Glip"
        x-throttling-group: "Medium"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "Glip"
        x-user-permission: "Glip"
        x-access-level: "PublicBeta"
    /restapi/v1.0/account/{accountId}/extension/{extensionId}/meeting:
      get:
        tags:
          - "Meetings"
        summary: "Get Scheduled Meetings"
        operationId: "getLiveMeetings"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "accountId"
            in: "path"
            required: true
            type: "string"
          -
            name: "extensionId"
            in: "path"
            required: true
            type: "string"
        responses:
          default:
            description: "successful operation"
            schema:
              $ref: "#/definitions/MeetingsResource"
        x-api-group: "extension/meeting"
        x-throttling-group: "Light"
        x-metered-api: true
        x-metering-group: "System"
        x-user-permission: "Meetings"
        x-app-permission: "Meetings"
        x-access-level: "PublicBeta"
      post:
        tags:
          - "Meetings"
        summary: "Create Meetings"
        operationId: "createMeeting"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "accountId"
            in: "path"
            required: true
            type: "string"
          -
            name: "extensionId"
            in: "path"
            required: true
            type: "string"
          -
            in: "body"
            name: "body"
            required: true
            schema:
              $ref: "#/definitions/MeetingRequestResource"
        responses:
          default:
            description: "successful operation"
            schema:
              $ref: "#/definitions/MeetingResponseResource"
        x-api-group: "extension/meeting"
        x-throttling-group: "Medium"
        x-metered-api: true
        x-metering-group: "System"
        x-user-permission: "Meetings"
        x-app-permission: "Meetings"
        x-access-level: "PublicBeta"
    /restapi/v1.0/account/{accountId}/extension/{extensionId}/meeting/{meetingId}:
      get:
        tags:
          - "Meetings"
        summary: "Get Meeting Info"
        operationId: "getMeetingDetails"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "accountId"
            in: "path"
            required: true
            type: "string"
          -
            name: "extensionId"
            in: "path"
            required: true
            type: "string"
          -
            name: "meetingId"
            in: "path"
            required: true
            type: "string"
        responses:
          default:
            description: "successful operation"
            schema:
              $ref: "#/definitions/MeetingResponseResource"
        x-api-group: "extension/meeting"
        x-throttling-group: "Light"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "Meetings"
        x-user-permission: "Meetings"
        x-access-level: "PublicBeta"
      put:
        tags:
          - "Meetings"
        summary: "Update Meeting"
        operationId: "updateMeeting"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "accountId"
            in: "path"
            required: true
            type: "string"
          -
            name: "extensionId"
            in: "path"
            required: true
            type: "string"
          -
            name: "meetingId"
            in: "path"
            required: true
            type: "string"
          -
            in: "body"
            name: "body"
            required: true
            schema:
              $ref: "#/definitions/MeetingRequestResource"
        responses:
          default:
            description: "successful operation"
            schema:
              $ref: "#/definitions/MeetingResponseResource"
        x-api-group: "extension/meeting"
        x-throttling-group: "Medium"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "Meetings"
        x-user-permission: "Meetings"
        x-access-level: "PublicBeta"
      delete:
        tags:
          - "Meetings"
        summary: "Delete Meeting"
        operationId: "deleteMeeting"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "meetingId"
            in: "path"
            required: true
            type: "string"
          -
            name: "extensionId"
            in: "path"
            required: true
            type: "string"
          -
            name: "accountId"
            in: "path"
            required: true
            type: "string"
        responses:
          default:
            description: "successful operation"
        x-api-group: "extension/meeting"
        x-throttling-group: "Medium"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "Meetings"
        x-user-permission: "Meetings"
        x-access-level: "PublicBeta"
    /restapi/v1.0/account/{accountId}/extension/{extensionId}/meeting/{meetingId}/end:
      post:
        tags:
          - "Meetings"
        summary: "End Meeting"
        operationId: "endMeeting"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "meetingId"
            in: "path"
            required: true
            type: "string"
          -
            name: "extensionId"
            in: "path"
            required: true
            type: "string"
          -
            name: "accountId"
            in: "path"
            required: true
            type: "string"
        responses:
          default:
            description: "successful operation"
        x-api-group: "extension/meeting/end"
        x-throttling-group: "Medium"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "Meetings"
        x-user-permission: "Meetings"
        x-access-level: "PublicBeta"
    /restapi/v1.0/account/{accountId}/extension/{extensionId}/meeting/service-info:
      get:
        tags:
          - "Meetings"
        summary: "Get Meeting Service Info"
        operationId: "getMeetingServiceInfo"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "extensionId"
            in: "path"
            required: true
            type: "string"
          -
            name: "accountId"
            in: "path"
            required: true
            type: "string"
        responses:
          default:
            description: "successful operation"
            schema:
              $ref: "#/definitions/MeetingServiceInfoResource"
        x-api-group: "extension/meeting/service-info"
        x-throttling-group: "Light"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "Meetings"
        x-user-permission: "Meetings"
        x-access-level: "PublicBeta"
    /restapi/v1.0/subscription:
      get:
        tags:
          - "Push Notifications"
        summary: "Get Subscriptions"
        operationId: "getSubscriptions"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters: []
        responses:
          default:
            description: "successful operation"
            schema:
              $ref: "#/definitions/RecordsCollectionResourceSubscriptionResponse"
        x-api-group: "subscription"
        x-throttling-group: "Light"
        x-metered-api: true
        x-metering-group: "System"
        x-access-level: "Public"
      post:
        tags:
          - "Push Notifications"
        summary: "Create Subscription"
        description: "<p style='font-style:italic;'>Since 1.0.6 (Release 5.15)</p><p>Creates a new subscription.</p><h4>Usage Plan Group</h4><p>Medium</p>"
        operationId: "createSubscription"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            in: "body"
            name: "body"
            description: "JSON body"
            required: true
            schema:
              $ref: "#/definitions/CreateSubscriptionRequest"
        responses:
          default:
            description: "Success"
            schema:
              $ref: "#/definitions/SubscriptionInfo"
        x-api-group: "subscription"
        x-throttling-group: "Medium"
        x-metered-api: true
        x-metering-group: "System"
        x-access-level: "Public"
    /restapi/v1.0/subscription/{subscriptionId}:
      get:
        tags:
          - "Push Notifications"
        summary: "Get Subscription"
        description: "<p style='font-style:italic;'>Since 1.0.6 (Release 5.15)</p><p>Returns the requested subscription.</p><h4>Usage Plan Group</h4><p>Light</p>"
        operationId: "loadSubscription"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "subscriptionId"
            in: "path"
            description: "Internal identifier of a subscription"
            required: true
            type: "integer"
        responses:
          default:
            description: "Success"
            schema:
              $ref: "#/definitions/SubscriptionInfo"
        x-api-group: "subscription"
        x-throttling-group: "Light"
        x-metered-api: true
        x-metering-group: "System"
        x-access-level: "Public"
      put:
        tags:
          - "Push Notifications"
        summary: "Renew Subscription / Update Event Filters"
        description: "<p style='font-style:italic;'>Since 1.0.6 (Release 5.15)</p><p>Renews the existent subscription if the request body is empty. If event filters are specified, calling this method modifies the event filters for the existing subscription. The client application can extend or narrow the events for which it receives notifications in the frame of one subscription.</p><h4>Usage Plan Group</h4><p>Medium</p>"
        operationId: "updateSubscription"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "subscriptionId"
            in: "path"
            description: "Internal identifier of a subscription"
            required: true
            type: "string"
          -
            name: "aggregated"
            in: "query"
            description: "If 'True' then aggregated presence status is returned in a notification payload"
            required: false
            type: "boolean"
          -
            in: "body"
            name: "body"
            description: "JSON body"
            required: true
            schema:
              $ref: "#/definitions/ModifySubscriptionRequest"
        responses:
          default:
            description: "Success"
            schema:
              $ref: "#/definitions/SubscriptionInfo"
        x-api-group: "subscription"
        x-throttling-group: "Medium"
        x-metered-api: true
        x-metering-group: "System"
        x-access-level: "Public"
      delete:
        tags:
          - "Push Notifications"
        summary: "Cancel Subscription"
        description: "<p style='font-style:italic;'></p><p>Cancels the existent subscription.</p><h4>Usage Plan Group</h4><p>Medium</p>"
        operationId: "deleteSubscription"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "subscriptionId"
            in: "path"
            description: "Internal identifier of a subscription"
            required: true
            type: "string"
        responses:
          default:
            description: "Success"
        x-api-group: "subscription"
        x-throttling-group: "Medium"
        x-metered-api: true
        x-metering-group: "System"
        x-access-level: "Public"
    /restapi/v1.0/subscription/{subscriptionId}/renew:
      post:
        tags:
          - "Push Notifications"
        summary: "Renew Subscription"
        description: "<p style='font-style:italic;'>Since 1.0.26 (Release 8.12)</p><p>Renews an existent subscription by ID by posting request with an empty body..</p><h4>Usage Plan Group</h4><p>Medium</p>"
        operationId: "renewSubscription"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "subscriptionId"
            in: "path"
            required: true
            type: "string"
        responses:
          default:
            description: "successful operation"
            schema:
              $ref: "#/definitions/SubscriptionInfo"
        x-api-group: "subscription"
        x-throttling-group: "Light"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "webhook_subscription"
        x-access-level: "Public"
    /restapi/v1.0/account/{accountId}/extension/{extensionId}/authz-profile:
      get:
        tags:
          - "Roles and Permissions"
        summary: "Get User Permissions"
        operationId: "getProfile"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "extensionId"
            in: "path"
            required: true
            type: "string"
          -
            name: "accountId"
            in: "path"
            required: true
            type: "string"
        responses:
          default:
            description: "successful operation"
            schema:
              $ref: "#/definitions/AuthProfileResource"
        x-api-group: "extension/authz-profile"
        x-throttling-group: "Medium"
        x-metered-api: true
        x-metering-group: "System"
        x-access-level: "Public"
    /restapi/v1.0/account/{accountId}/extension/{extensionId}/authz-profile/check:
      get:
        tags:
          - "Roles and Permissions"
        summary: "Check User Permissions"
        operationId: "checkPermission"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "permissionId"
            in: "query"
            required: false
            type: "string"
          -
            name: "targetExtensionId"
            in: "query"
            required: false
            type: "string"
          -
            name: "extensionId"
            in: "path"
            required: true
            type: "string"
          -
            name: "accountId"
            in: "path"
            required: true
            type: "string"
        responses:
          default:
            description: "successful operation"
            schema:
              $ref: "#/definitions/AuthProfileCheckResource"
        x-api-group: "extension/authz-profile/check"
        x-throttling-group: "Light"
        x-metered-api: true
        x-metering-group: "System"
        x-access-level: "Public"
    /restapi/v1.0/account/{accountId}/user-role/default:
      get:
        tags:
          - "Roles and Permissions"
        summary: "Get Default User Role"
        operationId: "loadUserRole"
        description: "<p style='font-style:italic;'>Since 1.0.28 (Release 8.4)</p><p>Returns account default user role.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>RoleManagement</td><td>Editing and assignment of user roles</td></tr></tbody></table><h4>API Group</h4><p>Light</p>"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "accountId"
            type: "string"
            in: "path"
            description: "Internal identifier of an account"
            required: true
            default: "~"
        responses:
          default:
            description: "Success"
        x-api-group: "account/user-role/default"
        x-throttling-group: "Light"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "RoleManagement"
        x-user-permission: "Roles"
        x-access-level: "Internal"
      put:
        tags:
          - "Roles and Permissions"
        summary: "Set Default User Role"
        operationId: "updateUserRole"
        description: "<p style='font-style:italic;'>Since 1.0.30 (Release 9.1)</p><p>Updates account default user role.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>RoleManagement</td><td>Editing and assignment of user roles</td></tr></tbody></table><h4>API Group</h4><p>Light</p>"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "accountId"
            type: "string"
            in: "path"
            description: "Internal identifier of an account"
            required: true
            default: "~"
          -
            name: "body"
            in: "body"
            description: "JSON body"
            schema:
              $ref: "#/definitions/DefaultUserRoleRequest"
            required: true
        responses:
          default:
            description: "Success"
        x-api-group: "account/user-role/default"
        x-throttling-group: "Medium"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "RoleManagement"
        x-user-permission: "Roles"
        x-access-level: "Internal"
    /restapi/v1.0/dictionary/user-role:
      get:
        tags:
          - "Roles and Permissions"
        summary: "Get Standard User Roles"
        operationId: "listSystemRoles"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "page"
            in: "query"
            required: false
            type: "string"
            default: "1"
          -
            name: "perPage"
            in: "query"
            required: false
            type: "string"
            default: "100"
          -
            name: "servicePlanId"
            in: "query"
            required: false
            type: "string"
        responses:
          default:
            description: "successful operation"
            schema:
              $ref: "#/definitions/RolesCollectionResource"
        x-api-group: "dictionary/user-role"
        x-throttling-group: "Light"
        x-metered-api: true
        x-metering-group: "System"
        x-access-level: "Internal"
    /restapi/v1.0/dictionary/user-role/{roleId}:
      get:
        tags:
          - "Roles and Permissions"
        summary: "Get User Role"
        operationId: "getSystemRole"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "roleId"
            in: "path"
            required: true
            type: "string"
        responses:
          default:
            description: "successful operation"
            schema:
              $ref: "#/definitions/RoleResource"
        x-api-group: "dictionary/user-role"
        x-throttling-group: "Light"
        x-metered-api: true
        x-metering-group: "System"
        x-access-level: "Internal"
    /restapi/v1.0/dictionary/permission:
      get:
        tags:
          - "Roles and Permissions"
        summary: "Get Permissions"
        operationId: "listPermissions"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "page"
            in: "query"
            required: false
            type: "string"
            default: "1"
          -
            name: "perPage"
            in: "query"
            required: false
            type: "string"
            default: "100"
          -
            name: "assignable"
            in: "query"
            required: false
            type: "boolean"
          -
            name: "servicePlanId"
            in: "query"
            required: false
            type: "string"
        responses:
          default:
            description: "successful operation"
            schema:
              $ref: "#/definitions/PermissionCollectionResource"
        x-api-group: "dictionary/permission"
        x-throttling-group: "Light"
        x-metered-api: true
        x-metering-group: "System"
        x-access-level: "Internal"
    /restapi/v1.0/dictionary/permission/{permissionId}:
      get:
        tags:
          - "Roles and Permissions"
        summary: "Get Permission Info"
        operationId: "getPermission"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "permissionId"
            in: "path"
            required: true
            type: "string"
        responses:
          default:
            description: "successful operation"
            schema:
              $ref: "#/definitions/PermissionResource"
        x-api-group: "dictionary/permission"
        x-throttling-group: "Light"
        x-metered-api: true
        x-metering-group: "System"
        x-access-level: "Internal"
    /restapi/v1.0/dictionary/permission-category:
      get:
        tags:
          - "Roles and Permissions"
        summary: "Get Permissions Categories"
        operationId: "listPermissionCategories"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "page"
            in: "query"
            required: false
            type: "string"
            default: "1"
          -
            name: "perPage"
            in: "query"
            required: false
            type: "string"
            default: "100"
          -
            name: "servicePlanId"
            in: "query"
            required: false
            type: "string"
        responses:
          default:
            description: "successful operation"
            schema:
              $ref: "#/definitions/PermissionCategoryCollectionResource"
        x-api-group: "dictionary/permission-category"
        x-throttling-group: "Light"
        x-metered-api: true
        x-metering-group: "System"
        x-access-level: "Internal"
    /restapi/v1.0/dictionary/permission-category/{permissionCategoryId}:
      get:
        tags:
          - "Roles and Permissions"
        summary: "Get Permission Category"
        operationId: "getPermissionCategory"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "permissionCategoryId"
            in: "path"
            required: true
            type: "string"
        responses:
          default:
            description: "successful operation"
            schema:
              $ref: "#/definitions/PermissionCategoryResource"
        x-api-group: "dictionary/permission-category"
        x-throttling-group: "Light"
        x-metered-api: true
        x-metering-group: "System"
        x-access-level: "Internal"
    /restapi/v1.0/account/{accountId}/extension/{extensionId}/forwarding-number:
      get:
        tags:
          - "Call Handling Settings"
        summary: "Get Forwarding Numbers"
        description: "<p style='font-style:italic;'>Since 1.0.7 (Release 5.16)</p><p>Returns the list of extension phone numbers used for call forwarding and call flip. The returned list contains all the extension phone numbers that are used for call forwarding and call flip.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadAccounts</td><td>Viewing user account info (including name, business name, address and phone number/account number)</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Light</p>"
        operationId: "listExtensionForwardingNumbers"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "accountId"
            in: "path"
            description: "Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"
            required: true
            type: "string"
            default: "~"
          -
            name: "extensionId"
            in: "path"
            description: "Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session"
            required: true
            type: "string"
            default: "~"
          -
            name: "page"
            in: "query"
            description: "Indicates the page number to retrieve. Only positive number values are allowed. Default value is '1'"
            required: false
            type: "integer"
          -
            name: "perPage"
            in: "query"
            description: "Indicates the page size (number of items). If not specified, the value is '100' by default"
            required: false
            type: "integer"
        responses:
          default:
            description: "Success"
            schema:
              $ref: "#/definitions/GetExtensionForwardingNumberListResponse"
        x-api-group: "extension/forwarding-number"
        x-throttling-group: "Light"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "ReadAccounts"
        x-user-permission: "ReadUserForwardingFlipNumbers"
        x-access-level: "Public"
      post:
        tags:
          - "Call Handling Settings"
        summary: "Create Forwarding Numbers"
        description: "<p style='font-style:italic;'>Since 1.0.12 (Release 6.4)</p><p>Adds a new forwarding number to the forwarding number list.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>EditExtensions</td><td>Viewing and updating user extension info (includes extension name, number, email and phone number, assigned phone numbers, devices and other extension settings)</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Medium</p>"
        operationId: "createExtensionForwardingNumber"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "accountId"
            in: "path"
            description: "Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"
            required: true
            type: "string"
            default: "~"
          -
            name: "extensionId"
            in: "path"
            description: "Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session"
            required: true
            type: "string"
            default: "~"
          -
            in: "body"
            name: "body"
            description: "JSON body"
            required: true
            schema:
              $ref: "#/definitions/CreateForwardingNumberRequest"
        responses:
          default:
            description: "Success"
            schema:
              $ref: "#/definitions/ForwardingNumberInfo"
        x-api-group: "extension/forwarding-number"
        x-throttling-group: "Medium"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "EditExtensions"
        x-user-permission: "EditUserForwardingFlipNumbers"
        x-access-level: "Public"
    /restapi/v1.0/account/{accountId}/extension/{extensionId}/forwarding-number/{forwardingNumberId}:
      get:
        tags:
          - "Call Handling Settings"
        summary: "Get Forwarding Number"
        operationId: "getForwardingNumber"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "forwardingNumberId"
            in: "path"
            required: true
            type: "string"
          -
            name: "extensionId"
            in: "path"
            required: true
            type: "string"
          -
            name: "accountId"
            in: "path"
            required: true
            type: "string"
        responses:
          default:
            description: "successful operation"
            schema:
              $ref: "#/definitions/ForwardingNumberResource"
        x-api-group: "extension/forwarding-number"
        x-throttling-group: "Light"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "ReadAccounts"
        x-user-permission: "ReadUserForwardingFlipNumbers"
        x-access-level: "Public"
      put:
        tags:
          - "Call Handling Settings"
        summary: "Update Forwarding Numbers"
        description: "<p style='font-style:italic;'>Since 1.0.24 (Release 8.0)</p><p>Updates an existent forwarding number from the forwarding number list.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>EditExtensions</td><td>Viewing and updating user extension info (includes extension name, number, email and phone number, assigned phone numbers, devices and other extension settings)</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Medium</p>"
        operationId: "updateExtensionForwardingNumber"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "accountId"
            in: "path"
            description: "Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"
            required: true
            type: "string"
            default: "~"
          -
            name: "extensionId"
            in: "path"
            description: "Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session"
            required: true
            type: "string"
            default: "~"
          -
            name: "forwardingNumberId"
            in: "path"
            description: "Internal identifier of a forwarding number; returned in response in the id field"
            required: true
            type: "string"
          -
            in: "body"
            name: "body"
            description: "JSON body"
            required: true
            schema:
              $ref: "#/definitions/UpdateForwardingNumberRequest"
        responses:
          default:
            description: "Success"
            schema:
              $ref: "#/definitions/ForwardingNumberInfo"
        x-api-group: "extension/forwarding-number"
        x-throttling-group: "Medium"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "EditExtensions"
        x-user-permission: "EditUserForwardingFlipNumbers"
        x-access-level: "Public"
      delete:
        tags:
          - "Call Handling Settings"
        summary: "Delete Forwarding Number"
        description: "<p style='font-style:italic;'>Since 1.0.24 (Release 8.0)</p><p>Deletes a forwarding number from the forwarding number list by its ID.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>EditExtensions</td><td>Viewing and updating user extension info (includes extension name, number, email and phone number, assigned phone numbers, devices and other extension settings)</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Medium</p>"
        operationId: "deleteExtensionForwardingNumber"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "accountId"
            in: "path"
            description: "Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"
            required: true
            type: "string"
            default: "~"
          -
            name: "extensionId"
            in: "path"
            description: "Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session"
            required: true
            type: "string"
            default: "~"
          -
            name: "forwardingNumberId"
            in: "path"
            description: "Internal identifier of a forwarding number"
            required: true
            type: "string"
        responses:
          default:
            description: "Success"
        x-api-group: "extension/forwarding-number"
        x-throttling-group: "Medium"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "EditExtensions"
        x-user-permission: "EditUserForwardingFlipNumbers"
        x-access-level: "Public"
    /restapi/v1.0/account/{accountId}/extension/{extensionId}/blocked-number:
      get:
        tags:
          - "Call Handling Settings"
        summary: "Get Blocked Numbers"
        description: "<p style='font-style:italic;'></p><p></p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadAccounts</td><td>Viewing user account info (including name, business name, address and phone number/account number)</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Light</p>"
        operationId: "listBlockedNumbers"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "accountId"
            in: "path"
            description: "Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"
            required: true
            type: "string"
            default: "~"
          -
            name: "extensionId"
            in: "path"
            description: "Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session"
            required: true
            type: "string"
            default: "~"
        responses:
          default:
            description: "Success"
            schema:
              $ref: "#/definitions/BlockedNumbersList"
        x-api-group: "extension/blocked-number"
        x-throttling-group: "Light"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "ReadAccounts"
        x-user-permission: "ReadBlockedNumbers"
        x-access-level: "Advanced"
      post:
        tags:
          - "Call Handling Settings"
        summary: "Add Blocked Numbers"
        description: "<p style='font-style:italic;'></p><p></p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>EditExtensions</td><td>Viewing and updating my extension info (includes extension name, number, email and phone number)</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Medium</p>"
        operationId: "blockNumber"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "accountId"
            in: "path"
            description: "Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"
            required: true
            type: "string"
            default: "~"
          -
            name: "extensionId"
            in: "path"
            description: "Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session"
            required: true
            type: "string"
            default: "~"
          -
            in: "body"
            name: "body"
            required: false
            schema:
              $ref: "#/definitions/BlockedNumberInfo"
        responses:
          default:
            description: "Success"
            schema:
              $ref: "#/definitions/BlockedNumberInfo"
        x-api-group: "extension/blocked-number"
        x-throttling-group: "Medium"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "EditExtensions"
        x-user-permission: "EditBlockedNumbers"
        x-access-level: "Advanced"
    /restapi/v1.0/account/{accountId}/extension/{extensionId}/blocked-number/{blockedNumberId}:
      get:
        tags:
          - "Call Handling Settings"
        summary: "Get Blocked Number"
        description: "<p style='font-style:italic;'></p><p></p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadAccounts</td><td>Viewing user account info (including name, business name, address and phone number/account number)</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Light</p>"
        operationId: "loadBlockedNumber"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "accountId"
            in: "path"
            description: "Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"
            required: true
            type: "string"
            default: "~"
          -
            name: "extensionId"
            in: "path"
            description: "Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session"
            required: true
            type: "string"
            default: "~"
          -
            name: "blockedNumberId"
            in: "path"
            description: "Internal identifiers of a blocked number list entry"
            required: true
            type: "integer"
        responses:
          default:
            description: "Success"
            schema:
              $ref: "#/definitions/BlockedNumberInfo"
        x-api-group: "extension/blocked-number"
        x-throttling-group: "Light"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "ReadAccounts"
        x-user-permission: "ReadBlockedNumbers"
        x-access-level: "Advanced"
      put:
        tags:
          - "Call Handling Settings"
        summary: "Update Blocked Number"
        description: "<p style='font-style:italic;'></p><p></p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>EditExtensions</td><td>Viewing and updating my extension info (includes extension name, number, email and phone number)</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Medium</p>"
        operationId: "updateBlockedNumber"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "accountId"
            in: "path"
            description: "Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"
            required: true
            type: "string"
            default: "~"
          -
            name: "extensionId"
            in: "path"
            description: "Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session"
            required: true
            type: "string"
            default: "~"
          -
            name: "blockedNumberId"
            in: "path"
            description: "Internal identifier of a blocked number list entry"
            required: true
            type: "integer"
          -
            in: "body"
            name: "body"
            required: false
            schema:
              $ref: "#/definitions/BlockedNumberInfo"
        responses:
          default:
            description: "Success"
            schema:
              $ref: "#/definitions/BlockedNumberInfo"
        x-api-group: "extension/blocked-number"
        x-throttling-group: "Medium"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "EditExtensions"
        x-user-permission: "EditBlockedNumbers"
        x-access-level: "Advanced"
      delete:
        tags:
          - "Call Handling Settings"
        summary: "Delete Blocked Number"
        description: "<p style='font-style:italic;'></p><p></p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>EditExtensions</td><td>Viewing and updating my extension info (includes extension name, number, email and phone number)</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Medium</p>"
        operationId: "unblockNumber"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "accountId"
            in: "path"
            description: "Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"
            required: true
            type: "string"
            default: "~"
          -
            name: "extensionId"
            in: "path"
            description: "Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session"
            required: true
            type: "string"
            default: "~"
          -
            name: "blockedNumberId"
            in: "path"
            description: "Internal identifiers of a blocked number list entry"
            required: true
            type: "integer"
        responses:
          default:
            description: "Success"
        x-api-group: "extension/blocked-number"
        x-throttling-group: "Medium"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "EditExtensions"
        x-user-permission: "EditBlockedNumbers"
        x-access-level: "Advanced"
    /restapi/v1.0/account/{accountId}/extension/{extensionId}/business-hours:
      get:
        tags:
          - "Call Handling Settings"
        summary: "Get User Business Hours"
        description: "<p style='font-style:italic;'>Since 1.0.15 (Release 7.0)</p><p>Returns the extension user hours when answering rules are to be applied.</p><h4>Usage Plan Group</h4><p>Light</p>"
        operationId: "loadUserBusinessHours"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "accountId"
            in: "path"
            description: "Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"
            required: true
            type: "string"
            default: "~"
          -
            name: "extensionId"
            in: "path"
            description: "Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session"
            required: true
            type: "string"
            default: "~"
        responses:
          default:
            description: "Success"
            schema:
              $ref: "#/definitions/GetUserBusinessHoursResponse"
        x-api-group: "extension/business-hours"
        x-throttling-group: "Light"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "ReadAccounts"
        x-user-permission: "ReadExtensions"
        x-access-level: "PublicBeta"
      put:
        tags:
          - "Call Handling Settings"
        summary: "Update User Business Hours"
        operationId: "updateUserBusinessHours"
        description: "<p style='font-style:italic;'>Since 1.0.28 (Release 8.4)</p><p>Updates the extension user hours when answering rules are to be applied.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>EditExtensions</td><td>Viewing and updating user extension info (includes extension name, number, email and phone number, assigned phone numbers, devices and other extension settings)</td></tr></tbody></table><h4>API Group</h4><p>Medium</p>"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "accountId"
            type: "string"
            in: "path"
            description: "Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"
            required: true
            default: "~"
          -
            name: "extensionId"
            type: "string"
            in: "path"
            description: "Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session"
            required: true
            default: "~"
          -
            name: "body"
            in: "body"
            description: "JSON body"
            schema:
              $ref: "#/definitions/UserBusinessHoursUpdateRequest"
            required: true
        responses:
          default:
            description: "Success"
            schema:
              $ref: "#/definitions/UserBusinessHoursUpdate"
        x-api-group: "extension/business-hours"
        x-throttling-group: "Medium"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "EditExtensions"
        x-user-permission: "EditUserAnsweringRules"
        x-access-level: "PublicBeta"
    /restapi/v1.0/account/{accountId}/extension/{extensionId}/answering-rule:
      get:
        tags:
          - "Call Handling Settings"
        summary: "Get Call Handling Rules"
        description: "<p style='font-style:italic;'>Since 1.0.15 (Release 7.0)</p><p>Returns the extension answering rules.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadAccounts</td><td>Viewing user account info (including name, business name, address and phone number/account number)</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Light</p>"
        operationId: "loadAnsweringRulesList"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "accountId"
            in: "path"
            description: "Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"
            required: true
            type: "string"
            default: "~"
          -
            name: "extensionId"
            in: "path"
            description: "Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session"
            required: true
            type: "string"
            default: "~"
          -
            name: "page"
            in: "query"
            required: false
            type: "string"
            default: "1"
          -
            name: "perPage"
            in: "query"
            required: false
            type: "string"
            default: "100"
        responses:
          default:
            description: "Success"
        x-api-group: "extension/answering-rule"
        x-throttling-group: "Medium"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "ReadAccounts"
        x-user-permission: "ReadUserAnsweringRules"
        x-access-level: "PublicBeta"
      post:
        tags:
          - "Call Handling Settings"
        summary: "Create Custom Call Handling Rules"
        description: "<p style='font-style:italic;'>Since 1.0.24 (Release 8.0)</p><p>Creates a custom answering rule for a particular caller ID.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>EditExtensions</td><td>Viewing and updating my extension info (includes extension name, number, email and phone number)</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Medium</p>"
        operationId: "createAnsweringRuleInfo"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "accountId"
            in: "path"
            description: "Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"
            required: true
            type: "string"
            default: "~"
          -
            name: "extensionId"
            in: "path"
            description: "Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session"
            required: true
            type: "string"
            default: "~"
          -
            in: "body"
            name: "body"
            description: "JSON body"
            required: true
            schema:
              $ref: "#/definitions/CreateAnsweringRuleRequest"
        responses:
          default:
            description: "Success"
            schema:
              $ref: "#/definitions/AnsweringRuleInfo"
        x-api-group: "extension/answering-rule"
        x-throttling-group: "Medium"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "EditExtensions"
        x-user-permission: "EditUserAnsweringRules"
        x-access-level: "PublicBeta"
    /restapi/v1.0/account/{accountId}/extension/{extensionId}/answering-rule/{ruleId}:
      get:
        tags:
          - "Call Handling Settings"
        summary: "Get Call Handling Rule"
        description: "<p style='font-style:italic;'>Since 1.0.15 (Release 7.0)</p><p>Returns an answering rule by ID.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadAccounts</td><td>Viewing user account info (including name, business name, address and phone number/account number)</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Light</p>"
        operationId: "loadAnsweringRuleInfo"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "accountId"
            in: "path"
            description: "Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"
            required: true
            type: "string"
            default: "~"
          -
            name: "extensionId"
            in: "path"
            description: "Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session"
            required: true
            type: "string"
            default: "~"
          -
            name: "ruleId"
            in: "path"
            description: "Internal identifier of an answering rule. The value can be standard digital ID or specific ID - either business-hours-rule or after-hours-rule"
            required: true
            type: "string"
        responses:
          default:
            description: "Success"
            schema:
              $ref: "#/definitions/AnsweringRuleInfo"
        x-api-group: "extension/answering-rule"
        x-throttling-group: "Light"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "ReadAccounts"
        x-user-permission: "ReadUserAnsweringRules"
        x-access-level: "PublicBeta"
      put:
        tags:
          - "Call Handling Settings"
        summary: "Update Custom Call Handling Rule"
        description: "<p style='font-style:italic;'>Since 1.0.24 (Release 8.0)</p><p>Updates a custom answering rule for a particular caller ID.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>EditExtensions</td><td>Viewing and updating my extension info (includes extension name, number, email and phone number)</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Medium</p>"
        operationId: "updateAnsweringRuleInfo"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "accountId"
            in: "path"
            description: "Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"
            required: true
            type: "string"
            default: "~"
          -
            name: "extensionId"
            in: "path"
            description: "Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session"
            required: true
            type: "string"
            default: "~"
          -
            name: "ruleId"
            in: "path"
            description: "Internal identifier of an answering rule"
            required: true
            type: "string"
          -
            in: "body"
            name: "body"
            description: "JSON body"
            required: true
            schema:
              $ref: "#/definitions/UpdateAnsweringRuleRequest"
        responses:
          default:
            description: "Success"
            schema:
              $ref: "#/definitions/AnsweringRuleInfo"
        x-api-group: "extension/answering-rule"
        x-throttling-group: "Medium"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "EditExtensions"
        x-user-permission: "EditUserAnsweringRules"
        x-access-level: "PublicBeta"
      delete:
        tags:
          - "Call Handling Settings"
        summary: "Delete Call Handling Rule"
        operationId: "deleteAnsweringRule"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "accountId"
            in: "path"
            description: "Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"
            required: true
            type: "string"
            default: "~"
          -
            name: "extensionId"
            in: "path"
            description: "Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session"
            required: true
            type: "string"
            default: "~"
          -
            name: "ruleId"
            in: "path"
            description: "Internal identifier of an answering rule"
            required: true
            type: "string"
        responses:
          default:
            description: "successful operation"
        x-api-group: "extension/answering-rule"
        x-throttling-group: "Medium"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "EditExtensions"
        x-user-permission: "EditUserAnsweringRules"
        x-access-level: "PublicBeta"
    /restapi/v1.0/dictionary/greeting:
      get:
        tags:
          - "Call Handling Settings"
        summary: "Get Standard Greetings"
        description: "<p style='font-style:italic;'>Since 8.2 (Release 1.0.26)</p><p>Returns a list of predefined standard greetings. Please note: Custom greetings recorded by user are not returned in response to this request. See Get Extension Custom Greetings.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadAccounts</td><td>View Greetings</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Light</p>"
        operationId: "getGreetings"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "page"
            in: "query"
            description: "Indicates the page number to retrieve. Only positive number values are allowed. Default value is '1'"
            required: false
            type: "integer"
          -
            name: "perPage"
            in: "query"
            description: "Indicates the page size (number of items). If not specified, the value is '100' by default"
            required: false
            type: "integer"
          -
            name: "type"
            in: "query"
            description: "Type of a greeting, specifying the case when the greeting is played"
            required: false
            type: "string"
            enum:
              - "Introductory"
              - "Announcement"
              - "ConnectingMessage"
              - "ConnectingAudio"
              - "Voicemail"
              - "Unavailable"
              - "HoldMusic"
              - "Company"
          -
            name: "usageType"
            in: "query"
            type: "string"
            description: "Usage type of a greeting, specifying if the greeting is applied for user extension or department extension"
            enum:
              - "UserExtensionAnsweringRule"
              - "ExtensionAnsweringRule"
              - "DepartmentExtensionAnsweringRule"
              - "CompanyAnsweringRule"
              - "CompanyAfterHoursAnsweringRule"
        responses:
          default:
            description: "successful operation"
            schema:
              $ref: "#/definitions/DictionaryGreetingList"
        x-api-group: "dictionary/greeting"
        x-throttling-group: "Medium"
        x-metered-api: true
        x-metering-group: "System"
        x-access-level: "PublicBeta"
    /restapi/v1.0/dictionary/greeting/{greetingId}:
      get:
        tags:
          - "Call Handling Settings"
        summary: "Get Greeting Info"
        description: "<p style='font-style:italic;'>Since 8.2 (Release 1.0.26)</p><p>Returns a standard greeting by ID</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadAccounts</td><td>View Greetings</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Medium</p>"
        operationId: "getGreeting"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "greetingId"
            in: "path"
            required: true
            type: "string"
        responses:
          default:
            description: "successful operation"
            schema:
              $ref: "#/definitions/DictionaryGreetingInfo"
        x-api-group: "dictionary/greeting"
        x-throttling-group: "Medium"
        x-metered-api: true
        x-metering-group: "System"
        x-access-level: "PublicBeta"
    /restapi/v1.0/account/{accountId}/extension/{extensionId}/greeting:
      post:
        tags:
          - "Call Handling Settings"
        summary: "Create User Custom Greeting"
        operationId: "createGreeting"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "accountId"
            in: "path"
            description: "Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"
            required: true
            type: "string"
            default: "~"
          -
            name: "extensionId"
            in: "path"
            description: "Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session"
            required: true
            type: "string"
            default: "~"
          -
            in: "body"
            name: "body"
            required: false
            schema:
              $ref: "#/definitions/CustomGreetingRequest"
        responses:
          default:
            description: "successful operation"
            schema:
              $ref: "#/definitions/CustomCompanyGreetingInfo"
        x-api-group: "extension/greeting"
        x-throttling-group: "Heavy"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "EditExtensions"
        x-user-permission: "EditUserAnsweringRules"
        x-access-level: "PublicBeta"
    /restapi/v1.0/account/{accountId}/extension/{extensionId}/greeting/{greetingId}:
      get:
        tags:
          - "Call Handling Settings"
        summary: "Get Custom Greeting Info"
        operationId: "getGreetingByID"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "accountId"
            in: "path"
            description: "Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"
            required: true
            type: "string"
            default: "~"
          -
            name: "extensionId"
            in: "path"
            description: "Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session"
            required: true
            type: "string"
            default: "~"
          -
            name: "greetingId"
            in: "path"
            description: ""
            required: true
            type: "integer"
        responses:
          default:
            description: "successful operation"
            schema:
              $ref: "#/definitions/CustomCompanyGreetingInfo"
        x-api-group: "extension/greeting"
        x-throttling-group: "Medium"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "ReadAccounts"
        x-user-permission: "ReadUserInfo"
        x-access-level: "PublicBeta"
    /restapi/v1.0/account/{accountId}/business-hours:
      get:
        tags:
          - "Call Handling Settings"
        summary: "Get Company Business Hours"
        description: "<p style='font-style:italic;'>Since 1.0.32 (Release 9.3)</p><p>Returns company hours when answering rules are to be applied.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadAccounts</td><td>Viewing user account info (including name, business name, address and phone number/account number)</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Light</p>"
        operationId: "loadBusinesshoursInfo"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "accountId"
            in: "path"
            description: "Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"
            required: true
            type: "string"
            default: "~"
        responses:
          default:
            description: "Success"
            schema:
              $ref: "#/definitions/CompanyBusinessHours"
        x-api-group: "extension/answering-rule"
        x-throttling-group: "Light"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "ReadAccounts"
        x-user-permission: "ReadUserAnsweringRules"
        x-access-level: "PublicBeta"
      put:
        tags:
          - "Call Handling Settings"
        summary: "Update Company Business Hours"
        description: "<p style='font-style:italic;'>Since 1.0.24 (Release 8.0)</p><p>Updates company hours when answering rules are to be applied.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>EditExtensions</td><td>Viewing and updating my extension info (includes extension name, number, email and phone number)</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Medium</p>"
        operationId: "updateCompanyBusinessHours"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "accountId"
            in: "path"
            description: "Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"
            required: true
            type: "string"
            default: "~"
          -
            in: "body"
            name: "body"
            description: "JSON body"
            required: true
            schema:
              $ref: "#/definitions/CompanyBusinessHoursUpdateRequest"
        responses:
          default:
            description: "Success"
            schema:
              $ref: "#/definitions/CompanyBusinessHours"
        x-api-group: "extension/answering-rule"
        x-throttling-group: "Medium"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "EditExtensions"
        x-user-permission: "EditUserAnsweringRules"
        x-access-level: "PublicBeta"
    /restapi/v1.0/account/{accountId}/greeting:
      post:
        tags:
          - "Call Handling Settings"
        summary: "Create Custom Company Greeting"
        operationId: "getCompanyGreeting"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "accountId"
            in: "path"
            description: "Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"
            required: true
            type: "string"
            default: "~"
          -
            in: "body"
            name: "body"
            description: "JSON body"
            required: true
            schema:
              $ref: "#/definitions/CustomCompanyGreetingRequest"
        responses:
          default:
            description: "successful operation"
            schema:
              $ref: "#/definitions/CustomCompanyGreetingInfo"
        x-api-group: "extension/greeting"
        x-throttling-group: "Medium"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "EditAccounts"
        x-user-permission: "ReadUserInfo"
        x-access-level: "Advanced"
    /restapi/v1.0/account/{accountId}/answering-rule:
      post:
        tags:
          - "Call Handling Settings"
        summary: "Create Company Call Handling Rule"
        operationId: "createCompanyAnsweringRuleInfo"
        description: "<p style='font-style:italic;'>Since 1.0.31 (Release 9.2)</p><p>Creates a company answering rule for a particular caller ID.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadAccounts</td><td>Viewing user account info (including name, business name, address and phone number/account number)</td></tr><tr><td class='code'>EditExtensions</td><td>Viewing and updating user extension info (includes extension name, number, email and phone number, assigned phone numbers, devices and other extension settings)</td></tr><tr><td class='code'>EditAccounts</td><td>Viewing user account info (including name, business name, address and phone number/account number)</td></tr></tbody></table><h4>API Group</h4><p>Medium</p>"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "accountId"
            type: "string"
            in: "path"
            description: "Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"
            required: true
            default: "~"
          -
            name: "body"
            in: "body"
            description: "JSON body"
            schema:
              $ref: "#/definitions/CompanyAnsweringRuleRequest"
            required: true
        responses:
          default:
            description: "Success"
            schema:
              $ref: "#/definitions/CompanyAnsweringRuleInfo"
        x-api-group: "account/answering-rule"
        x-throttling-group: "Medium"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "EditAccounts"
        x-user-permission: "EditCompanyAnsweringRules"
        x-access-level: "PublicBeta"
      get:
        tags:
          - "Call Handling Settings"
        summary: "Get Company Call Handling Rules"
        operationId: "listCompanyAnsweringRule"
        description: "<p style='font-style:italic;'>Since 1.0.31 (Release 9.2)</p><p>Returns a list of company answering rules.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadAccounts</td><td>Viewing user account info (including name, business name, address and phone number/account number)</td></tr></tbody></table><h4>API Group</h4><p>Medium</p>"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "accountId"
            type: "string"
            in: "path"
            description: "Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"
            required: true
            default: "~"
        responses:
          default:
            description: "Success"
            schema:
              $ref: "#/definitions/CompanyAnsweringRuleList"
        x-api-group: "account/answering-rule"
        x-throttling-group: "Medium"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "ReadAccounts"
        x-user-permission: "ReadCompanyAnsweringRules"
        x-access-level: "PublicBeta"
    /restapi/v1.0/account/{accountId}/answering-rule/{ruleId}:
      get:
        tags:
          - "Call Handling Settings"
        summary: "Get Company Call Handling Rule"
        operationId: "loadCompanyAnsweringRuleInfo"
        description: "<p style='font-style:italic;'>Since 1.0.31 (Release 9.2)</p><p>Returns a company answering rule by ID.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadAccounts</td><td>Viewing user account info (including name, business name, address and phone number/account number)</td></tr></tbody></table><h4>API Group</h4><p>Light</p>"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "accountId"
            type: "string"
            in: "path"
            description: "Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"
            required: true
            default: "~"
          -
            name: "ruleId"
            type: "string"
            in: "path"
            description: "Internal identifier of an answering rule. The value can be standard digital ID or specific ID - either business-hours-rule or after-hours-rule"
            required: true
        responses:
          default:
            description: "Success"
            schema:
              $ref: "#/definitions/CompanyAnsweringRuleInfo"
        x-api-group: "account/answering-rule"
        x-throttling-group: "Light"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "ReadAccounts"
        x-user-permission: "ReadCompanyAnsweringRules"
        x-access-level: "PublicBeta"
      put:
        tags:
          - "Call Handling Settings"
        summary: "Update Company Call Handling Rule"
        operationId: "updateCompanyAnsweringRuleInfo"
        description: "<p style='font-style:italic;'>Since 1.0.31 (Release 9.2)</p><p>Updates a company answering rule.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadAccounts</td><td>Viewing user account info (including name, business name, address and phone number/account number)</td></tr></tbody></table><h4>API Group</h4><p>Medium</p>"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "accountId"
            type: "string"
            in: "path"
            description: "Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"
            required: true
            default: "~"
          -
            name: "ruleId"
            type: "string"
            in: "path"
            description: "Internal identifier of an answering rule. The value can be standard digital ID or specific ID - either business-hours-rule or after-hours-rule"
            required: true
          -
            name: "body"
            in: "body"
            description: "JSON body"
            schema:
              $ref: "#/definitions/CompanyAnsweringRuleUpdate"
            required: true
        responses:
          default:
            description: "Success"
            schema:
              $ref: "#/definitions/CompanyAnsweringRuleInfo"
        x-api-group: "account/answering-rule"
        x-throttling-group: "Medium"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "EditAccounts"
        x-user-permission: "EditCompanyAnsweringRules"
        x-access-level: "PublicBeta"
    /restapi/v1.0/account/{accountId}/ivr-menus:
      post:
        summary: "Create IVR Menu"
        tags:
          - "Call Handling Settings"
        operationId: "createIVRMenu"
        description: "<p style='font-style:italic;'>Since 1.0.32 (Release 9.3)</p><p>Creates a company IVR menu</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>EditAccounts</td><td>Viewing and updating user account info (including name, business name, address and phone number/account number)</td></tr></tbody></table><h4>API Group</h4><p>Heavy</p>"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "accountId"
            in: "path"
            required: true
            type: "string"
          -
            name: "body"
            in: "body"
            description: "JSON body"
            schema:
              $ref: "#/definitions/IVRMenuInfo"
            required: true
        responses:
          default:
            description: "Success"
            schema:
              $ref: "#/definitions/IVRMenuInfo"
        x-api-group: "account/ivr-menus"
        x-throttling-group: "Heavy"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "ReadAccounts"
        x-user-permission: "AutoReceptionist"
        x-access-level: "Internal"
    /restapi/v1.0/account/{accountId}/ivr-menus/{ivrMenuId}:
      get:
        tags:
          - "Call Handling Settings"
        summary: "Get IVR Menu"
        operationId: "getIVRMenuById"
        description: "<p style='font-style:italic;'>Since 1.0.32 (Release 9.3)</p><p>Returns a company IVR menu by ID</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadAccounts</td><td>Viewing user account info (including name, business name, address and phone number/account number)</td></tr></tbody></table><h4>API Group</h4><p>Medium</p>"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "accountId"
            in: "path"
            required: true
            type: "string"
          -
            name: "ivrMenuId"
            in: "path"
            required: true
            type: "string"
        responses:
          default:
            description: "Success"
            schema:
              $ref: "#/definitions/IVRMenuInfo"
        x-api-group: "account/ivr-menus"
        x-throttling-group: "Medium"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "ReadAccounts"
        x-user-permission: "AutoReceptionist"
        x-access-level: "Advanced"
      put:
        tags:
          - "Call Handling Settings"
        summary: "Update IVR Menu"
        description: "<p style='font-style:italic;'>Since 1.0.32 (Release 9.3)</p><p>Returns a company IVR menu by ID</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadAccounts</td><td>Viewing user account info (including name, business name, address and phone number/account number)</td></tr></tbody></table><h4>API Group</h4><p>Medium</p>"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "accountId"
            in: "path"
            required: true
            type: "string"
          -
            name: "ivrMenuId"
            in: "path"
            required: true
            type: "string"
          -
            name: "body"
            in: "body"
            description: "JSON body"
            schema:
              $ref: "#/definitions/IVRMenuInfo"
            required: true
        responses:
          default:
            description: "Success"
            schema:
              $ref: "#/definitions/IVRMenuInfo"
        x-api-group: "account/ivr-menus"
        x-throttling-group: "Medium"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "ReadAccounts"
        x-user-permission: "AutoReceptionist"
        x-access-level: "Internal"
    /restapi/v1.0/account/{accountId}/ivr-prompts:
      post:
        tags:
          - "Call Handling Settings"
        summary: "Create IVR Prompt"
        operationId: "createPrompts"
        description: "<p style='font-style:italic;'>Since 1.0.32 (Release 9.3)</p><p>Creates an IVR prompt.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadAccounts</td><td>Viewing user account info (including name, business name, address and phone number/account number)</td></tr></tbody></table><h4>API Group</h4><p>Heavy</p>"
        consumes:
          - "multipart/form-data"
        produces:
          - "application/json"
        parameters:
          -
            name: "accountId"
            in: "path"
            required: true
            type: "string"
          -
            in: "formData"
            name: "attachment"
            type: "file"
            required: true
            description: "Audio file that will be used as a prompt. Attachment cannot be empty, only audio files are supported"
          -
            in: "formData"
            name: "name"
            type: "string"
            required: false
            description: "Description of file contents."
        responses:
          default:
            description: "Success"
            schema:
              $ref: "#/definitions/PromptInfo"
        x-api-group: "account/ivr-prompts"
        x-throttling-group: "Heavy"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "EditAccounts"
        x-user-permission: "EditCompanyGreetings"
        x-access-level: "Internal"
      get:
        tags:
          - "Call Handling Settings"
        summary: "Get IVR Prompts"
        operationId: "getIVRPrompts"
        description: "<p style='font-style:italic;'>Since 1.0.32 (Release 9.3)</p><p>Returns a list of IVR prompts.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadAccounts</td><td>Viewing user account info (including name, business name, address and phone number/account number)</td></tr></tbody></table><h4>API Group</h4><p>Medium</p>"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "accountId"
            in: "path"
            required: true
            type: "string"
        responses:
          default:
            description: "Success"
            schema:
              $ref: "#/definitions/IVRPrompts"
        x-api-group: "account/ivr-prompts"
        x-throttling-group: "Medium"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "ReadAccounts"
        x-user-permission: "ReadCompanyGreetings"
        x-access-level: "Advanced"
    /restapi/v1.0/account/{accountId}/ivr-prompts/{promptId}:
      get:
        tags:
          - "Call Handling Settings"
        summary: "Get IVR Prompt"
        operationId: "getIVRPrompt"
        description: "<p style='font-style:italic;'>Since 1.0.32 (Release 9.3)</p><p>Returns an IVR prompt by ID</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadAccounts</td><td>Viewing user account info (including name, business name, address and phone number/account number)</td></tr></tbody></table><h4>API Group</h4><p>Medium</p>"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "accountId"
            in: "path"
            required: true
            type: "string"
          -
            name: "promptId"
            in: "path"
            required: true
            type: "string"
        responses:
          default:
            description: "Success"
            schema:
              $ref: "#/definitions/PromptInfo"
        x-api-group: "account/ivr-prompts"
        x-throttling-group: "Medium"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "ReadAccounts"
        x-user-permission: "ReadCompanyGreetings"
        x-access-level: "Advanced"
      delete:
        tags:
          - "Call Handling Settings"
        summary: "Delete IVR Prompt"
        operationId: "deleteIVRPrompt"
        description: "<p style='font-style:italic;'>Since 1.0.32 (Release 9.3)</p><p>Deletes an IVR prompt by ID</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>EditAccounts</td><td>Viewing user account info (including name, business name, address and phone number/account number)</td></tr></tbody></table><h4>API Group</h4><p>Heavy</p>"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "accountId"
            in: "path"
            required: true
            type: "string"
          -
            name: "promptId"
            in: "path"
            required: true
            type: "string"
        responses:
          default:
            description: "Success"
        x-api-group: "account/ivr-prompts"
        x-throttling-group: "Heavy"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "EditAccounts"
        x-user-permission: "EditCompanyGreetings"
        x-access-level: "Advanced"
    /restapi/v1.0/account/{accountId}/ivr-prompts/{promptId}/content:
      get:
        tags:
          - "Call Handling Settings"
        summary: "Get IVR Prompt Content"
        operationId: "getIVRPromptContent"
        description: "<p style='font-style:italic;'>Since 1.0.32 (Release 9.3)</p><p>Returns media content of an IVR prompt by its ID</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadAccounts</td><td>Viewing user account info (including name, business name, address and phone number/account number)</td></tr></tbody></table><h4>API Group</h4><p>Medium</p>"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "accountId"
            in: "path"
            required: true
            type: "string"
          -
            name: "promptId"
            in: "path"
            required: true
            type: "string"
        responses:
          default:
            description: "Success"
        x-api-group: "account/ivr-prompts"
        x-throttling-group: "Medium"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "ReadAccounts"
        x-user-permission: "ReadCompanyGreetings"
        x-access-level: "Advanced"
    /restapi/v1.0/client-info:
      get:
        tags:
          - "Application Settings"
        summary: "Get App Settings"
        description: "<p style='font-style:italic;'>Since 1.0.11 (Release 6.3)</p><p>Returns client application data: general info, specific provisioning parameters, hints, etc.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadClientInfo</td><td>Viewing of client application registered attributes and additional helper information (external URLs, hints, etc.)</td></tr></tbody></table>"
        operationId: "loadClientInfo"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters: []
        responses:
          default:
            description: "Success"
            schema:
              $ref: "#/definitions/ClientApiResponse"
        x-api-group: "client-info"
        x-throttling-group: "Light"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "ReadClientInfo"
        x-access-level: "Internal"
    /restapi/v1.0/client-info/sip-provision:
      post:
        tags:
          - "Application Settings"
        summary: "Register SIP Device"
        description: "<p style='font-style:italic;'>Since 1.0.16 (Release 7.1)</p><p>Creates SIP registration of a device/application (WebPhone, Mobile, softphone)</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>VoipCalling</td><td>Registering as VoIP device and making VoIP calls</td></tr></tbody></table><h4>API Group</h4><p>Heavy</p>"
        operationId: "createSipRegistration"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            in: "body"
            name: "body"
            description: "JSON body"
            required: true
            schema:
              $ref: "#/definitions/CreateSipRegistrationRequest"
        responses:
          default:
            description: "Success"
            schema:
              $ref: "#/definitions/CreateSipRegistrationResponse"
        x-api-group: "client-info/sip-provision"
        x-throttling-group: "Heavy"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "VoipCalling"
        x-access-level: "PublicBeta"
    /restapi/v1.0/client-info/banners:
      get:
        tags:
          - "Application Settings"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        summary: "Get In Product Message List"
        description: "<p style='font-style:italic;'>Since 1.0.28 (Release 8.4)</p><p>Returns list of in-product messages: learderboards, announcements, etc. Please note: Banners are set on Marketing/Messages tab in Admin Web.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadClientInfo</td><td>Viewing of client application registered attributes and additional helper information (external URLs, hints, etc.)</td></tr></tbody></table><h4>API Group</h4><p>Light</p>"
        operationId: "getInProductMessage"
        parameters:
          -
            in: "query"
            required: true
            type: "string"
            name: "bannerType"
            default: "LeaderBoard"
        responses:
          default:
            description: "Success"
            schema:
              $ref: "#/definitions/InProductMessages"
        x-throttling-group: "Light"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "ReadClientInfo"
        x-api-group: "client-info/banners"
        x-access-level: "Internal"
    /restapi/v1.0/client-info/custom-data/{key}:
      get:
        tags:
          - "Application Settings"
        summary: "Get Custom Data"
        description: "<p style='font-style:italic;'>Since 1.0.14 (Release 6.6)</p>Returns custom data of a logged-in extension.<p></p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>EditCustomData</td><td>Viewing and updating client custom data (key-value)</td></tr></tbody></table><h4>API Group</h4><p>Light</p>"
        operationId: "getCustomData"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "key"
            in: "path"
            description: "Custom data access key. The number of unique custom data keys is limited to 100 keys per extension, summarized for all the applications. For example, if you have created 50 custom data keys under the Android mobile client application for the particular extension, then logged in the iOS application and created another 50 keys, the web client application won't be allowed to create any custom data key for that extension"
            required: true
            type: "integer"
        responses:
          default:
            description: "successful operation"
            schema:
              $ref: "#/definitions/CustomDataResource"
        x-api-group: "client-info/custom-data"
        x-throttling-group: "Light"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "EditCustomData"
        x-access-level: "Internal"
      put:
        tags:
          - "Application Settings"
        summary: "Create/Update Custom Data"
        description: "<p style='font-style:italic;'>Since 1.0.14 (Release 6.6)</p><p>Creates or updates custom data for the extension that is currently logged in.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>EditCustomData</td><td>Viewing and updating client custom data (key-value)</td></tr></tbody></table>"
        operationId: "updateCustomData"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "key"
            in: "path"
            description: "Custom data access key. The number of unique custom data keys is limited to 100 keys per extension, summarized for all the applications. For example, if you have created 50 custom data keys under the Android mobile client application for the particular extension, then logged in the iOS application and created another 50 keys, the web client application won't be allowed to create any custom data key for that extension"
            required: true
            type: "integer"
          -
            in: "body"
            name: "body"
            description: "JSON body"
            required: true
            schema:
              $ref: "#/definitions/CustomDataRequest"
        responses:
          default:
            description: "Success"
            schema:
              $ref: "#/definitions/CustomDataApiResponse"
        x-api-group: "client-info/custom-data"
        x-throttling-group: "Medium"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "EditCustomData"
        x-access-level: "Internal"
      delete:
        tags:
          - "Application Settings"
        summary: "Delete Custom Data"
        description: "<p style='font-style:italic;'>Since 1.0.14 (Release 6.6)</p>Deletes custom data by its ID.<p></p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>EditCustomData</td><td>Viewing and updating client custom data (key-value)</td></tr></tbody></table><h4>API Group</h4><p>Light</p>"
        operationId: "deleteCustomData"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "key"
            in: "path"
            description: "Custom data access key. The number of unique custom data keys is limited to 100 keys per extension, summarized for all the applications. For example, if you have created 50 custom data keys under the Android mobile client application for the particular extension, then logged in the iOS application and created another 50 keys, the web client application won't be allowed to create any custom data key for that extension"
            required: true
            type: "integer"
        responses:
          default:
            description: "successful operation"
        x-api-group: "client-info/custom-data"
        x-throttling-group: "Medium"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "EditCustomData"
        x-access-level: "Internal"
    /restapi/v1.0/client-info/custom-data/{key}/content:
      get:
        tags:
          - "Application Settings"
        summary: "Get Custom Data Attachment"
        description: "<p style='font-style:italic;'>Since 1.0.14 (Release 6.6)</p>Returns custom data attachment by ID.<p></p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>EditCustomData</td><td>Viewing and updating client custom data (key-value)</td></tr></tbody></table><h4>API Group</h4><p>Light</p>"
        operationId: "getAttachment"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "key"
            in: "path"
            required: true
            type: "string"
          -
            name: "Range"
            in: "header"
            required: false
            type: "string"
        responses:
          default:
            description: "successful operation"
        x-api-group: "client-info/custom-data/content"
        x-throttling-group: "Light"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "EditCustomData"
        x-access-level: "Internal"
    /restapi/v1.0/client-info/special-number-rule:
      get:
        tags:
          - "Application Settings"
        summary: "Get Special Numbers Calling Limitation"
        description: "<p style='font-style:italic;'>Since 1.0.12 (Release 6.4)</p><p>Returns available special numbers and rules of processing, depending on account brand and application type (mobile/softphone/web/other). A special number rule for each number includes limitations on the options: VoIP, RingOut, outgoing SMS and Fax. If the option is disallowed, the server returns the reason code and text description.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadClientInfo</td><td>Viewing of client application registered attributes and additional helper information (external URLs, hints, etc.)</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Light</p>"
        operationId: "getSpecialNumberRules."
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "countryId"
            in: "query"
            description: "Internal identifier of a country. If not specified, the response is returned for the brand country"
            required: false
            type: "integer"
        responses:
          default:
            description: "Success"
            schema:
              $ref: "#/definitions/NavigationInfo"
        x-api-group: "client-info/special-number-rule"
        x-throttling-group: "Light"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "ReadClientInfo"
        x-access-level: "Internal"
    /restapi/v1.0/number-parser/phonedata.xml:
      get:
        tags:
          - "Application Settings"
        summary: "Get Phonedata"
        description: "<p style='font-style:italic;'>Since 1.0.12 (Release 6.4)</p><p>Returns configuration settings for phone number parser in a phonedata.xml file.</p><h4>Usage Plan Group</h4><p>Medium</p>"
        operationId: "loadPhoneData"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters: []
        responses:
          default:
            description: "Success"
        x-api-group: "number-parser/phonedata.xml"
        x-throttling-group: "Medium"
        x-metered-api: true
        x-metering-group: "System"
        x-access-level: "Internal"
    /restapi/v1.0/account/{accountId}/extension/{extensionId}:
      get:
        tags:
          - "User Settings"
        summary: "Get Extension Info"
        description: "<p style='font-style:italic;'>Since 1.0.0</p><p>Returns basic information about a particular extension of an account.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadAccounts</td><td>Viewing user account info (including name, business name, address and phone number/account number)</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Light</p>"
        operationId: "loadExtensionInfo"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "accountId"
            in: "path"
            description: "Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"
            required: true
            type: "string"
            default: "~"
          -
            name: "extensionId"
            in: "path"
            description: "Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session"
            required: true
            type: "string"
            default: "~"
        responses:
          default:
            description: "Success"
            schema:
              $ref: "#/definitions/GetExtensionInfoResponse"
        x-api-group: "extension"
        x-throttling-group: "Light"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "ReadAccounts"
        x-user-permission: "ReadExtensions"
        x-access-level: "Public"
      put:
        tags:
          - "User Settings"
        summary: "Update Extension"
        description: "<p style='font-style:italic;'></p><p></p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>EditExtensions</td><td>Viewing and updating my extension info (includes extension name, number, email and phone number)</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Medium</p>"
        operationId: "updateExtension"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "accountId"
            in: "path"
            description: "Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"
            required: true
            type: "string"
            default: "~"
          -
            name: "extensionId"
            in: "path"
            description: "Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session"
            required: true
            type: "string"
            default: "~"
          -
            in: "body"
            name: "body"
            description: "JSON body"
            required: true
            schema:
              $ref: "#/definitions/ExtensionUpdateRequest"
        responses:
          default:
            description: "Success"
            schema:
              $ref: "#/definitions/GetExtensionInfoResponse"
        x-api-group: "extension"
        x-throttling-group: "Medium"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "EditExtensions"
        x-user-permission: "EditUserInfo OR EditUserCredentials"
        x-access-level: "Advanced"
      delete:
        tags:
          - "User Settings"
        summary: "Delete Extension"
        description: "<p style='font-style:italic;'>Since 1.0.10 (Release 6.2)</p><p>Deletes extension(s) by ID(s).</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>EditAccounts</td><td>Viewing and updating user account info (including name, business name, address and phone number/account number)</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Medium</p>"
        operationId: "deleteExtension"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "extensionId"
            in: "path"
            required: true
            type: "string"
          -
            name: "accountId"
            in: "path"
            required: true
            type: "string"
        responses:
          default:
            description: "successful operation"
        x-api-group: "extension"
        x-throttling-group: "Medium"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "EditAccounts"
        x-user-permission: "AddRemoveUsers"
        x-access-level: "Advanced"
    /restapi/v1.0/account/{accountId}/extension/{extensionId}/caller-id:
      get:
        tags:
          - "User Settings"
        summary: "Get Extension Caller ID"
        operationId: "loadExtensionCallerId"
        description: "<p style='font-style:italic;'>Since 1.0.28 (Release 8.4)</p><p>Returns information on an outbound caller ID of an extension.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadAccounts</td><td>Viewing user account info (including name, business name, address and phone number/account number)</td></tr></tbody></table><h4>API Group</h4><p>Light</p>"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "accountId"
            type: "string"
            in: "path"
            description: "Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"
            required: true
            default: "~"
          -
            name: "extensionId"
            type: "string"
            in: "path"
            description: "Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session"
            required: true
            default: "~"
        responses:
          default:
            description: "Success"
            schema:
              $ref: "#/definitions/ExtensionCallerIdInfo"
        x-api-group: "extension/caller-id"
        x-throttling-group: "Light"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "ReadAccounts"
        x-user-permission: "ReadCallerIDSettings"
        x-access-level: "Public"
      put:
        tags:
          - "User Settings"
        summary: "Update Extension Caller ID"
        operationId: "updateExtensionCallerId"
        description: "<p style='font-style:italic;'>Since 1.0.28 (Release 8.4)</p><p>Updates outbound caller ID information of an extension.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>EditExtensions</td><td>Viewing and updating my extension info (includes extension name, number, email and phone number)</td></tr></tbody></table><h4>API Group</h4><p>Medium</p>"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "accountId"
            type: "string"
            in: "path"
            description: "Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"
            required: true
            default: "~"
          -
            name: "extensionId"
            type: "string"
            in: "path"
            description: "Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session"
            required: true
            default: "~"
          -
            name: "body"
            in: "body"
            description: "JSON body"
            schema:
              $ref: "#/definitions/ExtensionCallerIdInfo"
            required: true
        responses:
          default:
            description: "Success"
            schema:
              $ref: "#/definitions/ExtensionCallerIdInfo"
        x-api-group: "extension/caller-id"
        x-throttling-group: "Medium"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "EditExtensions"
        x-user-permission: "EditCallerIDSettings"
        x-access-level: "Public"
    /restapi/v1.0/account/{accountId}/extension/{extensionId}/credentials:
      get:
        tags:
          - "User Settings"
        summary: "Get User Credentials"
        operationId: "loadExtensionUserCredentials"
        description: "<p style='font-style:italic;'>Since 1.0.27 (Release 8.3)</p><p>Returns extension user credentials.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadAccounts</td><td>Viewing user account info (including name, business name, address and phone number/account number)</td></tr></tbody></table><h4>API Group</h4><p>Medium</p>"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "accountId"
            type: "string"
            in: "path"
            description: "Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"
            required: true
            default: "~"
          -
            name: "extensionId"
            type: "string"
            in: "path"
            description: "Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session"
            required: true
            default: "~"
        responses:
          default:
            description: "Success"
            schema:
              $ref: "#/definitions/ExtensionUserCredentials"
        x-api-group: "extension/credentials"
        x-throttling-group: "Medium"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "ReadAccounts"
        x-user-permission: "ReadUserInfo"
        x-access-level: "Internal"
      put:
        tags:
          - "User Settings"
        summary: "Update User Credentials"
        operationId: "updateExtensionUserCredentials"
        description: "<p style='font-style:italic;'>Since 1.0.27 (Release 8.3)</p><p>Updates extension user credentials.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadAccounts</td><td>Viewing user account info (including name, business name, address and phone number/account number)</td></tr></tbody></table><h4>API Group</h4><p>Medium</p>"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "accountId"
            type: "string"
            in: "path"
            description: "Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"
            required: true
            default: "~"
          -
            name: "extensionId"
            type: "string"
            in: "path"
            description: "Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session"
            required: true
            default: "~"
          -
            name: "body"
            in: "body"
            description: "JSON body"
            required: true
            schema:
              $ref: "#/definitions/ExtensionUserCredentailsRequest"
        responses:
          default:
            description: "Success"
            schema:
              $ref: "#/definitions/ExtensionUserCredentials"
        x-api-group: "extension/credentials"
        x-throttling-group: "Medium"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "EditExtensions"
        x-user-permission: "EditUserCredentials"
        x-access-level: "Internal"
    /restapi/v1.0/account/{accountId}/extension/{extensionId}/credentials/validate:
      post:
        tags:
          - "User Settings"
        summary: "Validate User Credentials"
        operationId: "validateExtensionUserCredentials"
        description: "<p style='font-style:italic;'>Since 1.0.27 (Release 8.3)</p><p>Validates if extension user credentials specified can be applied.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>EditExtensions</td><td>Viewing and updating my extension info (includes extension name, number, email and phone number)</td></tr></tbody></table><h4>API Group</h4><p>Medium</p>"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "accountId"
            type: "string"
            in: "path"
            description: "Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"
            required: true
            default: "~"
          -
            name: "extensionId"
            type: "string"
            in: "path"
            description: "Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session"
            required: true
            default: "~"
          -
            name: "body"
            in: "body"
            description: "JSON body"
            schema:
              $ref: "#/definitions/ValidateExtensionUserCredentials"
            required: true
        responses:
          default:
            description: "Success"
        x-api-group: "extension/credentials/validate"
        x-throttling-group: "Medium"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "EditExtensions"
        x-access-level: "Internal"
    /restapi/v1.0/account/{accountId}/extension/{extensionId}/credentials/verify:
      post:
        tags:
          - "User Settings"
        summary: "Verify Extension User Credentials"
        operationId: "verifyExtensionUserCredentials"
        description: "<p style='font-style:italic;'>Since 1.0.27 (Release 8.3)</p><p>Verifies current extension user credentials.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>EditExtensions</td><td>Viewing and updating my extension info (includes extension name, number, email and phone number)</td></tr></tbody></table><h4>API Group</h4><p>Medium</p>"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "accountId"
            type: "string"
            in: "path"
            description: "Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"
            required: true
            default: "~"
          -
            name: "extensionId"
            type: "string"
            in: "path"
            description: "Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session"
            required: true
            default: "~"
          -
            name: "body"
            in: "body"
            description: "JSON body"
            schema:
              $ref: "#/definitions/VerifyExtensionUserCredentials"
            required: true
        responses:
          default:
            description: "Success"
        x-api-group: "extension/credentials/validate"
        x-throttling-group: "Medium"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "EditExtensions"
        x-user-permission: "EditUserCredentials"
        x-access-level: "Internal"
    /restapi/v1.0/dictionary/secret-question:
      get:
        tags:
          - "User Settings"
        summary: "Get Secret Questions"
        description: "<p style='font-style:italic;'>Since 1.0.20 (Release 7.4)</p><p>Returns the list of secret questions for a specific language.</p><h4>Usage Plan Group</h4><p>Light</p>"
        operationId: "listSecretQuestions"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "signupOnly"
            in: "query"
            required: false
            type: "boolean"
            default: false
          -
            name: "page"
            in: "query"
            required: false
            type: "string"
            default: "1"
          -
            name: "perPage"
            in: "query"
            required: false
            type: "string"
            default: "100"
        responses:
          default:
            description: "Success"
            schema:
              $ref: "#/definitions/GetSecretQuestionListResponse"
        x-api-group: "dictionary/secret-question"
        x-throttling-group: "Light"
        x-metered-api: true
        x-metering-group: "System"
        x-access-level: "Internal"
    /restapi/v1.0/dictionary/secret-question/{questionId}:
      get:
        tags:
          - "User Settings"
        summary: "Get Secret Question"
        description: "<p style='font-style:italic;'>Since 1.0.20 (Release 7.4)</p><p>Returns a particular secret question in specific language by question ID.</p><h4>Usage Plan Group</h4><p>Light</p>"
        operationId: "loadSecretQuestion"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "questionId"
            in: "path"
            description: "Internal identifier of a question"
            required: true
            type: "integer"
        responses:
          default:
            description: "Success"
            schema:
              $ref: "#/definitions/SecretQuestionInfo"
        x-api-group: "dictionary/secret-question"
        x-throttling-group: "Light"
        x-metered-api: true
        x-metering-group: "System"
        x-access-level: "Internal"
    /restapi/v1.0/account/{accountId}/extension/{extensionId}/grant:
      get:
        tags:
          - "User Settings"
        summary: "Get Extension Grants"
        description: "<p style='font-style:italic;'></p><p>Returns the list of extension grants.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadAccounts</td><td>Viewing user account info (including name, business name, address and phone number/account number)</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Light</p>"
        operationId: "listExtensionGrants"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "accountId"
            in: "path"
            description: "Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"
            required: true
            type: "string"
            default: "~"
          -
            name: "extensionId"
            in: "path"
            description: "Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session"
            required: true
            type: "string"
            default: "~"
          -
            name: "page"
            in: "query"
            description: "Indicates the page number to retrieve. Only positive number values are allowed. Default value is '1'"
            required: false
            type: "integer"
          -
            name: "perPage"
            in: "query"
            description: "Indicates the page size (number of items). If not specified, the value is '100' by default"
            required: false
            type: "integer"
        responses:
          default:
            description: "Success"
            schema:
              $ref: "#/definitions/GetExtensionGrantListResponse"
        x-api-group: "extension/grant"
        x-throttling-group: "Light"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "ReadAccounts"
        x-user-permission: "ReadExtensions"
        x-access-level: "Public"
    /restapi/v1.0/account/{accountId}/extension/{extensionId}/notification-settings:
      get:
        tags:
          - "User Settings"
        summary: "Get Notification Settings"
        description: "<p style='font-style:italic;'>Since 1.0.26 (Release 8.2)</p><p>Returns notification settings for the current extension.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadAccounts</td><td>Viewing user account info (including name, business name, address and phone number/account number)</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Light</p>"
        operationId: "getNotificationSettings"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "accountId"
            in: "path"
            description: "Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"
            required: true
            type: "string"
            default: "~"
          -
            name: "extensionId"
            in: "path"
            description: "Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session"
            required: true
            type: "string"
        responses:
          default:
            description: "Success"
            schema:
              $ref: "#/definitions/NotificationSettings"
        x-api-group: "extension/notification-settings"
        x-throttling-group: "Light"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "ReadAccounts"
        x-user-permission: "ReadMessagesNotificationsSettings"
        x-access-level: "PublicBeta"
      put:
        tags:
          - "User Settings"
        summary: "Update Notification Settings"
        description: "<p style='font-style:italic;'>Since 1.0.26 (Release 8.2)</p><p>Updates notification settings for the current extension.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>EditExtensions</td><td>Viewing and updating my extension info (includes extension name, number, email and phone number)</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Medium</p>"
        operationId: "updateNotificationSettings"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "accountId"
            in: "path"
            description: "Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"
            required: true
            type: "string"
            default: "~"
          -
            name: "extensionId"
            in: "path"
            description: "Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session"
            required: true
            type: "integer"
          -
            in: "body"
            name: "body"
            required: true
            schema:
              $ref: "#/definitions/NotificationSettingsUpdateRequest"
        responses:
          default:
            description: "Success"
            schema:
              $ref: "#/definitions/NotificationSettings"
        x-api-group: "extension/notification-settings"
        x-throttling-group: "Medium"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "EditExtensions"
        x-user-permission: "EditMessagesNotificationsSettings"
        x-access-level: "PublicBeta"
    /restapi/v1.0/account/{accountId}/extension/{extensionId}/profile-image:
      get:
        tags:
          - "User Settings"
        summary: "Get User Profile Image"
        description: "<p style='font-style:italic;'>Since 1.0.20 (Release 7.4)</p><p>Returns the extension profile image.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadAccounts</td><td>Viewing user account info (including name, business name, address and phone number/account number)</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Medium</p>"
        operationId: "downloadImage"
        consumes:
          - "application/json"
        produces:
          - "*/*"
          - "image/png"
          - "image/jpeg"
          - "image/gif"
        parameters:
          -
            name: "extensionId"
            in: "path"
            required: true
            type: "string"
          -
            name: "accountId"
            in: "path"
            required: true
            type: "string"
        responses:
          default:
            description: "successful operation"
            schema:
              $ref: "#/definitions/Binary"
        x-api-group: "extension/profile-image"
        x-throttling-group: "Medium"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "ReadAccounts"
        x-user-permission: "ReadExtensions"
        x-access-level: "Public"
      post:
        tags:
          - "User Settings"
        summary: "Upload User Profile Image"
        description: "<p style='font-style:italic;'>Since 1.0.26 (Release 8.2)</p><p>Returns the extension profile image.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>EditExtensions</td><td>Viewing and updating my extension info (includes extension name, number, email and phone number)</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Heavy</p>"
        operationId: "uploadImageByPostForm"
        consumes:
          - "multipart/form-data"
        produces:
          - "application/json"
        parameters:
          -
            name: "image"
            in: "formData"
            required: true
            type: "file"
          -
            name: "extensionId"
            in: "path"
            required: true
            type: "string"
          -
            name: "accountId"
            in: "path"
            required: true
            type: "string"
        responses:
          default:
            description: "successful operation"
            schema:
              $ref: "#/definitions/Binary"
        x-api-group: "extension/profile-image"
        x-throttling-group: "Heavy"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "EditExtensions"
        x-user-permission: "EditUserInfo"
        x-access-level: "Public"
      put:
        tags:
          - "User Settings"
        summary: "Update User Profile Image"
        description: "<p style='font-style:italic;'>Since 1.0.26 (Release 8.2)</p><p>Updates the extension profile image..</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>EditExtensions</td><td>Viewing and updating my extension info (includes extension name, number, email and phone number)</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Heavy</p>"
        operationId: "uploadImageByPutForm"
        consumes:
          - "multipart/form-data"
        produces:
          - "application/json"
        parameters:
          -
            name: "image"
            in: "formData"
            required: false
            type: "file"
          -
            name: "extensionId"
            in: "path"
            required: true
            type: "string"
          -
            name: "accountId"
            in: "path"
            required: true
            type: "string"
        responses:
          default:
            description: "successful operation"
            schema:
              $ref: "#/definitions/Binary"
        x-api-group: "extension/profile-image"
        x-throttling-group: "Heavy"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "EditExtensions"
        x-user-permission: "EditUserInfo"
        x-access-level: "Public"
    /restapi/v1.0/account/{accountId}/extension/{extensionId}/profile-image/{scaleSize}:
      get:
        tags:
          - "User Settings"
        summary: "Get Extension Profile Image (Scaled)"
        description: "<p style='font-style:italic;'></p><p>Returns the extension profile image.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadAccounts</td><td>Viewing user account info (including name, business name, address and phone number/account number)</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Medium</p>"
        operationId: "loadExtensionProfileImage"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "accountId"
            in: "path"
            description: "Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"
            required: true
            type: "string"
            default: "~"
          -
            name: "extensionId"
            in: "path"
            description: "Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session"
            required: true
            type: "string"
            default: "~"
          -
            name: "scaleSize"
            in: "path"
            description: "Dimensions of a profile image which will be returned in response. If this path parameter is not specified in request URI then"
            required: true
            type: "string"
        responses:
          default:
            description: "Success"
            schema:
              $ref: "#/definitions/Binary"
        x-api-group: "extension/profile-image"
        x-throttling-group: "Light"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "ReadAccounts"
        x-user-permission: "ReadExtensions"
        x-access-level: "Public"
    /restapi/v1.0/account/{accountId}/extension/{extensionId}/conferencing:
      get:
        tags:
          - "User Settings"
        summary: "Get User Conferencing Settings"
        description: "<p style='font-style:italic;'>Since 1.0.4 (Release 5.13)</p><p>Returns the information on the Free Conference Calling (FCC) feature for a given extension.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadAccounts</td><td>Viewing user account info (including name, business name, address and phone number/account number)</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Light</p>"
        operationId: "loadConferencingInfo"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "accountId"
            in: "path"
            description: "Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"
            required: true
            type: "string"
            default: "~"
          -
            name: "extensionId"
            in: "path"
            description: "Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session"
            required: true
            type: "string"
            default: "~"
          -
            name: "countryId"
            in: "query"
            description: "Internal identifier of a country. If not specified, the response is returned for the brand country"
            required: false
            type: "string"
        responses:
          default:
            description: "Success"
            schema:
              $ref: "#/definitions/GetConferencingInfoResponse"
        x-api-group: "extension/conferencing"
        x-throttling-group: "Light"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "ReadAccounts"
        x-user-permission: "OrganizeConference"
        x-access-level: "Public"
      put:
        tags:
          - "User Settings"
        summary: "Update User Conferencing Settings"
        description: "<p style='font-style:italic;'></p><p></p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>EditExtensions</td><td>Viewing and updating my extension info (includes extension name, number, email and phone number)</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Medium</p>"
        operationId: "updateConferencingInfo"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "accountId"
            in: "path"
            description: "Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"
            required: true
            type: "string"
            default: "~"
          -
            name: "extensionId"
            in: "path"
            description: "Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session"
            required: true
            type: "string"
            default: "~"
          -
            in: "body"
            name: "body"
            description: "JSON body"
            required: true
            schema:
              $ref: "#/definitions/UpdateConferencingInfoRequest"
        responses:
          default:
            description: "Success"
            schema:
              $ref: "#/definitions/GetConferencingInfoResponse"
        x-api-group: "extension/conferencing"
        x-throttling-group: "Medium"
        x-metered-api: true
        x-metering-group: "System"
        x-user-permission: "OrganizeConference"
        x-app-permission: "EditExtensions"
        x-access-level: "Public"
    /restapi/v1.0/account/{accountId}:
      get:
        tags:
          - "Company Settings"
        summary: "Get Company Info"
        description: "<p style='font-style:italic;'>Since 1.0.0</p><p>Returns basic information about a particular RingCentral customer account.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadAccounts</td><td>Viewing user account info (including name, business name, address and phone number/account number)</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Light</p>"
        operationId: "loadAccount"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "accountId"
            in: "path"
            description: "Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"
            required: true
            type: "string"
            default: "~"
        responses:
          default:
            description: "Success"
            schema:
              $ref: "#/definitions/GetAccountInfoResponse"
        x-api-group: "account"
        x-throttling-group: "Light"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "ReadAccounts"
        x-user-permission: "ReadCompanyInfo"
        x-access-level: "Public"
      put:
        tags:
          - "Company Settings"
        summary: "Update Company"
        description: "<p style='font-style:italic;'>Since 1.0.0</p><p>Updates account information.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>EditAccounts</td><td>Viewing and updating user account info (including name, business name, address and phone number/account number)</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Medium</p>"
        operationId: "modifyAccount"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "accountId"
            in: "path"
            required: true
            type: "string"
          -
            in: "body"
            name: "body"
            description: "JSON body"
            required: true
            schema:
              $ref: "#/definitions/UpdateAccountRequest"
        responses:
          default:
            description: "successful operation"
            schema:
              $ref: "#/definitions/GetAccountInfoResponse"
        x-api-group: "account"
        x-throttling-group: "Medium"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "EditAccounts"
        x-user-permission: "EditCompanyInfo"
        x-access-level: "Internal"
      delete:
        tags:
          - "Company Settings"
        summary: "Delete Account"
        description: "<p style='font-style:italic;'>Since 1.0.0</p><p>Updates account information.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>EditAccounts</td><td>Viewing and updating user account info (including name, business name, address and phone number/account number)</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Medium</p>"
        operationId: "deleteAccount"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "accountId"
            in: "path"
            required: true
            type: "string"
        responses:
          default:
            description: "successful operation"
        x-api-group: "account"
        x-throttling-group: "Medium"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "Accounts"
        x-access-level: "Internal"
    /restapi/v1.0/account/{accountId}/business-address:
      get:
        tags:
          - "Company Settings"
        summary: "Get Company Business Address"
        description: "<p style='font-style:italic;'></p><p></p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadAccounts</td><td>Viewing user account info (including name, business name, address and phone number/account number)</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Light</p>"
        operationId: "loadAccountBusinessAddress"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "accountId"
            in: "path"
            description: "Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"
            required: true
            type: "string"
            default: "~"
        responses:
          default:
            description: "Success"
            schema:
              $ref: "#/definitions/GetAccountInfoResponse"
        x-api-group: "account/business-address"
        x-throttling-group: "Light"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "ReadAccounts"
        x-user-permission: "ReadCompanyInfo"
        x-access-level: "Public"
      put:
        tags:
          - "Company Settings"
        summary: "Update Company Business Address"
        description: "<p style='font-style:italic;'></p><p></p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>EditAccounts</td><td>Viewing and updating user account info (including name, business name, address and phone number/account number)</td></tr><tr><td class='code'>ReadAccounts</td><td>Viewing user account info (including name, business name, address and phone number/account number)</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Medium</p>"
        operationId: "updateAccountBusinessAddress"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "accountId"
            in: "path"
            description: "Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"
            required: true
            type: "string"
            default: "~"
          -
            in: "body"
            name: "body"
            description: "JSON body"
            required: true
            schema:
              $ref: "#/definitions/ModifyAccountBusinessAddressRequest"
        responses:
          default:
            description: "Success"
            schema:
              $ref: "#/definitions/AccountBusinessAddressResource"
        x-api-group: "account/business-address"
        x-throttling-group: "Medium"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "EditAccounts"
        x-user-permission: "EditCompanyInfo"
        x-access-level: "Advanced"
    /restapi/v1.0/account/{accountId}/service-info:
      get:
        tags:
          - "Company Settings"
        summary: "Get Account Service Info"
        description: "<p style='font-style:italic;'></p><p></p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadAccounts</td><td>Viewing user account info (including name, business name, address and phone number/account number)</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Light</p>"
        operationId: "loadServiceInfo"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "accountId"
            in: "path"
            description: "Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"
            required: true
            type: "string"
            default: "~"
        responses:
          default:
            description: "Success"
            schema:
              $ref: "#/definitions/GetServiceInfoResponse"
        x-api-group: "account/service-info"
        x-throttling-group: "Light"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "ReadAccounts"
        x-user-permission: "ReadServicePlanInfo"
        x-access-level: "Advanced"
      put:
        tags:
          - "Company Settings"
        summary: "Update Account Service Info [Beta]"
        operationId: "updateServiceInfo"
        description: "<p style='font-style:italic;'>Since 1.0.29 (Release 9.0)</p><p>Updates limitations for a particular RingCentral customer account.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>Accounts</td><td>Managing accounts: creating new accounts, viewing and updating account information, deleting existing accounts</td></tr><tr><td class='code'>EditAccounts</td><td>Viewing and updating user account info (including name, business name, address and phone number/account number)</td></tr></tbody></table><h4>API Group</h4><p>Light</p>"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "accountId"
            type: "string"
            in: "path"
            description: "Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"
            required: true
            default: "~"
          -
            name: "body"
            in: "body"
            description: "JSON body"
            schema:
              $ref: "#/definitions/ServiceInfoRequest"
            required: true
        responses:
          default:
            description: "Success"
            schema:
              $ref: "#/definitions/AccountServiceInfo"
        x-api-group: "account/service-info"
        x-throttling-group: "Light"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "Accounts"
        x-user-permission: "EditServicePlanInfo"
        x-access-level: "Internal"
    /restapi/v1.0/account/{accountId}/dialing-plan:
      get:
        tags:
          - "Company Settings"
        summary: "Get Available Dialing Plans"
        description: "<p style='font-style:italic;'></p><p>Returns list of countries which can be selected for a dialing plan (to call short numbers and special services).</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadAccounts</td><td>Viewing user account info (including name, business name, address and phone number/account number)</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Heavy</p>"
        operationId: "listDialingPlans"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "accountId"
            in: "path"
            description: "Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"
            required: true
            type: "string"
            default: "~"
          -
            name: "page"
            in: "query"
            description: "Indicates the page number to retrieve. Only positive number values are allowed. Default value is '1'"
            required: false
            type: "integer"
          -
            name: "perPage"
            in: "query"
            description: "Indicates the page size (number of items). If not specified, the value is '100' by default"
            required: false
            type: "integer"
        responses:
          default:
            description: "Success"
            schema:
              $ref: "#/definitions/GetDialingPlanInfo"
        x-api-group: "account/dialing-plan"
        x-throttling-group: "Heavy"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "ReadAccounts"
        x-user-permission: "ReadUserInfo"
        x-access-level: "Internal"
    /restapi/v1.0/dictionary/language:
      get:
        tags:
          - "Regional Settings"
        summary: "Get Language List"
        description: "<p style='font-style:italic;'>Since 1.0.14 (Release 6.6)</p><p>Returns the information about supported languages.</p><h4>Usage Plan Group</h4><p>Light</p>"
        operationId: "listLanguages"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        responses:
          default:
            description: "Success"
            schema:
              $ref: "#/definitions/LanguageList"
        x-api-group: "dictionary/language"
        x-throttling-group: "Light"
        x-metered-api: true
        x-metering-group: "System"
        x-access-level: "Public"
    /restapi/v1.0/dictionary/language/{languageId}:
      get:
        tags:
          - "Regional Settings"
        summary: "Get Language"
        description: "<p style='font-style:italic;'>Since 1.0.14 (Release 6.6)</p><p>Returns language by its respective ID.</p><h4>Usage Plan Group</h4><p>Light</p>"
        operationId: "loadLanguage"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "languageId"
            in: "path"
            description: "Internal identifier of a language"
            required: true
            type: "integer"
        responses:
          default:
            description: "Success"
            schema:
              $ref: "#/definitions/LanguageInfo"
        x-api-group: "dictionary/language"
        x-throttling-group: "Light"
        x-metered-api: true
        x-metering-group: "System"
        x-access-level: "Public"
    /restapi/v1.0/dictionary/country:
      get:
        tags:
          - "Regional Settings"
        summary: "Get Country List"
        description: "<p style='font-style:italic;'>Since 1.0.10 (Release 6.2)</p><p>Returns all the countries available for calling.</p><h4>Usage Plan Group</h4><p>Light</p>"
        operationId: "listCountries"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "loginAllowed"
            in: "query"
            description: "Specifies whether login with the phone numbers of this country is enabled or not"
            required: false
            type: "boolean"
          -
            name: "signupAllowed"
            in: "query"
            description: "Indicates whether signup/billing is allowed for a country. If not specified all countries are returned (according to other filters specified if any)"
            required: false
            type: "boolean"
          -
            name: "numberSelling"
            in: "query"
            description: "Specifies if RingCentral sells phone numbers of this country"
            required: false
            type: "boolean"
          -
            name: "page"
            in: "query"
            description: "Indicates the page number to retrieve. Only positive number values are allowed. Default value is '1'"
            required: false
            type: "integer"
          -
            name: "perPage"
            in: "query"
            description: "Indicates the page size (number of items). If not specified, the value is '100' by default"
            required: false
            type: "integer"
          -
            name: "freeSoftphoneLine"
            in: "query"
            description: "Specifies if free phone line for softphone is available for a country or not"
            required: false
            type: "boolean"
        responses:
          default:
            description: "Success"
            schema:
              $ref: "#/definitions/GetCountryListResponse"
        x-api-group: "dictionary/country"
        x-throttling-group: "Light"
        x-metered-api: true
        x-metering-group: "System"
        x-access-level: "Public"
    /restapi/v1.0/dictionary/country/{countryId}:
      get:
        tags:
          - "Regional Settings"
        summary: "Get Country"
        description: "<p style='font-style:italic;'>Since 1.0.10 (Release 6.2)</p><p>Returns the information on the required country.</p><h4>Usage Plan Group</h4><p>Light</p>"
        operationId: "loadCountry"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "countryId"
            in: "path"
            description: "Internal identifier of a country"
            required: true
            type: "integer"
        responses:
          default:
            description: "Success"
            schema:
              $ref: "#/definitions/GetCountryInfoDictionaryResponse"
        x-api-group: "dictionary/country"
        x-throttling-group: "Light"
        x-metered-api: true
        x-metering-group: "System"
        x-access-level: "Public"
    /restapi/v1.0/dictionary/location:
      get:
        tags:
          - "Regional Settings"
        summary: "Get Location List"
        description: "<p style='font-style:italic;'>Since 1.0.10 (Release 6.2)</p><p>Returns all the available locations for the certain state.</p><h4>Usage Plan Group</h4><p>Light</p>"
        operationId: "listLocations"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "orderBy"
            in: "query"
            description: "Sorts results by the specified property. The default value is 'City'"
            required: false
            type: "array"
            items:
              type: "string"
            collectionFormat: "multi"
            enum:
              - "Npa"
              - "City"
          -
            name: "page"
            in: "query"
            description: "Indicates the page number to retrieve. Only positive number values are allowed. Default value is '1'."
            required: false
            type: "integer"
          -
            name: "perPage"
            in: "query"
            description: "Indicates the page size (number of items). If not specified, the value is '100' by default."
            required: false
            type: "integer"
          -
            name: "stateId"
            in: "query"
            description: "Internal identifier of a state"
            required: false
            type: "string"
          -
            name: "withNxx"
            in: "query"
            description: "Specifies if nxx codes are returned"
            required: false
            type: "boolean"
        responses:
          default:
            description: "Success"
            schema:
              $ref: "#/definitions/GetLocationListResponse"
        x-api-group: "dictionary/location"
        x-throttling-group: "Light"
        x-metered-api: true
        x-metering-group: "System"
        x-access-level: "Public"
    /restapi/v1.0/dictionary/state:
      get:
        tags:
          - "Regional Settings"
        summary: "Get State List"
        description: "<p style='font-style:italic;'>Since 1.0.10 (Release 6.2)</p><p>Returns all the states for a certain country.</p><h4>Usage Plan Group</h4><p>Light</p>"
        operationId: "loadlistStates"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "countryId"
            in: "query"
            description: "Internal identifier of a country"
            required: false
            type: "integer"
          -
            name: "page"
            in: "query"
            description: "Indicates the page number to retrieve. Only positive number values are allowed. Default value is '1'."
            required: false
            type: "integer"
          -
            name: "perPage"
            in: "query"
            description: "Indicates the page size (number of items). If not specified, the value is '100' by default"
            required: false
            type: "integer"
          -
            name: "withPhoneNumbers"
            in: "query"
            description: "If 'True', the list of states with phone numbers available for buying is returned. The default value is 'False'"
            required: false
            type: "boolean"
        responses:
          default:
            description: "Success"
            schema:
              $ref: "#/definitions/GetStateListResponse"
        x-api-group: "dictionary/state"
        x-throttling-group: "Light"
        x-metered-api: true
        x-metering-group: "System"
        x-access-level: "Public"
    /restapi/v1.0/dictionary/state/{stateId}:
      get:
        tags:
          - "Regional Settings"
        summary: "Get State"
        description: "<p style='font-style:italic;'>Since 1.0.10 (Release 6.2)</p><p>Returns the information on the required state.</p><h4>Usage Plan Group</h4><p>Light</p>"
        operationId: "loadState"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "stateId"
            in: "path"
            description: "Internal identifier of a state"
            required: true
            type: "integer"
        responses:
          default:
            description: "Success"
            schema:
              $ref: "#/definitions/GetStateInfoResponse"
        x-api-group: "dictionary/state"
        x-throttling-group: "Light"
        x-metered-api: true
        x-metering-group: "System"
        x-access-level: "Public"
    /restapi/v1.0/dictionary/timezone:
      get:
        tags:
          - "Regional Settings"
        summary: "Get Timezone List"
        description: "<p style='font-style:italic;'>Since 1.0.10 (Release 6.2)</p><p>Returns all available timezones.</p><h4>Usage Plan Group</h4><p>Light</p>"
        operationId: "listTimezones"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "page"
            in: "query"
            description: "Indicates the page number to retrieve. Only positive number values are allowed. Default value is '1'"
            required: false
            type: "string"
          -
            name: "perPage"
            in: "query"
            description: "Indicates the page size (number of items). If not specified, the value is '100' by default"
            required: false
            type: "string"
        responses:
          default:
            description: "Success"
            schema:
              $ref: "#/definitions/GetTimezoneListResponse"
        x-api-group: "dictionary/timezone"
        x-throttling-group: "Light"
        x-metered-api: true
        x-metering-group: "System"
        x-access-level: "Public"
    /restapi/v1.0/dictionary/timezone/{timezoneId}:
      get:
        tags:
          - "Regional Settings"
        summary: "Get Timezone"
        description: "<p style='font-style:italic;'>Since 1.0.10 (Release 6.2)</p><p>Returns the information on a certain timezone.</p><h4>Usage Plan Group</h4><p>Light</p>"
        operationId: "loadTimezone"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "timezoneId"
            in: "path"
            description: "Internal identifier of a timezone"
            required: true
            type: "integer"
          -
            name: "page"
            in: "query"
            description: "Indicates the page number to retrieve. Only positive number values are allowed. Default value is '1'"
            required: false
            type: "integer"
          -
            name: "perPage"
            in: "query"
            description: "Indicates the page size (number of items). If not specified, the value is '100' by default"
            required: false
            type: "integer"
        responses:
          default:
            description: "Success"
            schema:
              $ref: "#/definitions/GetTimezoneInfoResponse"
        x-api-group: "dictionary/timezone"
        x-throttling-group: "Light"
        x-metered-api: true
        x-metering-group: "System"
        x-access-level: "Public"
    /restapi/v1.0/dictionary/brand/{brandId}:
      get:
        tags:
          - "Account Provisioning"
        summary: "Get Brand Info"
        operationId: "getBrandInfo"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "brandId"
            in: "path"
            required: true
            type: "string"
        responses:
          default:
            description: "successful operation"
            schema:
              $ref: "#/definitions/BrandResource"
        x-api-group: "dictionary/brand"
        x-throttling-group: "Light"
        x-metered-api: true
        x-metering-group: "System"
        x-access-level: "Internal"
    /restapi/v1.0/dictionary/service-plan/{servicePlanId}:
      get:
        tags:
          - "Account Provisioning"
        summary: "Get Service Plan"
        operationId: "getServicePlanInfo"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "servicePlanId"
            in: "path"
            required: true
            type: "string"
        responses:
          default:
            description: "successful operation"
            schema:
              $ref: "#/definitions/ServicePlanResource"
        x-api-group: "dictionary/service-plan"
        x-throttling-group: "Light"
        x-metered-api: true
        x-metering-group: "System"
        x-access-level: "Internal"
    /restapi/v1.0/number-pool/lookup:
      post:
        tags:
          - "Account Provisioning"
        summary: "Get Numbers"
        description: "<p style='font-style:italic;'>Since 1.0.10 (Release 6.2)</p><p>Returns the required numbers filtered by criteria.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>NumberLookup</td><td>Looking-up and reserving available phone number</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Medium</p>"
        operationId: "lookupPhoneNumbers"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "areaCode"
            in: "query"
            description: "Area code of the location"
            required: false
            type: "integer"
          -
            name: "countryCode"
            in: "query"
            description: "Two-letter country code, complying with the ISO standard"
            required: false
            type: "string"
          -
            name: "countryId"
            in: "query"
            description: "Internal identifier of a country; '1'- the US; '39' - Canada; '224' - the UK. The default value is '1'"
            required: false
            type: "string"
          -
            name: "exclude"
            in: "query"
            description: "A string of digits (one and more) that should not appear among the last four digits (line part) of the phone numbers that will be returned. It is possible to specify severalT?exclude parameters. If specified, it is taken into account in all returned phone numbers both in the phone numbers satisfying to parameters of lookup and in alternative phone numbers (in case when extendedSearch is specified)"
            required: false
            type: "string"
          -
            name: "extendedSearch"
            in: "query"
            description: "If the value is 'False', then the returned numbers exactly correspond to the specified NXX, NPA and LINE or countryCode, areaCode and numberPattern parameters. If the value is 'True', then the resulting numbers are ranked and returned with the rank attribute values (1-10). The default value is 'False'"
            required: false
            type: "boolean"
          -
            name: "line"
            in: "query"
            description: "LINE pattern for vanity or wildcard search. Digits, Latin characters and asterisks are allowed (usually 4 characters)"
            required: false
            type: "string"
          -
            name: "numberPattern"
            in: "query"
            description: "Phone number pattern (for wildcard or vanity search). For NANP countries (US, Canada) is concatenation of nxx (the first three digits) and line. If the first three characters are specified as not digits (e.g. 5** or CAT) then parameter extendedSearch will be ignored."
            required: false
            type: "string"
          -
            name: "nxx"
            in: "query"
            description: "NXX pattern for vanity or wildcard search. Digits, Latin characters and asterisks are allowed (usually 3 characters)"
            required: false
            type: "string"
          -
            name: "npa"
            in: "query"
            description: "Area code (mandatory). For example, 800, 844, 855, 866, 877, 888 for North America; and 647 for Canada"
            required: false
            type: "string"
          -
            name: "paymentType"
            in: "query"
            description: "Payment type. Default is 'Local' (it should correlate with the npa provided)"
            required: false
            type: "array"
            items:
              type: "string"
            collectionFormat: "multi"
            enum:
              - "TollFree"
              - "Local"
          -
            name: "perPage"
            in: "query"
            description: "Indicates the page size (number of items). If not specified, the value is '10' by default"
            required: false
            type: "integer"
          -
            name: "providerId"
            in: "query"
            description: "Internal identifier of a phone number provider. Supported if brand is specified. If specified, area code and nxx are optional"
            required: false
            type: "integer"
          -
            name: "smsEnabled"
            in: "query"
            description: "Specifies if SMS activation is available for the number. If specified, it is taken into account in all returned phone numbers both in the phone numbers satisfying to parameters of lookup and in alternative phone numbers (in case when extendedSearch is specified). If not specified, the value is null."
            required: false
            type: "boolean"
        responses:
          default:
            description: "Success"
            schema:
              $ref: "#/definitions/PhoneNumbers"
        x-api-group: "number-pool/lookup"
        x-throttling-group: "Medium"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "NumberLookup"
        x-access-level: "Internal"
    /restapi/v1.0/number-pool/reserve:
      post:
        tags:
          - "Account Provisioning"
        summary: "Reserve/ Un-reserve Numbers"
        description: "<p style='font-style:italic;'>Since 1.0.10 (Release 6.2)</p><p></p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>NumberLookup</td><td>Looking-up and reserving available phone number</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Medium</p>"
        operationId: "reservePhoneNumbers"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            in: "body"
            name: "body"
            description: "JSON body"
            required: true
            schema:
              $ref: "#/definitions/NumberPoolPhoneNumberRequest"
        responses:
          default:
            description: "Success"
            schema:
              $ref: "#/definitions/ReservePhoneNumbersRecordsResource"
        x-api-group: "number-pool/reserve"
        x-throttling-group: "Medium"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "NumberLookup"
        x-access-level: "Internal"
    /restapi/v1.0/account:
      post:
        tags:
          - "Account Provisioning"
        summary: "Create Account"
        description: "<p style='font-style:italic;'>Since 1.0.10 (Release 6.2)</p><p>Creates the account in Initial state.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>Accounts</td><td>Managing accounts: creating new accounts, viewing and updating account information, deleting existing accounts</td></tr><tr><td class='code'>EditAccounts</td><td>Viewing and updating user account info (including name, business name, address and phone number/account number)</td></tr><tr><td class='code'>ReadAccounts</td><td>Viewing user account info (including name, business name, address and phone number/account number)</td></tr><tr><td class='code'>EditExtensions</td><td>Viewing and updating user extension info (includes extension name, number, email and phone number, assigned phone numbers, devices and other extension settings)</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Medium</p>"
        operationId: "createAccount"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            in: "body"
            name: "body"
            description: "JSON body"
            required: true
            schema:
              $ref: "#/definitions/CreateAccountRequest"
        responses:
          default:
            description: "Success"
            schema:
              $ref: "#/definitions/GetAccountInfoResponse"
        x-api-group: "account"
        x-throttling-group: "Medium"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "Accounts"
        x-access-level: "Internal"
    /restapi/v1.0/account/{accountId}/phone-number:
      get:
        tags:
          - "Account Provisioning"
        summary: "Get All Company Phone Numbers"
        description: "<p style='font-style:italic;'></p><p></p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadAccounts</td><td>Viewing user account info (including name, business name, address and phone number/account number)</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Heavy</p>"
        operationId: "listAccountPhoneNumbers"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "accountId"
            in: "path"
            description: "Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"
            required: true
            type: "string"
            default: "~"
          -
            name: "page"
            in: "query"
            description: "Indicates the page number to retrieve. Only positive number values are allowed. Default value is '1'"
            required: false
            type: "integer"
          -
            name: "perPage"
            in: "query"
            description: "Indicates the page size (number of items). If not specified, the value is '100' by default"
            required: false
            type: "integer"
          -
            name: "usageType"
            in: "query"
            description: "Usage type of the phone number"
            required: false
            type: "array"
            items:
              type: "string"
            collectionFormat: "multi"
            enum:
              - "MainCompanyNumber"
              - "AdditionalCompanyNumber"
              - "CompanyNumber"
              - "DirectNumber"
              - "CompanyFaxNumber"
              - "ForwardedNumber"
              - "ForwardedCompanyNumber"
              - "ContactCenterNumber"
        responses:
          default:
            description: "Success"
            schema:
              $ref: "#/definitions/AccountPhoneNumbers"
        x-api-group: "account/phone-number"
        x-throttling-group: "Heavy"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "ReadAccounts"
        x-user-permission: "ReadCompanyPhoneNumbers"
        x-access-level: "Public"
      post:
        tags:
          - "Account Provisioning"
        summary: "Provision Phone Numbers"
        description: "<p style='font-style:italic;'>Since 1.0.11 (Release 6.3)</p><p>Provisions a phone number.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>EditAccounts</td><td>Viewing and updating user account info (including name, business name, address and phone number/account number)</td></tr><tr><td class='code'>ReadAccounts</td><td>Viewing user account info (including name, business name, address and phone number/account number)</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Medium</p>"
        operationId: "provisionPhoneNumber"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "accountId"
            in: "path"
            description: "Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"
            required: true
            type: "string"
            default: "~"
          -
            in: "body"
            name: "body"
            description: "JSON body"
            required: true
            schema:
              $ref: "#/definitions/ProvisionPhoneNumberRequest"
        responses:
          default:
            description: "Success"
            schema:
              $ref: "#/definitions/PhoneNumberInfo"
        x-api-group: "account/phone-number"
        x-throttling-group: "Medium"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "EditAccounts"
        x-user-permission: "EditCompanyPhoneNumbers"
        x-access-level: "Internal"
    /restapi/v1.0/account/{accountId}/phone-number/{phoneNumberId}:
      get:
        tags:
          - "Account Provisioning"
        summary: "Get Phone Number"
        description: "<p style='font-style:italic;'></p><p></p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadAccounts</td><td>Viewing user account info (including name, business name, address and phone number/account number)</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Light</p>"
        operationId: "loadAccountPhoneNumber"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "accountId"
            in: "path"
            description: "Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"
            required: true
            type: "string"
            default: "~"
          -
            name: "phoneNumberId"
            in: "path"
            description: "Internal identifier of a phone number"
            required: true
            type: "integer"
        responses:
          default:
            description: "Success"
            schema:
              $ref: "#/definitions/PhoneNumberInfo"
        x-api-group: "account/phone-number"
        x-throttling-group: "Light"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "ReadAccounts"
        x-user-permission: "ReadCompanyPhoneNumbers"
        x-access-level: "Public"
      put:
        tags:
          - "Account Provisioning"
        summary: "Reassign Phone Number"
        description: "<p style='font-style:italic;'>Since 1.0.11 (Release 6.3) </p><p>Reassigns the phone number belonging to a certain account/extension. This call reassigns a phone number, currently belonging to some other extension or company (Auto-Receptionist). Please note: numbers with certain usage types 'MainCompanyNumber', 'AdditionalCompanyNumber' and 'CompanyFaxNumber' cannot be reassigned</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>EditAccounts</td><td>Viewing and updating user account info (including name, business name, address and phone number/account number)</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Medium</p>"
        operationId: "reassignPhoneNumberById"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "phoneNumberId"
            in: "path"
            required: true
            type: "integer"
            format: "int64"
          -
            in: "body"
            name: "body"
            required: false
            schema:
              $ref: "#/definitions/ReassignPhoneNumberResource"
          -
            name: "accountId"
            in: "path"
            required: true
            type: "string"
        responses:
          default:
            description: "successful operation"
            schema:
              $ref: "#/definitions/PhoneNumberResource"
        x-api-group: "account/phone-number"
        x-throttling-group: "Medium"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "EditAccounts"
        x-user-permission: "EditCompanyPhoneNumbers"
        x-access-level: "Internal"
      delete:
        tags:
          - "Account Provisioning"
        summary: "Delete Phone Number"
        description: "<p style='font-style:italic;'>Since 1.0.11 (Release 6.3) </p><p>Deletes a phone number belonging to a certain account/extension.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>EditAccounts</td><td>Viewing and updating user account info (including name, business name, address and phone number/account number)</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Medium</p>"
        operationId: "deletePhoneNumberById"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "phoneNumberId"
            in: "path"
            required: true
            type: "integer"
            format: "int64"
          -
            name: "accountId"
            in: "path"
            required: true
            type: "string"
        responses:
          default:
            description: "successful operation"
        x-api-group: "account/phone-number"
        x-throttling-group: "Medium"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "EditAccounts"
        x-user-permission: "EditCompanyPhoneNumbers"
        x-access-level: "Internal"
    /restapi/v1.0/number-parser/parse:
      post:
        tags:
          - "Account Provisioning"
        summary: "Parse Phone Number"
        description: "<p style='font-style:italic;'>Since 1.0.13 (Release 6.5)</p><p>Returns one or more parsed and/or formatted phone numbers that are passed as a string.</p><h4>Usage Plan Group</h4><p>Light</p>"
        operationId: "parsePhoneNumber"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "homeCountry"
            in: "query"
            description: "Internal identifier of a home country. The default value is ISO code (ISO 3166) of the user's home country or brand country, if the user is undefined"
            required: false
            type: "string"
          -
            name: "nationalAsPriority"
            in: "query"
            description: "The default value is 'False'. If 'True', the numbers that are closer to the home country are given higher priority"
            required: false
            type: "boolean"
          -
            in: "body"
            name: "body"
            description: "JSON body"
            required: true
            schema:
              $ref: "#/definitions/ParsePhoneNumberRequest"
        responses:
          default:
            description: "Success"
            schema:
              $ref: "#/definitions/ParsePhoneNumberResponse"
        x-api-group: "number-parser/parse"
        x-throttling-group: "Light"
        x-metered-api: true
        x-metering-group: "System"
        x-access-level: "PublicBeta"
    /restapi/v1.0/account/{accountId}/device:
      get:
        tags:
          - "Account Provisioning"
        summary: "Get Account Devices"
        description: "<p style='font-style:italic;'>Since 1.0.12 (Release 6.4)</p><p>Returns all the devices for a particular extension.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadAccounts</td><td>Viewing user account info (including name, business name, address and phone number/account number)</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Light</p>"
        operationId: "listAccountDevices"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "accountId"
            in: "path"
            description: "Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"
            required: true
            type: "string"
            default: "~"
        responses:
          default:
            description: "Success"
            schema:
              $ref: "#/definitions/GetAccountDevicesResponse"
        x-api-group: "account/device"
        x-throttling-group: "Medium"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "ReadAccounts"
        x-user-permission: "ReadCompanyDevices"
        x-access-level: "Advanced"
    /restapi/v1.0/account/{accountId}/device/{deviceId}:
      get:
        tags:
          - "Account Provisioning"
        summary: "Get Device Info"
        description: "<p style='font-style:italic;'>Since 1.0.9 (Release 6.1)</p><p>Returns account device(s) by their ID(s).</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadAccounts</td><td>Viewing user account info (including name, business name, address and phone number/account number)</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Light</p>"
        operationId: "loadAccountDevice"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "accountId"
            in: "path"
            description: "Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"
            required: true
            type: "string"
            default: "~"
          -
            name: "deviceId"
            in: "path"
            description: "Internal identifier of a device"
            required: true
            type: "string"
        responses:
          default:
            description: "Success"
            schema:
              $ref: "#/definitions/GetDeviceInfoResponse"
        x-api-group: "account/device"
        x-throttling-group: "Light"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "ReadAccounts"
        x-user-permission: "ReadCompanyDevices"
        x-access-level: "Advanced"
      put:
        tags:
          - "Account Provisioning"
        summary: "Update Device"
        operationId: "updateDevice"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "accountId"
            in: "path"
            required: true
            type: "string"
          -
            name: "deviceId"
            in: "path"
            required: true
            type: "string"
          -
            in: "body"
            name: "body"
            required: true
            schema:
              $ref: "#/definitions/AccountDeviceUpdate"
        responses:
          default:
            description: "successful operation"
            schema:
              $ref: "#/definitions/DeviceResource"
        x-api-group: "account/device"
        x-throttling-group: "Medium"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "EditAccounts"
        x-user-permission: "EditCompanyDevices"
        x-access-level: "Advanced"
    /restapi/v1.0/account/{accountId}/extension/free-numbers:
      get:
        tags:
          - "Account Provisioning"
        summary: "Get Free Extension Numbers"
        operationId: "getExtensionFreeNumbers"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "accountId"
            in: "path"
            required: true
            type: "string"
        responses:
          default:
            description: "successful operation"
            schema:
              $ref: "#/definitions/BulkProvisionUnassignedExtensionsResponseResource"
        x-api-group: "extension/free-numbers"
        x-throttling-group: "Heavy"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "ReadAccounts"
        x-user-permission: "ReadExtensions"
        x-access-level: "Internal"
    /restapi/v1.0/account/{accountId}/extension/{extensionId}/device:
      get:
        tags:
          - "Account Provisioning"
        summary: "Get User Device Info"
        description: "<p style='font-style:italic;'>Since 1.0.12 (Release 6.4)</p><p>Returns all the devices for extension(s) by extension ID(s). Batch request is supported, see Batch Requests for details.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadAccounts</td><td>Viewing user account info (including name, business name, address and phone number/account number)</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Light</p>"
        operationId: "listExtensionDevices"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "accountId"
            in: "path"
            description: "Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"
            required: true
            type: "string"
            default: "~"
          -
            name: "extensionId"
            in: "path"
            description: "Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session"
            required: true
            type: "string"
            default: "~"
          -
            name: "linePooling"
            in: "query"
            type: "string"
            description: "Pooling type of a device"
            required: false
            enum:
              - "Host"
              - "Guest"
              - "None"
        responses:
          default:
            description: "Success"
            schema:
              $ref: "#/definitions/GetExtensionDevicesResponse"
        x-api-group: "extension/device"
        x-throttling-group: "Light"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "ReadAccounts"
        x-user-permission: "ReadUserDevices"
        x-access-level: "Advanced"
    /restapi/v1.0/account/{accountId}/order:
      post:
        tags:
          - "Account Provisioning"
        summary: "Create Device Order"
        description: "<p style='font-style:italic;'></p><p></p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>EditAccounts</td><td>Viewing and updating user account info (including name, business name, address and phone number/account number)</td></tr><tr><td class='code'>ReadAccounts</td><td>Viewing user account info (including name, business name, address and phone number/account number)</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Heavy</p>"
        operationId: "createDeviceOrder"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "accountId"
            in: "path"
            description: "Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"
            required: true
            type: "string"
            default: "~"
          -
            name: "async"
            in: "query"
            description: "Specifies whether a client expects order details to be returned or not. If 'True' the server returns a link for tracking order status without waiting for it to be actually created. If 'False' the server returns order details once it is created - it may take some time depending on device count. The default value is 'False'"
            required: false
            type: "boolean"
            default: false
          -
            in: "body"
            name: "body"
            required: false
            schema:
              $ref: "#/definitions/DeviceResource"
        responses:
          default:
            description: "Success"
            schema:
              $ref: "#/definitions/DeviceOrderCreation"
        x-api-group: "account/order"
        x-throttling-group: "Heavy"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "EditAccounts"
        x-user-permission: "EditCompanyDevices"
        x-access-level: "Internal"
    /restapi/v1.0/account/{accountId}/order/{orderId}:
      get:
        tags:
          - "Account Provisioning"
        summary: "Get Device Order by ID"
        description: "<p style='font-style:italic;'></p><p></p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadAccounts</td><td>Viewing user account info (including name, business name, address and phone number/account number)</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Light</p>"
        operationId: "loadDeviceOrder"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "accountId"
            in: "path"
            description: "Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"
            required: true
            type: "string"
            default: "~"
          -
            name: "orderId"
            in: "path"
            description: "Internal identifier of an order"
            required: true
            type: "integer"
        responses:
          default:
            description: "Success"
            schema:
              $ref: "#/definitions/DeviceOrder"
        x-api-group: "account/order"
        x-throttling-group: "Light"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "ReadAccounts"
        x-user-permission: "EditCompanyDevices"
        x-access-level: "Internal"
    /restapi/v1.0/dictionary/device:
      get:
        tags:
          - "Account Provisioning"
        summary: "Get Device Catalog"
        operationId: "getDeviceModels"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        responses:
          default:
            description: "successful operation"
            schema:
              $ref: "#/definitions/DeviceModelExtsResource"
        x-api-group: "dictionary/device"
        x-throttling-group: "Light"
        x-metered-api: true
        x-metering-group: "System"
        x-access-level: "Internal"
    /restapi/v1.0/dictionary/shipping-options:
      get:
        tags:
          - "Account Provisioning"
        summary: "Get Shipping Options"
        description: "<p style='font-style:italic;'>Since 1.0.16 (Release 7.1)</p><p>Returns the list of device shipping options with their prices, according to brand, tier, number of ordered devices.</p><h4>Usage Plan Group</h4><p>Light</p>"
        operationId: "listShippingOptions"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "servicePlanId"
            in: "query"
            required: false
            type: "integer"
          -
            name: "brandId"
            in: "query"
            required: false
            type: "integer"
          -
            name: "quantity"
            in: "query"
            required: false
            type: "integer"
            maximum: 10000
            minimum: 1
            format: "int32"
        responses:
          default:
            description: "Success"
            schema:
              $ref: "#/definitions/DictionaryShippingOptions"
        x-api-group: "dictionary/shipping-options"
        x-throttling-group: "Light"
        x-metered-api: true
        x-metering-group: "System"
        x-access-level: "Internal"
    /restapi/v1.0/account/{accountId}/licenses:
      get:
        tags:
          - "Account Provisioning"
        summary: "Get License List"
        operationId: "listLicenses"
        description: "<p style='font-style:italic;'>Since 1.0.31 (Release 9.2)</p><p>Returns list of licenses for a specific user.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadAccounts</td><td>Viewing user account info (including name, business name, address and phone number/account number)</td></tr></tbody></table><h4>API Group</h4><p>Light</p>"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "accountId"
            type: "string"
            in: "path"
            description: "Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"
            required: true
            default: "~"
          -
            name: "page"
            type: "integer"
            format: "int64"
            in: "query"
            description: "Indicates the page number to retrieve. Only positive number values are allowed. The default value is '1'"
            required: false
          -
            name: "perPage"
            type: "integer"
            format: "int64"
            in: "query"
            description: "Indicates the page size (number of items). If not specified, the value is '25' by default"
            required: false
          -
            name: "typeId"
            type: "integer"
            format: "int64"
            in: "query"
            description: "Internal identifier of a license type. If not specified account licenses of all types are returned"
            required: false
        responses:
          default:
            description: "Success"
            schema:
              $ref: "#/definitions/LicenseList"
        x-api-group: "account/licenses"
        x-throttling-group: "Light"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "ReadAccounts"
        x-user-permission: "MeetingsPlan"
        x-access-level: "Advanced"
    /restapi/v1.0/account/{accountId}/licenses/bulk-purchase:
      post:
        tags:
          - "Account Provisioning"
        summary: "Order Licenses"
        operationId: "createLicensesOrder"
        description: "<p style='font-style:italic;'>Since 1.0.31 (Release 9.2)</p><p>Purchases licenses for add-on features: Rooms, Room Connector, Webinar, Live Reports, etc.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadAccounts</td><td>Viewing user account info (including name, business name, address and phone number/account number)</td></tr><tr><td class='code'>EditExtensions</td><td>Viewing and updating user extension info (includes extension name, number, email and phone number, assigned phone numbers, devices and other extension settings)</td></tr><tr><td class='code'>EditAccounts</td><td>Viewing and updating user account info (including name, business name, address and phone number/account number)</td></tr></tbody></table><h4>API Group</h4><p>Heavy</p>"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "accountId"
            type: "string"
            in: "path"
            description: "Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"
            required: true
            default: "~"
          -
            name: "body"
            in: "body"
            description: "JSON body"
            schema:
              $ref: "#/definitions/OrderLicensesRequest"
            required: true
        responses:
          default:
            description: "Success"
        x-api-group: "account/licenses"
        x-throttling-group: "Heavy"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "EditAccounts"
        x-user-permission: "MeetingsPlan"
        x-access-level: "Advanced"
    /restapi/v1.0/account/{accountId}/licenses/{licenseId}:
      get:
        tags:
          - "Account Provisioning"
        summary: "Get License"
        operationId: "loadLicense"
        description: "<p style='font-style:italic;'>Since 1.0.31 (Release 9.2)</p><p>Returns license information by its ID.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadAccounts</td><td>Viewing user account info (including name, business name, address and phone number/account number)</td></tr></tbody></table><h4>API Group</h4><p>Light</p>"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "accountId"
            type: "string"
            in: "path"
            description: "Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"
            required: true
            default: "~"
          -
            name: "licenseId"
            type: "string"
            in: "path"
            description: "Internal identifier of a license"
            required: true
        responses:
          default:
            description: "Success"
            schema:
              $ref: "#/definitions/LicenseInfo"
        x-throttling-group: "Light"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "ReadAccounts"
        x-user-permission: "MeetingsPlan"
        x-api-group: "account/licenses"
        x-access-level: "Advanced"
      delete:
        tags:
          - "Account Provisioning"
        summary: "Delete License"
        operationId: "deleteLicense"
        description: "<p style='font-style:italic;'>Since 1.0.31 (Release 9.2)</p><p>Removes a license for a specific user. Please note: It is not allowed to remove assigned licenses (only Webinars and Large Meetings can be assigned).</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadAccounts</td><td>Viewing user account info (including name, business name, address and phone number/account number)</td></tr><tr><td class='code'>EditExtensions</td><td>Viewing and updating user extension info (includes extension name, number, email and phone number, assigned phone numbers, devices and other extension settings)</td></tr><tr><td class='code'>EditAccounts</td><td>Viewing and updating user account info (including name, business name, address and phone number/account number)</td></tr></tbody></table><h4>API Group</h4><p>Medium</p>"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "accountId"
            type: "string"
            in: "path"
            description: "Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"
            required: true
            default: "~"
          -
            name: "licenseId"
            type: "string"
            in: "path"
            description: "Internal identifier of a license"
            required: true
        responses:
          default:
            description: "Success"
        x-throttling-group: "Medium"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "EditAccounts"
        x-user-permission: "MeetingsPlan"
        x-api-group: "account/licenses"
        x-access-level: "Advanced"
    /restapi/v1.0/dictionary/license-types:
      get:
        tags:
          - "Account Provisioning"
        summary: "Get License Types"
        operationId: "listLicenseTypes"
        description: "<p style='font-style:italic;'>Since 1.0.31 (Release 9.2)</p><p>Returns supported license types.</p><h4>API Group</h4><p>Light</p>"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters: []
        responses:
          default:
            description: "Success"
            schema:
              $ref: "#/definitions/LicenseTypes"
        x-api-group: "dictionary/license-types"
        x-throttling-group: "Light"
        x-metered-api: true
        x-metering-group: "System"
        x-user-permission: "MeetingsPlan"
        x-access-level: "Advanced"
    /restapi/v1.0/account/{accountId}/department/{departmentId}/members:
      get:
        tags:
          - "Account Provisioning"
        summary: "Get Department Member List"
        description: "<p style='font-style:italic;'></p><p></p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadAccounts</td><td>Viewing user account info (including name, business name, address and phone number/account number)</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Light</p>"
        operationId: "listDepartmentMembers"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "accountId"
            in: "path"
            description: "Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"
            required: true
            type: "string"
            default: "~"
          -
            name: "departmentId"
            in: "path"
            description: "Internal identifier of a Department extension (same as extensionId but only the ID of a department extension is valid)"
            required: true
            type: "integer"
          -
            name: "page"
            in: "query"
            description: "Indicates the page number to retrieve. Only positive number values are allowed. Default value is '1'"
            required: false
            type: "integer"
          -
            name: "perPage"
            in: "query"
            description: "Indicates the page size (number of items). If not specified, the value is '100' by default"
            required: false
            type: "integer"
        responses:
          default:
            description: "Success"
            schema:
              $ref: "#/definitions/DepartmentMemberList"
        x-api-group: "account/department/members"
        x-throttling-group: "Light"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "ReadAccounts"
        x-user-permission: "ReadExtensions"
        x-access-level: "PublicBeta"
    /restapi/v1.0/account/{accountId}/department/bulk-assign:
      post:
        tags:
          - "Account Provisioning"
        summary: "Edit Call Queue Members"
        description: "<p style='font-style:italic;'>Since 1.0.32 (Release 9.3)</p><p>Adds and/or removes multiple call queue members.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>EditExtensions</td><td>Viewing and updating my extension info (includes extension name, number, email and phone number)</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Heavy</p>"
        operationId: "bulkAssign"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            in: "body"
            name: "body"
            required: false
            schema:
              $ref: "#/definitions/DepartmentBulkAssignResource"
          -
            name: "accountId"
            in: "path"
            required: true
            type: "string"
            default: "~"
        responses:
          default:
            description: "successful operation"
        x-api-group: "account/department"
        x-throttling-group: "Heavy"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "EditAccounts"
        x-user-permission: "UserGroups"
        x-access-level: "PublicBeta"
    /restapi/v1.0/account/{accountId}/paging-only-groups/{pagingOnlyGroupId}/users:
      get:
        tags:
          - "Account Provisioning"
        summary: "Get Paging Only Group Users"
        operationId: "getPagingOnlyGroupUsers"
        description: "<p style='font-style:italic;'>Since 1.0.32 (Release 9.3)</p><p>Returns the list of users allowed to page this group.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadAccounts</td><td>Viewing user account info (including name, business name, address and phone number/account number)</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Light</p>"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "accountId"
            in: "path"
            required: true
            type: "string"
          -
            name: "pagingOnlyGroupId"
            in: "path"
            required: true
            type: "string"
          -
            name: "page"
            in: "query"
            description: "Indicates the page number to retrieve. Only positive number values are allowed. Default value is '1'"
            required: false
            type: "integer"
          -
            name: "perPage"
            in: "query"
            description: "Indicates the page size (number of items). If not specified, the value is '100' by default"
            required: false
            type: "integer"
        responses:
          default:
            description: "Success"
            schema:
              $ref: "#/definitions/PagingOnlyGroupUsers"
        x-api-group: "account/paging-only-groups/users"
        x-throttling-group: "Light"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "ReadAccounts"
        x-user-permission: "ReadUserInfo"
        x-access-level: "PublicBeta"
    /restapi/v1.0/account/{accountId}/paging-only-groups/{pagingOnlyGroupId}/devices:
      get:
        tags:
          - "Account Provisioning"
        summary: "Get Paging Only Group Devices"
        operationId: "getPagingOnlyGroupDevices"
        description: "<p style='font-style:italic;'>Since 1.0.32 (Release 9.3)</p><p>Returns the list of paging devices assigned to this group.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadAccounts</td><td>Viewing user account info (including name, business name, address and phone number/account number)</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Light</p>"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "accountId"
            in: "path"
            required: true
            type: "string"
          -
            name: "pagingOnlyGroupId"
            in: "path"
            required: true
            type: "string"
          -
            name: "page"
            in: "query"
            description: "Indicates the page number to retrieve. Only positive number values are allowed. Default value is '1'"
            required: false
            type: "integer"
          -
            name: "perPage"
            in: "query"
            description: "Indicates the page size (number of items). If not specified, the value is '100' by default"
            required: false
            type: "integer"
        responses:
          default:
            description: "Success"
            schema:
              $ref: "#/definitions/PagingOnlyGroupDevices"
        x-api-group: "account/paging-only-groups/devices"
        x-throttling-group: "Light"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "ReadAccounts"
        x-user-permission: "ReadCompanyDevices"
        x-access-level: "PublicBeta"
    /restapi/v1.0/account/{accountId}/paging-only-groups/{pagingOnlyGroupId}/bulk-assign:
      post:
        tags:
          - "Account Provisioning"
        summary: "Edit Paging Group Users & Devices"
        operationId: "updatePagingOnlyGroupUsersAndDevices"
        description: "<p style='font-style:italic;'>Since 1.0.32 (Release 9.3)</p><p>Adds and/or removes paging group users and devices.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>EditExtensions</td><td>Viewing and updating my extension info (includes extension name, number, email and phone number)</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Heavy</p>"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "accountId"
            in: "path"
            required: true
            type: "string"
          -
            name: "pagingOnlyGroupId"
            in: "path"
            required: true
            type: "string"
          -
            in: "body"
            name: "body"
            required: false
            schema:
              $ref: "#/definitions/EditPagingGroupRequest"
        responses:
          default:
            description: "Success"
        x-api-group: "account/paging-only-groups/devices"
        x-throttling-group: "Light"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "ReadAccounts"
        x-user-permission: "ReadCompanyDevices"
        x-access-level: "PublicBeta"
    /restapi/v1.0/account/{accountId}/park-locations/{parkLocationId}/users:
      get:
        tags:
          - "Account Provisioning"
        summary: "Get Park Location Users"
        operationId: "getParkLocationUsers"
        description: "<p style='font-style:italic;'>Since 1.0.32 (Release 9.3)</p><p>Returns the list of users allowed to park and unpark calls to/from the park location extension specified</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadAccounts</td><td>Viewing user account info (including name, business name, address and phone number/account number)</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Light</p>"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "accountId"
            in: "path"
            required: true
            type: "string"
          -
            name: "parkLocationId"
            in: "path"
            required: true
            type: "string"
          -
            name: "page"
            in: "query"
            description: "Indicates the page number to retrieve. Only positive number values are allowed. Default value is '1'"
            required: false
            type: "integer"
          -
            name: "perPage"
            in: "query"
            description: "Indicates the page size (number of items). If not specified, the value is '100' by default"
            required: false
            type: "integer"
        responses:
          default:
            description: "Success"
            schema:
              $ref: "#/definitions/ParkLocationResponse"
        x-api-group: "account/park-locations/users"
        x-throttling-group: "Light"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "ReadAccounts"
        x-user-permission: "ReadExtensions"
        x-access-level: "Internal"
    /restapi/v1.0/account/{accountId}/park-locations/{parkLocationId}/bulk-assign:
      post:
        tags:
          - "Account Provisioning"
        summary: "Adds and/or removes park location users"
        operationId: "updateParkLocationUsers"
        description: "<p style='font-style:italic;'>Since 1.0.32 (Release 9.3)</p><p>Adds and/or removes park location users.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>EditExtensions</td><td>Viewing and updating my extension info (includes extension name, number, email and phone number)</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Heavy</p>"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "accountId"
            in: "path"
            required: true
            type: "string"
          -
            name: "parkLocationId"
            in: "path"
            required: true
            type: "string"
          -
            in: "body"
            name: "body"
            required: false
            schema:
              $ref: "#/definitions/EditParkLocationRequest"
        responses:
          default:
            description: "Success"
        x-api-group: "account/park-location/bulk-assign"
        x-throttling-group: "Heavy"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "EditExtensions"
        x-user-permission: "EditExtensions"
        x-access-level: "Internal"
    /scim/v2/ServiceProviderConfig:
      get:
        tags:
          - "SCIM"
        summary: "Get Service Provider Config"
        operationId: "getServiceProviderConfig"
        description: "<p style='font-style:italic;'>Since 1.0.31 (Release 9.2)</p><p>Returns the list of users requested.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadAccounts</td><td>Viewing Service Provider confiog</td></tr></tbody></table><h4>API Group</h4><p>Medium</p>"
        consumes:
          - "application/json"
          - "application/scim+json"
        produces:
          - "application/json"
          - "application/scim+json"
        responses:
          default:
            description: "Success"
            schema:
              $ref: "#/definitions/ServiceProviderConfig"
        x-api-group: "scim"
        x-throttling-group: "Medium"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "ReadAccounts"
        x-user-permission: "ReadExtensions"
        x-access-level: "PublicBeta"
    /scim/v2/Users:
      get:
        tags:
          - "SCIM"
        summary: "Get User List"
        operationId: "listUsers"
        description: "<p style='font-style:italic;'>Since 1.0.31 (Release 9.2)</p><p>Returns the list of users requested.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadAccounts</td><td>Viewing user account info (including name, business name, address and phone number/account number)</td></tr></tbody></table><h4>API Group</h4><p>Medium</p>"
        consumes:
          - "application/json"
          - "application/scim+json"
        produces:
          - "application/json"
          - "application/scim+json"
        parameters:
          -
            name: "filter"
            in: "query"
            type: "string"
            description: "only support 'userName' or 'email' filter expressions for now"
            enum:
              - "userName"
              - "email"
            required: false
          -
            name: "count"
            in: "query"
            description: "page size"
            required: false
            type: "integer"
            default: 100
            format: "int32"
          -
            name: "startIndex"
            in: "query"
            description: "start index (1-based)"
            required: false
            type: "integer"
            default: 1
            format: "int32"
        responses:
          400:
            description: "bad request"
            schema:
              $ref: "#/definitions/SCIMErrorResponse"
          401:
            description: "authorization failure"
            schema:
              $ref: "#/definitions/SCIMErrorResponse"
          403:
            description: "permissions denied"
            schema:
              $ref: "#/definitions/SCIMErrorResponse"
          429:
            description: "too many requests"
            schema:
              $ref: "#/definitions/SCIMErrorResponse"
          500:
            description: "internal server error"
            schema:
              $ref: "#/definitions/SCIMErrorResponse"
          default:
            description: "Success"
            schema:
              $ref: "#/definitions/GetUserListResponse"
        x-api-group: "scim"
        x-throttling-group: "Medium"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "ReadAccounts"
        x-user-permission: "ReadExtensions"
        x-access-level: "PublicBeta"
      post:
        tags:
          - "SCIM"
        summary: "Create User"
        operationId: "createUser"
        description: "<p style='font-style:italic;'>Since 1.0.31 (Release 9.2)</p><p>Creates a user.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>EditAccounts</td><td>Viewing and updating user account info (including name, business name, address and phone number/account number)</td></tr></tbody></table><h4>API Group</h4><p>Medium</p>"
        consumes:
          - "application/json"
          - "application/scim+json"
        produces:
          - "application/json"
          - "application/scim+json"
        parameters:
          -
            name: "body"
            in: "body"
            description: "a new user without 'id'"
            schema:
              $ref: "#/definitions/UserCreationRequest"
            required: true
        responses:
          400:
            description: "bad request"
            schema:
              $ref: "#/definitions/SCIMErrorResponse"
          401:
            description: "authorization failure"
            schema:
              $ref: "#/definitions/SCIMErrorResponse"
          403:
            description: "permissions denied"
            schema:
              $ref: "#/definitions/SCIMErrorResponse"
          404:
            description: "not found"
            schema:
              $ref: "#/definitions/SCIMErrorResponse"
          409:
            description: "duplicate email"
            schema:
              $ref: "#/definitions/SCIMErrorResponse"
          429:
            description: "too many requests"
            schema:
              $ref: "#/definitions/SCIMErrorResponse"
          500:
            description: "internal server error"
            schema:
              $ref: "#/definitions/SCIMErrorResponse"
          default:
            description: "Success"
            schema:
              $ref: "#/definitions/UserInfo"
        x-api-group: "scim"
        x-throttling-group: "Medium"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "EditAccounts"
        x-user-permission: "EditExtensions"
        x-access-level: "PublicBeta"
    /scim/v2/Users/.search:
      post:
        tags:
          - "SCIM"
        summary: "search or list users"
        operationId: "searchUsersViaPost"
        description: "<p style='font-style:italic;'>Since 1.0.31 (Release 9.2)</p><p>Returns the list of users requested.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadAccounts</td><td>Searching SCIM Users</td></tr></tbody></table><h4>API Group</h4><p>Medium</p>"
        consumes:
          - "application/json"
          - "application/scim+json"
        produces:
          - "application/json"
          - "application/scim+json"
        parameters:
          -
            in: "body"
            name: "body"
            description: "search parameters"
            required: false
            schema:
              $ref: "#/definitions/SCIMSearchRequestInfo"
        responses:
          400:
            description: "bad request"
            schema:
              $ref: "#/definitions/SCIMErrorResponse"
          401:
            description: "authorization failure"
            schema:
              $ref: "#/definitions/SCIMErrorResponse"
          403:
            description: "permissions denied"
            schema:
              $ref: "#/definitions/SCIMErrorResponse"
          429:
            description: "too many requests"
            schema:
              $ref: "#/definitions/SCIMErrorResponse"
          500:
            description: "internal server error"
            schema:
              $ref: "#/definitions/SCIMErrorResponse"
          default:
            description: "successful operation"
            schema:
              $ref: "#/definitions/GetUserListResponse"
    /scim/v2/Users/{id}:
      get:
        tags:
          - "SCIM"
        summary: "Get User"
        operationId: "getUserById"
        description: "<p style='font-style:italic;'>Since 1.0.31 (Release 9.2)</p><p>Returns a user by ID.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadAccounts</td><td>Viewing user account info (including name, business name, address and phone number/account number)</td></tr></tbody></table><h4>API Group</h4><p>Light</p>"
        consumes:
          - "application/json"
          - "application/scim+json"
        produces:
          - "application/json"
          - "application/scim+json"
        parameters:
          -
            name: "id"
            type: "string"
            in: "path"
            description: "Internal identifier of a user"
            required: true
        responses:
          400:
            description: "bad request"
            schema:
              $ref: "#/definitions/SCIMErrorResponse"
          401:
            description: "authorization failure"
            schema:
              $ref: "#/definitions/SCIMErrorResponse"
          403:
            description: "permissions denied"
            schema:
              $ref: "#/definitions/SCIMErrorResponse"
          429:
            description: "too many requests"
            schema:
              $ref: "#/definitions/SCIMErrorResponse"
          500:
            description: "internal server error"
            schema:
              $ref: "#/definitions/SCIMErrorResponse"
          default:
            description: "Success"
            schema:
              $ref: "#/definitions/UserInfo"
        x-api-group: "scim"
        x-throttling-group: "Light"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "ReadAccounts"
        x-user-permission: "ReadExtensions"
        x-access-level: "PublicBeta"
      put:
        tags:
          - "SCIM"
        summary: "Update or replace user"
        operationId: "updateUser"
        description: "<p style='font-style:italic;'>Since 1.0.31 (Release 9.2)</p><p></p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>EditExtensions</td><td>Updating User using SCIM</td></tr></tbody></table><h4>API Group</h4><p>Medium</p>"
        consumes:
          - "application/json"
          - "application/scim+json"
        produces:
          - "application/json"
          - "application/scim+json"
        parameters:
          -
            name: "id"
            type: "string"
            in: "path"
            description: "Internal identifier of a user"
            required: true
          -
            name: "body"
            in: "body"
            description: "An Exisiting User"
            schema:
              $ref: "#/definitions/UserUpdateRequest"
            required: true
        responses:
          400:
            description: "bad request"
            schema:
              $ref: "#/definitions/SCIMErrorResponse"
          401:
            description: "authorization failure"
            schema:
              $ref: "#/definitions/SCIMErrorResponse"
          403:
            description: "permissions denied"
            schema:
              $ref: "#/definitions/SCIMErrorResponse"
          404:
            description: "not found"
            schema:
              $ref: "#/definitions/SCIMErrorResponse"
          409:
            description: "duplicate email"
            schema:
              $ref: "#/definitions/SCIMErrorResponse"
          429:
            description: "too many requests"
            schema:
              $ref: "#/definitions/SCIMErrorResponse"
          500:
            description: "internal server error"
            schema:
              $ref: "#/definitions/SCIMErrorResponse"
          default:
            description: "Success"
            schema:
              $ref: "#/definitions/UserInfo"
        x-api-group: "scim"
        x-throttling-group: "Medium"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "EditExtensions"
        x-user-permission: "ReadExtensions"
        x-access-level: "PublicBeta"
      delete:
        tags:
          - "SCIM"
        summary: "Delete User"
        operationId: "deleteUser"
        description: "<p style='font-style:italic;'>Since 1.0.31 (Release 9.2)</p><p></p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>EditAccounts</td><td>Deleting User using scim</td></tr></tbody></table><h4>API Group</h4><p>Medium</p>"
        consumes:
          - "application/json"
          - "application/scim+json"
        produces:
          - "application/json"
          - "application/scim+json"
        parameters:
          -
            name: "id"
            type: "string"
            in: "path"
            description: "Internal identifier of a user"
            required: true
        responses:
          401:
            description: "authorization failure"
            schema:
              $ref: "#/definitions/SCIMErrorResponse"
          403:
            description: "permissions denied"
            schema:
              $ref: "#/definitions/SCIMErrorResponse"
          404:
            description: "not found"
            schema:
              $ref: "#/definitions/SCIMErrorResponse"
          429:
            description: "too many requests"
            schema:
              $ref: "#/definitions/SCIMErrorResponse"
          500:
            description: "internal server error"
            schema:
              $ref: "#/definitions/SCIMErrorResponse"
          default:
            description: "Success"
        x-api-group: "scim"
        x-throttling-group: "Medium"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "EditAccounts"
        x-user-permission: "ReadAccounts"
        x-access-level: "PublicBeta"
      patch:
        tags:
          - "SCIM"
        summary: "Partially update/patch a user"
        operationId: "patchUser"
        description: "<p style='font-style:italic;'>Since 1.0.31 (Release 9.2)</p><p></p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>EditAccounts</td><td>Partially update/patch a user</td></tr></tbody></table><h4>API Group</h4><p>Medium</p>"
        consumes:
          - "application/json"
          - "application/scim+json"
        produces:
          - "application/json"
          - "application/scim+json"
        parameters:
          -
            name: "id"
            type: "string"
            in: "path"
            description: "Internal identifier of a user"
            required: true
          -
            in: "body"
            name: "body"
            description: "patch operations list"
            required: false
            schema:
              $ref: "#/definitions/SCIMUserPatch"
        responses:
          400:
            description: "bad request"
            schema:
              $ref: "#/definitions/SCIMErrorResponse"
          401:
            description: "authorization failure"
            schema:
              $ref: "#/definitions/SCIMErrorResponse"
          403:
            description: "permissions denied"
            schema:
              $ref: "#/definitions/SCIMErrorResponse"
          404:
            description: "not found"
            schema:
              $ref: "#/definitions/SCIMErrorResponse"
          429:
            description: "too many requests"
            schema:
              $ref: "#/definitions/SCIMErrorResponse"
          500:
            description: "internal server error"
            schema:
              $ref: "#/definitions/SCIMErrorResponse"
          default:
            description: "Success"
            schema:
              $ref: "#/definitions/UserInfo"
        x-api-group: "scim"
        x-throttling-group: "Medium"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "EditAccounts"
        x-user-permission: "ReadAccounts"
        x-access-level: "PublicBeta"
    /restapi/v1.0/account/{accountId}/extension/{extensionId}/reporting/settings:
      get:
        tags:
          - "Reporting"
        summary: "Get Reporting Settings"
        operationId: "loadReportingSettings"
        description: "<p style='font-style:italic;'>Since 1.0.17 (Release 7.2)</p><p>Returns user-defined configuration of CFA (Customer Facing Analytics) reports.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadAccounts</td><td>Viewing user account info (including name, business name, address and phone number/account number)</td></tr></tbody></table><h4>API Group</h4><p>Light</p>"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "accountId"
            type: "string"
            in: "path"
            description: "Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"
            required: true
            default: "~"
          -
            name: "extensionId"
            type: "string"
            in: "path"
            description: "Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session"
            required: true
            default: "~"
        responses:
          default:
            description: "Success"
            schema:
              $ref: "#/definitions/ReportingSettings"
        x-api-group: "extension/reporting/settings"
        x-throttling-group: "Light"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "ReadAccounts"
        x-user-permission: "ReadAccounts"
        x-access-level: "Internal"
      put:
        tags:
          - "Reporting"
        summary: "Update Reporting Settings"
        operationId: "updateReportingSettings"
        description: "<p style='font-style:italic;'></p><p>Sets user-defined configuration of CFA (Customer Facing Analytics) reports.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>EditAccounts</td><td>Viewing and updating user account info (including name, business name, address and phone number/account number)</td></tr></tbody></table><h4>API Group</h4><p>Light</p>"
        consumes:
          - "application/json"
        produces:
          - "application/json"
        parameters:
          -
            name: "accountId"
            type: "string"
            in: "path"
            description: "Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"
            required: true
            default: "~"
          -
            name: "extensionId"
            type: "string"
            in: "path"
            description: "Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session"
            required: true
            default: "~"
          -
            name: "body"
            in: "body"
            description: "JSON body"
            schema:
              $ref: "#/definitions/SetReportingSettingsRequest"
            required: true
        responses:
          default:
            description: "Success"
            schema:
              $ref: "#/definitions/ReportingSettings"
        x-api-group: "extension/reporting/settings"
        x-throttling-group: "Light"
        x-metered-api: true
        x-metering-group: "System"
        x-app-permission: "EditAccounts"
        x-user-permission: "EditAccounts"
        x-access-level: "Internal"
  definitions:
    SCIMUserPatch:
      type: "object"
      required:
        - "Operations"
        - "schemas"
      properties:
        Operations:
          type: "array"
          description: "patch operations list"
          items:
            $ref: "#/definitions/PatchOperationInfo"
        schemas:
          type: "array"
          items:
            type: "string"
            enum:
              - "urn:ietf:params:scim:api:messages:2.0:PatchOp"
    PatchOperationInfo:
      type: "object"
      required:
        - "op"
      properties:
        op:
          type: "string"
          enum:
            - "add"
            - "replace"
            - "remove"
        path:
          type: "string"
        value:
          type: "object"
          description: "corresponding 'value' of that field specified by 'path'"
    SCIMErrorResponse:
      type: "object"
      properties:
        detail:
          type: "string"
          description: "detail error message"
        schemas:
          type: "array"
          items:
            type: "string"
            enum:
              - "urn:ietf:params:scim:api:messages:2.0:Error"
        scimType:
          type: "string"
          description: "bad request type when status code is 400"
          enum:
            - "uniqueness"
            - "tooMany"
            - "mutability"
            - "sensitive"
            - "invalidSyntax"
            - "invalidFilter"
            - "invalidPath"
            - "invalidValue"
            - "invalidVers"
            - "noTarget"
        status:
          type: "string"
          description: "same as HTTP status code, e.g. 400, 401, etc."
    SCIMSearchRequestInfo:
      type: "object"
      properties:
        count:
          type: "integer"
          format: "int32"
          description: "page size"
        filter:
          type: "string"
          description: "only support 'userName' or 'email' filter expressions for now"
        schemas:
          type: "array"
          items:
            type: "string"
            enum:
              - "urn:ietf:params:scim:api:messages:2.0:SearchRequest"
        startIndex:
          type: "integer"
          format: "int32"
          description: "start index (1-based)"
    AuthenticationSchemes:
      type: "object"
      properties:
        authenticationSchemes:
          type: "array"
          items:
            $ref: "#/definitions/AuthenticationScheme"
    AuthenticationScheme:
      type: "object"
      properties:
        description:
          type: "string"
        documentationUrl:
          type: "string"
        name:
          type: "string"
        specUrl:
          type: "string"
    ServiceProviderConfig:
      type: "object"
      properties:
        authenticationSchemes:
          $ref: "#/definitions/AuthenticationSchemes"
        bulk:
          $ref: "#/definitions/BulkSupported"
        changePassword:
          $ref: "#/definitions/Supported"
        etag:
          $ref: "#/definitions/Supported"
        filter:
          $ref: "#/definitions/FilterSupported"
        patch:
          $ref: "#/definitions/Supported"
        schemas:
          type: "array"
          items:
            type: "string"
            enum:
              - "urn:ietf:params:scim:schemas:core:2.0:ServiceProviderConfig"
        sort:
          $ref: "#/definitions/Supported"
    BulkSupported:
      type: "object"
      properties:
        maxOperations:
          type: "integer"
          format: "int32"
        maxPayloadSize:
          type: "integer"
          format: "int32"
        supported:
          type: "boolean"
          default: false
    FilterSupported:
      type: "object"
      properties:
        maxResults:
          type: "integer"
          format: "int32"
        supported:
          type: "boolean"
          default: false
    Supported:
      type: "object"
      properties:
        supported:
          type: "boolean"
          default: false
    FaxResponse:
      type: "object"
      properties:
        id:
          type: "integer"
          format: "int64"
          description: "Internal identifier of a message"
        uri:
          type: "string"
          description: "Canonical URI of a message"
        type:
          type: "string"
          description: "Message type - 'Fax'"
        from:
          description: "Sender information"
          $ref: "#/definitions/CallerInfoFrom"
        to:
          type: "array"
          description: "Recipient information"
          items:
            $ref: "#/definitions/CallerInfoTo"
        creationTime:
          type: "string"
          format: "date-time"
          description: "Message creation datetime in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z"
        readStatus:
          type: "string"
          description: "Message read status"
          enum:
            - "Read"
            - "Unread"
        priority:
          type: "string"
          description: "Message priority"
          enum:
            - "Normal"
            - "High"
        attachments:
          type: "array"
          description: "The list of message attachments"
          items:
            $ref: "#/definitions/MessageAttachmentInfoIntId"
        direction:
          type: "string"
          description: "Message direction"
          enum:
            - "Inbound"
            - "Outbound"
        availability:
          type: "string"
          description: "Message availability status. Message in 'Deleted' state is still preserved with all its attachments and can be restored. 'Purged' means that all attachments are already deleted and the message itself is about to be physically deleted shortly"
          enum:
            - "Alive"
            - "Deleted"
            - "Purged"
        messageStatus:
          type: "string"
          description: "Message status. 'Queued' - the message is queued for sending; 'Sent' - a message is successfully sent; 'SendingFailed' - a message sending attempt has failed; 'Received' - a message is received (inbound messages have this status by default)"
          enum:
            - "Queued"
            - "Sent"
            - "SendingFailed"
            - "Received"
        faxResolution:
          type: "string"
          description: "Resolution of a fax message. ('High' for black and white image scanned at 200 dpi, 'Low' for black and white image scanned at 100 dpi)"
          enum:
            - "High"
            - "Low"
        faxPageCount:
          type: "integer"
          description: "Page count in a fax message"
        lastModifiedTime:
          type: "string"
          format: "date-time"
          description: "Datetime when the message was modified on server in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z"
        coverIndex:
          type: "integer"
          description: "Cover page identifier. For the list of available cover page identifiers please call the method Fax Cover Pages"
        coverPageText:
          type: "string"
          description: "Cover page text, entered by the fax sender and printed on the cover page. Maximum length is limited to 1024 symbols"
    Binary:
      type: "object"
      properties:
        data:
          type: "string"
          description: "Required Binary Data"
          format: "binary"
    ContactList:
      type: "object"
      properties:
        records:
          type: "array"
          description: "List of personal contacts from the extension address book"
          items:
            $ref: "#/definitions/PersonalContactResource"
        navigation:
          description: "Information on navigation"
          $ref: "#/definitions/NavigationInfo"
        paging:
          description: "Information on paging"
          $ref: "#/definitions/PagingInfo"
    ParkLocationResponse:
      type: "object"
      properties:
        records:
          type: "array"
          description: "List of user extensions allowed to park and unpark calls to/from the extension specified"
          items:
            $ref: "#/definitions/ExtensionInfo"
        navigation:
          description: "Information on navigation"
          $ref: "#/definitions/NavigationInfo"
        paging:
          description: "Information on paging"
          $ref: "#/definitions/PagingInfo"
    DeviceOrder:
      type: "object"
      properties:
        id:
          type: "string"
          description: "Identifier of a device"
        uri:
          type: "string"
          description: "Canonical URI of an order resource"
        devices:
          type: "array"
          description: "List of devices ordered"
          items:
            $ref: "#/definitions/DeviceResource"
    DeviceOrderCreation:
      type: "object"
      properties:
        devices:
          type: "array"
          description: "List of devices ordered"
          items:
            $ref: "#/definitions/DeviceResource"
        task:
          description: "For Async Order Only. Information on device ordering task"
          $ref: "#/definitions/TaskInfo"
    TaskInfo:
      type: "object"
      properties:
        id:
          type: "string"
          description: "Internal identifier of a task"
        uri:
          type: "string"
          description: "Link to a task resource"
        status:
          type: "string"
          description: "Device order status"
          enum:
            - "Accepted"
            - "Failed"
        creationTime:
          type: "string"
          format: "date-time"
          description: "Task creation time"
        lastModifiedTime:
          type: "string"
          format: "date-time"
          description: "Time of task last modification"
    AccountSignupInfoRequest:
      type: "object"
      properties:
        marketingAccepted:
          type: "boolean"
          description: " Specifies whether marketing information is sent to the user"
    PhoneNumbers:
      type: "object"
      properties:
        uri:
          type: "string"
          description: "Canonical URI of the phone numbers resource"
        records:
          type: "array"
          description: "List of phone numbers filtered by the specified criteria"
          items:
            $ref: "#/definitions/LookupPhoneNumberInfo"
    LookupPhoneNumberInfo:
      type: "object"
      properties:
        phoneNumber:
          type: "string"
          description: "Phone number in E.164 format"
        formattedNumber:
          type: "string"
          description: "Phone number formatted according to current brand's default country"
        vanityPattern:
          type: "string"
          description: "Vanity pattern for this number. Returned only when vanity search option is requested. Vanity pattern corresponds to request parameters nxx plus line or numberPattern"
        rank:
          type: "integer"
          description: "The value is returned if the extendedSearch parameter is true. The values are 10, 9, 8, etc.; '10' is the closest match"
    PagingOnlyGroupDevices:
      type: "object"
      properties:
        records:
          type: "array"
          description: "List of paging devices assigned to this group"
          items:
            $ref: "#/definitions/PagingDeviceInfo"
        navigation:
          description: "Information on navigation"
          $ref: "#/definitions/NavigationInfo"
        paging:
          description: "Information on paging"
          $ref: "#/definitions/PagingInfo"
    PagingDeviceInfo:
      type: "object"
      properties:
        id:
          type: "string"
          description: "Internal identifier of a paging device"
        uri:
          type: "string"
          description: "Link to a paging device resource"
        name:
          type: "string"
          description: "Name of a paging device"
    PagingOnlyGroupUsers:
      type: "object"
      properties:
        records:
          type: "array"
          description: "List of users allowed to page this group"
          items:
            $ref: "#/definitions/PagingGroupExtensionInfo"
        navigation:
          description: "Information on navigation"
          $ref: "#/definitions/NavigationInfo"
        paging:
          description: "Information on paging"
          $ref: "#/definitions/PagingInfo"
    PagingGroupExtensionInfo:
      type: "object"
      properties:
        id:
          type: "string"
          description: "Internal identifier of a paging group user extension"
        uri:
          type: "string"
          description: "Link to a paging group user extension"
        extensionNumber:
          type: "string"
          description: "Extension number of a paging group user"
        name:
          type: "string"
          description: "Name of a paging group user"
    AccountPhoneNumbers:
      type: "object"
      properties:
        records:
          type: "array"
          description: "List of account phone numbers"
          items:
            $ref: "#/definitions/PhoneNumberInfo"
        navigation:
          description: "Information on navigation"
          $ref: "#/definitions/NavigationInfo"
        paging:
          description: "Information on paging"
          $ref: "#/definitions/PagingInfo"
    BlockedNumbersList:
      type: "object"
      properties:
        records:
          type: "array"
          description: "List of blocked phone numbers"
          items:
            $ref: "#/definitions/BlockedNumberInfo"
        navigation:
          description: "Information on navigation"
          $ref: "#/definitions/NavigationInfo"
        paging:
          description: "Information on paging"
          $ref: "#/definitions/PagingInfo"
    BlockedNumberInfo:
      type: "object"
      properties:
        id:
          type: "string"
          description: "Internal identifier of a blocked number"
        uri:
          type: "string"
          description: "Canonical URI of a blocked number"
        name:
          type: "string"
          description: "Name assigned by a user to a blocked phone number"
        phoneNumber:
          type: "string"
          description: "Phone number to be blocked"
    DictionaryGreetingList:
      type: "object"
      properties:
        uri:
          type: "string"
          description: "Canonical URI of greetings list resource"
        records:
          type: "array"
          description: "List of greetings"
          items:
            $ref: "#/definitions/DictionaryGreetingInfo"
    DictionaryGreetingInfo:
      type: "object"
      properties:
        id:
          type: "string"
          description: "Internal identifier of a greeting"
        uri:
          type: "string"
          description: "Link to a greeting"
        name:
          type: "string"
          description: "Name of a greeting"
        usageType:
          type: "string"
          description: "Usage type of a greeting, specifying if the greeting is applied for user extension or department extension = ['UserExtensionAnsweringRule', 'ExtensionAnsweringRule', 'DepartmentExtensionAnsweringRule', 'CompanyAnsweringRule', 'CompanyAfterHoursAnsweringRule']"
          enum:
            - "UserExtensionAnsweringRule"
            - "ExtensionAnsweringRule"
            - "DepartmentExtensionAnsweringRule"
            - "CompanyAnsweringRule"
            - "CompanyAfterHoursAnsweringRule"
        text:
          type: "string"
          description: "Text of a greeting, if any"
        contentUri:
          type: "string"
          description: "Link to a greeting content (audio file), if any"
        type:
          type: "string"
          description: "Type of a greeting, specifying the case when the greeting is played. See Greeting Types = ['Introductory', 'Announcement', 'ConnectingMessage', 'ConnectingAudio', 'Voicemail', 'Unavailable', 'InterruptPrompt', 'HoldMusic', 'Company']"
          enum:
            - "Introductory"
            - "Announcement"
            - "ConnectingMessage"
            - "ConnectingAudio"
            - "Voicemail"
            - "Unavailable"
            - "InterruptPrompt"
            - "HoldMusic"
            - "Company"
        category:
          type: "string"
          description: "Category of a greeting, specifying data form. The category value 'None' specifies that greetings of a certain type ('Introductory', 'ConnectingAudio', etc.) are switched off for an extension = ['Music', 'Message', 'Ring Tones', 'None']"
          enum:
            - "Music"
            - "Message"
            - "Ring Tones"
            - "None"
        navigation:
          description: "Information on navigation"
          $ref: "#/definitions/NavigationInfo"
        paging:
          description: "Information on paging"
          $ref: "#/definitions/PagingInfo"
    AccountPresenceInfo:
      type: "object"
      properties:
        uri:
          type: "string"
          description: "Canonical URI of account presence resource"
        records:
          type: "array"
          description: "List of Prompts"
          items:
            $ref: "#/definitions/GetPresenceInfo"
        navigation:
          description: "Information on navigation"
          $ref: "#/definitions/NavigationInfo"
        paging:
          description: "Information on paging"
          $ref: "#/definitions/PagingInfo"
    CallLogRecordDeviceInfo:
      type: "object"
      properties:
        id:
          type: "string"
          description: "Internal identifier of a device"
        uri:
          type: "string"
          description: "string to a device"
    GlipCreateGroup:
      type: "object"
      required:
        - "type"
      properties:
        type:
          type: "string"
          enum:
            - "PrivateChat"
            - "Team"
          description: "Type of a group to be created. 'PrivateChat' is a group of 2 members. 'Team' is a chat of 1 and more participants, the membership can be modified in future"
        isPublic:
          type: "boolean"
          description: "For 'Team' group type only. Team access level"
        name:
          type: "string"
          description: "For 'Team' group type only. Team name"
        description:
          type: "string"
          description: "For 'Team' group type only. Team description"
        members:
          type: "array"
          items:
            type: "string"
          description: "Identifier(s) of group members. For 'PrivateChat' group type 2 members only are supported"
    EditGroupRequest:
      type: "object"
      properties:
        addedPersonIds:
          type: "array"
          items:
            type: "string"
          description: "List of users to be added to the team"
        addedPersonEmails:
          type: "array"
          items:
            type: "string"
          description: "List of user email addresses to be added to the team (i.e. as guests)"
        removedPersonIds:
          type: "array"
          items:
            type: "string"
          description: "List of users to be removed from the team"
    GlipCreatePost:
      type: "object"
      properties:
        text:
          type: "string"
          description: "Text of a post, the maximum is 10000 unicode characters"
        attachments:
          type: "array"
          items:
            $ref: "#/definitions/GlipMessageAttachmentInfoRequest"
          description: "List of attachments to be posted"
    GlipCompany:
      type: "object"
      required:
        - "id"
        - "creationTime"
        - "lastModifiedTime"
      properties:
        id:
          type: "string"
          description: "Internal identifier of an RC account/Glip company, or tilde (~) to indicate a company the current user belongs to"
        name:
          type: "string"
          description: "Name of a company"
        domain:
          type: "string"
          description: "Domain name of a company"
        creationTime:
          type: "string"
          description: "Datetime of creation in ISO 8601 format"
        lastModifiedTime:
          type: "string"
          description: "Datetime of last modification in ISO 8601 format"
    GlipGroupList:
      type: "object"
      required:
        - "records"
      properties:
        records:
          type: "array"
          items:
            $ref: "#/definitions/GlipGroupInfo"
          description: "List of groups/teams/private chats"
        navigation:
          $ref: "#/definitions/GlipNavigationInfo"
          description: "Information on navigation"
    GlipNavigationInfo:
      type: "object"
      properties:
        prevPageToken:
          type: "string"
          description: "Previous page token. To get previous page, user should pass one of returned token in next request and, in turn, required page will be returned with new tokens"
        nextPageToken:
          type: "string"
          description: "Next page token. To get next page, user should pass one of returned token in next request and, in turn, required page will be returned with new tokens"
    GlipGroupInfo:
      type: "object"
      properties:
        id:
          type: "string"
          description: "Internal identifier of a group"
        type:
          type: "string"
          enum:
            - "PrivateChat"
            - "Group"
            - "Team"
          description: "Type of a group. 'PrivateChat' is a group of 2 members. 'Group' is a chat of 2 and more participants, the membership cannot be changed after group creation. 'Team' is a chat of 1 and more participants, the membership can be modified in future"
        isPublic:
          type: "boolean"
          description: "For 'Team' group type only. Team access level"
        name:
          type: "string"
          description: "For 'Team' group type only. Team name"
        description:
          type: "string"
          description: "For 'Team' group type only. Team description"
        members:
          type: "array"
          items:
            type: "string"
          description: "Identifier(s) of group members"
        creationTime:
          type: "string"
          format: "date-time"
          description: "Group creation datetime in ISO 8601 format"
        lastModifiedTime:
          type: "string"
          format: "date-time"
          description: "Group last change datetime in ISO 8601 format"
    GlipPersonInfo:
      type: "object"
      required:
        - "id"
      properties:
        id:
          type: "string"
          description: "Internal identifier of a user"
        firstName:
          type: "string"
          description: "First name of a user"
        lastName:
          type: "string"
          description: "Last name of a user"
        email:
          type: "string"
          description: "Email of a user"
        jobTitle:
          type: "string"
          description: "Job title of a user"
        location:
          type: "string"
          description: "Location of a user"
        avatar:
          type: "string"
          description: "Photo of a user"
        companyId:
          type: "string"
          description: "Internal identifier of a company"
        creationTime:
          type: "string"
          format: "date-time"
          description: "Time of creation in ISO 8601 format"
        lastModifiedTime:
          type: "string"
          format: "date-time"
          description: "Time of last modification in ISO 8601 format"
    GlipPosts:
      type: "object"
      required:
        - "records"
      properties:
        records:
          type: "array"
          items:
            $ref: "#/definitions/GlipPostInfo"
          description: "List of posts"
        navigation:
          $ref: "#/definitions/GlipNavigationInfo"
          description: "Information on navigation"
    GlipPostInfo:
      type: "object"
      properties:
        id:
          type: "string"
          description: "Internal identifier of a post"
        groupId:
          type: "string"
          description: "Internal identifier of a group a post belongs to"
        type:
          type: "string"
          enum:
            - "TextMessage"
            - "PersonJoined"
            - "PersonsAdded"
          description: "Type of a post"
        text:
          type: "string"
          description: "For 'TextMessage' post type only. Message text"
        creatorId:
          type: "string"
          description: "Internal identifier of a user - author of a post"
        addedPersonIds:
          type: "array"
          items:
            type: "string"
          description: "For PersonsAdded post type only. Identifiers of persons added to a group"
        creationTime:
          type: "string"
          format: "date-time"
          description: "Post creation datetime in ISO 8601 format"
        lastModifiedTime:
          type: "string"
          format: "date-time"
          description: "Post last modification datetime in ISO 8601 format"
        attachments:
          type: "array"
          items:
            $ref: "#/definitions/GlipMessageAttachmentInfo"
          description: "List of posted attachments"
        mentions:
          type: "array"
          items:
            $ref: "#/definitions/GlipMentionsInfo"
          description: "List of posted attachments"
        activity:
          type: "string"
          description: "activity type"
        title:
          type: "string"
          description: "Title of the message. Can be set for bot messages only"
        iconUri:
          type: "string"
          description: "URI to an image to use as the icon for this message."
        iconEmoji:
          type: "string"
          description: "Emoji to use as the icon for a message"
    GlipMessageAttachmentInfoRequest:
      type: "object"
      properties:
        type:
          type: "string"
          description: "Type of an attachment"
          default: "Card"
        fallback:
          type: "string"
          description: "A string of default text that will be rendered in the case that the client does not support Interactive Messages"
        color:
          type: "string"
          description: "A Hex color code that determines the color of the side border of the Interactive Message"
        intro:
          type: "string"
          description: "A pretext to the message"
        author:
          description: "Information about the author"
          $ref: "#/definitions/GlipMessageAttachmentAuthorInfo"
        title:
          type: "string"
          description: "Message title"
        text:
          type: "string"
          description: "A large string field (up to 1000 chars) to be displayed as the body of a message (Supports GlipDown)"
        imageUri:
          type: "string"
          description: "url used to display a single image at the bottom of a message"
        thumbnailUri:
          type: "string"
          description: "url used to display a thumbnail to the right of a message (82x82)"
        fields:
          type: "array"
          description: "Information on navigation"
          items:
            $ref: "#/definitions/GlipMessageAttachmentFieldsInfo"
        footnote:
          description: "Message Footer"
          $ref: "#/definitions/GlipMessageAttachmentFootnoteInfo"
    GlipMessageAttachmentInfo:
      type: "object"
      properties:
        id:
          type: "string"
          description: "Internal identifier of an attachment"
        type:
          type: "string"
          description: "Type of an attachment"
          default: "Card"
        fallback:
          type: "string"
          description: "A string of default text that will be rendered in the case that the client does not support Interactive Messages"
        color:
          type: "string"
          description: "A Hex color code that determines the color of the side border of the Interactive Message"
        intro:
          type: "string"
          description: "A pretext to the message"
        author:
          description: "Information about the author"
          $ref: "#/definitions/GlipMessageAttachmentAuthorInfo"
        title:
          type: "string"
          description: "Message title"
        text:
          type: "string"
          description: "A large string field (up to 1000 chars) to be displayed as the body of a message (Supports GlipDown)"
        imageUri:
          type: "string"
          description: "url used to display a single image at the bottom of a message"
        thumbnailUri:
          type: "string"
          description: "url used to display a thumbnail to the right of a message (82x82)"
        fields:
          type: "array"
          description: "Information on navigation"
          items:
            $ref: "#/definitions/GlipMessageAttachmentFieldsInfo"
        footnote:
          description: "Message Footer"
          $ref: "#/definitions/GlipMessageAttachmentFootnoteInfo"
    GlipMessageAttachmentAuthorInfo:
      type: "object"
      properties:
        name:
          type: "string"
          description: "The author name"
        uri:
          type: "string"
          description: "Used to link the authors name"
        iconUri:
          type: "string"
          description: "A url to an image up to 82x82px that will display to the left of the author’s name"
    GlipMessageAttachmentFootnoteInfo:
      type: "object"
      properties:
        text:
          type: "string"
          description: "A string used to be displayed as the body of the footer."
        iconUri:
          type: "string"
          description: "A URL used to display a 32x32px icon to the left of the footer"
        time:
          type: "string"
          description: "A Unix timestamp to be displayed to the right of the footer (prettified)"
          format: "date-time"
    GlipMessageAttachmentFieldsInfo:
      type: "object"
      properties:
        title:
          type: "string"
          description: "Title for an individual field"
        value:
          type: "string"
          description: "Field Value (Supports Markdown)"
        style:
          type: "string"
          description: "A style used to flag fields that should span the width of the message, Defaults to 'Short' (Not full width)"
          enum:
            - "Short"
            - "Long"
    GlipMentionsInfo:
      type: "object"
      properties:
        id:
          type: "string"
          description: "Id of the user"
        type:
          type: "string"
          description: "Type of mentions"
          enum:
            - "Person"
            - "Team"
            - "File"
            - "Link"
            - "Event"
            - "Task"
            - "Note"
            - "Card"
        name:
          type: "string"
          description: "Name of the user"
    PostGlipFile:
      type: "object"
      required:
        - "id"
        - "contentUri"
      properties:
        id:
          type: "string"
          description: "Internal identifier of a file"
        contentUri:
          type: "string"
          description: "Link to binary content"
        name:
          type: "string"
          description: "Name of a file"
    GlipUnreadMessageCount:
      type: "object"
      properties:
        unreadPostsCount:
          type: "integer"
          description: "Total count of unread posts"
        tooManyUnreadPosts:
          type: "boolean"
          description: "'True' if message quantity exceeds the threshold (100 by default)"
    BotExtensionCreation:
      type: "object"
      properties:
        uri:
          type: "string"
          description: "Link to a bot extension resource"
        id:
          type: "string"
          description: "Internal identifier of a bot extension"
        extensionNumber:
          type: "string"
          description: "Bot extension number"
        name:
          type: "string"
          description: "Bot name (equals to extension first name)"
        applicationKey:
          type: "string"
          description: "Identifier key of a bot application"
        creatorId:
          type: "string"
          description: "User extension identifier"
    BotExtensionCreationRequest:
      type: "object"
      properties:
        name:
          type: "string"
          description: "Bot name (equals to extension first name)"
        applicationKey:
          type: "string"
          description: "Key of a bot application"
        creatorId:
          type: "string"
          description: "User extension identifier"
    CompanyDirectoryContactInfo:
      type: "object"
      properties:
        id:
          type: "string"
          description: "Internal identifier of an extension"
        type:
          type: "string"
          enum:
            - "User"
            - "Department"
            - "Announcement"
            - "Voicemail"
            - "SharedLinesGroup"
            - "PagingOnly"
            - "IvrMenu"
            - "ParkLocation"
            - "Limited"
          description: "Type of an extension"
        status:
          type: "string"
          enum:
            - "Enabled"
            - "Disabled"
            - "NotActivated"
          description: "Status of an extension"
        firstName:
          type: "string"
          description: "User extension first name"
        lastName:
          type: "string"
          description: "User extension last name"
        name:
          type: "string"
          description: "Name of an extension"
        department:
          type: "string"
          description: "Department name of an extension"
        email:
          type: "string"
          description: "Email of an extension"
        extensionNumber:
          type: "string"
          description: "Number of an extension"
        account:
          $ref: "#/definitions/CompanyDirectoryAccountInfo"
          description: "Account data of an extension"
        phoneNumbers:
          type: "array"
          items:
            $ref: "#/definitions/CompanyDirectoryPhoneNumberInfo"
          description: "Extension phone numbers information"
        profileImage:
          $ref: "#/definitions/CompanyDirectoryProfileImageInfo"
          description: "Extension profile image information. Not returned if profile images are absent for an extension"
    CompanyDirectoryAccountInfo:
      type: "object"
      properties:
        id:
          type: "string"
          description: "Internal identifier of an account"
    CompanyDirectoryPhoneNumberInfo:
      type: "object"
      properties:
        phoneNumber:
          type: "string"
          description: "Extension phone number in E.164 format"
        type:
          type: "string"
          enum:
            - "VoiceFax"
            - "FaxOnly"
            - "VoiceOnly"
          description: "Type of a phone number"
        hidden:
          type: "boolean"
          description: "Specifies if a phone number should be hidden or not. Returned only if the value is 'True'"
        usageType:
          type: "string"
          enum:
            - "MobileNumber"
            - "ContactNumber"
            - "DirectNumber"
            - "ForwardedNumber"
          description: "Usage type of a phone number"
    CompanyDirectoryProfileImageInfo:
      type: "object"
      properties:
        uri:
          type: "string"
          description: "Link to a profile image resource"
        etag:
          type: "string"
          description: "Internal identifier of an image"
    CompanyDirectoryContacts:
      type: "object"
      required:
        - "records"
        - "paging"
      properties:
        records:
          type: "array"
          items:
            $ref: "#/definitions/CompanyDirectoryContactInfo"
          description: "List of countries which can be selected for a dialing plan"
        paging:
          $ref: "#/definitions/PagingInfo"
          description: "Information on paging"
    FederationInfo:
      type: "object"
      properties:
        id:
          type: "string"
          description: "Internal identifier of a federation"
        displayName:
          type: "string"
          description: "Name of a federation"
        creationTime:
          type: "string"
          format: "date-time"
          description: "Datetime of federation creation, in ISO 8601 format, for example 2016-03-10T18:07:52.534Z"
        lastModifiedTime:
          type: "string"
          format: "date-time"
          description: "Datetime of the last change of federation composition, in ISO 8601 format, for example 2016-03-10T18:07:52.534Z"
        accounts:
          type: "array"
          items:
            $ref: "#/definitions/FederationAccountInfo"
          description: "List of countries which can be selected for a dialing plan"
    FederationAccountInfo:
      type: "object"
      properties:
        id:
          type: "string"
          description: "Internal identifier of an account"
        companyName:
          type: "string"
          description: "Company name of an account"
        federatedName:
          type: "string"
          description: "Federation name of an account"
        linkCreationTime:
          type: "string"
          description: "Datetime when this account was linked to a federation, in ISO 8601 format, for example 2016-03-10T18:07:52.534Z"
        mainNumber:
          $ref: "#/definitions/FederationMainNumberInfo"
          description: "Main company number information"
        conflictCount:
          type: "integer"
          description: "Count of federation extension numbers conflicting with extension numbers of the requested account. For extension numbers of the requested account the value of this parameter is '0'"
    FederationMainNumberInfo:
      type: "object"
      properties:
        phoneNumber:
          type: "string"
          description: "Main company number of an account in E.164 format"
        formattedPhoneNumber:
          type: "string"
          description: "Main company number of an account formatted as consistent with the home country of the current extension"
    FederationConflicts:
      type: "object"
      required:
        - "records"
      properties:
        records:
          type: "array"
          items:
            $ref: "#/definitions/FederationExtensionInfo"
          description: "List of conflicting federation extensions"
    FederationExtensionInfo:
      type: "object"
      properties:
        id:
          type: "string"
          description: "Internal identifier of an extension of current account"
        extensionNumber:
          type: "string"
          description: "Number of an extension"
        firstName:
          type: "string"
          description: "Extension user first name"
        lastName:
          type: "string"
          description: "Extension user last name"
        conflicts:
          type: "array"
          items:
            $ref: "#/definitions/ConflictsInfo"
          description: "Conflicting extensions information"
    ConflictsInfo:
      type: "object"
      properties:
        id:
          type: "string"
          description: "Internal identifier of a conflicting extension assigned to another account of the current federation"
        firstName:
          type: "string"
          description: "Extension user first name"
        lastName:
          type: "string"
          description: "Extension user last name"
        account:
          $ref: "#/definitions/FederationConflictsAccountInfo"
          description: "Account data of an extension"
    FederationConflictsAccountInfo:
      type: "object"
      properties:
        id:
          type: "string"
          description: "Internal identifier of an account"
        federatedName:
          type: "string"
          description: "Federated name of an account"
    FederationExtensionNumbers:
      type: "object"
      required:
        - "records"
      properties:
        records:
          type: "array"
          items:
            $ref: "#/definitions/FederationExtensionNumbersExtensionInfo"
          description: "List of extension numbers of the current federation"
    FederationExtensionNumbersExtensionInfo:
      type: "object"
      properties:
        id:
          type: "string"
          description: "Internal identifier of an extension"
        extensionNumber:
          type: "string"
          description: "Number of an extension"
    ReportingSettings:
      type: "object"
      required:
        - "views"
      properties:
        views:
          type: "array"
          items:
            $ref: "#/definitions/ReportingViewInfo"
          description: "List of 'View' structures with a tuple of filter values, pages and schedules"
    ReportingViewInfo:
      type: "object"
      required:
        - "name"
        - "pages"
      properties:
        name:
          type: "string"
          description: "User-defined name of a 'View'. The maximum value is 255"
        pages:
          type: "array"
          items:
            $ref: "#/definitions/ReportingPagesInfo"
          description: "List of pages, the max amount is 10"
        schedules:
          type: "array"
          items:
            $ref: "#/definitions/ReportingSchedulesInfo"
          description: "List of schedules, the max amount is 5. Each 'View' may have several schedules for reporting. For example, customer may want to get daily and weekly reports with the same set of settings"
    ReportingPagesInfo:
      type: "object"
      required:
        - "name"
      properties:
        name:
          type: "string"
          description: "Name of a page. CFA application UI predefines a set of possible names and treats them as enum constants to distinguish pages by type. This is not user-visible value, as it might need localization. The maximum value is 255"
        attrX:
          type: "string"
          description: "CFA-defined filter values/page parameters"
    ReportingSchedulesInfo:
      type: "object"
      properties:
        scheduleId:
          type: "string"
          description: "Unique schedule identifier"
        recurrence:
          type: "array"
          items:
            $ref: "#/definitions/ReportingRecurrenceInfo"
          description: "Recurrence pattern of a schedule"
        viewType:
          type: "string"
          enum:
            - "Detailed"
            - "Simple"
          description: "Type of report. Detailed reports include tables with data. Simple reports only include charts"
        attachments:
          type: "array"
          items:
            $ref: "#/definitions/ReportingAttachmentInfo"
          description: "Set of optional attachments. Basically, every report email is in HTML format. Optionally, it can contain PDF or CSV files"
        pages:
          type: "array"
          items:
            type: "string"
          description: "List of pages to include to the report. If empty, all pages are included. Otherwise, only specified pages are included. API doesn't check validity of page names. Client application is responsible to do that"
        recipients:
          type: "array"
          items:
            type: "string"
          description: "List of emails to which to send rendered reports"
    ReportingRecurrenceInfo:
      type: "object"
      properties:
        pattern:
          type: "string"
          enum:
            - "Daily"
            - "Weekly"
            - "Monthly"
          description: "Pattern (frequency) of recurrence"
        value:
          type: "string"
          enum:
            - "0"
            - "1-7"
            - "1-31"
            - "last"
          description: "Time and dates should be specified in UTC time zone"
    ReportingAttachmentInfo:
      type: "object"
      properties:
        csv:
          type: "boolean"
          description: "Specifies whether to include CSV version of the report"
        pdf:
          type: "boolean"
          description: "Specifies whether to include PDF version of the report"
    UserUpdateRequest:
      type: "object"
      required:
        - "schemas"
        - "name"
        - "userName"
        - "emails"
      properties:
        active:
          type: "boolean"
          description: "Status of a user"
          default: false
        addresses:
          type: "array"
          items:
            $ref: "#/definitions/AddressInfo"
          description: "User addresses"
        emails:
          type: "array"
          items:
            $ref: "#/definitions/EmailInfo"
          description: "User email addresses"
        externalId:
          type: "string"
          description: "External identifier of a user"
        id:
          type: "string"
          description: "Internal identifier of a user"
        name:
          $ref: "#/definitions/NameInfo"
          description: "User name"
        phoneNumbers:
          type: "array"
          items:
            $ref: "#/definitions/PhoneNumberInfoRequest"
          description: "User phone numbers"
        photos:
          type: "array"
          items:
            $ref: "#/definitions/PhotoInfo"
        schemas:
          type: "array"
          items:
            type: "string"
          enum:
            - "urn:ietf:params:scim:schemas:core:2.0:User"
          description: "Specification links"
        urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:
          $ref: "#/definitions/EnterpriseUser"
        userName:
          type: "string"
          description: "User mailbox. Must be same as work type email address"
    UserCreationRequest:
      type: "object"
      required:
        - "schemas"
        - "name"
        - "userName"
        - "emails"
      properties:
        active:
          type: "boolean"
          description: "Status of a user"
          default: false
        addresses:
          type: "array"
          items:
            $ref: "#/definitions/AddressInfo"
          description: "User addresses"
        emails:
          type: "array"
          items:
            $ref: "#/definitions/EmailInfo"
          description: "User email addresses"
        externalId:
          type: "string"
          description: "External identifier of a user"
        id:
          type: "string"
          description: "Internal identifier of a user"
        name:
          $ref: "#/definitions/NameInfo"
          description: "User name"
        phoneNumbers:
          type: "array"
          items:
            $ref: "#/definitions/PhoneNumberInfoRequest"
          description: "User phone numbers"
        photos:
          type: "array"
          items:
            $ref: "#/definitions/PhotoInfo"
        schemas:
          type: "array"
          items:
            type: "string"
          enum:
            - "urn:ietf:params:scim:schemas:core:2.0:User"
          description: "Specification links"
        urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:
          $ref: "#/definitions/EnterpriseUser"
        userName:
          type: "string"
          description: "User mailbox. Must be same as work type email address"
    NameInfoRequest:
      type: "object"
      properties:
        givenName:
          type: "string"
          description: "User first name"
        familyName:
          type: "string"
          description: "User last name"
    EmailInfoRequest:
      type: "object"
      properties:
        value:
          type: "string"
          description: "Email address"
        type:
          type: "string"
          description: "Email address type"
    PhoneNumberInfoRequest:
      type: "object"
      properties:
        value:
          type: "string"
          description: "Phone number"
        type:
          type: "string"
          description: "Phone number type"
          enum:
            - "work"
            - "mobile"
            - "other"
    AddressInfoRequest:
      type: "object"
      properties:
        streetAddress:
          type: "string"
          description: "User street address"
        locality:
          type: "string"
          description: "User city"
        region:
          type: "string"
          description: "User state/region"
        postalCode:
          type: "string"
          description: "User postal code"
        country:
          type: "string"
          description: "User country"
        type:
          type: "string"
          description: "Address type"
    UrnInfoRequest:
      type: "object"
      properties:
        department:
          type: "string"
          description: "Name of department (call queue) member"
    GetUserListResponse:
      type: "object"
      properties:
        schemas:
          type: "array"
          items:
            type: "string"
          description: "Specification links"
        startIndex:
          type: "integer"
          description: "1-based index of query result"
        totalResults:
          type: "integer"
          description: "Results count"
        Resources:
          type: "array"
          items:
            $ref: "#/definitions/UserInfo"
          description: "List of users with detailed info"
        itemsPerPage:
          type: "integer"
          description: "Number of users displayed per page"
    UserInfo:
      type: "object"
      properties:
        active:
          type: "boolean"
          description: "Status of a user"
          default: false
        addresses:
          type: "array"
          items:
            $ref: "#/definitions/AddressInfo"
          description: "User addresses"
        emails:
          type: "array"
          items:
            $ref: "#/definitions/EmailInfo"
          description: "User email addresses"
        externalId:
          type: "string"
          description: "External identifier of a user"
        id:
          type: "string"
          description: "Internal identifier of a user"
        name:
          $ref: "#/definitions/NameInfo"
          description: "User name"
        phoneNumbers:
          type: "array"
          items:
            $ref: "#/definitions/PhoneNumberInfoRequest"
          description: "User phone numbers"
        photos:
          type: "array"
          items:
            $ref: "#/definitions/PhotoInfo"
        schemas:
          type: "array"
          items:
            type: "string"
          enum:
            - "urn:ietf:params:scim:schemas:core:2.0:User"
          description: "Specification links"
        urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:
          $ref: "#/definitions/EnterpriseUser"
        userName:
          type: "string"
          description: "User mailbox. Must be same as work type email address"
        meta:
          $ref: "#/definitions/MetaInfo"
          description: "User metadata"
    EnterpriseUser:
      type: "object"
      properties:
        department:
          type: "string"
    PhotoInfo:
      type: "object"
      properties:
        value:
          type: "string"
        type:
          type: "string"
          enum:
            - "photo"
    MetaInfo:
      type: "object"
      properties:
        resourceType:
          type: "string"
          description: "User type"
          enum:
            - "User"
            - "Group"
        created:
          type: "string"
          format: "date-time"
          description: "Datetime of user creation in ISO 8601 format, for example 2016-03-10T18:07:52.534Z"
        lastModified:
          type: "string"
          format: "date-time"
          description: "Datetime of the last change of user information in ISO 8601 format,for example 2016-03-10T18:07:52.534Z"
        location:
          type: "string"
          description: "resource location URI"
    NameInfo:
      type: "object"
      properties:
        givenName:
          type: "string"
          description: "User first name"
        familyName:
          type: "string"
          description: "User last name"
    EmailInfo:
      type: "object"
      properties:
        value:
          type: "string"
          description: "Email address"
        type:
          type: "string"
          description: "Email address type"
          enum:
            - "work"
    AddressInfo:
      type: "object"
      properties:
        streetAddress:
          type: "string"
          description: "User street address"
        locality:
          type: "string"
          description: "User city"
        region:
          type: "string"
          description: "User state/region"
        postalCode:
          type: "string"
          description: "User postal code"
        country:
          type: "string"
          description: "User country"
        type:
          type: "string"
          description: "Address type"
          enum:
            - "work"
    EditParkLocationRequest:
      type: "object"
      properties:
        addedUserIds:
          type: "array"
          description: "List of users that will be allowed to park/unpark calls using the specified park location"
          items:
            type: "string"
        removedUserIds:
          type: "array"
          description: "List of users that will be unallowed to park/unpark calls using the specified park location"
          items:
            type: "string"
    EditPagingGroupRequest:
      type: "object"
      properties:
        addedUserIds:
          type: "array"
          description: "List of users that will be allowed to page a group specified"
          items:
            type: "string"
        removedUserIds:
          type: "array"
          description: "List of users that will be unallowed to page a group specified"
          items:
            type: "string"
        addedDeviceIds:
          type: "array"
          description: "List of account devices that will be assigned to a paging group specified"
          items:
            type: "string"
        removedDeviceIds:
          type: "array"
          description: "List of account devices that will be unassigned from a paging group specified"
          items:
            type: "string"
    DepartmentMemberList:
      type: "object"
      properties:
        records:
          type: "array"
          description: "List of department members extensions"
          items:
            $ref: "#/definitions/ExtensionInfo"
        navigation:
          description: "Information on navigation"
          $ref: "#/definitions/NavigationInfo"
        paging:
          description: "Information on paging"
          $ref: "#/definitions/PagingInfo"
    DictionaryShippingOptions:
      type: "object"
      properties:
        quantity:
          type: "integer"
          description: "Quantity of devices to ship"
        price:
          type: "integer"
          description: "Price for shipping with the specified method (depending on the quantity value)"
        method:
          description: "Shipping method description"
          $ref: "#/definitions/ShippingMethod"
    LanguageList:
      type: "object"
      properties:
        uri:
          type: "string"
          description: "Canonical URI of the language list resource"
        records:
          type: "array"
          description: "Language data"
          items:
            $ref: "#/definitions/LanguageInfo"
        navigation:
          description: "Information on navigation"
          $ref: "#/definitions/NavigationInfo"
        paging:
          description: "Information on paging"
          $ref: "#/definitions/PagingInfo"
    NotificationSettings:
      type: "object"
      properties:
        uri:
          type: "string"
          description: "Canonical URI of notifications settings resource"
        emailAddresses:
          type: "array"
          items:
            type: "string"
          description: "List of notification recipient email addresses"
        smsEmailAddresses:
          type: "array"
          items:
            type: "string"
          description: "List of notification recipient email addresses"
        advancedMode:
          type: "boolean"
          description: "Specifies notifications settings mode. If 'True' then advanced mode is on, it allows using different emails and/or phone numbers for each notification type. If 'False' then basic mode is on. Advanced mode settings are returned in both modes, if specified once, but if basic mode is switched on, they are not applied"
        voicemails:
          $ref: "#/definitions/VoicemailsInfo"
        inboundFaxes:
          $ref: "#/definitions/InboundFaxesInfo"
        outboundFaxes:
          $ref: "#/definitions/OutboundFaxesInfo"
        inboundTexts:
          $ref: "#/definitions/InboundTextsInfo"
        missedCalls:
          $ref: "#/definitions/MissedCallsInfo"
    InProductMessages:
      type: "object"
      properties:
        uri:
          type: "string"
          description: "Link to the in-product messages resource"
        records:
          type: "array"
          description: "The list of in-product messages"
          items:
            $ref: "#/definitions/BannerInfo"
        navigation:
          description: "Information on navigation"
          $ref: "#/definitions/NavigationInfo"
        paging:
          description: "Information on paging"
          $ref: "#/definitions/PagingInfo"
    BannerInfo:
      type: "object"
      properties:
        bannerType:
          type: "string"
          description: "Type of a banner"
        description:
          type: "string"
          description: "Custom text description of a banner"
        content:
          type: "string"
          description: "HTML formatted message content"
        expirationDate:
          type: "string"
          description: "Datetime of message expiration in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z"
    IVRPrompts:
      type: "object"
      properties:
        uri:
          type: "string"
          description: "Link to prompts library resource"
        records:
          type: "array"
          description: "List of Prompts"
          items:
            $ref: "#/definitions/PromptInfo"
        navigation:
          description: "Information on navigation"
          $ref: "#/definitions/NavigationInfo"
        paging:
          description: "Information on paging"
          $ref: "#/definitions/PagingInfo"
    PromptInfo:
      type: "object"
      properties:
        uri:
          type: "string"
          description: "Internal identifier of a prompt"
        id:
          type: "string"
          description: "Link to a prompt metadata"
        contentType:
          type: "string"
          description: "Type of a prompt media content"
        contentUri:
          type: "string"
          description: "Link to a prompt media content"
        filename:
          type: "string"
          description: "Name of a prompt"
    IVRMenuInfo:
      type: "object"
      properties:
        id:
          type: "string"
          description: "Internal identifier of an IVR Menu extension"
        uri:
          type: "string"
          description: "Link to an IVR Menu extension resource"
        name:
          type: "string"
          description: "First name of an IVR Menu user"
        extensionNumber:
          type: "string"
          description: "Number of an IVR Menu extension"
        prompt:
          description: "Prompt metadata"
          $ref: "#/definitions/IVRMenuPromptInfo"
        actions:
          type: "array"
          description: "Keys handling settings"
          items:
            $ref: "#/definitions/IVRMenuActionsInfo"
    IVRMenuPromptInfo:
      type: "object"
      properties:
        mode:
          type: "string"
          description: "Prompt mode: custom media or text = ['Audio', 'TextToSpeech']"
          enum:
            - "Audio"
            - "TextToSpeech"
        audio:
          description: "For 'Audio' mode only. Prompt media reference"
          $ref: "#/definitions/PromptLanguageInfo"
        text:
          type: "string"
          description: "For 'TextToSpeech' mode only. Prompt text"
        language:
          description: "For 'TextToSpeech' mode only. Prompt language metadata"
          $ref: "#/definitions/AudioPromptInfo"
    IVRMenuActionsInfo:
      type: "object"
      properties:
        input:
          type: "string"
          description: "Key. The following values are supported: numeric: '1' to '9' Star Hash NoInput"
        action:
          type: "string"
          description: "Internal identifier of an answering rule"
          enum:
            - "Connect"
            - "Voicemail"
            - "DialByName"
            - "Transfer"
            - "Repeat"
            - "ReturnToRoot"
            - "ReturnToPrevious"
            - "Disconnect"
        extension:
          description: "For 'Connect' or 'Voicemail' actions only. Extension reference"
          $ref: "#/definitions/IVRMenuExtensionInfo"
        phoneNumber:
          type: "string"
          description: "For 'Transfer' action only. PSTN number in E.164 format"
    AudioPromptInfo:
      type: "object"
      properties:
        uri:
          type: "string"
          description: "Link to an prompt audio file"
        id:
          type: "string"
          description: "Internal identifier of an prompt"
    PromptLanguageInfo:
      type: "object"
      properties:
        uri:
          type: "string"
          description: "Link to prompt language"
        id:
          type: "string"
          description: "Internal identifier of an language"
        name:
          type: "string"
          description: "Language name"
        localeCode:
          type: "string"
          description: "Language locale code"
    IVRMenuExtensionInfo:
      type: "object"
      properties:
        uri:
          type: "string"
          description: "Link to an extension resource"
        id:
          type: "string"
          description: "Internal identifier of an extension"
    CustomCompanyGreetingInfo:
      type: "object"
      properties:
        uri:
          type: "string"
          description: "Link to an extension custom greeting"
        id:
          type: "string"
          description: "Internal identifier of an answering rule"
        type:
          type: "string"
          description: "Internal identifier of an answering rule"
          enum:
            - "Company"
        contentType:
          type: "string"
          description: "Content media type in WAV/MP3 format"
          enum:
            - "WAV"
            - "MP3"
        contentUri:
          type: "string"
          description: "Link to a greeting content (audio file)"
        answeringRule:
          description: "Information on an answering rule that the greeting is applied to"
          $ref: "#/definitions/CustomGreetingAnsweringRuleInfo"
    CustomGreetingAnsweringRuleInfo:
      type: "object"
      properties:
        uri:
          type: "string"
          description: "Canonical URI of an answering rule"
        id:
          type: "string"
          description: "Internal identifier of an answering rule"
    CustomCompanyGreetingRequest:
      type: "object"
      properties:
        type:
          type: "string"
          description: "Type of a greeting, specifying the case when the greeting is played. See Greeting Types = ['Introductory', 'Announcement', 'ConnectingMessage', 'ConnectingAudio', 'Voicemail', 'Unavailable', 'HoldMusic']"
          enum:
            - "Introductory"
            - "Announcement"
            - "ConnectingMessage"
            - "ConnectingAudio"
            - "Voicemail"
            - "Unavailable"
            - "HoldMusic"
        answeringRule:
          description: "nformation on an answering rule that the greeting is applied to"
          $ref: "#/definitions/CustomCompanyGreetingAnsweringRuleInfo"
    CustomCompanyGreetingAnsweringRuleInfo:
      type: "object"
      properties:
        id:
          type: "string"
          description: "Internal identifier of an answering rule"
    CompanyBusinessHours:
      type: "object"
      properties:
        uri:
          type: "string"
          description: "Canonical URI of a business-hours resource "
        schedule:
          description: "Schedule when an answering rule is applied"
          $ref: "#/definitions/CompanyBusinessHoursScheduleInfo"
    CompanyBusinessHoursUpdateRequest:
      type: "object"
      properties:
        schedule:
          description: "Schedule when an answering rule is applied"
          $ref: "#/definitions/CompanyBusinessHoursScheduleInfo"
    CompanyBusinessHoursScheduleInfo:
      type: "object"
      properties:
        weeklyRanges:
          $ref: "#/definitions/WeeklyScheduleInfo"
    UserPresencePermissionsUpdateRequest:
      type: "object"
      properties:
        extensions:
          type: "array"
          items:
            $ref: "#/definitions/PresencePermissionsExtensionInfoRequest"
    PresencePermissionsExtensionInfoRequest:
      type: "object"
      properties:
        id:
          type: "string"
          description: "Internal identifier of an extension"
    CreateAccountRequest:
      type: "object"
      properties:
        mainNumber:
          type: "string"
          description: "Main account VoIP phone number, either Local or Toll-Free. Cannot be Fax Only. Obtained via lookup/reserve API"
        operator:
          description: "Operator's extension information. This extension will receive all calls and messages intended for the operator"
          $ref: "#/definitions/GetExtensionInfoResponse"
        partnerId:
          type: "string"
          description: "Partner identifier for this account"
        promotionCode:
          type: "string"
          description: "Promotion code to calculate a discount"
        reservationId:
          type: "string"
          description: "Internal identifier of phone number reservation; encoded data including reservation type (by brand, by account, by session), particular brand/account/session data, and reservation date and time"
        serviceInfo:
          description: "Account service information, brand identifier and service plan"
          $ref: "#/definitions/GetServiceInfoResponse"
        status:
          type: "string"
          description: "The status with which an account is created. The default value is 'Initial'"
          enum:
            - "Initial"
            - "Unconfirmed"
            - "Confirmed"
        signupInfo:
          description: "Account sign up data"
          $ref: "#/definitions/AccountSignupInfoRequest"
    ModifyAccountBusinessAddressRequest:
      required:
        - "businessAddress"
      type: "object"
      properties:
        company:
          type: "string"
          description: "Company business name"
        email:
          type: "string"
          description: "Company business email address"
        businessAddress:
          description: "Company business address"
          $ref: "#/definitions/BusinessAddressInfo"
    BusinessAddressInfo:
      type: "object"
      properties:
        country:
          type: "string"
          description: "Name of a country"
        state:
          type: "string"
          description: "Name of a state/province"
        city:
          type: "string"
          description: "Name of a city"
        street:
          type: "string"
          description: "Street address"
        zip:
          type: "string"
          description: "Zip code"
    ExtensionInfoProvisionPhoneNumbers:
      type: "object"
      properties:
        id:
          type: "string"
          description: "Internal identifier of an extension"
        partnerId:
          type: "string"
          description: "For Partner Applications Internal identifier of an extension created by partner. The RingCentral supports the mapping of accounts and stores the corresponding account ID/extension ID for each partner ID of a client application. In request URIs partner IDs are accepted instead of regular RingCentral native IDs as path parameters using pid = XXX clause. Though in response URIs contain the corresponding account IDs and extension IDs. In all request and response bodies these values are reflected via partnerId attributes of account and extension"
    CreateAnsweringRuleRequest:
      type: "object"
      required:
        - "name"
        - "type"
      properties:
        enabled:
          type: "boolean"
          description: "Specifies if the rule is active or inactive. The default value is 'True'"
        type:
          type: "string"
          description: "Type of an answering rule. The 'Custom' value should be specified"
        name:
          type: "string"
          description: "Name of an answering rule specified by user"
        callers:
          type: "array"
          description: "Answering rule will be applied when calls are received from the specified caller(s)"
          items:
            $ref: "#/definitions/CallersInfoRequest"
        calledNumbers:
          type: "array"
          description: "Answering rules are applied when calling to selected number(s)"
          items:
            $ref: "#/definitions/CalledNumberInfo"
        schedule:
          description: "Schedule when an answering rule should be applied"
          $ref: "#/definitions/ScheduleInfo"
        callHandlingAction:
          type: "string"
          description: "Specifies how incoming calls are forwarded"
          enum:
            - "ForwardCalls"
            - "UnconditionalForwarding"
            - "AgentQueue"
            - "TransferToExtension"
            - "TakeMessagesOnly"
            - "PlayAnnouncementOnly"
        forwarding:
          description: "Forwarding parameters. Returned if 'ForwardCalls' is specified in 'callHandlingAction'. These settings determine the forwarding numbers to which the call will be forwarded"
          $ref: "#/definitions/ForwardingInfo"
        unconditionalForwarding:
          description: "Unconditional forwarding parameters. Returned if 'UnconditionalForwarding' is specified in 'callHandlingAction'"
          $ref: "#/definitions/UnconditionalForwardingInfo"
        queue:
          description: "Queue settings applied for department (call queue) extension type, with the 'AgentQueue' value specified as a call handling action"
          $ref: "#/definitions/QueueInfo"
        transfer:
          description: "Transfer settings applied for department (call queue) extension type, with 'TransferToExtension' call handling action"
          $ref: "#/definitions/TransferredExtensionInfo"
        voicemail:
          description: "Specifies whether to take a voicemail and who should do it"
          $ref: "#/definitions/VoicemailInfo"
        greetings:
          type: "array"
          description: "Greetings applied for an answering rule; only predefined greetings can be applied, see Dictionary Greeting List"
          items:
            $ref: "#/definitions/GreetingInfo"
    TransferredExtensionInfo:
      type: "object"
      properties:
        extension:
          $ref: "#/definitions/ExtensionInfo"
    QueueInfo:
      type: "object"
      properties:
        transferMode:
          type: "string"
          description: "Specifies how calls are transferred to group members"
          enum:
            - "Rotating"
            - "Simultaneous"
            - "FixedOrder"
        fixedOrderAgents:
          type: "array"
          description: "Information on a call forwarding rule"
          items:
            $ref: "#/definitions/FixedOrderAgents"
        holdAudioInterruptionMode:
          type: "string"
          description: "Connecting audio interruption mode"
          enum:
            - "Never"
            - "WhenMusicEnds"
            - "Periodically"
        holdAudioInterruptionPeriod:
          type: "integer"
          description: "Connecting audio interruption message period in seconds"
        agentTimeout:
          type: "integer"
          description: "Maximum time in seconds to wait for a call queue member before trying the next member"
        wrapUpTime:
          type: "integer"
          description: "Minimum post-call wrap up time in seconds before agent status is automatically set"
        holdTime:
          type: "integer"
          description: "Maximum hold time in seconds to wait for an available call queue member"
        maxCallers:
          type: "integer"
          description: "Maximum count of callers on hold"
        maxCallersAction:
          type: "string"
          description: "Action which should be taken if count of callers on hold exceeds the maximum"
          enum:
            - "Voicemail"
            - "Announcement"
    FixedOrderAgents:
      type: "object"
      properties:
        extension:
          $ref: "#/definitions/ExtensionInfo"
        index:
          type: "integer"
          description: "Ordinal of an agent (call queue member)"
    CallersInfoRequest:
      type: "object"
      properties:
        callerId:
          type: "string"
          description: "Phone number of a caller"
        name:
          type: "string"
          description: "Contact name of a caller"
    ForwardingInfoCreateRuleRequest:
      type: "object"
      properties:
        notifyMySoftPhones:
          type: "boolean"
          description: "Specifies if the first ring on desktop/mobile apps is enabled. The default value is 'True'"
        notifyAdminSoftPhones:
          type: "boolean"
          description: "Specifies if the administrator's softphone (desktop application) is notified before forwarding the incoming call to desk phones and forwarding numbers. The default value is 'True'"
        softPhonesRingCount:
          type: "integer"
          description: "Specifies delay between ring on apps and starting of a call forwarding. The default value is 1"
        ringingMode:
          type: "string"
          description: "Specifies the order in which forwarding numbers ring. 'Sequentially' means that forwarding numbers are ringing one at a time, in order of priority. 'Simultaneously' means that forwarding numbers are ringing all at the same time. The default value is 'Sequentially'"
          enum:
            - "Sequentially"
            - "Simultaneously"
        rules:
          type: "array"
          description: "Information on a call forwarding rule"
          items:
            $ref: "#/definitions/RuleInfoCreateRuleRequest"
    RuleInfoCreateRuleRequest:
      type: "object"
      properties:
        index:
          type: "integer"
          description: "Forwarding number (or group) ordinal"
        ringCount:
          type: "integer"
          description: "Number of rings for a forwarding number (or group)"
        forwardingNumbers:
          type: "array"
          description: "Forwarding number (or group) data"
          items:
            $ref: "#/definitions/ForwardingNumberInfoRulesCreateRuleRequest"
    ForwardingNumberInfoRulesCreateRuleRequest:
      type: "object"
      properties:
        id:
          type: "string"
          description: "Internal identifier of a forwarding number"
    UpdateAnsweringRuleRequest:
      type: "object"
      properties:
        name:
          type: "string"
          description: "Name of an answering rule specified by user"
        enabled:
          type: "boolean"
          description: "Specifies if an answering rule is active or inactive"
        callers:
          type: "array"
          description: "Answering rules are applied when calls are received from specified caller(s)"
          items:
            $ref: "#/definitions/CallersInfo"
        calledNumbers:
          type: "array"
          description: "Answering rules are applied when calling to selected number(s)"
          items:
            $ref: "#/definitions/CalledNumberInfo"
        schedule:
          description: "Schedule when an answering rule should be applied"
          $ref: "#/definitions/ScheduleInfo"
        callHandlingAction:
          type: "string"
          description: "Specifies how incoming calls are forwarded"
          enum:
            - "ForwardCalls"
            - "UnconditionalForwarding"
            - "AgentQueue"
            - "TransferToExtension"
            - "TakeMessagesOnly"
            - "PlayAnnouncementOnly"
        forwarding:
          description: "Forwarding parameters. Returned if 'ForwardCalls' is specified in 'callHandlingAction'. These settings determine the forwarding numbers to which the call will be forwarded"
          $ref: "#/definitions/ForwardingInfo"
        unconditionalForwarding:
          description: "Unconditional forwarding parameters. Returned if 'UnconditionalForwarding' is specified in 'callHandlingAction'"
          $ref: "#/definitions/UnconditionalForwardingInfo"
        queue:
          description: "Queue settings applied for department (call queue) extension type, with the 'AgentQueue' value specified as a call handling action"
          $ref: "#/definitions/QueueInfo"
        voicemail:
          description: "Specifies whether to take a voicemail and who should do it"
          $ref: "#/definitions/VoicemailInfo"
        greetings:
          type: "array"
          description: "Greetings applied for an answering rule; only predefined greetings can be applied, see Dictionary Greeting List"
          items:
            $ref: "#/definitions/GreetingInfo"
    UpdateConferencingInfoRequest:
      type: "object"
      properties:
        phoneNumbers:
          type: "array"
          items:
            $ref: "#/definitions/ConferencePhoneNumberInfo"
          description: "Multiple dial-in phone numbers to connect to audio conference service, relevant for user's brand. Each number is given with the country and location information, in order to let the user choose the less expensive way to connect to a conference. The first number in the list is the primary conference number, that is default and domestic"
        allowJoinBeforeHost:
          type: "boolean"
          description: "Determines if host user allows conference participants to join before the host"
    ConferencePhoneNumberInfo:
      type: "object"
      properties:
        phoneNumber:
          type: "string"
          description: "Dial-in phone number to connect to a conference"
        default:
          type: "boolean"
          description: "'True' if the number is default for the conference. Default conference number is a domestic number that can be set by user (otherwise it is set by the system). Only one default number per country is allowed"
    CreateForwardingNumberRequest:
      type: "object"
      properties:
        phoneNumber:
          type: "string"
          description: "Forwarding/Call flip phone number"
        label:
          type: "string"
          description: "Forwarding/Call flip number title"
    UpdateForwardingNumberRequest:
      type: "object"
      properties:
        phoneNumber:
          type: "string"
          description: "Forwarding/Call flip phone number"
        label:
          type: "string"
          description: "Forwarding/Call flip number title"
        flipNumber:
          type: "string"
          description: "Number assigned to the call flip phone number, corresponds to the shortcut dial number"
    CreatePagerMessageRequest:
      type: "object"
      required:
        - "from"
        - "text"
      properties:
        from:
          description: "Sender of a pager message. The extensionNumber property must be filled"
          $ref: "#/definitions/MessageStoreCallerInfoRequest"
        replyOn:
          type: "integer"
          description: "Internal identifier of a message this message replies to"
        text:
          type: "string"
          description: "Text of a pager message. Max length is 1024 symbols (2-byte UTF-16 encoded). If a character is encoded in 4 bytes in UTF-16 it is treated as 2 characters, thus restricting the maximum message length to 512 symbols"
        to:
          type: "array"
          description: "Optional if replyOn parameter is specified. Receiver of a pager message. The extensionNumber property must be filled"
          items:
            $ref: "#/definitions/MessageStoreCallerInfoRequest"
    MessageStoreCallerInfoRequest:
      type: "object"
      properties:
        extensionNumber:
          type: "string"
          description: "Extension short number (usually 3 or 4 digits). This property is filled when parties communicate by means of short internal numbers, for example when calling to other extension or sending/receiving Company Pager message"
        location:
          type: "string"
          description: "Contains party location (city, state) if one can be determined from phoneNumber. This property is filled only when phoneNumber is not empty and server can calculate location information from it (for example, this information is unavailable for US toll-free numbers)"
        name:
          type: "string"
          description: "Symbolic name associated with a party. If the phone does not belong to the known extension,only the location is returned, the name is not determined then"
        phoneNumber:
          type: "string"
          description: "Phone number of a party. Usually it is a plain number including country and area code like 18661234567. But sometimes it could be returned from database with some formatting applied, for example (866)123-4567. This property is filled in all cases where parties communicate by means of global phone numbers, for example when calling to direct numbers or sending/receiving SMS"
    CreateFaxMessageRequest:
      type: "object"
      required:
        - "to"
      properties:
        to:
          type: "array"
          description: "Recipient information. Phone number property is mandatory. Optional for resend fax request"
          items:
            $ref: "#/definitions/MessageStoreCallerInfoRequest"
        resolution:
          type: "string"
          description: "Fax resolution"
          enum:
            - "High"
            - "Low"
        sendTime:
          type: "string"
          format: "date-time"
          description: "The datetime to send fax at, in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z. If time is not specified, the fax will be send immediately"
        coverPageText:
          type: "string"
          description: "Optional. Cover page text, entered by the fax sender and printed on the cover page. Maximum length is limited to 1024 symbols"
        originalMessageId:
          type: "string"
          description: "Internal identifier of the original fax message which needs to be resent. Mandatory for resend fax request"
    CreateSMSMessage:
      type: "object"
      required:
        - "from"
        - "text"
        - "to"
      properties:
        from:
          description: "Sender of an SMS message. The phoneNumber property must be filled to correspond to one of the account phone numbers which is allowed to send SMS"
          $ref: "#/definitions/MessageStoreCallerInfoRequest"
        to:
          type: "array"
          description: "Receiver of an SMS message. The phoneNumber property must be filled"
          items:
            $ref: "#/definitions/MessageStoreCallerInfoRequest"
        text:
          type: "string"
          description: "Text of a message. Max length is 1000 symbols (2-byte UTF-16 encoded). If a character is encoded in 4 bytes in UTF-16 it is treated as 2 characters, thus restricting the maximum message length to 500 symbols"
    UpdateMessageRequest:
      type: "object"
      properties:
        readStatus:
          type: "string"
          description: "Read status of a message to be changed. Multiple values are accepted"
          enum:
            - "Read"
            - "Unread"
    SetReportingSettingsRequest:
      type: "object"
      required:
        - "views"
      properties:
        views:
          type: "array"
          description: "List of 'View' structures with a tuple of filter values, pages and schedules"
          items:
            $ref: "#/definitions/ViewInfoReporting"
    MakeRingOutRequest:
      type: "object"
      required:
        - "from"
        - "to"
      properties:
        from:
          description: "Phone number of the caller. This number corresponds to the 1st leg of the RingOut call. This number can be one of user's configured forwarding numbers or arbitrary number"
          $ref: "#/definitions/MakeRingOutCallerInfoRequestFrom"
        to:
          description: "Phone number of the called party. This number corresponds to the 2nd leg of the RingOut call"
          $ref: "#/definitions/MakeRingOutCallerInfoRequestTo"
        callerId:
          description: "The number which will be displayed to the called party"
          $ref: "#/definitions/MakeRingOutCallerInfoRequestTo"
        playPrompt:
          type: "boolean"
          description: "The audio prompt that the calling party hears when the call is connected"
        country:
          description: "Optional. Dialing plan country data. If not specified, then extension home country is applied by default"
          $ref: "#/definitions/MakeRingOutCountryInfo"
    MakeRingOutCallerInfoRequestFrom:
      type: "object"
      properties:
        phoneNumber:
          type: "string"
          description: "Phone number in E.164 format"
        forwardingNumberId:
          type: "string"
          description: "Internal identifier of a forwarding number; returned in response in the id field. Can be specified instead of the phoneNumber attribute"
    MakeRingOutCallerInfoRequestTo:
      type: "object"
      properties:
        phoneNumber:
          type: "string"
          description: "Phone number in E.164 format"
    MakeRingOutCountryInfo:
      type: "object"
      properties:
        id:
          type: "string"
          description: "Dialing plan country identifier"
    CustomDataRequest:
      type: "object"
      properties:
        id:
          type: "string"
          description: "Custom data access key. Optional. If specified, must match the custom key in the URL"
        value:
          type: "string"
          description: "Description of custom data. Mandatory for create, if there is no attachment specified. Maximum length is limited to 256 symbols"
    CreateSipRegistrationRequest:
      type: "object"
      required:
        - "device"
        - "sipInfo"
      properties:
        device:
          type: "array"
          description: "Device unique description"
          items:
            $ref: "#/definitions/DeviceInfoRequest"
        sipInfo:
          type: "array"
          description: "SIP settings for device"
          items:
            $ref: "#/definitions/SIPInfoRequest"
    DeviceInfoRequest:
      type: "object"
      properties:
        id:
          type: "string"
          description: "Device unique identifier, retrieved on previous session (if any)"
        appExternalId:
          type: "string"
          description: "For iOS devices only Certificate name (used by iOS applications for APNS subscription)"
        computerName:
          type: "string"
          description: "For SoftPhone only Computer name"
    SIPInfoRequest:
      type: "object"
      properties:
        transport:
          type: "string"
          description: "Supported transport. SIP info will be returned for this transport if supported"
          enum:
            - "UDP"
            - "TCP"
            - "TLS"
            - "WS"
            - "WSS"
    ParsePhoneNumberRequest:
      type: "object"
      properties:
        originalStrings:
          type: "string"
          description: "Phone numbers passed in a string. The maximum value of phone numbers is limited to 64. The maximum number of symbols in each phone number in a string is 64"
    CreateSubscriptionRequest:
      type: "object"
      required:
        - "deliveryMode"
      properties:
        eventFilters:
          type: "array"
          description: "Mandatory. Collection of URIs to API resources (see Event Types for details). For APNS transport type only message event filter is available"
          items:
            type: "string"
        deliveryMode:
          description: "Notification delivery settings"
          $ref: "#/definitions/NotificationDeliveryModeRequest"
        expiresIn:
          type: "integer"
          description: "Subscription lifetime in seconds. Max value is 7 days (604800 sec)"
    NotificationDeliveryModeRequest:
      type: "object"
      properties:
        transportType:
          type: "string"
          description: "Notifications transportation provider name. 'APNS' (Apple Push Notifications Service)"
          enum:
            - "PubNub"
            - "Webhook"
            - "APNS"
            - "PubNub/APNS"
            - "PubNub/GCM"
        address:
          type: "string"
          description: "Mandatory for 'APNS' and 'WebHook' transport types. For 'APNS' - internal identifier of a device 'device_token' for 'WebHook' - URL of a consumer service (cannot be changed during subscription update)"
        encryption:
          type: "boolean"
          description: "Optional parameter. Specifies if the message will be encrypted or not. If request contains any presence event filter the value by default is 'True' (even if specified as 'false'). If request contains only message event filters the value by default is 'False'"
        certificateName:
          type: "string"
          description: "For 'PubNub/APNS' and 'PubNub/GCM' transport types. Name of a certificate"
        registrationId:
          type: "string"
          description: "For 'PubNub/APNS' and 'PubNub/GCM' transport types. Identifier of a registration"
    ModifySubscriptionRequest:
      type: "object"
      properties:
        eventFilters:
          type: "array"
          description: "Collection of URIs to API resources (see Event Types). Mandatory field"
          items:
            type: "string"
    GetVersionsResponse:
      type: "object"
      properties:
        uri:
          type: "string"
          description: "Canonical URI of the API version"
        apiVersions:
          type: "array"
          description: "Full API version information: uri, number, release date"
          items:
            $ref: "#/definitions/VersionInfo"
        serverVersion:
          type: "string"
          description: "Server version"
        serverRevision:
          type: "string"
          description: "Server revision"
    VersionInfo:
      type: "object"
      properties:
        uri:
          type: "string"
          description: "Canonical URI of API versions"
        versionString:
          type: "string"
          description: "Version of the RingCentral REST API"
        releaseDate:
          type: "string"
          description: "Release date of this version"
        uriString:
          type: "string"
          description: "URI part determining the current version"
    GetVersionResponse:
      type: "object"
      properties:
        uri:
          type: "string"
          description: "Canonical URI of the version info resource"
        versionString:
          type: "string"
          description: "Version of the RingCentral REST API"
        releaseDate:
          type: "string"
          description: "Release date of this version"
        uriString:
          type: "string"
          description: "URI part determining the current version"
    GetAccountInfoResponse:
      type: "object"
      properties:
        id:
          type: "string"
          description: "Internal identifier of an account"
        uri:
          type: "string"
          description: "Canonical URI of an account"
        mainNumber:
          type: "string"
          description: "Main phone number of the current account"
        operator:
          description: "Operator's extension information. This extension will receive all calls and messages intended for the operator"
          $ref: "#/definitions/GetExtensionInfoResponse"
        partnerId:
          type: "string"
          description: "Additional account identifier, developed and applied by the client"
        serviceInfo:
          description: "Account service information, including brand, service plan and billing plan"
          $ref: "#/definitions/ServiceInfo"
        setupWizardState:
          type: "string"
          description: "Specifies account configuration wizard state (web service setup). The default value is 'NotStarted'"
          enum:
            - "NotStarted"
            - "Incomplete"
            - "Completed"
        status:
          type: "string"
          description: "Status of the current account"
          enum:
            - "Confirmed"
            - "Disabled"
        statusInfo:
          description: "Status information (reason, comment, lifetime). Returned for 'Disabled' status only"
          $ref: "#/definitions/AccountStatusInfo"
        regionalSettings:
          description: "Account level region data (web service Auto-Receptionist settings)"
          $ref: "#/definitions/RegionalSettings"
        federated:
          description: "Specifies whether an account is included into any federation of accounts or not"
          type: "boolean"
    ServiceInfo:
      type: "object"
      properties:
        uri:
          type: "string"
          description: "Canonical URI of a service info resource"
        billingPlan:
          description: "Information on account billing plan"
          $ref: "#/definitions/BillingPlanInfo"
        brand:
          description: "Information on account brand"
          $ref: "#/definitions/BrandInfo"
        servicePlan:
          description: "Information on account service plan"
          $ref: "#/definitions/ServicePlanInfo"
        targetServicePlan:
          description: "Information on account target service plan"
          $ref: "#/definitions/TargetServicePlanInfo"
    BillingPlanInfo:
      type: "object"
      properties:
        id:
          type: "string"
          description: "Internal identifier of a billing plan"
        name:
          type: "string"
          description: "Billing plan name"
        durationUnit:
          type: "string"
          description: "Duration period"
          enum:
            - "Month"
            - "Day"
        duration:
          type: "string"
          description: "Number of duration units"
        type:
          type: "string"
          description: "Billing plan type"
          enum:
            - "Initial"
            - "Regular"
            - "Suspended"
            - "Trial"
            - "TrialNoCC"
            - "Free"
    BrandInfo:
      type: "object"
      properties:
        id:
          type: "string"
          description: "Internal identifier of a brand"
        name:
          type: "string"
          description: "Brand name, for example  RingCentral UK ,  ClearFax "
        homeCountry:
          description: "Home country information"
          $ref: "#/definitions/CountryInfo"
    FaxCountryInfo:
      type: "object"
      properties:
        id:
          type: "string"
          description: "Internal identifier of a home country"
        isoCode:
          type: "string"
          description: "Country code in ISO 3166-1 alpha-2. If specified then country ID cannot be specified"
    CountryInfo:
      type: "object"
      properties:
        id:
          type: "string"
          description: "Internal identifier of a home country"
        uri:
          type: "string"
          description: "Canonical URI of a home country"
        name:
          type: "string"
          description: "Official name of a home country"
    ServicePlanInfo:
      type: "object"
      properties:
        id:
          type: "string"
          description: "Internal identifier of a service plan"
        name:
          type: "string"
          description: "Name of a service plan"
        edition:
          type: "string"
          description: "Edition of a service plan"
    TargetServicePlanInfo:
      type: "object"
      properties:
        id:
          type: "string"
          description: "Internal identifier of a target service plan"
        name:
          type: "string"
          description: "Name of a target service plan"
    AccountStatusInfo:
      type: "object"
      properties:
        comment:
          type: "string"
          description: "A free-form user comment, describing the status change reason"
        reason:
          type: "string"
          description: "Type of suspension"
          enum:
            - "Voluntarily"
            - "Involuntarily"
        till:
          type: "string"
          description: "Date until which the account will get deleted. The default value is 30 days since current date"
    GetDialingPlanInfo:
      type: "object"
      required:
        - "navigation"
        - "paging"
        - "records"
      properties:
        records:
          type: "array"
          description: "List of countries which can be selected for a dialing plan"
          items:
            $ref: "#/definitions/GetDialingPlanCountryInfo"
        paging:
          description: "Information on paging"
          $ref: "#/definitions/PagingInfo"
        navigation:
          description: "Information on navigation"
          $ref: "#/definitions/NavigationInfo"
    GetDialingPlanCountryInfo:
      type: "object"
      properties:
        id:
          type: "string"
          description: "Internal identifier of a country"
        uri:
          type: "string"
          description: "Canonical URI of a country"
        callingCode:
          type: "string"
          description: "Country calling code defined by ITU-T recommendations E.123 and E.164, see Calling Codes"
        isoCode:
          type: "string"
          description: "Country code according to the ISO standard, see ISO 3166"
        name:
          type: "string"
          description: "Official name of a country"
    GetServiceInfoResponse:
      type: "object"
      properties:
        uri:
          type: "string"
          description: "Canonical URI of the account Service Info resource"
        servicePlanName:
          type: "string"
          description: "Account Service Plan name"
        serviceFeatures:
          type: "array"
          description: "Service features information, see Service Feature List"
          items:
            $ref: "#/definitions/ServiceFeatureInfo"
        limits:
          description: "Limits which are effective for the account"
          $ref: "#/definitions/AccountLimits"
    ServiceFeatureInfo:
      type: "object"
      properties:
        featureName:
          type: "string"
          description: "Feature name, see all available values in Service Feature List"
        enabled:
          type: "boolean"
          description: "Feature status, shows feature availability for the extension"
    GetExtensionListResponse:
      type: "object"
      required:
        - "navigation"
        - "paging"
        - "records"
      properties:
        records:
          type: "array"
          description: "List of extensions with extension information"
          items:
            $ref: "#/definitions/GetExtensionInfoResponse"
        navigation:
          description: "Information on navigation"
          $ref: "#/definitions/NavigationInfo"
        paging:
          description: "Information on paging"
          $ref: "#/definitions/PagingInfo"
    NavigationInfo:
      type: "object"
      properties:
        firstPage:
          description: "Canonical URI for the first page of the list"
          $ref: "#/definitions/NavigationInfoURI"
        nextPage:
          description: "Canonical URI for the next page of the list"
          $ref: "#/definitions/NavigationInfoURI"
        previousPage:
          description: "Canonical URI for the previous page of the list"
          $ref: "#/definitions/NavigationInfoURI"
        lastPage:
          description: "Canonical URI for the last page of the list"
          $ref: "#/definitions/NavigationInfoURI"
    PagingInfo:
      type: "object"
      properties:
        page:
          type: "integer"
          description: "The current page number. 1-indexed, so the first page is 1 by default. May be omitted if result is empty (because non-existent page was specified or perPage=0 was requested)"
        perPage:
          type: "integer"
          description: "Current page size, describes how many items are in each page. Default value is 100. Maximum value is 1000. If perPage value in the request is greater than 1000, the maximum value (1000) is applied"
        pageStart:
          type: "integer"
          description: "The zero-based number of the first element on the current page. Omitted if the page is omitted or result is empty"
        pageEnd:
          type: "integer"
          description: "The zero-based index of the last element on the current page. Omitted if the page is omitted or result is empty"
        totalPages:
          type: "integer"
          description: "The total number of pages in a dataset. May be omitted for some resources due to performance reasons"
        totalElements:
          type: "integer"
          description: "The total number of elements in a dataset. May be omitted for some resource due to performance reasons"
    NavigationInfoURI:
      type: "object"
      properties:
        uri:
          type: "string"
    GetExtensionInfoResponse:
      type: "object"
      required:
        - "id"
        - "profileImage"
        - "status"
        - "type"
        - "uri"
      properties:
        id:
          type: "integer"
          format: "int64"
          description: "Internal identifier of an extension"
        uri:
          type: "string"
          description: "Canonical URI of an extension"
        contact:
          description: "Contact detailed information"
          $ref: "#/definitions/ContactInfo"
        departments:
          type: "array"
          description: "Information on department extension(s), to which the requested extension belongs. Returned only for user extensions, members of department, requested by single extensionId"
          items:
            $ref: "#/definitions/DepartmentInfo"
        extensionNumber:
          type: "string"
          description: "Number of department extension"
        name:
          type: "string"
          description: "Extension user name"
        partnerId:
          type: "string"
          description: "For Partner Applications Internal identifier of an extension created by partner. The RingCentral supports the mapping of accounts and stores the corresponding account ID/extension ID for each partner ID of a client application. In request URIs partner IDs are accepted instead of regular RingCentral native IDs as path parameters using pid = XXX clause. Though in response URIs contain the corresponding account IDs and extension IDs. In all request and response bodies these values are reflected via partnerId attributes of account and extension"
        permissions:
          description: "Extension permissions, corresponding to the Service Web permissions 'Admin' and 'InternationalCalling'"
          $ref: "#/definitions/ExtensionPermissions"
        profileImage:
          description: "Information on profile image"
          $ref: "#/definitions/ProfileImageInfo"
        references:
          type: "array"
          description: "List of non-RC internal identifiers assigned to an extension"
          items:
            $ref: "#/definitions/ReferenceInfo"
        regionalSettings:
          description: "Extension region data (timezone, home country, language)"
          $ref: "#/definitions/RegionalSettings"
        serviceFeatures:
          type: "array"
          description: "Extension service features returned in response only when the logged-in user requests his/her own extension info, see also Extension Service Features"
          items:
            $ref: "#/definitions/ExtensionServiceFeatureInfo"
        setupWizardState:
          type: "string"
          description: "Specifies extension configuration wizard state (web service setup). The default value is 'NotStarted'"
          enum:
            - "NotStarted"
            - "Incomplete"
            - "Completed"
        status:
          type: "string"
          description: "Extension current state. If the status is 'Unassigned'. Returned for all extensions"
          enum:
            - "Enabled"
            - "Disabled"
            - "NotActivated"
            - "Unassigned"
        statusInfo:
          description: "Status information (reason, comment). Returned for 'Disabled' status only"
          $ref: "#/definitions/ExtensionStatusInfo"
        type:
          type: "string"
          description: "Extension type"
          enum:
            - "User"
            - "FaxUser"
            - "VirtualUser"
            - "DigitalUser"
            - "Department"
            - "Announcement"
            - "Voicemail"
            - "SharedLinesGroup"
            - "PagingOnlyGroup"
            - "IvrMenu"
            - "ApplicationExtension"
            - "ParkLocation"
        callQueueInfo:
          description: "For Department extension type only. Call queue settings"
          $ref: "#/definitions/CallQueueInfo"
    CallQueueInfo:
      type: "object"
      properties:
        slaGoal:
          type: "integer"
          description: "Target percentage of calls that must be answered by agents within the service level time threshold"
        slaThresholdSeconds:
          type: "integer"
          description: "Period of time in seconds that is considered to be an acceptable service level"
        includeAbandonedCalls:
          type: "boolean"
          description: "If 'True' abandoned calls (hanged up prior to being served) are included into service level calculation"
        abandonedThresholdSeconds:
          type: "integer"
          description: "Period of time in seconds specifying abandoned calls duration - calls that are shorter will not be included into the calculation of service level.; zero value means that abandoned calls of any duration will be included into calculation"
    ContactInfo:
      type: "object"
      properties:
        firstName:
          type: "string"
          description: "For User extension type only. Extension user first name"
        lastName:
          type: "string"
          description: "For User extension type only. Extension user last name"
        company:
          type: "string"
          description: "Extension user company name"
        email:
          type: "string"
          description: "Email of extension user"
        businessPhone:
          type: "string"
          description: "Extension user contact phone number"
        businessAddress:
          description: "Business address of extension user company"
          $ref: "#/definitions/ContactAddressInfo"
    ContactAddressInfo:
      type: "object"
      properties:
        country:
          type: "string"
          description: "Country name of extension user company. Not returned for Address Book"
        state:
          type: "string"
          description: "State/province name of extension user company"
        city:
          type: "string"
          description: "City name of extension user company"
        street:
          type: "string"
          description: "Street address of extension user company"
        zip:
          type: "string"
          description: "Zip code of extension user company"
    DepartmentInfo:
      type: "object"
      properties:
        id:
          type: "string"
          description: "Internal identifier of a department extension"
        uri:
          type: "string"
          description: "Canonical URI of a department extension"
        extensionNumber:
          type: "string"
          description: "Number of a department extension"
    ExtensionPermissions:
      type: "object"
      properties:
        admin:
          description: "Admin permission"
          $ref: "#/definitions/PermissionInfo"
        internationalCalling:
          description: "International Calling permission"
          $ref: "#/definitions/PermissionInfo"
    PermissionInfo:
      type: "object"
      properties:
        enabled:
          type: "boolean"
          description: "Specifies if a permission is enabled or not"
    ProfileImageInfo:
      type: "object"
      required:
        - "uri"
      properties:
        uri:
          type: "string"
          description: "Link to a profile image. If an image is not uploaded for an extension, only uri is returned"
        etag:
          type: "string"
          description: "Identifier of an image"
        lastModified:
          type: "string"
          format: "date-time"
          description: "The datetime when an image was last updated in ISO 8601 format, for example 2016-03-10T18:07:52.534Z"
        contentType:
          type: "string"
          description: "The type of an image"
        scales:
          type: "array"
          items:
            $ref: "#/definitions/ProfileImageInfoURI"
          description: "List of URIs to profile images in different dimensions"
    ProfileImageInfoURI:
      type: "object"
      properties:
        uri:
          type: "string"
    ReferenceInfo:
      type: "object"
      properties:
        ref:
          type: "string"
          description: "Non-RC identifier of an extension"
        type:
          type: "string"
          description: "Type of external identifier"
          enum:
            - "PartnerId"
            - "CustomerDirectoryId"
    RegionalSettings:
      type: "object"
      properties:
        homeCountry:
          description: "Extension country information"
          $ref: "#/definitions/CountryInfo"
        timezone:
          description: "Extension timezone information"
          $ref: "#/definitions/TimezoneInfo"
        language:
          description: "User interface language data"
          $ref: "#/definitions/LanguageInfo"
        greetingLanguage:
          description: "Information on language used for telephony greetings"
          $ref: "#/definitions/GreetingLanguageInfo"
        formattingLocale:
          description: "Formatting language preferences for numbers, dates and currencies"
          $ref: "#/definitions/FormattingLocaleInfo"
        timeFormat:
          type: "string"
          description: "Time format setting. The default value is '12h' = ['12h', '24h']"
          enum:
            - "12h"
            - "24h"
    TimezoneInfo:
      type: "object"
      properties:
        id:
          type: "string"
          description: "Internal identifier of a timezone"
        uri:
          type: "string"
          description: "Canonical URI of a timezone"
        name:
          type: "string"
          description: "Short name of a timezone"
        description:
          type: "string"
          description: "Meaningful description of the timezone"
    LanguageInfo:
      type: "object"
      properties:
        id:
          type: "string"
          description: "Internal identifier of a language"
        uri:
          type: "string"
          description: "Canonical URI of a language"
        greeting:
          type: "boolean"
          description: "Indicates whether a language is available as greeting language"
        formattingLocale:
          type: "boolean"
          description: "Indicates whether a language is available as formatting locale"
        localeCode:
          type: "string"
          description: "Localization code of a language"
        name:
          type: "string"
          description: "Official name of a language"
        ui:
          type: "boolean"
          description: "Indicates whether a language is available as UI language"
    GreetingLanguageInfo:
      type: "object"
      properties:
        id:
          type: "string"
          description: "Internal identifier of a greeting language"
        localeCode:
          type: "string"
          description: "Localization code of a greeting language"
        name:
          type: "string"
          description: "Official name of a greeting language"
    FormattingLocaleInfo:
      type: "object"
      description: "Official name of a formatting language"
      properties:
        id:
          type: "string"
          description: "Internal identifier of a formatting language"
        localeCode:
          type: "string"
          description: "Localization code of a formatting language"
        name:
          type: "string"
    ExtensionServiceFeatureInfo:
      type: "object"
      properties:
        enabled:
          type: "boolean"
          description: "Feature status; shows feature availability for an extension"
        featureName:
          type: "string"
          description: "Feature name, see all available values in Service Feature List"
        reason:
          type: "string"
          description: "Reason of limitation for a particular service feature. Returned only if the enabled parameter value is 'False', see Service Feature Limitations and Reasons. When retrieving service features for an extension, the reasons for the limitations, if any, are returned in response"
    ExtensionStatusInfo:
      type: "object"
      properties:
        comment:
          type: "string"
          description: "A free-form user comment, describing the status change reason"
        reason:
          type: "string"
          description: "Type of suspension"
          enum:
            - "Voluntarily"
            - "Involuntarily"
    GetExtensionPhoneNumbersResponse:
      type: "object"
      required:
        - "navigation"
        - "paging"
        - "records"
      properties:
        records:
          type: "array"
          description: "List of phone numbers"
          items:
            $ref: "#/definitions/PhoneNumberInfo"
        navigation:
          description: "Information on navigation"
          $ref: "#/definitions/NavigationInfo"
        paging:
          description: "Information on paging"
          $ref: "#/definitions/PagingInfo"
    PhoneNumberInfo:
      type: "object"
      properties:
        id:
          type: "string"
          description: "Internal identifier of a phone number"
        country:
          description: "Brief information on a phone number country"
          $ref: "#/definitions/CountryInfo"
        extension:
          description: "Information on the extension, to which the phone number is assigned. Returned only for the request of Account phone number list"
          $ref: "#/definitions/ExtensionInfo"
        label:
          type: "string"
          description: "Custom user name of a phone number, if any. Supported for numbers assigned to Auto-Receptionist, with usage type 'CompanyNumber'"
        location:
          type: "string"
          description: "Location (City, State). Filled for local US numbers"
        paymentType:
          type: "string"
          description: "Payment type. 'External' is returned for forwarded numbers which are not terminated in the RingCentral phone system"
          enum:
            - "External"
            - "TollFree"
            - "Local"
        phoneNumber:
          type: "string"
          description: "Phone number"
        status:
          type: "string"
          description: "Status of a phone number. If the value is 'Normal', the phone number is ready to be used. Otherwise it is an external number not yet ported to RingCentral"
        type:
          type: "string"
          description: "Phone number type"
          enum:
            - "VoiceFax"
            - "FaxOnly"
            - "VoiceOnly"
        usageType:
          type: "string"
          description: "Usage type of the phone number"
          enum:
            - "MainCompanyNumber"
            - "AdditionalCompanyNumber"
            - "CompanyNumber"
            - "DirectNumber"
            - "CompanyFaxNumber"
            - "ForwardedNumber"
            - "ForwardedCompanyNumber"
            - "ContactCenterNumber"
    PhoneNumberInfoIntId:
      type: "object"
      properties:
        id:
          type: "integer"
          format: "int64"
          description: "Internal identifier of a phone number"
        country:
          description: "Brief information on a phone number country"
          $ref: "#/definitions/CountryInfo"
        extension:
          description: "Information on the extension, to which the phone number is assigned. Returned only for the request of Account phone number list"
          $ref: "#/definitions/ExtensionInfo"
        label:
          type: "string"
          description: "Custom user name of a phone number, if any. Supported for numbers assigned to Auto-Receptionist, with usage type 'CompanyNumber'"
        location:
          type: "string"
          description: "Location (City, State). Filled for local US numbers"
        paymentType:
          type: "string"
          description: "Payment type. 'External' is returned for forwarded numbers which are not terminated in the RingCentral phone system"
          enum:
            - "External"
            - "TollFree"
            - "Local"
        phoneNumber:
          type: "string"
          description: "Phone number"
        status:
          type: "string"
          description: "Status of a phone number. If the value is 'Normal', the phone number is ready to be used. Otherwise it is an external number not yet ported to RingCentral"
        type:
          type: "string"
          description: "Phone number type"
          enum:
            - "VoiceFax"
            - "FaxOnly"
            - "VoiceOnly"
        usageType:
          type: "string"
          description: "Usage type of the phone number"
          enum:
            - "MainCompanyNumber"
            - "AdditionalCompanyNumber"
            - "CompanyNumber"
            - "DirectNumber"
            - "CompanyFaxNumber"
            - "ForwardedNumber"
            - "ForwardedCompanyNumber"
            - "ContactCenterNumber"
    ExtensionInfo:
      type: "object"
      properties:
        id:
          type: "string"
          description: "Internal identifier of an extension"
        uri:
          type: "string"
          description: "Canonical URI of an extension"
        extensionNumber:
          type: "string"
          description: "Number of department extension"
        partnerId:
          type: "string"
          description: "For Partner Applications Internal identifier of an extension created by partner. The RingCentral supports the mapping of accounts and stores the corresponding account ID/extension ID for each partner ID of a client application. In request URIs partner IDs are accepted instead of regular RingCentral native IDs as path parameters using pid = XXX clause. Though in response URIs contain the corresponding account IDs and extension IDs. In all request and response bodies these values are reflected via partnerId attributes of account and extension"
    ExtensionInfoIntId:
      # Used in GetDeviceInfoResponse
      type: "object"
      properties:
        id:
          type: "integer"
          format: "int64"
          description: "Internal identifier of an extension"
        uri:
          type: "string"
          description: "Canonical URI of an extension"
        extensionNumber:
          type: "string"
          description: "Number of department extension"
        partnerId:
          type: "string"
          description: "For Partner Applications Internal identifier of an extension created by partner. The RingCentral supports the mapping of accounts and stores the corresponding account ID/extension ID for each partner ID of a client application. In request URIs partner IDs are accepted instead of regular RingCentral native IDs as path parameters using pid = XXX clause. Though in response URIs contain the corresponding account IDs and extension IDs. In all request and response bodies these values are reflected via partnerId attributes of account and extension"
    GetExtensionGrantListResponse:
      type: "object"
      required:
        - "navigation"
        - "paging"
        - "records"
      properties:
        records:
          type: "array"
          description: "List of extension grants with the data"
          items:
            $ref: "#/definitions/GrantInfo"
        navigation:
          description: "Information on navigation"
          $ref: "#/definitions/NavigationInfo"
        paging:
          description: "Information on paging"
          $ref: "#/definitions/PagingInfo"
    GrantInfo:
      type: "object"
      properties:
        uri:
          type: "string"
          description: "Canonical URI of a grant"
        extension:
          description: "Extension information"
          $ref: "#/definitions/ExtensionInfoGrants"
        callPickup:
          type: "boolean"
          description: "Specifies if picking up of other extensions' calls is allowed for the extension. If 'Presence' feature is disabled for the given extension, the flag is not returned"
        callMonitoring:
          type: "boolean"
          description: "Specifies if monitoring of other extensions' calls is allowed for the extension. If 'CallMonitoring' feature is disabled for the given extension, the flag is not returned"
    ExtensionInfoGrants:
      type: "object"
      properties:
        id:
          type: "string"
          description: "Internal identifier of an extension"
        uri:
          type: "string"
          description: "Canonical URI of an extension"
        extensionNumber:
          type: "string"
          description: "Extension short number (usually 3 or 4 digits)"
        type:
          type: "string"
          description: "Extension type"
          enum:
            - "User"
            - "Fax User"
            - "VirtualUser"
            - "DigitalUser"
            - "Department"
            - "Announcement"
            - "Voicemail"
            - "SharedLinesGroup"
            - "PagingOnly"
            - "IvrMenu"
            - "ApplicationExtension"
            - "Park Location"
    AnsweringRuleInfo:
      type: "object"
      properties:
        uri:
          type: "string"
          description: "Canonical URI to the answering rule resource"
        id:
          type: "string"
          description: "Internal identifier of an answering rule"
        type:
          type: "string"
          description: "Type of an answering rule"
          enum:
            - "BusinessHours"
            - "AfterHours"
            - "Custom"
        name:
          type: "string"
          description: "Name of an answering rule specified by user"
        enabled:
          type: "boolean"
          description: "Specifies if an answering rule is active or inactive"
        schedule:
          description: "Schedule when an answering rule should be applied"
          $ref: "#/definitions/ScheduleInfo"
        calledNumbers:
          type: "array"
          description: "Answering rules are applied when calling to selected number(s)"
          items:
            $ref: "#/definitions/CalledNumberInfo"
        callers:
          type: "array"
          description: "Answering rules are applied when calls are received from specified caller(s)"
          items:
            $ref: "#/definitions/CallersInfo"
        callHandlingAction:
          type: "string"
          description: "Specifies how incoming calls are forwarded"
          enum:
            - "ForwardCalls"
            - "UnconditionalForwarding"
            - "AgentQueue"
            - "TransferToExtension"
            - "TakeMessagesOnly"
            - "PlayAnnouncementOnly"
        forwarding:
          description: "Forwarding parameters. Returned if 'ForwardCalls' is specified in 'callHandlingAction'. These settings determine the forwarding numbers to which the call will be forwarded"
          $ref: "#/definitions/ForwardingInfo"
        unconditionalForwarding:
          description: "Unconditional forwarding parameters. Returned if 'UnconditionalForwarding' is specified in 'callHandlingAction'"
          $ref: "#/definitions/UnconditionalForwardingInfo"
        queue:
          description: "Queue settings applied for department (call queue) extension type, with the 'AgentQueue' value specified as a call handling action"
          $ref: "#/definitions/QueueInfo"
        transfer:
          description: "Transfer settings applied for department (call queue) extension type, with 'TransferToExtension' call handling action"
          $ref: "#/definitions/TransferredExtensionInfo"
        voicemail:
          description: "Specifies whether to take a voicemail and who should do it"
          $ref: "#/definitions/VoicemailInfo"
        greetings:
          type: "array"
          description: "Greetings applied for an answering rule; only predefined greetings can be applied, see Dictionary Greeting List"
          items:
            $ref: "#/definitions/GreetingInfo"
    ScheduleInfo:
      type: "object"
      properties:
        weeklyRanges:
          description: "Weekly schedule"
          $ref: "#/definitions/WeeklyScheduleInfo"
        ranges:
          description: "Specific data ranges"
          $ref: "#/definitions/RangesInfo"
        ref:
          type: "string"
          description: "The user's schedule specified for business hours or after hours; it can also be set/retrieved calling the corresponding method"
          enum:
            - "BusinessHours"
            - "AfterHours"
    WeeklyScheduleInfo:
      type: "object"
      properties:
        monday:
          type: "array"
          description: "Time intervals for a particular day"
          items:
            $ref: "#/definitions/TimeInterval"
        tuesday:
          type: "array"
          description: "Time intervals for a particular day"
          items:
            $ref: "#/definitions/TimeInterval"
        wednesday:
          type: "array"
          description: "Time intervals for a particular day"
          items:
            $ref: "#/definitions/TimeInterval"
        thursday:
          type: "array"
          description: "Time intervals for a particular day"
          items:
            $ref: "#/definitions/TimeInterval"
        friday:
          type: "array"
          description: "Time intervals for a particular day"
          items:
            $ref: "#/definitions/TimeInterval"
        saturday:
          type: "array"
          description: "Time intervals for a particular day"
          items:
            $ref: "#/definitions/TimeInterval"
        sunday:
          type: "array"
          description: "Time intervals for a particular day"
          items:
            $ref: "#/definitions/TimeInterval"
    RangesInfo:
      type: "object"
      properties:
        from:
          type: "string"
          format: "date-time"
          description: "Date and time in format YYYY-MM-DD hh:mm"
        to:
          type: "string"
          format: "date-time"
          description: "Date and time in format YYYY-MM-DD hh:mm"
    TimeInterval:
      type: "object"
      properties:
        from:
          type: "string"
          format: "date-time"
          description: "Time in format hh:mm"
        to:
          type: "string"
          format: "date-time"
          description: "Time in format hh:mm"
    CalledNumberInfo:
      type: "object"
      properties:
        phoneNumber:
          type: "string"
          description: "Called phone number"
    CallersInfo:
      type: "object"
      properties:
        callerId:
          type: "string"
          description: "Phone number of a caller"
        name:
          type: "string"
          description: "Contact name of a caller"
    ForwardingInfo:
      type: "object"
      properties:
        notifyMySoftPhones:
          type: "boolean"
          description: "Specifies if the user's softphone(s) are notified before forwarding the incoming call to desk phones and forwarding numbers"
        notifyAdminSoftPhones:
          type: "boolean"
          description: "Specifies if the administrator's softphone is notified before forwarding the incoming call to desk phones and forwarding numbers. The default value is 'False'"
        softPhonesRingCount:
          type: "integer"
          description: "Number of rings before forwarding starts"
        ringingMode:
          type: "string"
          description: "Specifies the order in which forwarding numbers ring. 'Sequentially' means that forwarding numbers are ringing one at a time, in order of priority. 'Simultaneously' means that forwarding numbers are ring all at the same time"
          enum:
            - "Sequentially"
            - "Simultaneously"
        rules:
          type: "array"
          description: "Information on a call forwarding rule"
          items:
            $ref: "#/definitions/RuleInfo"
    RuleInfo:
      type: "object"
      properties:
        index:
          type: "integer"
          description: "Forwarding number (or group) ordinal"
        ringCount:
          type: "integer"
          description: "Number of rings for a forwarding number (or group)"
        forwardingNumbers:
          type: "array"
          description: "Forwarding number (or group) data"
          items:
            $ref: "#/definitions/ForwardingNumberInfoRules"
    ForwardingNumberInfoRules:
      type: "object"
      properties:
        uri:
          type: "string"
          description: "Link to a forwarding number resource"
        id:
          type: "string"
          description: "Internal identifier of a forwarding number"
        phoneNumber:
          type: "string"
          description: "Phone number to which the call is forwarded"
        label:
          type: "string"
          description: "Title of a forwarding number"
    UnconditionalForwardingInfo:
      type: "object"
      properties:
        phoneNumber:
          type: "string"
          description: "Phone number to which the call is forwarded"
    VoicemailInfo:
      type: "object"
      properties:
        enabled:
          type: "boolean"
          description: "If 'True' then voicemails are allowed to be received"
        recipient:
          description: "Recipient data"
          $ref: "#/definitions/RecipientInfo"
    RecipientInfo:
      type: "object"
      properties:
        uri:
          type: "string"
          description: "Link to a recipient extension resource"
        id:
          type: "string"
          description: "Internal identifier of a recipient extension"
    GetUserBusinessHoursResponse:
      type: "object"
      properties:
        uri:
          type: "string"
          description: "Canonical URI of a business-hours resource"
        schedule:
          description: "Schedule when an answering rule is applied"
          $ref: "#/definitions/ScheduleInfoUserBusinessHours"
    ScheduleInfoUserBusinessHours:
      type: "object"
      properties:
        weeklyRanges:
          description: "Weekly schedule"
          $ref: "#/definitions/WeeklyScheduleInfo"
    AccountActiveCallsResponse:
      type: "object"
      required:
        - "navigation"
        - "paging"
        - "records"
      properties:
        records:
          type: "array"
          description: "List of call log records"
          items:
            $ref: "#/definitions/CallLogRecord"
        navigation:
          description: "Information on navigation"
          $ref: "#/definitions/NavigationInfo"
        paging:
          description: "Information on paging"
          $ref: "#/definitions/PagingInfo"
    AccountCallLogResponse:
      type: "object"
      required:
        - "navigation"
        - "paging"
        - "records"
      properties:
        records:
          type: "array"
          description: "List of call log records"
          items:
            $ref: "#/definitions/CallLogRecord"
        navigation:
          description: "Information on navigation"
          $ref: "#/definitions/NavigationInfo"
        paging:
          description: "Information on paging"
          $ref: "#/definitions/PagingInfo"
    GetAccountCallLogRecordResponse:
      type: "object"
      properties:
        id:
          type: "string"
          description: "Internal identifier of a cal log record"
        uri:
          type: "string"
          description: "Canonical URI of a call log record"
        sessionId:
          type: "string"
          description: "Internal identifier of a call session"
        from:
          description: "Caller information"
          $ref: "#/definitions/CallLogCallerInfo"
        to:
          description: "Callee information"
          $ref: "#/definitions/CallLogCallerInfo"
        type:
          type: "string"
          description: "Call type"
          enum:
            - "Voice"
            - "Fax"
        direction:
          type: "string"
          description: "Call direction"
          enum:
            - "Inbound"
            - "Outbound"
        action:
          type: "string"
          description: "Action description of the call operation"
          enum:
            - "Unknown"
            - "Phone Call"
            - "Phone Login"
            - "Incoming Fax"
            - "Accept Call"
            - "FindMe"
            - "FollowMe"
            - "Outgoing Fax"
            - "Call Return"
            - "Calling Card"
            - "Ring Directly"
            - "RingOut Web"
            - "VoIP Call"
            - "RingOut PC"
            - "RingMe"
            - "Transfer"
            - "411 Info"
            - "Emergency"
            - "E911 Update"
            - "Support"
            - "RingOut Mobile"
        result:
          type: "string"
          description: "Status description of the call operation"
          enum:
            - "Unknown"
            - "ResultInProgress"
            - "Missed"
            - "Call accepted"
            - "Voicemail"
            - "Rejected"
            - "Reply"
            - "Received"
            - "Receive Error"
            - "Fax on Demand"
            - "Partial Receive"
            - "Blocked"
            - "Call connected"
            - "No Answer"
            - "International Disabled"
            - "Busy"
            - "Send Error"
            - "Sent"
            - "No fax machine"
            - "ResultEmpty"
            - "Account"
            - "Suspended"
            - "Call Failed"
            - "Call Failure"
            - "Internal Error"
            - "IP Phone offline"
            - "Restricted Number"
            - "Wrong Number"
            - "Stopped"
            - "Hang up"
            - "Poor Line Quality"
            - "Partially Sent"
            - "International Restriction"
            - "Abandoned"
            - "Declined"
            - "Fax Receipt Error"
            - "Fax Send Error"
        startTime:
          type: "string"
          format: "date-time"
          description: "The call start datetime in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z"
        duration:
          type: "integer"
          description: "Call duration in seconds"
        recording:
          description: "Call recording data. Returned if the call is recorded"
          $ref: "#/definitions/RecordingInfo"
    ExtensionActiveCallsResponse:
      type: "object"
      required:
        - "navigation"
        - "paging"
        - "records"
      properties:
        records:
          type: "array"
          description: "List of call log records"
          items:
            $ref: "#/definitions/CallLogRecord"
        navigation:
          description: "Information on navigation"
          $ref: "#/definitions/NavigationInfo"
        paging:
          description: "Information on paging"
          $ref: "#/definitions/PagingInfo"
    ExtensionCallLogResponse:
      type: "object"
      required:
        - "navigation"
        - "paging"
        - "records"
      properties:
        records:
          type: "array"
          description: "List of call log records"
          items:
            $ref: "#/definitions/CallLogRecord"
        navigation:
          description: "Information on navigation"
          $ref: "#/definitions/NavigationInfo"
        paging:
          description: "Information on paging"
          $ref: "#/definitions/PagingInfo"
    CallLogSync:
      type: "object"
      properties:
        records:
          type: "array"
          items:
            $ref: "#/definitions/CallLogRecord"
          description: "List of call log records with synchronization information. For ISync the total number of returned records is limited to 250; this includes both new records and the old ones, specified by the recordCount parameter"
        syncInfo:
          $ref: "#/definitions/SyncInfoCallLog"
          description: "Sync information (type, token and time)"
    SyncInfoCallLog:
      type: "object"
      properties:
        syncType:
          type: "string"
          enum:
            - "FSync"
            - "ISync"
          description: "Type of synchronization"
        syncToken:
          type: "string"
          description: "Synchronization token"
        syncTime:
          type: "string"
          format: "date-time"
          description: "The last synchronization datetime in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z"
    CallLogRecord:
      type: "object"
      required:
        - "legs"
      properties:
        id:
          type: "string"
          description: "Internal identifier of a cal log record"
        uri:
          type: "string"
          description: "Canonical URI of a call log record"
        sessionId:
          type: "string"
          description: "Internal identifier of a call session"
        from:
          description: "Caller information"
          $ref: "#/definitions/CallLogCallerInfo"
        to:
          description: "Callee information"
          $ref: "#/definitions/CallLogCallerInfo"
        type:
          type: "string"
          description: "Call type"
          enum:
            - "Voice"
            - "Fax"
        direction:
          type: "string"
          description: "Call direction"
          enum:
            - "Inbound"
            - "Outbound"
        action:
          type: "string"
          description: "Action description of the call operation"
          enum:
            - "Unknown"
            - "Phone Call"
            - "Phone Login"
            - "Incoming Fax"
            - "Accept Call"
            - "FindMe"
            - "FollowMe"
            - "Outgoing Fax"
            - "Call Return"
            - "Calling Card"
            - "Ring Directly"
            - "RingOut Web"
            - "VoIP Call"
            - "RingOut PC"
            - "RingMe"
            - "Transfer"
            - "411 Info"
            - "Emergency"
            - "E911 Update"
            - "Support"
            - "RingOut Mobile"
        result:
          type: "string"
          description: "Status description of the call operation"
          enum:
            - "Unknown"
            - "ResultInProgress"
            - "Missed"
            - "Call accepted"
            - "Voicemail"
            - "Rejected"
            - "Reply"
            - "Received"
            - "Receive Error"
            - "Fax on Demand"
            - "Partial Receive"
            - "Blocked"
            - "Call connected"
            - "No Answer"
            - "International Disabled"
            - "Busy"
            - "Send Error"
            - "Sent"
            - "No fax machine"
            - "ResultEmpty"
            - "Account"
            - "Suspended"
            - "Call Failed"
            - "Call Failure"
            - "Internal Error"
            - "IP Phone offline"
            - "Restricted Number"
            - "Wrong Number"
            - "Stopped"
            - "Hang up"
            - "Poor Line Quality"
            - "Partially Sent"
            - "International Restriction"
            - "Abandoned"
            - "Declined"
            - "Fax Receipt Error"
            - "Fax Send Error"
        startTime:
          type: "string"
          format: "date-time"
          description: "The call start datetime in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z"
        duration:
          type: "integer"
          description: "Call duration in seconds"
        recording:
          description: "Call recording data. Returned if the call is recorded, the withRecording parameter is set to 'True' in this case"
          $ref: "#/definitions/RecordingInfo"
        lastModifiedTime:
          type: "string"
          format: "date-time"
          description: "For 'Detailed' view only. The datetime when the call log record was modified in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z"
        transport:
          type: "string"
          description: "For 'Detailed' view only. Call transport"
          enum:
            - "PSTN"
            - "VoIP"
        legs:
          type: "array"
          description: "For 'Detailed' view only. Leg description"
          items:
            $ref: "#/definitions/CallLogRecordLegInfo"
    UserCallLogRecord:
      type: "object"
      properties:
        id:
          type: "string"
          description: "Internal identifier of a cal log record"
        uri:
          type: "string"
          description: "Canonical URI of a call log record"
        sessionId:
          type: "string"
          description: "Internal identifier of a call session"
        from:
          $ref: "#/definitions/CallLogCallerInfo"
        to:
          $ref: "#/definitions/CallLogCallerInfo"
        type:
          type: "string"
          description: "Call type = ['Voice', 'Fax']"
          enum:
            - "Voice"
            - "Fax"
        direction:
          type: "string"
          description: "Call direction = ['Inbound', 'Outbound']"
          enum:
            - "Inbound"
            - "Outbound"
        startTime:
          type: "string"
          description: "The call start datetime in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z"
        duration:
          type: "integer"
          description: "Call duration in seconds"
        recording:
          $ref: "#/definitions/RecordingInfo"
    CallLogCallerInfo:
      type: "object"
      properties:
        phoneNumber:
          type: "string"
          description: "Phone number of a party. Usually it is a plain number including country and area code like 18661234567. But sometimes it could be returned from database with some formatting applied, for example (866)123-4567. This property is filled in all cases where parties communicate by means of global phone numbers, for example when calling to direct numbers or sending/receiving SMS"
        extensionNumber:
          type: "string"
          description: "Extension short number (usually 3 or 4 digits). This property is filled when parties communicate by means of short internal numbers, for example when calling to other extension or sending/receiving Company Pager message"
        location:
          type: "string"
          description: "Contains party location (city, state) if one can be determined from phoneNumber. This property is filled only when phoneNumber is not empty and server can calculate location information from it (for example, this information is unavailable for US toll-free numbers)"
        name:
          type: "string"
          description: "Symbolic name associated with a party. If the phone does not belong to the known extension, only the location is returned, the name is not determined then"
        device:
          $ref: "#/definitions/CallLogRecordDeviceInfo"
    CallLogRecordLegInfo:
      type: "object"
      properties:
        action:
          type: "string"
          description: "Action description of the call operation"
          enum:
            - "Unknown"
            - "Phone Call"
            - "Phone Login"
            - "Incoming Fax"
            - "Accept Call"
            - "FindMe"
            - "FollowMe"
            - "Outgoing Fax"
            - "Call Return"
            - "Calling Card"
            - "Ring Directly"
            - "RingOut Web"
            - "VoIP Call"
            - "RingOut PC"
            - "RingMe"
            - "Transfer"
            - "411 Info"
            - "Emergency"
            - "E911 Update"
            - "Support"
            - "RingOut Mobile"
        direction:
          type: "string"
          description: "Call direction"
          enum:
            - "Inbound"
            - "Outbound"
        duration:
          type: "integer"
          description: "Call duration in seconds"
        extension:
          description: "Information on extension"
          $ref: "#/definitions/ExtensionInfoCallLog"
        legType:
          type: "string"
          description: "Leg type"
        startTime:
          type: "string"
          format: "date-time"
          description: "The call start datetime in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z"
        type:
          type: "string"
          description: "Call type"
          enum:
            - "Voice"
            - "Fax"
        result:
          type: "string"
          description: "Status description of the call operation"
          enum:
            - "Unknown"
            - "ResultInProgress"
            - "Missed"
            - "Call accepted"
            - "Voicemail"
            - "Rejected"
            - "Reply"
            - "Received"
            - "Receive Error"
            - "Fax on Demand"
            - "Partial Receive"
            - "Blocked"
            - "Call connected"
            - "No Answer"
            - "International Disabled"
            - "Busy"
            - "Send Error"
            - "Sent"
            - "No fax machine"
            - "ResultEmpty"
            - "Account"
            - "Suspended"
            - "Call Failed"
            - "Call Failure"
            - "Internal Error"
            - "IP Phone offline"
            - "Restricted Number"
            - "Wrong Number"
            - "Stopped"
            - "Hang up"
            - "Poor Line Quality"
            - "Partially Sent"
            - "International Restriction"
            - "Abandoned"
            - "Declined"
            - "Fax Receipt Error"
            - "Fax Send Error"
        from:
          description: "Caller information"
          $ref: "#/definitions/CallLogCallerInfo"
        to:
          description: "Callee information"
          $ref: "#/definitions/CallLogCallerInfo"
        transport:
          type: "string"
          description: "Call transport"
          enum:
            - "PSTN"
            - "VoIP"
        recording:
          description: "Call recording data. Returned if the call is recorded"
          $ref: "#/definitions/RecordingInfo"
    RecordingInfo:
      type: "object"
      properties:
        id:
          type: "string"
          description: "Internal identifier of the call recording"
        uri:
          type: "string"
          description: "Link to the call recording metadata resource"
        type:
          type: "string"
          description: "Indicates recording mode used"
          enum:
            - "Automatic"
            - "OnDemand"
        contentUri:
          type: "string"
          description: "Link to the call recording binary content"
    ExtensionInfoCallLog:
      type: "object"
      properties:
        id:
          type: "string"
          description: "Internal identifier of an extension"
        uri:
          type: "string"
          description: "Canonical URI of an extension"
    GetExtensionCallLogRecordResponse:
      type: "object"
      properties:
        id:
          type: "string"
          description: "Internal identifier of a cal log record"
        uri:
          type: "string"
          description: "Canonical URI of a call log record"
        sessionId:
          type: "string"
          description: "Internal identifier of a call session"
        from:
          description: "Caller information"
          $ref: "#/definitions/CallLogCallerInfo"
        to:
          description: "Callee information"
          $ref: "#/definitions/CallLogCallerInfo"
        type:
          type: "string"
          description: "Call type"
          enum:
            - "Voice"
            - "Fax"
        direction:
          type: "string"
          description: "Call direction"
          enum:
            - "Inbound"
            - "Outbound"
        action:
          type: "string"
          description: "Action description of the call operation"
          enum:
            - "Unknown"
            - "Phone Call"
            - "Phone Login"
            - "Incoming Fax"
            - "Accept Call"
            - "FindMe"
            - "FollowMe"
            - "Outgoing Fax"
            - "Call Return"
            - "Calling Card"
            - "Ring Directly"
            - "RingOut Web"
            - "VoIP Call"
            - "RingOut PC"
            - "RingMe"
            - "Transfer"
            - "411 Info"
            - "Emergency"
            - "E911 Update"
            - "Support"
            - "RingOut Mobile"
        result:
          type: "string"
          description: "Status description of the call operation"
          enum:
            - "Unknown"
            - "ResultInProgress"
            - "Missed"
            - "Call accepted"
            - "Voicemail"
            - "Rejected"
            - "Reply"
            - "Received"
            - "Receive Error"
            - "Fax on Demand"
            - "Partial Receive"
            - "Blocked"
            - "Call connected"
            - "No Answer"
            - "International Disabled"
            - "Busy"
            - "Send Error"
            - "Sent"
            - "No fax machine"
            - "ResultEmpty"
            - "Account"
            - "Suspended"
            - "Call Failed"
            - "Call Failure"
            - "Internal Error"
            - "IP Phone offline"
            - "Restricted Number"
            - "Wrong Number"
            - "Stopped"
            - "Hang up"
            - "Poor Line Quality"
            - "Partially Sent"
            - "International Restriction"
            - "Abandoned"
            - "Declined"
            - "Fax Receipt Error"
            - "Fax Send Error"
        startTime:
          type: "string"
          format: "date-time"
          description: "The call start datetime in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z"
        duration:
          type: "integer"
          description: "Call duration in seconds"
        recording:
          description: "Call recording data. Returned if the call is recorded"
          $ref: "#/definitions/RecordingInfo"
    GetCallRecordingResponse:
      type: "object"
      properties:
        id:
          type: "string"
          description: "Internal identifier of the call recording"
        contentUri:
          type: "string"
          description: "Link to the call recording binary content"
        contentType:
          type: "string"
          description: "Call recording file format. Supported format is audio/x-wav"
        duration:
          type: "integer"
          description: "Recorded call duration"
    GetConferencingInfoResponse:
      type: "object"
      properties:
        uri:
          type: "string"
          description: "Canonical URI of a conferencing"
        allowJoinBeforeHost:
          type: "boolean"
          description: "Determines if host user allows conference participants to join before the host"
        hostCode:
          type: "string"
          description: "Access code for a host user"
        mode:
          type: "string"
          description: "Internal parameter specifying conferencing engine"
        participantCode:
          type: "string"
          description: "Access code for any participant"
        phoneNumber:
          type: "string"
          description: "Primary conference phone number for user's home country returned in E.164 (11-digits) format"
        tapToJoinUri:
          type: "string"
          description: "Short URL leading to the service web page Tap to Join for audio conference bridge"
        phoneNumbers:
          type: "array"
          description: "List of multiple dial-in phone numbers to connect to audio conference service, relevant for user's brand. Each number is given with the country and location information, in order to let the user choose the less expensive way to connect to a conference. The first number in the list is the primary conference number, that is default and domestic"
          items:
            $ref: "#/definitions/PhoneNumberInfoConferencing"
    PhoneNumberInfoConferencing:
      type: "object"
      properties:
        country:
          description: "Information on a home country of a conference phone number"
          $ref: "#/definitions/GetCountryInfoConferencing"
        default:
          type: "boolean"
          description: "'True' if the number is default for the conference. Default conference number is a domestic number that can be set by user (otherwise it is set by the system). Only one default number per country is allowed"
        hasGreeting:
          type: "boolean"
          description: "'True' if the greeting message is played on this number"
        location:
          type: "string"
          description: "Location (city, region, state) of a conference phone number"
        phoneNumber:
          type: "string"
          description: "Dial-in phone number to connect to a conference"
    GetCountryInfoConferencing:
      type: "object"
      properties:
        id:
          type: "string"
          description: "Internal identifier of a country"
        uri:
          type: "string"
          description: "Canonical URI of a country"
        callingCode:
          type: "string"
          description: "Country calling code defined by ITU-T recommendations E.123 and E.164, see Calling Codes"
        emergencyCalling:
          type: "boolean"
          description: "Emergency calling feature availability/emergency address requirement indicator"
        isoCode:
          type: "string"
          description: "Country code according to the ISO standard, see ISO 3166"
        name:
          type: "string"
          description: "Official name of a country"
    GetAccountDevicesResponse:
      type: "object"
      required:
        - "navigation"
        - "paging"
        - "records"
      properties:
        records:
          type: "array"
          description: "List of extension records"
          items:
            $ref: "#/definitions/GetDeviceInfoResponse"
        navigation:
          description: "Information on navigation"
          $ref: "#/definitions/NavigationInfo"
        paging:
          description: "Information on paging"
          $ref: "#/definitions/PagingInfo"
    GetDeviceInfoResponse:
      type: "object"
      properties:
        id:
          type: "string"
          description: "Internal identifier of a device"
        uri:
          type: "string"
          description: "Canonical URI of a device"
        sku:
          type: "string"
          description: "Device identification number (stock keeping unit) in the format TP-ID [-AT-AC], where TP is device type (HP for RC HardPhone, DV for all other devices including softphone); ID - device model ID; AT -addon type ID; AC - addon count (if any). For example 'HP-56-2-2'"
        type:
          type: "string"
          description: "Device type. The default value is 'HardPhone'"
          enum:
            - "SoftPhone"
            - "OtherPhone"
            - "HardPhone"
        name:
          type: "string"
          description: "Device name. Mandatory if ordering  SoftPhone  or  OtherPhone . Optional for  HardPhone . If not specified for HardPhone, then device model  name is used as device  name"
        serial:
          type: "string"
          description: "Serial number for HardPhone (is returned only when the phone is shipped and provisioned); endpoint_id for softphone and mobile applications"
        computerName:
          type: "string"
          description: "PC name for softphone"
        model:
          description: "HardPhone model information"
          $ref: "#/definitions/ModelInfo"
        extension:
          description: "This attribute can be omitted for unassigned devices"
          $ref: "#/definitions/ExtensionInfoIntId"
        emergencyServiceAddress:
          description: "Address for emergency cases. The same emergency address is assigned to all the numbers of one device"
          $ref: "#/definitions/EmergencyAddressInfo"
        phoneLines:
          description: "Phone lines information"
          type: "array"
          items:
            $ref: "#/definitions/PhoneLinesInfo"
        shipping:
          description: "Shipping information, according to which devices (in case of HardPhone ) or e911 stickers (in case of  SoftPhone  and  OtherPhone ) will be delivered to the customer"
          $ref: "#/definitions/ShippingInfo"
        boxBillingId:
          type: "integer"
          description: "Box billing identifier of a device. Applicable only for HardPhones. It is an alternative way to identify the device to be ordered. EitherT? model  structure, or  boxBillingId  must be specified forT?HardPhone"
    ModelInfo:
      type: "object"
      required:
        - "addons"
      properties:
        id:
          type: "string"
          description: "Addon identifier. For HardPhones of certain types, which are compatible with this addon identifier"
        name:
          type: "string"
          description: "Device name"
        addons:
          description: "Addons description"
          type: "array"
          items:
            $ref: "#/definitions/AddonInfo"
    AddonInfo:
      type: "object"
      properties:
        id:
          type: "string"
        count:
          type: "string"
    EmergencyAddress:
      type: "object"
      properties:
        required:
          type: "boolean"
          description: " 'True' if specifying of emergency address is required"
        localOnly:
          type: "boolean"
          description: " 'True' if only local emergency address can be specified"
    EmergencyAddressInfo:
      type: "object"
      properties:
        customerName:
          type: "string"
          description: "Name of a customer"
        street:
          type: "string"
          description: "Street address, line 1 - street address, P.O. box, company name, c/o"
        street2:
          type: "string"
          description: "Street address, line 2 - apartment, suite, unit, building, floor, etc."
        city:
          type: "string"
          description: "City name"
        state:
          type: "string"
          description: "State/province name"
        zip:
          type: "string"
          description: "Zip code"
        country:
          type: "string"
          description: "Country name"
    PhoneLinesInfo:
      type: "object"
      properties:
        lineType:
          type: "string"
          description: "Type of phone line"
          enum:
            - "Standalone"
            - "StandaloneFree"
            - "BlaPrimary"
            - "BlaSecondary"
        phoneInfo:
          description: "Phone number information"
          $ref: "#/definitions/PhoneNumberInfoIntId"
    ShippingInfo:
      type: "object"
      required:
        - "address"
        - "method"
      properties:
        status:
          type: "string"
          description: "Shipping status of the order item. It is set to 'Initial' when the order is submitted. Then it is changed to 'Accepted' when a distributor starts processing the order. Finally it is changed to Shipped which means that distributor has shipped the device."
          enum:
            - "Initial"
            - "Accepted"
            - "Shipped"
        carrier:
          type: "string"
          description: "Shipping carrier name. Appears only if the device status is  Shipped "
        trackingNumber:
          type: "string"
          description: "Carrier-specific tracking number. Appears only if the device status is  Shipped"
        method:
          description: "Shipping method information"
          $ref: "#/definitions/MethodInfo"
        address:
          description: "Shipping address for the order. If it coincides with the Emergency Service Address, then can be omitted. By default the same value as the emergencyServiceAddress. Multiple addresses can be specified; in case an order contains several devices, they can be delivered to different addresses"
          $ref: "#/definitions/ShippingAddressInfo"
    ShippingAddressInfo:
      type: "object"
      properties:
        customerName:
          type: "string"
          description: "Name of a receiver"
        street:
          type: "string"
          description: "Street address, line 1 - street address, P.O. box, company name, c/o"
        street2:
          type: "string"
          description: "Street address, line 2 - apartment, suite, unit, building, floor, etc."
        city:
          type: "string"
          description: "City name"
        state:
          type: "string"
          description: "State/province name"
        zip:
          type: "string"
          description: "Zip code"
        country:
          type: "string"
          description: "Country name"
    MethodInfo:
      type: "object"
      properties:
        id:
          type: "string"
          description: "Method identifier. The default value is  1  (Ground)"
          enum:
            - "1"
            - "2"
            - "3"
        name:
          type: "string"
          description: "Method name, corresponding to the identifier"
          enum:
            - "Ground"
            - "2 Day"
            - "Overnight"
    GetExtensionDevicesResponse:
      type: "object"
      required:
        - "navigation"
        - "paging"
        - "records"
      properties:
        records:
          type: "array"
          description: "List of extension devices"
          items:
            $ref: "#/definitions/GetDeviceInfoResponse"
        navigation:
          description: "Information on navigation"
          $ref: "#/definitions/NavigationInfo"
        paging:
          description: "Information on paging"
          $ref: "#/definitions/PagingInfo"
    GetExtensionForwardingNumberListResponse:
      type: "object"
      properties:
        records:
          type: "array"
          description: "List of forwarding phone numbers"
          items:
            $ref: "#/definitions/ForwardingNumberInfo"
        navigation:
          description: "Information on navigation"
          $ref: "#/definitions/NavigationInfo"
        paging:
          description: "Information on paging"
          $ref: "#/definitions/PagingInfo"
    ForwardingNumberInfo:
      type: "object"
      properties:
        id:
          type: "string"
          description: "Internal identifier of a forwarding/call flip phone number"
        uri:
          type: "string"
          description: "Canonical URI of a forwarding/call flip phone number"
        phoneNumber:
          type: "string"
          description: "Forwarding/Call flip phone number"
        label:
          type: "string"
          description: "Forwarding/Call flip number title"
        features:
          type: "array"
          description: "Type of option this phone number is used for. Multiple values are accepted"
          items:
            type: "string"
            enum:
              - "CallFlip"
              - "CallForwarding"
        flipNumber:
          type: "string"
          description: "Number assigned to the call flip phone number, corresponds to the shortcut dial number"
    GetMessageList:
      type: "object"
      required:
        - "navigation"
        - "paging"
        - "records"
      properties:
        records:
          type: "array"
          description: "List of records with message information"
          items:
            $ref: "#/definitions/GetMessageInfoResponseIntId"
        navigation:
          description: "Information on navigation"
          $ref: "#/definitions/NavigationInfo"
        paging:
          description: "Information on paging"
          $ref: "#/definitions/PagingInfo"
    GetMessageInfoResponse:
      type: "object"
      properties:
        id:
          type: "string"
          description: "Internal identifier of a message"
        uri:
          type: "string"
          description: "Canonical URI of a message"
        attachments:
          type: "array"
          description: "The list of message attachments"
          items:
            $ref: "#/definitions/MessageAttachmentInfo"
        availability:
          type: "string"
          description: "Message availability status. Message in 'Deleted' state is still preserved with all its attachments and can be restored. 'Purged' means that all attachments are already deleted and the message itself is about to be physically deleted shortly"
          enum:
            - "Alive"
            - "Deleted"
            - "Purged"
        conversationId:
          type: "integer"
          description: "SMS and Pager only. Identifier of the conversation the message belongs to"
        creationTime:
          type: "string"
          format: "date-time"
          description: "Message creation datetime in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z"
        deliveryErrorCode:
          type: "string"
          description: "SMS only. Delivery error code returned by gateway"
        direction:
          type: "string"
          description: "Message direction. Note that for some message types not all directions are allowed. For example voicemail messages can be only inbound"
          enum:
            - "Inbound"
            - "Outbound"
        faxPageCount:
          type: "integer"
          description: "Fax only. Page count in fax message"
        faxResolution:
          type: "string"
          description: "Fax only. Resolution of fax message. ('High' for black and white image scanned at 200 dpi, 'Low' for black and white image scanned at 100 dpi)"
          enum:
            - "High"
            - "Low"
        from:
          description: "Sender information"
          $ref: "#/definitions/MessageStoreCallerInfoResponse"
        lastModifiedTime:
          type: "string"
          format: "date-time"
          description: "The datetime when the message was modified on server in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z"
        messageStatus:
          type: "string"
          description: "Message status. Different message types may have different allowed status values.For outbound faxes the aggregated message status is returned: If status for at least one recipient is 'Queued', then 'Queued' value is returned If status for at least one recipient is 'SendingFailed', then 'SendingFailed' value is returned In other cases Sent status is returned"
          enum:
            - "Queued"
            - "Sent"
            - "Delivered"
            - "DeliveryFailed"
            - "SendingFailed"
            - "Received"
        pgToDepartment:
          type: "boolean"
          description: "Pager only True if at least one of the message recipients is Department extension"
        priority:
          type: "string"
          description: "Message priority"
          enum:
            - "Normal"
            - "High"
        readStatus:
          type: "string"
          description: "Message read status"
          enum:
            - "Read"
            - "Unread"
        smsDeliveryTime:
          type: "string"
          format: "date-time"
          description: "SMS only. The datetime when outbound SMS was delivered to recipient's handset in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z. It is filled only if the carrier sends a delivery receipt to RingCentral"
        smsSendingAttemptsCount:
          type: "integer"
          description: "SMS only. Number of attempts made to send an outbound SMS to the gateway (if gateway is temporary unavailable)"
        subject:
          type: "string"
          description: "Message subject. For SMS and Pager messages it replicates message text which is also returned as an attachment"
        to:
          type: "array"
          description: "Recipient information"
          items:
            $ref: "#/definitions/MessageStoreCallerInfoResponse"
        type:
          type: "string"
          description: "Message type"
          enum:
            - "Fax"
            - "SMS"
            - "VoiceMail"
            - "Pager"
            - "Text"
        vmTranscriptionStatus:
          type: "string"
          description: "Voicemail only. Status of voicemail to text transcription. If VoicemailToText feature is not activated for account, the 'NotAvailable' value is returned"
          enum:
            - "NotAvailable"
            - "InProgress"
            - "TimedOut"
            - "Completed"
            - "CompletedPartially"
            - "Failed"
    GetMessageInfoResponseIntId:
      type: "object"
      properties:
        id:
          type: "integer"
          format: "int64"
          description: "Internal identifier of a message"
        uri:
          type: "string"
          description: "Canonical URI of a message"
        attachments:
          type: "array"
          description: "The list of message attachments"
          items:
            $ref: "#/definitions/MessageAttachmentInfoIntId"
        availability:
          type: "string"
          description: "Message availability status. Message in 'Deleted' state is still preserved with all its attachments and can be restored. 'Purged' means that all attachments are already deleted and the message itself is about to be physically deleted shortly"
          enum:
            - "Alive"
            - "Deleted"
            - "Purged"
        conversationId:
          type: "integer"
          format: "int64"
          description: "SMS and Pager only. Identifier of the conversation the message belongs to"
        creationTime:
          type: "string"
          format: "date-time"
          description: "Message creation datetime in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z"
        deliveryErrorCode:
          type: "string"
          description: "SMS only. Delivery error code returned by gateway"
        direction:
          type: "string"
          description: "Message direction. Note that for some message types not all directions are allowed. For example voicemail messages can be only inbound"
          enum:
            - "Inbound"
            - "Outbound"
        faxPageCount:
          type: "integer"
          description: "Fax only. Page count in fax message"
        faxResolution:
          type: "string"
          description: "Fax only. Resolution of fax message. ('High' for black and white image scanned at 200 dpi, 'Low' for black and white image scanned at 100 dpi)"
          enum:
            - "High"
            - "Low"
        from:
          description: "Sender information"
          $ref: "#/definitions/MessageStoreCallerInfoResponse"
        lastModifiedTime:
          type: "string"
          format: "date-time"
          description: "The datetime when the message was modified on server in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z"
        messageStatus:
          type: "string"
          description: "Message status. Different message types may have different allowed status values.For outbound faxes the aggregated message status is returned: If status for at least one recipient is 'Queued', then 'Queued' value is returned If status for at least one recipient is 'SendingFailed', then 'SendingFailed' value is returned In other cases Sent status is returned"
          enum:
            - "Queued"
            - "Sent"
            - "Delivered"
            - "DeliveryFailed"
            - "SendingFailed"
            - "Received"
        pgToDepartment:
          type: "boolean"
          description: "Pager only True if at least one of the message recipients is Department extension"
        priority:
          type: "string"
          description: "Message priority"
          enum:
            - "Normal"
            - "High"
        readStatus:
          type: "string"
          description: "Message read status"
          enum:
            - "Read"
            - "Unread"
        smsDeliveryTime:
          type: "string"
          format: "date-time"
          description: "SMS only. The datetime when outbound SMS was delivered to recipient's handset in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z. It is filled only if the carrier sends a delivery receipt to RingCentral"
        smsSendingAttemptsCount:
          type: "integer"
          description: "SMS only. Number of attempts made to send an outbound SMS to the gateway (if gateway is temporary unavailable)"
        subject:
          type: "string"
          description: "Message subject. For SMS and Pager messages it replicates message text which is also returned as an attachment"
        to:
          type: "array"
          description: "Recipient information"
          items:
            $ref: "#/definitions/MessageStoreCallerInfoResponse"
        type:
          type: "string"
          description: "Message type"
          enum:
            - "Fax"
            - "SMS"
            - "VoiceMail"
            - "Pager"
            - "Text"
        vmTranscriptionStatus:
          type: "string"
          description: "Voicemail only. Status of voicemail to text transcription. If VoicemailToText feature is not activated for account, the 'NotAvailable' value is returned"
          enum:
            - "NotAvailable"
            - "InProgress"
            - "TimedOut"
            - "Completed"
            - "CompletedPartially"
            - "Failed"
    MessageAttachmentInfo:
      type: "object"
      properties:
        id:
          type: "string"
          description: "Internal identifier of a message attachment"
        uri:
          type: "string"
          description: "Canonical URI of a message attachment"
        type:
          type: "string"
          description: "Type of message attachment"
          enum:
            - "AudioRecording"
            - "AudioTranscription"
            - "Text"
            - "SourceDocument"
            - "RenderedDocument"
            - "MmsAttachment"
        contentType:
          type: "string"
          description: "MIME type for a given attachment, for instance 'audio/wav'"
        vmDuration:
          type: "integer"
          description: "Voicemail only Duration of the voicemail in seconds"
        filename:
          type: "string"
          description: "Name of a file attached"
        size:
          type: "integer"
          description: "Size of attachment in bytes"
    MessageAttachmentInfoIntId:
      # Used in FaxResponse
      type: "object"
      properties:
        id:
          type: "integer"
          format: "int64"
          description: "Internal identifier of a message attachment"
        uri:
          type: "string"
          description: "Canonical URI of a message attachment"
        type:
          type: "string"
          description: "Type of message attachment"
          enum:
            - "AudioRecording"
            - "AudioTranscription"
            - "Text"
            - "SourceDocument"
            - "RenderedDocument"
            - "MmsAttachment"
        contentType:
          type: "string"
          description: "MIME type for a given attachment, for instance 'audio/wav'"
        vmDuration:
          type: "integer"
          description: "Voicemail only Duration of the voicemail in seconds"
        filename:
          type: "string"
          description: "Name of a file attached"
        size:
          type: "integer"
          description: "Size of attachment in bytes"
    MessageStoreCallerInfoResponse:
      type: "object"
      required:
        - "extensionNumber"
      properties:
        extensionNumber:
          type: "string"
          description: "Extension short number (usually 3 or 4 digits). This property is filled when parties communicate by means of short internal numbers, for example when calling to other extension or sending/receiving Company Pager message"
        location:
          type: "string"
          description: "Contains party location (city, state) if one can be determined from phoneNumber. This property is filled only when phoneNumber is not empty and server can calculate location information from it (for example, this information is unavailable for US toll-free numbers)"
        messageStatus:
          type: "string"
          description: "Status of a message. Returned for outbound fax messages only"
          enum:
            - "Queued"
            - "Sent"
            - "Delivered"
            - "DeliveryFailed"
            - "SendingFailed"
            - "Received"
        faxErrorCode:
          type: "string"
          description: "Fax only. Error code returned in case of fax sending failure. Returned if messageStatus value is 'SendingFailed'"
          enum:
            - "Undefined"
            - "NoFaxSendPermission"
            - "NoInternationalPermission"
            - "NoFaxMachine"
            - "OutgoingCallError"
            - "RenderingFailed"
            - "TooManyPages"
            - "ReturnToDBQueue"
            - "NoCallTime"
            - "WrongNumber"
            - "ProhibitedNumber"
            - "InternalError"
            - "FaxSendingProhibited"
            - "ThePhoneIsBlacklisted"
            - "UserNotFound"
            - "ConvertError"
            - "DBGeneralError"
            - "SkypeBillingFailed"
            - "AccountSuspended"
            - "ProhibitedDestination"
            - "InternationalDisabled"
        name:
          type: "string"
          description: "Symbolic name associated with a party. If the phone does not belong to the known extension, only the location is returned, the name is not determined then"
        phoneNumber:
          type: "string"
          description: "Phone number of a party. Usually it is a plain number including country and area code like 18661234567. But sometimes it could be returned from database with some formatting applied, for example (866)123-4567. This property is filled in all cases where parties communicate by means of global phone numbers, for example when calling to direct numbers or sending/receiving SMS"
    GetMessageSyncResponse:
      type: "object"
      required:
        - "records"
        - "syncInfo"
      properties:
        records:
          type: "array"
          description: "List of message records with synchronization information"
          items:
            $ref: "#/definitions/GetMessageInfoResponse"
        syncInfo:
          description: "Sync type, token and time"
          $ref: "#/definitions/SyncInfoMessages"
    SyncInfoMessages:
      type: "object"
      properties:
        syncType:
          type: "string"
          description: "Type of synchronization"
          enum:
            - "FSync"
            - "ISync"
        syncToken:
          type: "string"
          description: "Synchronization token"
        syncTime:
          type: "string"
          format: "date-time"
          description: "Last synchronization datetime in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z"
    GetPresenceInfo:
      type: "object"
      properties:
        uri:
          type: "string"
          description: "Canonical URI of a presence info resource"
        allowSeeMyPresence:
          type: "boolean"
          description: "If 'True' enables other extensions to see the extension presence status"
        dndStatus:
          type: "string"
          description: "Extended DnD (Do not Disturb) status. Cannot be set for Department/Announcement/Voicemail (Take Messages Only)/Fax User/Shared Lines Group/Paging Only Group/IVR Menu/Application Extension/Park Location extensions. The 'DoNotAcceptDepartmentCalls' and 'TakeDepartmentCallsOnly' values are applicable only for extensions - members of a Department; if these values are set for department outsiders, the 400 Bad Request error code is returned. The 'TakeDepartmentCallsOnly' status can be set through the old RingCentral user interface and is available for some migrated accounts only."
          enum:
            - "TakeAllCalls"
            - "DoNotAcceptAnyCalls"
            - "DoNotAcceptDepartmentCalls"
            - "TakeDepartmentCallsOnly"
        extension:
          description: "Information on extension, for which this presence data is returned"
          $ref: "#/definitions/GetPresenceExtensionInfo"
        message:
          type: "string"
          description: "Custom status message (as previously published by user)"
        pickUpCallsOnHold:
          type: "boolean"
          description: "If 'True' enables the extension user to pick up a monitored line on hold"
        presenceStatus:
          type: "string"
          description: "Aggregated presence status, calculated from a number of sources"
          enum:
            - "Offline"
            - "Busy"
            - "Available"
        ringOnMonitoredCall:
          type: "boolean"
          description: "If 'True' enables to ring extension phone, if any user monitored by this extension is ringing"
        telephonyStatus:
          type: "string"
          description: "Telephony presence status"
          enum:
            - "NoCall"
            - "CallConnected"
            - "Ringing"
            - "OnHold"
            - "ParkedCall"
        userStatus:
          type: "string"
          description: "User-defined presence status (as previously published by the user)"
          enum:
            - "Offline"
            - "Busy"
            - "Available"
        activeCalls:
          type: "array"
          description: "Information on active calls"
          items:
            $ref: "#/definitions/ActiveCallInfo"
    GetPresenceExtensionInfo:
      type: "object"
      properties:
        id:
          type: "string"
          description: "Internal identifier of an extension"
        uri:
          type: "string"
          description: "Canonical URI of an extension"
        extensionNumber:
          type: "string"
          description: "Extension number (usually 3 or 4 digits)"
    GetMonitoredExtensionsResponse:
      type: "object"
      required:
        - "navigation"
        - "paging"
        - "records"
      properties:
        uri:
          type: "string"
          description: "Canonical URI of the monitored lines (extensions) resource"
        records:
          type: "array"
          description: "List of lines (extensions) the presence of which is monitored by the user. The first two lines always indicate the user's extension presence, they cannot be changed"
          items:
            $ref: "#/definitions/LineInfo"
        navigation:
          description: "Information on navigation"
          $ref: "#/definitions/NavigationInfo"
        paging:
          description: "Information on paging"
          $ref: "#/definitions/PagingInfo"
    LineInfo:
      type: "object"
      properties:
        id:
          type: "string"
          description: "Internal identifier of a monitored extension"
        uri:
          type: "string"
          description: "Canonical URI of a monitored extension"
        extension:
          description: "Brief information on a monitored extension"
          $ref: "#/definitions/ExtensionInfoMonitoredLines"
    ExtensionInfoMonitoredLines:
      type: "object"
      properties:
        id:
          type: "string"
          description: "Internal identifier of a monitored extension"
        uri:
          type: "string"
          description: "Canonical URI of a monitored extension"
        extensionNumber:
          type: "string"
          description: "Brief information on a monitored extension"
        type:
          type: "string"
          description: "Type of a monitored extension"
          enum:
            - "User"
            - "FaxUser"
            - "VirtualUser"
            - "DigitalUser"
            - "Department"
            - "ApplicationExtension"
            - "ParkLocation"
    GetReportingSettingsResponse:
      type: "object"
      required:
        - "views"
      properties:
        views:
          type: "array"
          description: "List of 'View' structures with a tuple of filter values, pages and schedules"
          items:
            $ref: "#/definitions/ViewInfoReporting"
    ViewInfoReporting:
      type: "object"
      required:
        - "name"
        - "pages"
      properties:
        name:
          type: "string"
          description: "User-defined name of a 'View'. The maximum value is 255"
        pages:
          type: "array"
          description: "List of pages, the max amount is 10"
          items:
            $ref: "#/definitions/PagesInfoReporting"
        schedules:
          type: "array"
          description: "List of schedules, the max amount is 5. Each 'View' may have several schedules for reporting. For example, customer may want to get daily and weekly reports with the same set of settings"
          items:
            $ref: "#/definitions/SchedulesInfoReporting"
    PagesInfoReporting:
      type: "object"
      required:
        - "name"
      properties:
        name:
          type: "string"
          description: "Name of a page. CFA application UI predefines a set of possible names and treats them as enum constants to distinguish pages by type. This is not user-visible value, as it might need localization. The maximum value is 255"
        attrX:
          type: "string"
          description: "CFA-defined filter values/page parameters"
    SchedulesInfoReporting:
      type: "object"
      properties:
        scheduleId:
          type: "string"
          description: "Unique schedule identifier"
        recurrence:
          type: "array"
          description: "Recurrence pattern of a schedule"
          items:
            $ref: "#/definitions/RecurrenceInfoReporting"
        viewType:
          type: "string"
          description: "Type of report. Detailed reports include tables with data. Simple reports only include charts"
          enum:
            - "Detailed"
            - "Simple"
        attachments:
          type: "array"
          description: "Set of optional attachments. Basically, every report email is in HTML format. Optionally, it can contain PDF or CSV files"
          items:
            $ref: "#/definitions/AttachmentInfoReporting"
        pages:
          type: "array"
          description: "List of pages to include to the report. If empty, all pages are included. Otherwise, only specified pages are included. API doesn't check validity of page names. Client application is responsible to do that"
          items:
            type: "string"
        recipients:
          type: "array"
          description: "List of emails to which to send rendered reports"
          items:
            type: "string"
    RecurrenceInfoReporting:
      type: "object"
      properties:
        pattern:
          type: "string"
          description: "Pattern (frequency) of recurrence"
          enum:
            - "Daily"
            - "Weekly"
            - "Monthly"
        value:
          type: "string"
          description: "Time and dates should be specified in UTC time zone"
          enum:
            - "0"
            - "1-7"
            - "1-31"
            - "last"
    AttachmentInfoReporting:
      type: "object"
      properties:
        csv:
          type: "boolean"
          description: "Specifies whether to include CSV version of the report"
        pdf:
          type: "boolean"
          description: "Specifies whether to include PDF version of the report"
    GetRingOutStatusResponse:
      type: "object"
      properties:
        id:
          type: "string"
          description: "Internal identifier of a RingOut call"
        uri:
          type: "string"
        status:
          description: "RingOut status information"
          $ref: "#/definitions/RingOutStatusInfo"
    GetRingOutStatusResponseIntId:
      type: "object"
      properties:
        id:
          type: "integer"
          format: "int64"
          description: "Internal identifier of a RingOut call"
        uri:
          type: "string"
        status:
          description: "RingOut status information"
          $ref: "#/definitions/RingOutStatusInfo"
    RingOutStatusInfo:
      type: "object"
      properties:
        callStatus:
          type: "string"
          description: "Status of a call"
          enum:
            - "Invalid"
            - "Success"
            - "InProgress"
            - "Busy"
            - "NoAnswer"
            - "Rejected"
            - "GenericError"
            - "Finished"
            - "InternationalDisabled"
            - "DestinationBlocked"
            - "NotEnoughFunds"
            - "NoSuchUser"
        callerStatus:
          type: "string"
          description: "Status of a calling party"
          enum:
            - "Invalid"
            - "Success"
            - "InProgress"
            - "Busy"
            - "NoAnswer"
            - "Rejected"
            - "GenericError"
            - "Finished"
            - "InternationalDisabled"
            - "DestinationBlocked"
            - "NotEnoughFunds"
            - "NoSuchUser"
        calleeStatus:
          type: "string"
          description: "Status of a called party"
          enum:
            - "Invalid"
            - "Success"
            - "InProgress"
            - "Busy"
            - "NoAnswer"
            - "Rejected"
            - "GenericError"
            - "Finished"
            - "InternationalDisabled"
            - "DestinationBlocked"
            - "NotEnoughFunds"
            - "NoSuchUser"
    ClientApiResponse:
      type: "object"
      required:
        - "client"
        - "provisioning"
      properties:
        client:
          description: "Client application information"
          $ref: "#/definitions/ClientApplicationInfo"
        provisioning:
          description: "Provisioning parameters. Available for the  detected  applications only"
          $ref: "#/definitions/ClientProvisioningInfo"
    ClientApplicationInfo:
      type: "object"
      required:
        - "detected"
      properties:
        detected:
          type: "boolean"
          description: "'True', if the server succeeded detecting application info, sufficient to return provisioning info"
        userAgent:
          type: "string"
          description: "The value of 'User-Agent' header, as it was passed in request"
        appId:
          type: "string"
          description: "Application identifier (from authorization session)"
        appName:
          type: "string"
          description: "Application name (from authorization session, but must match 'User-Agent')"
        appVersion:
          type: "string"
          description: "Application version (parsed from 'User-Agent')"
        appPlatform:
          type: "string"
          description: "Application platform operation system (parsed from 'User-Agent': Windows, MacOS, Android, iOS"
        appPlatformVersion:
          type: "string"
          description: "Application platform operation system version (parsed from 'User-Agent')"
        locale:
          type: "string"
          description: "Locale, parsed from 'Accept-Language'. Currently en-GB and en-US locales are supported. The default value is en-US"
    ClientProvisioningInfo:
      type: "object"
      required:
        - "hints"
        - "webUris"
      properties:
        webUris:
          description: "Links to the mobile web and Service Web resources"
          $ref: "#/definitions/ClientProvisioningWebUriInfo"
        hints:
          description: "Informs client application on the required user action"
          $ref: "#/definitions/ClientProvisioningHintsInfo"
    ClientProvisioningWebUriInfo:
      type: "object"
      properties:
        appDownload:
          type: "string"
          description: "Link to web page with the application description. Returned if the application needs to be updated, together with the appVersionUpgrade hint"
        appDownloadFile:
          type: "string"
          description: "Link to the application distributive package. Returned if the application needs to be updated, together with the appVersionUpgrade hint"
        expressSetupMobile:
          type: "string"
          description: "Link to express setup page (mobile application)"
        meetingsAppDownload:
          type: "string"
          description: "Link to the RC Meetings application distributive package"
        mobileWebBilling:
          type: "string"
          description: "Link to billing page (mobile application)"
        mobileWebCallHandling:
          type: "string"
          description: "Link to call handling page (mobile application)"
        mobileWebInternationalCalling:
          type: "string"
          description: "Link to international calling page (mobile application)"
        mobileWebNotifications:
          type: "string"
          description: "Link to notifications page (mobile application)"
        mobileWebPhoneSystem:
          type: "string"
          description: "Link to phone system settings page (mobile application)"
        mobileWebReporting:
          type: "string"
          description: "Link to reports page (mobile application)"
        mobileWebResetPassword:
          type: "string"
          description: "Link to reset password page (mobile application)"
        mobileWebTellAFriend:
          type: "string"
          description: "Link to  Tell A Friend  page (mobile application)"
        mobileWebTrialUpgrade:
          type: "string"
          description: "Link to upgrade trial account (mobile application)"
        mobileWebUserSettings:
          type: "string"
          description: "Link to user settings page (mobile application)"
        serviceWebBilling:
          type: "string"
          description: "Link to billing page (web application)"
        serviceWebHome:
          type: "string"
          description: "Link to home page (web application)"
        serviceWebPhoneSystem:
          type: "string"
          description: "Link to phone system settings page (web application)"
        serviceWebResetPassword:
          type: "string"
          description: "Link to reset password page (web application)"
        serviceWebTellAFriend:
          type: "string"
          description: "Link to  Tell A Friend  page (web application)"
        serviceWebUserSettings:
          type: "string"
          description: "Link to user settings page (web application)"
        signUp:
          type: "string"
          description: "Link to sign up page (web application)"
        support:
          type: "string"
          description: "Link to support page (web application)"
    ClientProvisioningHintsInfo:
      type: "object"
      properties:
        trialState:
          description: "Trial account expiration. Returned for trial accounts only"
          $ref: "#/definitions/ClientProvisioningHintInfo"
        userCredentialState:
          description: "User credentials expiration"
          $ref: "#/definitions/ClientProvisioningHintInfo"
        appVersionUpgrade:
          description: "Application version update. Returned only if the client current version is older than the latest version. 'actionRequired': 'true' means the application requires force updating to the latest version"
          $ref: "#/definitions/ClientProvisioningHintInfo"
    ClientProvisioningHintInfo:
      type: "object"
      properties:
        expiresIn:
          type: "integer"
          description: "Seconds until expiration date. Returned only if applicable"
        actionRequired:
          type: "boolean"
          description: "'False', if the value of expiresIn is greater than 0 (zero), otherwise - 'True'"
    CustomDataApiResponse:
      type: "object"
      required:
        - "id"
        - "lastModifiedTime"
        - "uri"
      properties:
        id:
          type: "string"
          description: "Custom data access key"
        uri:
          type: "string"
          description: "Link to the custom data"
        value:
          type: "string"
          description: "Description of custom data"
        lastModifiedTime:
          type: "string"
          description: "Time of the last change in custom data"
        attachment:
          description: "Attachment data: link and type"
          $ref: "#/definitions/CustomDataAttachmentInfo"
    CustomDataAttachmentInfo:
      type: "object"
      required:
        - "contentType"
        - "uri"
      properties:
        uri:
          type: "string"
          description: "Link to custom data attachment"
        contentType:
          type: "string"
          description: "Type of custom data attachment, see also MIME Types"
    CreateSipRegistrationResponse:
      type: "object"
      required:
        - "sipFlags"
        - "sipInfo"
      properties:
        sipInfo:
          type: "array"
          description: "SIP settings for device"
          items:
            $ref: "#/definitions/SIPInfoResponse"
        sipFlags:
          type: "array"
          description: "SIP flags data"
          items:
            $ref: "#/definitions/SIPFlagsRespones"
    SIPFlagsRespones:
      type: "object"
      properties:
        voipFeatureEnabled:
          type: "string"
          description: "If 'True' VoIP calling feature is enabled"
          enum:
            - "True"
            - "False"
        voipCountryBlocked:
          type: "string"
          description: "If 'True' the request is sent from IP address of a country blocked for VoIP calling"
          enum:
            - "True"
            - "False"
        outboundCallsEnabled:
          type: "string"
          description: "If 'True' outbound calls are enabled"
          enum:
            - "True"
            - "False"
    SIPInfoResponse:
      type: "object"
      properties:
        username:
          type: "string"
          description: "User credentials"
        password:
          type: "string"
          description: "User password"
        authorizationId:
          type: "string"
          description: "Identifier for SIP authorization"
        domain:
          type: "string"
          description: "SIP domain"
        outboundProxy:
          type: "string"
          description: "SIP outbound proxy"
        transport:
          type: "string"
          description: "Preferred transport. SIP info will be returned for this transport if supported"
          enum:
            - "UDP"
            - "TCP"
            - "TLS"
            - "WS"
            - "WSS"
        certificate:
          type: "string"
          description: "For TLS transport only Base64 encoded certificate"
    ExtensionInfoSIP:
      type: "object"
      properties:
        id:
          type: "string"
          description: "Internal identifier of an extension"
        uri:
          type: "string"
          description: "Canonical URI of an extension"
        extensionNumber:
          type: "string"
          description: "Extension number"
    SpecialNumberInfo:
      type: "object"
      required:
        - "features"
      properties:
        phoneNumber:
          type: "string"
          description: "Service phone number in N11 code format"
        description:
          type: "string"
          description: "Description of a special number"
        features:
          description: "Information on options allowed/disallowed for the special number"
          $ref: "#/definitions/SpecialNumberFeaturesInfo"
    SpecialNumberFeaturesInfo:
      type: "object"
      properties:
        voip:
          description: "VoIP call"
          $ref: "#/definitions/OptionInfo"
        ringOut:
          description: "RingOut call"
          $ref: "#/definitions/OptionInfo"
        sms:
          description: "Outgoing SMS"
          $ref: "#/definitions/OptionInfo"
        faxOut:
          description: "Outgoing Fax"
          $ref: "#/definitions/OptionInfo"
    OptionInfo:
      type: "object"
      required:
        - "reason"
      properties:
        enabled:
          type: "boolean"
          description: "Specifies if the feature is allowed ('True') or disallowed ('False') for the special number"
        reason:
          description: "The reason explaining why the option is disallowed. Returned if the value of enabled is 'False'"
          $ref: "#/definitions/OptionInfoReason"
    OptionInfoReason:
      type: "object"
      properties:
        id:
          type: "string"
          description: "Internal code of the option disallowance reason"
        message:
          type: "string"
          description: "Text description of the option disallowance reason"
    GetCountryListResponse:
      type: "object"
      required:
        - "navigation"
        - "paging"
        - "records"
      properties:
        records:
          type: "array"
          description: "List of countries with the country data"
          items:
            $ref: "#/definitions/GetCountryInfoDictionaryResponse"
        navigation:
          description: "Information on navigation"
          $ref: "#/definitions/NavigationInfo"
        paging:
          description: "Information on paging"
          $ref: "#/definitions/PagingInfo"
    GetCountryInfoDictionaryResponse:
      type: "object"
      properties:
        id:
          type: "string"
          description: "Internal identifier of a country"
        uri:
          type: "string"
          description: "Canonical URI of a country"
        callingCode:
          type: "string"
          description: "Country calling code defined by ITU-T recommendations E.123 and E.164, see Calling Codes"
        emergencyCalling:
          type: "boolean"
          description: "Emergency calling feature availability/emergency address requirement indicator"
        isoCode:
          type: "string"
          description: "Country code according to the ISO standard, see ISO 3166"
        name:
          type: "string"
          description: "Official name of a country"
        numberSelling:
          type: "boolean"
          description: "Determines whether phone numbers are available for a country"
        loginAllowed:
          type: "boolean"
          description: "Specifies whether login with the phone numbers of this country is enabled or not"
        signupAllowed:
          type: "boolean"
          description: "Indicates whether signup/billing is allowed for a country"
        freeSoftphoneLine:
          type: "boolean"
          description: "Specifies if free phone line for softphone is available for a country or not"
    GetLocationListResponse:
      type: "object"
      required:
        - "navigation"
        - "paging"
      properties:
        records:
          type: "array"
          description: "List of locations"
          items:
            $ref: "#/definitions/LocationInfo"
        navigation:
          description: "Information on navigation"
          $ref: "#/definitions/NavigationInfo"
        paging:
          description: "Information on paging"
          $ref: "#/definitions/PagingInfo"
    LocationInfo:
      type: "object"
      properties:
        uri:
          type: "string"
          description: "Canonical URI of a location"
        areaCode:
          type: "string"
          description: "Area code of the location"
        city:
          type: "string"
          description: "Official name of the city, belonging to the certain state"
        npa:
          type: "string"
          description: "Area code of the location (3-digit usually), according to the NANP number format, that can be summarized as NPA-NXX-xxxx and covers Canada, the United States, parts of the Caribbean Sea, and some Atlantic and Pacific islands. See for details North American Numbering Plan"
        nxx:
          type: "string"
          description: "Central office code of the location, according to the NANP number format, that can be summarized as NPA-NXX-xxxx and covers Canada, the United States, parts of the Caribbean Sea, and some Atlantic and Pacific islands. See for details North American Numbering Plan"
        state:
          type: "string"
          description: "ID and URI of the state this location belongs to, see State Info"
    GetSecretQuestionListResponse:
      type: "object"
      properties:
        uri:
          type: "string"
          description: "Canonical URI of a question list resource"
        records:
          type: "array"
          description: "List of secret questions with their descriptions"
          items:
            $ref: "#/definitions/SecretQuestionInfo"
        navigation:
          description: "Information on navigation"
          $ref: "#/definitions/NavigationInfo"
        paging:
          description: "Information on paging"
          $ref: "#/definitions/PagingInfo"
    SecretQuestionInfo:
      type: "object"
      properties:
        id:
          type: "string"
          description: "Internal identifier of a question"
        questionType:
          type: "integer"
          description: "Internal identifier of a question type"
        languageId:
          type: "string"
          description: "Internal identifier of a question language"
        questionText:
          type: "string"
          description: "Text of a secret question shown to the end user"
        showInSignUp:
          type: "boolean"
          description: "Specifies if the question is used during signup"
    GetStateListResponse:
      type: "object"
      required:
        - "navigation"
        - "paging"
        - "records"
      properties:
        records:
          type: "array"
          description: "List of states"
          items:
            $ref: "#/definitions/GetStateInfoResponse"
        navigation:
          description: "Information on navigation"
          $ref: "#/definitions/NavigationInfo"
        paging:
          description: "Information on paging"
          $ref: "#/definitions/PagingInfo"
    GetStateInfoResponse:
      type: "object"
      properties:
        id:
          type: "string"
          description: "Internal identifier of a state"
        uri:
          type: "string"
          description: "Canonical URI of a state"
        country:
          description: "Information on a country the state belongs to"
          $ref: "#/definitions/GetCountryInfoState"
        isoCode:
          type: "string"
          description: "Short code for a state (2-letter usually)"
        name:
          type: "string"
          description: "Official name of a state"
    GetCountryInfoState:
      type: "object"
      properties:
        id:
          type: "string"
          description: "Internal identifier of a state"
        uri:
          type: "string"
          description: "Canonical URI of a state"
    GetTimezoneListResponse:
      type: "object"
      required:
        - "navigation"
        - "paging"
        - "records"
      properties:
        records:
          type: "array"
          description: "List of timezones"
          items:
            $ref: "#/definitions/GetTimezoneInfoResponse"
        navigation:
          description: "Information on navigation"
          $ref: "#/definitions/NavigationInfo"
        paging:
          description: "Information on paging"
          $ref: "#/definitions/PagingInfo"
    GetTimezoneInfoResponse:
      type: "object"
      properties:
        id:
          type: "string"
          description: "Internal identifier of a timezone"
        uri:
          type: "string"
          description: "Canonical URI of the timezone"
        name:
          type: "string"
          description: "Short name of the timezone"
        description:
          type: "string"
          description: "Description of the timezone"
    ParsePhoneNumberResponse:
      type: "object"
      required:
        - "homeCountry"
        - "phoneNumbers"
      properties:
        uri:
          type: "string"
          description: "Canonical URI of a resource"
        homeCountry:
          type: "array"
          description: "Information on a user home country"
          items:
            $ref: "#/definitions/GetCountryInfoNumberParser"
        phoneNumbers:
          type: "array"
          description: "Parsed phone numbers data"
          items:
            $ref: "#/definitions/PhoneNumberInfoNumberParser"
        originalString:
          type: "string"
          description: "One of the numbers to be parsed, passed as a string in response"
        areaCode:
          type: "string"
          description: "Area code of the location (3-digit usually), according to the NANP number format, that can be summarized as NPA-NXX-xxxx and covers Canada, the United States, parts of the Caribbean Sea, and some Atlantic and Pacific islands. See North American Numbering Plan for details"
        formattedNational:
          type: "string"
          description: "Domestic format of a phone number"
        formattedInternational:
          type: "string"
          description: "International format of a phone number"
        dialable:
          type: "string"
          description: "Dialing format of a phone number"
        e164:
          type: "string"
          description: "E.164 (11-digits) format of a phone number"
        special:
          type: "boolean"
          description: " True  if the number is in a special format (for example N11 code)"
        normalized:
          type: "string"
          description: "E.164 (11-digits) format of a phone number without the plus sign ('+')"
        country:
          type: "array"
          description: "Information on a country the phone number belongs to"
          items:
            $ref: "#/definitions/GetCountryInfoNumberParser"
    GetCountryInfoNumberParser:
      type: "object"
      properties:
        id:
          type: "string"
          description: "Internal identifier of a country"
        uri:
          type: "string"
          description: "Canonical URI of a country"
        callingCode:
          type: "string"
          description: "Country calling code defined by ITU-T recommendations E.123 and E.164, see Calling Codes"
        emergencyCalling:
          type: "boolean"
          description: "Emergency calling feature availability/emergency address requirement indicator"
        isoCode:
          type: "string"
          description: "Country code according to the ISO standard, see ISO 3166"
        name:
          type: "string"
          description: "Official name of a country"
    PhoneNumberInfoNumberParser:
      type: "object"
      properties:
        areaCode:
          type: "string"
          description: "Area code of the location (3-digit usually), according to the NANP number format, that can be summarized as NPA-NXX-xxxx and covers Canada, the United States, parts of the Caribbean Sea, and some Atlantic and Pacific islands. See North American Numbering Plan for details"
        country:
          type: "array"
          description: "Information on a country the phone number belongs to"
          items:
            $ref: "#/definitions/GetCountryInfoNumberParser"
        dialable:
          type: "string"
          description: "Dialing format of a phone number"
        e164:
          type: "string"
          description: "E.164 (11-digits) format of a phone number"
        formattedInternational:
          type: "string"
          description: "International format of a phone number"
        formattedNational:
          type: "string"
          description: "Domestic format of a phone number"
        originalString:
          type: "string"
          description: "One of the numbers to be parsed, passed as a string in response"
        special:
          type: "boolean"
          description: " True  if the number is in a special format (for example N11 code)"
        normalized:
          type: "string"
          description: "E.164 (11-digits) format of a phone number without the plus sign ('+')"
    SubscriptionInfo:
      type: "object"
      required:
        - "deliveryMode"
      properties:
        id:
          type: "string"
          description: "Internal identifier of a subscription"
        uri:
          type: "string"
          description: "Canonical URI of a subscription"
        eventFilters:
          type: "array"
          description: "Collection of URIs to API resources (message-store/presence/detailed presence)"
          items:
            type: "string"
        expirationTime:
          type: "string"
          format: "date-time"
          description: "Subscription expiration datetime in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z"
        expiresIn:
          type: "integer"
          description: "Subscription lifetime in seconds. The default value is 900"
        status:
          type: "string"
          description: "Subscription status"
          enum:
            - "Active"
            - "Suspended"
        creationTime:
          type: "string"
          format: "date-time"
          description: "Subscription creation datetime in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z"
        deliveryMode:
          description: "Delivery mode data"
          $ref: "#/definitions/NotificationDeliveryMode"
    NotificationDeliveryMode:
      type: "object"
      properties:
        transportType:
          type: "string"
          description: "Notifications transportation provider name. 'APNS' (Apple Push Notifications Service)"
          enum:
            - "PubNub"
            - "APNS"
            - "PubNub/APNS/VoIP"
        encryption:
          type: "boolean"
          description: "Optional parameter. Specifies if the message will be encrypted or not. For APNS transport type the value is always  false"
        address:
          type: "string"
          description: "PubNub channel name. For APNS transport type - internal identifier of a device  device_token"
        subscriberKey:
          type: "string"
          description: "PubNub subscriber credentials required to subscribe to the channel"
        secretKey:
          type: "string"
          description: "PubNub subscriber credentials required to subscribe to the channel. Optional (for PubNub transport type only)"
        encryptionAlgorithm:
          type: "string"
          description: "Encryption algorithm 'AES' (for PubNub transport type only)"
        encryptionKey:
          type: "string"
          description: "Key for notification message decryption (for PubNub transport type only)"
    GroupsCollection:
      type: "object"
      properties:
        uri:
          type: "string"
          format: "uri"
        records:
          type: "array"
          items:
            $ref: "#/definitions/GroupResource"
        paging:
          $ref: "#/definitions/Paging"
        navigation:
          $ref: "#/definitions/Navigation"
    NavigableCollectionResourceExtensionIdResource:
      type: "object"
      properties:
        uri:
          type: "string"
          format: "uri"
        records:
          type: "array"
          items:
            $ref: "#/definitions/ExtensionIdResource"
        paging:
          $ref: "#/definitions/Paging"
        navigation:
          $ref: "#/definitions/Navigation"
    RingOutPhoneNumberInfo:
      type: "object"
      properties:
        phoneNumber:
          type: "string"
    UnconditionalForwardingResource:
      type: "object"
      properties:
        phoneNumber:
          type: "string"
    CountriesResource:
      type: "object"
      properties:
        uri:
          type: "string"
          format: "uri"
        records:
          type: "array"
          items:
            $ref: "#/definitions/CountryResource"
        paging:
          $ref: "#/definitions/Paging"
        navigation:
          $ref: "#/definitions/Navigation"
    Feature:
      type: "object"
      properties:
        enabled:
          type: "boolean"
          default: false
        reason:
          $ref: "#/definitions/Reason"
    HintResource:
      type: "object"
      properties:
        expiresIn:
          type: "integer"
          format: "int64"
        actionRequired:
          type: "boolean"
          default: false
        messageUri:
          type: "string"
    ConferencingInfoResource:
      type: "object"
      properties:
        uri:
          type: "string"
          format: "uri"
        phoneNumber:
          type: "string"
        hostCode:
          type: "string"
        participantCode:
          type: "string"
        allowJoinBeforeHost:
          type: "boolean"
          default: false
        tapToJoinUri:
          type: "string"
        supportUri:
          type: "string"
        mode:
          type: "string"
          enum:
            - "FCC"
            - "RCC"
        phoneNumbers:
          type: "array"
          items:
            $ref: "#/definitions/ConferencingNumberResource"
    ErrorEntity:
      type: "object"
      properties:
        errorCode:
          type: "string"
        message:
          type: "string"
    SyncInfo:
      type: "object"
      properties:
        syncType:
          type: "string"
          enum:
            - "FSync"
            - "ISync"
        syncToken:
          type: "string"
        syncTime:
          type: "string"
          format: "date-time"
        olderRecordsExist:
          type: "boolean"
          default: false
    Currency:
      type: "object"
      properties:
        id:
          type: "string"
        code:
          type: "string"
        name:
          type: "string"
        symbol:
          type: "string"
        minorSymbol:
          type: "string"
    Permission:
      type: "object"
      properties:
        enabled:
          type: "boolean"
          default: false
    MediaType:
      type: "object"
      properties:
        type:
          type: "string"
        subtype:
          type: "string"
        wildcardType:
          type: "boolean"
          default: false
        wildcardSubtype:
          type: "boolean"
          default: false
    Cookie:
      type: "object"
      properties:
        name:
          type: "string"
        value:
          type: "string"
        version:
          type: "integer"
          format: "int32"
        path:
          type: "string"
        domain:
          type: "string"
    SyncMessages:
      type: "object"
      properties:
        uri:
          type: "string"
          format: "uri"
        records:
          type: "array"
          items:
            $ref: "#/definitions/MessageInfoResource"
        syncInfo:
          $ref: "#/definitions/SyncInfo"
    DeviceModelExtsResource:
      type: "object"
      properties:
        uri:
          type: "string"
          format: "uri"
          description: "Canonical URI of a device"
        records:
          type: "array"
          description: "Devices data"
          items:
            $ref: "#/definitions/DeviceModelExtResource"
    ExtensionGrantsResource:
      type: "object"
      properties:
        uri:
          type: "string"
          format: "uri"
        records:
          type: "array"
          items:
            $ref: "#/definitions/ExtensionGrantResource"
        paging:
          $ref: "#/definitions/Paging"
        navigation:
          $ref: "#/definitions/Navigation"
    ServiceFeatureValue:
      type: "object"
      properties:
        featureName:
          type: "string"
        enabled:
          type: "boolean"
          default: false
        reason:
          type: "string"
          enum:
            - "Available"
            - "AccountTypeLimitation"
            - "ExtensionTypeLimitation"
            - "AccountLimitation"
            - "ExtensionLimitation"
            - "InsufficientPermissions"
            - "ApplicationLimitation"
    RegionalSettingsResource:
      type: "object"
      properties:
        timezone:
          $ref: "#/definitions/TimezoneResource"
        homeCountry:
          $ref: "#/definitions/CountryResource"
        language:
          $ref: "#/definitions/LanguageResource"
        greetingLanguage:
          $ref: "#/definitions/LanguageResource"
        formattingLocale:
          $ref: "#/definitions/LanguageResource"
    UriTemplate:
      type: "object"
      properties:
        template:
          type: "string"
        pattern:
          $ref: "#/definitions/PatternWithGroups"
        templateVariables:
          type: "array"
          items:
            type: "string"
        numberOfExplicitRegexes:
          type: "integer"
          format: "int32"
        numberOfRegexGroups:
          type: "integer"
          format: "int32"
        numberOfExplicitCharacters:
          type: "integer"
          format: "int32"
        numberOfTemplateVariables:
          type: "integer"
          format: "int32"
    GroupResource:
      type: "object"
      properties:
        uri:
          type: "string"
          format: "uri"
        contacts:
          $ref: "#/definitions/ResourceLink"
        id:
          type: "string"
        notes:
          type: "string"
        groupName:
          type: "string"
        contactsCount:
          type: "integer"
          format: "int32"
    TranscriptionResult:
      type: "object"
      properties:
        STTId:
          type: "string"
        ExternalId:
          type: "string"
        Status:
          type: "integer"
          format: "int32"
        Mailbox:
          type: "string"
        TranscriptionText:
          type: "string"
        Message:
          type: "string"
        MessageLength:
          type: "string"
        Confidence:
          type: "string"
    CallLogRecordingResource:
      type: "object"
      properties:
        uri:
          type: "string"
          format: "uri"
        id:
          type: "string"
        type:
          type: "string"
        contentUri:
          type: "string"
    ParameterizedHeader:
      type: "object"
      properties:
        value:
          type: "string"
    SessionResource:
      type: "object"
      properties:
        uri:
          type: "string"
          format: "uri"
        id:
          type: "string"
        accountId:
          type: "string"
        extensionId:
          type: "string"
        creationTime:
          type: "string"
          format: "date-time"
        clientId:
          type: "string"
        application:
          $ref: "#/definitions/ApplicationResource"
    MonitoringExtensionResource:
      type: "object"
      properties:
        uri:
          type: "string"
          format: "uri"
        id:
          type: "string"
        extensionNumber:
          type: "string"
    AssignedRolesResource:
      type: "object"
      properties:
        uri:
          type: "string"
          format: "uri"
        records:
          type: "array"
          items:
            $ref: "#/definitions/AssignedRoleResource"
    VersioningResource:
      type: "object"
      properties:
        uri:
          type: "string"
          format: "uri"
        resourceDescription:
          type: "string"
        id:
          type: "string"
        ver:
          $ref: "#/definitions/ApiVersionResource"
    AccountBusinessAddressResource:
      type: "object"
      properties:
        uri:
          type: "string"
          format: "uri"
        businessAddress:
          $ref: "#/definitions/ContactAddressInfo"
        company:
          type: "string"
        email:
          type: "string"
    PersonalContactResource:
      type: "object"
      properties:
        uri:
          type: "string"
          format: "uri"
        availability:
          type: "string"
          enum:
            - "Alive"
            - "Deleted"
            - "Purged"
        id:
          type: "string"
        firstName:
          type: "string"
        lastName:
          type: "string"
        middleName:
          type: "string"
        birthday:
          type: "string"
          format: "date-time"
        notes:
          type: "string"
        webPage:
          type: "string"
        company:
          type: "string"
        jobTitle:
          type: "string"
        nickName:
          type: "string"
        email:
          type: "string"
        email2:
          type: "string"
        email3:
          type: "string"
        homeAddress:
          $ref: "#/definitions/ContactAddressInfo"
        otherAddress:
          $ref: "#/definitions/ContactAddressInfo"
        homePhone:
          type: "string"
        homePhone2:
          type: "string"
        mobilePhone:
          type: "string"
        businessPhone:
          type: "string"
        callbackPhone:
          type: "string"
        carPhone:
          type: "string"
        companyPhone:
          type: "string"
        otherPhone:
          type: "string"
        businessFax:
          type: "string"
        otherFax:
          type: "string"
        businessAddress:
          $ref: "#/definitions/ContactAddressInfo"
        assistantPhone:
          type: "string"
        businessPhone2:
          type: "string"
    IncomingCallInformationResource:
      type: "object"
      properties:
        uri:
          type: "string"
          format: "uri"
        announcementWhenDirectCalls:
          type: "string"
          enum:
            - "Never"
            - "Always"
            - "NonRingCentral"
        announcementWhenDepartmentCalls:
          type: "string"
          enum:
            - "Always"
            - "NonRingCentral"
    AddressFormResource:
      type: "object"
      properties:
        uri:
          type: "string"
          format: "uri"
        records:
          type: "array"
          items:
            $ref: "#/definitions/AddressFormCountryResource"
    PathPattern:
      type: "object"
      properties:
        regex:
          type: "string"
        groupIndexes:
          type: "array"
          items:
            type: "integer"
            format: "int32"
        template:
          $ref: "#/definitions/UriTemplate"
    FaxResendInfo:
      type: "object"
      required:
        - "originalMessageId"
      properties:
        originalMessageId:
          type: "integer"
          format: "int64"
        sendTime:
          type: "string"
          format: "date-time"
        to:
          type: "array"
          items:
            $ref: "#/definitions/CallerInfo"
    FormFieldResource:
      type: "object"
      properties:
        name:
          type: "string"
        fieldType:
          type: "string"
        description:
          type: "string"
        maxLength:
          type: "integer"
          format: "int32"
    HintsResource:
      type: "object"
      properties:
        userCredentialState:
          $ref: "#/definitions/HintResource"
        trialState:
          $ref: "#/definitions/HintResource"
        appVersionUpgrade:
          $ref: "#/definitions/HintResource"
    NewCookie:
      type: "object"
      properties:
        name:
          type: "string"
        value:
          type: "string"
        version:
          type: "integer"
          format: "int32"
        path:
          type: "string"
        domain:
          type: "string"
        comment:
          type: "string"
        maxAge:
          type: "integer"
          format: "int32"
        expiry:
          type: "string"
          format: "date-time"
        secure:
          type: "boolean"
          default: false
        httpOnly:
          type: "boolean"
          default: false
    AdminNoticeResource:
      type: "object"
      properties:
        subjectCode:
          type: "string"
        message:
          type: "string"
    PhoneNumberResource:
      type: "object"
      properties:
        id:
          type: "string"
          description: "Internal identifier of a phone number"
        country:
          description: "Brief information on a phone number country"
          $ref: "#/definitions/CountryResource"
        extension:
          description: "Information on an extension to which the phone number is assigned"
          $ref: "#/definitions/ExtensionResource"
        label:
          type: "string"
          description: "Custom user name of a phone number, if any. Supported for numbers assigned to Auto-Receptionist, with usage type 'CompanyNumber'"
        location:
          type: "string"
          description: "Location (City, State). Filled for local US numbers"
        paymentType:
          type: "string"
          description: "Payment type. 'External' is returned for forwarded numbers which are not terminated in the RingCentral phone system = ['External', 'TollFree', 'Local'],"
          enum:
            - "External"
            - "TollFree"
            - "Local"
        phoneNumber:
          type: "string"
          description: "Phone number"
          minLength: 0
          maxLength: 128
        status:
          type: "string"
          description: "Status of a phone number. If the value is 'Normal', the phone number is ready to be used. Otherwise it is an external number not yet ported to RingCentral ,"
        usageType:
          type: "string"
          enum:
            - "CompanyNumber"
            - "MainCompanyNumber"
            - "AdditionalCompanyNumber"
            - "DirectNumber"
            - "CompanyFaxNumber"
            - "ForwardedNumber"
            - "ForwardedCompanyNumber"
            - "ContactCenterNumber"
        type:
          type: "string"
          description: "Type of a phone number"
          enum:
            - "VoiceFax"
            - "FaxOnly"
            - "VoiceOnly"
    PhoneNumberResourceIntId:
      type: "object"
      properties:
        id:
          type: "integer"
          format: "int64"
          description: "Internal identifier of a phone number"
        country:
          description: "Brief information on a phone number country"
          $ref: "#/definitions/CountryResource"
        extension:
          description: "Information on an extension to which the phone number is assigned"
          $ref: "#/definitions/ExtensionResource"
        label:
          type: "string"
          description: "Custom user name of a phone number, if any. Supported for numbers assigned to Auto-Receptionist, with usage type 'CompanyNumber'"
        location:
          type: "string"
          description: "Location (City, State). Filled for local US numbers"
        paymentType:
          type: "string"
          description: "Payment type. 'External' is returned for forwarded numbers which are not terminated in the RingCentral phone system = ['External', 'TollFree', 'Local'],"
          enum:
            - "External"
            - "TollFree"
            - "Local"
        phoneNumber:
          type: "string"
          description: "Phone number"
          minLength: 0
          maxLength: 128
        status:
          type: "string"
          description: "Status of a phone number. If the value is 'Normal', the phone number is ready to be used. Otherwise it is an external number not yet ported to RingCentral ,"
        usageType:
          type: "string"
          enum:
            - "CompanyNumber"
            - "MainCompanyNumber"
            - "AdditionalCompanyNumber"
            - "DirectNumber"
            - "CompanyFaxNumber"
            - "ForwardedNumber"
            - "ForwardedCompanyNumber"
            - "ContactCenterNumber"
        type:
          type: "string"
          description: "Type of a phone number"
          enum:
            - "VoiceFax"
            - "FaxOnly"
            - "VoiceOnly"
    TesterFlagsResource:
      type: "object"
      properties:
        tester:
          type: "boolean"
          default: false
        autoDelete:
          type: "boolean"
          default: false
        noBilling:
          type: "boolean"
          default: false
        noBillingLimit:
          type: "boolean"
          default: false
    AddressFormCountryResource:
      type: "object"
      properties:
        uri:
          type: "string"
          format: "uri"
        country:
          $ref: "#/definitions/CountryResource"
        attributes:
          type: "array"
          items:
            $ref: "#/definitions/FormFieldResource"
        emergencyNumber:
          type: "string"
        default:
          type: "boolean"
          default: false
    AccessValidationResource:
      type: "object"
      properties:
        uri:
          type: "string"
          format: "uri"
        applicationId:
          type: "string"
        endpointId:
          type: "string"
        sessionId:
          type: "string"
        credentialType:
          type: "string"
          enum:
            - "Password"
            - "IvrPin"
            - "ExternalSso"
            - "NativeId"
            - "ExternalId"
            - "None"
            - "AIToken"
        scope:
          type: "array"
          items:
            type: "string"
            enum:
              - "ReadMessages"
              - "SMS"
              - "InternalMessages"
              - "Faxes"
              - "ReadCallLog"
              - "EditCallLog"
              - "ReadContacts"
              - "Contacts"
              - "EditMessages"
              - "EditExtensions"
              - "ReadAccounts"
              - "EditAccounts"
              - "Accounts"
              - "ReadPresence"
              - "EditPresence"
              - "RingOut"
              - "DirectRingOut"
              - "ReadClientInfo"
              - "NumberLookup"
              - "EditCustomData"
              - "EditPaymentInfo"
              - "Interoperability"
              - "ReadCallRecording"
              - "EditReportingSettings"
              - "VoipCalling"
              - "Meetings"
              - "RoleManagement"
        accountId:
          type: "string"
        extensionId:
          type: "string"
        brandId:
          type: "string"
        tierId:
          type: "string"
    PresenceInfoResource:
      type: "object"
      properties:
        userStatus:
          type: "string"
          enum:
            - "Offline"
            - "Busy"
            - "Available"
        dndStatus:
          type: "string"
          enum:
            - "TakeAllCalls"
            - "DoNotAcceptDepartmentCalls"
            - "TakeDepartmentCallsOnly"
            - "DoNotAcceptAnyCalls"
            - "Unknown"
        message:
          type: "string"
          minLength: 0
          maxLength: 75
        allowSeeMyPresence:
          type: "boolean"
          default: false
        ringOnMonitoredCall:
          type: "boolean"
          default: false
        pickUpCallsOnHold:
          type: "boolean"
          default: false
        activeCalls:
          type: "array"
          items:
            $ref: "#/definitions/ActiveCallInfo"
    AccountLimitsResource:
      type: "object"
      properties:
        freeSoftPhoneLinesPerExtension:
          type: "integer"
          format: "int32"
        meetingSize:
          type: "integer"
          format: "int32"
        maxMonitoredExtensionsPerUser:
          type: "integer"
          format: "int32"
        maxFreeDigitalLines:
          type: "integer"
          format: "int32"
    CfaSettingsResource:
      type: "object"
      properties:
        views:
          type: "array"
          items:
            $ref: "#/definitions/CfaView"
    UserGroupBulkAssignResource:
      type: "object"
      properties:
        items:
          type: "array"
          items:
            $ref: "#/definitions/BulkAssignItem"
    PermissionCategoryCollectionResource:
      type: "object"
      properties:
        uri:
          type: "string"
          format: "uri"
        records:
          type: "array"
          items:
            $ref: "#/definitions/PermissionCategoryResource"
        paging:
          $ref: "#/definitions/Paging"
        navigation:
          $ref: "#/definitions/Navigation"
    StatusInfo:
      type: "object"
      properties:
        reason:
          type: "string"
        till:
          type: "string"
          format: "date-time"
        comment:
          type: "string"
    SipFlags:
      type: "object"
      properties:
        voipFeatureEnabled:
          type: "boolean"
          default: false
        voipCountryBlocked:
          type: "boolean"
          default: false
        outboundCallsEnabled:
          type: "boolean"
          default: false
    PaymentInfoCardResource:
      type: "object"
      properties:
        cardType:
          type: "string"
        number:
          type: "string"
        securityCode:
          type: "string"
        expiry:
          type: "string"
        token:
          type: "string"
        holder:
          $ref: "#/definitions/PaymentInfoCardHolderResource"
    ExtensionPermissionsResource:
      type: "object"
      properties:
        uri:
          type: "string"
          format: "uri"
        admin:
          $ref: "#/definitions/Permission"
        internationalCalling:
          $ref: "#/definitions/Permission"
        freeSoftPhoneDigitalLine:
          $ref: "#/definitions/Permission"
    ClientInfoSpecialNumberResource:
      type: "object"
      properties:
        uri:
          type: "string"
          format: "uri"
        phoneNumber:
          type: "string"
        description:
          type: "string"
        features:
          $ref: "#/definitions/Features"
    CfaAttachments:
      type: "object"
      properties:
        csv:
          type: "boolean"
          default: false
        pdf:
          type: "boolean"
          default: false
    AddressBookResource:
      type: "object"
      properties:
        uri:
          type: "string"
          format: "uri"
        contacts:
          $ref: "#/definitions/ResourceLink"
        groups:
          $ref: "#/definitions/ResourceLink"
    ShippingMethod:
      type: "object"
      properties:
        id:
          type: "string"
          description: "Internal identifier of the shipping method"
        name:
          type: "string"
          description: "Name/description of the shipping method"
    DeviceOrderResource:
      type: "object"
      properties:
        accountId:
          type: "string"
        requestNumber:
          type: "string"
        distributorName:
          type: "string"
        trackingNumber:
          type: "string"
        shippingCarrier:
          type: "string"
        devices:
          type: "array"
          items:
            $ref: "#/definitions/DeviceInstance"
    CfaRecurrence:
      type: "object"
      properties:
        pattern:
          type: "string"
          enum:
            - "Daily"
            - "Weekly"
            - "Monthly"
        value:
          type: "string"
    InternalMessageResource:
      type: "object"
      properties:
        to:
          type: "array"
          items:
            $ref: "#/definitions/CallerInfo"
        from:
          $ref: "#/definitions/CallerInfo"
        text:
          type: "string"
        replyOn:
          type: "integer"
          format: "int64"
    OrderResource:
      type: "object"
      properties:
        id:
          type: "string"
        uri:
          type: "string"
          format: "uri"
        devices:
          type: "array"
          items:
            $ref: "#/definitions/DeviceResource"
    ParsedPhoneNumbersResource:
      type: "object"
      properties:
        uri:
          type: "string"
          format: "uri"
        homeCountry:
          $ref: "#/definitions/HomeCountryResource"
        phoneNumbers:
          type: "array"
          items:
            $ref: "#/definitions/ParsedNumberResource"
    PhoneLineResource:
      type: "object"
      properties:
        lineType:
          type: "string"
          enum:
            - "Unknown"
            - "Standalone"
            - "BlaPrimary"
            - "BlaSecondary"
            - "BLF"
            - "StandaloneFree"
        phoneInfo:
          $ref: "#/definitions/PhoneNumberResourceIntId"
        emergencyAddress:
          $ref: "#/definitions/EmergencyAddress"
    InlinedExtensionResource:
      type: "object"
      properties:
        uri:
          type: "string"
          format: "uri"
        extensionNumber:
          type: "string"
        id:
          type: "string"
        type:
          type: "string"
          enum:
            - "Unknown"
            - "User"
            - "Department"
            - "Announcement"
            - "Voicemail"
            - "DigitalUser"
            - "VirtualUser"
            - "FaxUser"
            - "PagingOnly"
            - "SharedLinesGroup"
            - "IvrMenu"
            - "ApplicationExtension"
            - "ParkLocation"
    EmailResource:
      type: "object"
      properties:
        accountId:
          type: "string"
        extensionId:
          type: "string"
        templateId:
          type: "string"
        recipients:
          type: "array"
          items:
            type: "string"
        files:
          type: "array"
          items:
            type: "string"
    AttachmentInfo:
      type: "object"
      properties:
        uri:
          type: "string"
          format: "uri"
        contentType:
          type: "string"
    AuthProfileResource:
      type: "object"
      properties:
        uri:
          type: "string"
          format: "uri"
        permissions:
          type: "array"
          items:
            $ref: "#/definitions/ActivePermissionResource"
    SaveRequestResource:
      type: "object"
      properties:
        rendererId:
          type: "string"
        messageId:
          type: "string"
        status:
          type: "string"
        resultFile:
          type: "string"
    ExtensionResource:
      type: "object"
      properties:
        uri:
          type: "string"
          format: "uri"
        id:
          type: "string"
        partnerId:
          type: "string"
          minLength: 0
          maxLength: 128
          pattern: "^[\\p{Alnum}\\.\\-_]*$"
        extensionNumber:
          type: "string"
        loginName:
          type: "string"
        contact:
          $ref: "#/definitions/ContactInfo"
        references:
          type: "array"
          items:
            $ref: "#/definitions/Reference"
        name:
          type: "string"
        type:
          type: "string"
          enum:
            - "Unknown"
            - "User"
            - "Department"
            - "Announcement"
            - "Voicemail"
            - "DigitalUser"
            - "VirtualUser"
            - "FaxUser"
            - "PagingOnly"
            - "SharedLinesGroup"
            - "IvrMenu"
            - "ApplicationExtension"
            - "ParkLocation"
        status:
          type: "string"
          enum:
            - "Enabled"
            - "Disabled"
            - "Frozen"
            - "NotActivated"
            - "Unassigned"
        statusInfo:
          $ref: "#/definitions/StatusInfo"
        departments:
          type: "array"
          items:
            $ref: "#/definitions/DepartmentResource"
        serviceFeatures:
          type: "array"
          items:
            $ref: "#/definitions/ServiceFeatureValue"
        regionalSettings:
          $ref: "#/definitions/RegionalSettingsResource"
        setupWizardState:
          type: "string"
          enum:
            - "NotStarted"
            - "Incomplete"
            - "Completed"
            - "Unknown"
        permissions:
          $ref: "#/definitions/ExtensionPermissionsResource"
        password:
          type: "string"
        ivrPin:
          type: "string"
        profileImage:
          $ref: "#/definitions/ProfileImageResource"
    ExtensionResourceIntId:
      type: "object"
      properties:
        uri:
          type: "string"
          format: "uri"
        id:
          type: "integer"
          format: "int64"
        partnerId:
          type: "string"
          minLength: 0
          maxLength: 128
          pattern: "^[\\p{Alnum}\\.\\-_]*$"
        extensionNumber:
          type: "string"
        loginName:
          type: "string"
        contact:
          $ref: "#/definitions/ContactInfo"
        references:
          type: "array"
          items:
            $ref: "#/definitions/Reference"
        name:
          type: "string"
        type:
          type: "string"
          enum:
            - "Unknown"
            - "User"
            - "Department"
            - "Announcement"
            - "Voicemail"
            - "DigitalUser"
            - "VirtualUser"
            - "FaxUser"
            - "PagingOnly"
            - "SharedLinesGroup"
            - "IvrMenu"
            - "ApplicationExtension"
            - "ParkLocation"
        status:
          type: "string"
          enum:
            - "Enabled"
            - "Disabled"
            - "Frozen"
            - "NotActivated"
            - "Unassigned"
        statusInfo:
          $ref: "#/definitions/StatusInfo"
        departments:
          type: "array"
          items:
            $ref: "#/definitions/DepartmentResource"
        serviceFeatures:
          type: "array"
          items:
            $ref: "#/definitions/ServiceFeatureValue"
        regionalSettings:
          $ref: "#/definitions/RegionalSettingsResource"
        setupWizardState:
          type: "string"
          enum:
            - "NotStarted"
            - "Incomplete"
            - "Completed"
            - "Unknown"
        permissions:
          $ref: "#/definitions/ExtensionPermissionsResource"
        password:
          type: "string"
        ivrPin:
          type: "string"
        profileImage:
          $ref: "#/definitions/ProfileImageResource"
    ContactsCollection:
      type: "object"
      properties:
        uri:
          type: "string"
          format: "uri"
        records:
          type: "array"
          items:
            $ref: "#/definitions/PersonalContactResource"
        paging:
          $ref: "#/definitions/Paging"
        navigation:
          $ref: "#/definitions/Navigation"
        groups:
          $ref: "#/definitions/ResourceLink"
    SipInfo:
      type: "object"
      properties:
        transport:
          type: "string"
          enum:
            - "UDP"
            - "TCP"
            - "TLS"
            - "WS"
            - "WSS"
        certificate:
          type: "string"
        username:
          type: "string"
        password:
          type: "string"
        authorizationId:
          type: "string"
        domain:
          type: "string"
        outboundProxy:
          type: "string"
        wsProxy:
          type: "string"
    FavoriteCollection:
      type: "object"
      properties:
        uri:
          type: "string"
          format: "uri"
        records:
          type: "array"
          items:
            $ref: "#/definitions/FavoriteContactResource"
    BulkRoleAssignResource:
      type: "object"
      properties:
        uri:
          type: "string"
          format: "uri"
        addedExtensionIds:
          type: "array"
          items:
            type: "string"
        removedExtensionIds:
          type: "array"
          items:
            type: "string"
    SubscriptionResponse:
      type: "object"
      properties:
        uri:
          type: "string"
          format: "uri"
        id:
          type: "string"
        creationTime:
          type: "string"
          format: "date-time"
        status:
          type: "string"
        eventFilters:
          type: "array"
          items:
            type: "string"
        expirationTime:
          type: "string"
          format: "date-time"
        expiresIn:
          type: "integer"
          format: "int64"
        deliveryMode:
          description: "Delivery mode data"
          $ref: "#/definitions/DeliveryModeResource"
        blacklistedData:
          $ref: "#/definitions/NotificationBlacklistedData"
    NotificationBlacklistedData:
      description: "Returned if WebHook subscription is blacklisted"
      type: "object"
      properties:
        blacklistedAt:
          type: "string"
          format: "date-time"
          description: "Time of adding subscrition to a black list in (ISO 8601)[https://en.wikipedia.org/wiki/ISO_8601] format including timezone, for example *2016-03-10T18:07:52.534Z*"
        reason:
          type: "string"
          description: "Reason of adding subscrition to a black list"
    MeetingScheduleResource:
      type: "object"
      properties:
        startTime:
          type: "string"
        durationInMinutes:
          type: "integer"
          format: "int32"
        timeZone:
          $ref: "#/definitions/TimezoneResource"
    LocationsResource:
      type: "object"
      properties:
        uri:
          type: "string"
          format: "uri"
        records:
          type: "array"
          items:
            $ref: "#/definitions/LocationResource"
        paging:
          $ref: "#/definitions/Paging"
        navigation:
          $ref: "#/definitions/Navigation"
    TimezoneResource:
      type: "object"
      properties:
        uri:
          type: "string"
          format: "uri"
        id:
          type: "string"
        name:
          type: "string"
        description:
          type: "string"
    Brand:
      type: "object"
      properties:
        id:
          type: "string"
        name:
          type: "string"
        homeCountry:
          $ref: "#/definitions/HomeCountry"
    SipDetailsToRegister:
      type: "object"
      properties:
        transport:
          type: "string"
          enum:
            - "UDP"
            - "TCP"
            - "TLS"
            - "WS"
            - "WSS"
    RolesCollectionResource:
      type: "object"
      properties:
        uri:
          type: "string"
          format: "uri"
        records:
          type: "array"
          items:
            $ref: "#/definitions/RoleResource"
        paging:
          $ref: "#/definitions/Paging"
        navigation:
          $ref: "#/definitions/Navigation"
    TouchRequestResource:
      type: "object"
      properties:
        rendererId:
          type: "string"
        messageId:
          type: "string"
    ScheduleResource:
      type: "object"
      properties:
        ranges:
          type: "array"
          items:
            $ref: "#/definitions/DateTimeIntervalResource"
        ref:
          type: "string"
          enum:
            - "BusinessHours"
            - "AfterHours"
    RingOutResource:
      type: "object"
      properties:
        from:
          $ref: "#/definitions/RingOutFromInfo"
        to:
          $ref: "#/definitions/RingOutPhoneNumberInfo"
        callerId:
          $ref: "#/definitions/RingOutPhoneNumberInfo"
        playPrompt:
          type: "boolean"
          default: false
        country:
          $ref: "#/definitions/RingOutCountry"
    PhoneNumberForProvisioningResource:
      type: "object"
      properties:
        phoneNumber:
          type: "string"
        vanityPattern:
          type: "string"
        source:
          type: "string"
          enum:
            - "Internal"
            - "External"
        type:
          type: "string"
          enum:
            - "VoiceOnly"
            - "FaxOnly"
            - "VoiceFax"
        usageType:
          type: "string"
          enum:
            - "MainCompanyNumber"
            - "AdditionalCompanyNumber"
            - "CompanyFaxNumber"
            - "CompanyNumber"
            - "DirectNumber"
        extension:
          $ref: "#/definitions/ExtensionReferenceResource"
        reservationId:
          type: "string"
    ExtensionAssignmentResult:
      type: "object"
      properties:
        successful:
          type: "boolean"
          default: false
        extension:
          $ref: "#/definitions/ExtensionResource"
        error:
          $ref: "#/definitions/ErrorEntity"
    MethodResource:
      type: "object"
      properties:
        id:
          type: "string"
        name:
          type: "string"
    ApplicationInfoResource:
      type: "object"
      properties:
        clientId:
          type: "string"
        application:
          $ref: "#/definitions/ApplicationResource"
    VoicemailSettingsResource:
      type: "object"
      properties:
        enabled:
          type: "boolean"
          default: false
        recipient:
          $ref: "#/definitions/ExtensionResource"
    HomeCountryResource:
      type: "object"
      properties:
        uri:
          type: "string"
          format: "uri"
        id:
          type: "string"
        name:
          type: "string"
        isoCode:
          type: "string"
        callingCode:
          type: "string"
    LanguageInfoResource:
      type: "object"
      properties:
        uri:
          type: "string"
          format: "uri"
        id:
          type: "string"
        name:
          type: "string"
        isoCode:
          type: "string"
        localeCode:
          type: "string"
        ui:
          type: "boolean"
          default: false
        greeting:
          type: "boolean"
          default: false
        formattingLocale:
          type: "boolean"
          default: false
    Extensions:
      type: "object"
      properties:
        uri:
          type: "string"
          format: "uri"
        records:
          type: "array"
          items:
            $ref: "#/definitions/ExtensionResource"
        paging:
          $ref: "#/definitions/Paging"
        navigation:
          $ref: "#/definitions/Navigation"
    ScaledProfileImageResource:
      type: "object"
      properties:
        uri:
          type: "string"
          format: "uri"
    SimpleResource:
      type: "object"
      properties:
        uri:
          type: "string"
          format: "uri"
        resourceDescription:
          type: "string"
        id:
          type: "string"
        ver:
          $ref: "#/definitions/ApiVersionResource"
    Features:
      type: "object"
      properties:
        voip:
          $ref: "#/definitions/Feature"
        ringOut:
          $ref: "#/definitions/Feature"
        sms:
          $ref: "#/definitions/Feature"
        faxOut:
          $ref: "#/definitions/Feature"
    DateTimeIntervalResource:
      type: "object"
      properties:
        from:
          type: "string"
        to:
          type: "string"
    MatchingEntityTag:
      type: "object"
      properties:
        value:
          type: "string"
        weak:
          type: "boolean"
          default: false
    BlacklistEntriesResource:
      type: "object"
      properties:
        uri:
          type: "string"
          format: "uri"
        records:
          type: "array"
          items:
            $ref: "#/definitions/BlacklistEntryResource"
        paging:
          $ref: "#/definitions/Paging"
        navigation:
          $ref: "#/definitions/Navigation"
    TimezonesResource:
      type: "object"
      properties:
        uri:
          type: "string"
          format: "uri"
        records:
          type: "array"
          items:
            $ref: "#/definitions/TimezoneResource"
        paging:
          $ref: "#/definitions/Paging"
        navigation:
          $ref: "#/definitions/Navigation"
    DialInNumberResource:
      type: "object"
      properties:
        phoneNumber:
          type: "string"
        formattedNumber:
          type: "string"
        location:
          type: "string"
        country:
          $ref: "#/definitions/CountryResource"
    HomeCountry:
      type: "object"
      properties:
        id:
          type: "string"
        uri:
          type: "string"
          format: "uri"
        name:
          type: "string"
        isoCode:
          type: "string"
        callingCode:
          type: "string"
    PresenceLineResource:
      type: "object"
      properties:
        id:
          type: "string"
        extension:
          $ref: "#/definitions/InlinedExtensionResource"
    Request:
      type: "object"
      properties:
        method:
          type: "string"
    PutPresenceResource:
      type: "object"
      properties:
        userStatus:
          type: "string"
          enum:
            - "Offline"
            - "Busy"
            - "Available"
        message:
          type: "string"
          minLength: 0
          maxLength: 75
        dndStatus:
          type: "string"
          enum:
            - "TakeAllCalls"
            - "DoNotAcceptDepartmentCalls"
            - "TakeDepartmentCallsOnly"
            - "DoNotAcceptAnyCalls"
            - "Unknown"
        allowSeeMyPresence:
          type: "boolean"
          default: false
        ringOnMonitoredCall:
          type: "boolean"
          default: false
        pickUpCallsOnHold:
          type: "boolean"
          default: false
    BillingPlanResource:
      type: "object"
      properties:
        uri:
          type: "string"
          format: "uri"
        id:
          type: "string"
        name:
          type: "string"
        durationUnit:
          type: "string"
        duration:
          type: "integer"
          format: "int32"
        type:
          type: "string"
    PermissionCollectionResource:
      type: "object"
      properties:
        uri:
          type: "string"
          format: "uri"
        records:
          type: "array"
          items:
            $ref: "#/definitions/PermissionResource"
        paging:
          $ref: "#/definitions/Paging"
        navigation:
          $ref: "#/definitions/Navigation"
    BillingStatementResource:
      type: "object"
      properties:
        fees:
          type: "array"
          items:
            $ref: "#/definitions/FeeChargeResource"
        charges:
          type: "array"
          items:
            $ref: "#/definitions/FeeChargeResource"
        totalCharges:
          type: "number"
        totalFees:
          type: "number"
        subtotal:
          type: "number"
        currency:
          type: "string"
    MeetingExternalUserInfoResource:
      type: "object"
      properties:
        uri:
          type: "string"
          format: "uri"
        userId:
          type: "string"
        accountId:
          type: "string"
        userType:
          type: "integer"
          format: "int64"
        userToken:
          type: "string"
    FaxCallerInfo:
      type: "object"
      properties:
        phoneNumber:
          type: "string"
          description: "Recipient information. Phone number property is mandatory. Optional for resend fax request"
    CallerInfo:
      type: "object"
      properties:
        phoneNumber:
          type: "string"
        extensionNumber:
          type: "string"
        name:
          type: "string"
        location:
          type: "string"
        contact:
          $ref: "#/definitions/PersonalContactResource"
        messageStatus:
          type: "string"
          enum:
            - "Sent"
            - "SendingFailed"
            - "Queued"
        faxErrorCode:
          type: "string"
          enum:
            - "Undefined"
            - "NoFaxSendPermission"
            - "NoInternationalPermission"
            - "NoFaxMachine"
            - "OutgoingCallError"
            - "RenderingFailed"
            - "TooManyPages"
            - "ReturnToDBQueue"
            - "NoCallTime"
            - "WrongNumber"
            - "ProhibitedNumber"
            - "InternalError"
            - "FaxSendingProhibited"
            - "ThePhoneIsBlacklisted"
            - "UserNotFound"
            - "ConvertError"
            - "DBGeneralError"
            - "SkypeBillingFailed"
            - "AccountSuspended"
            - "ProhibitedDestination"
            - "InternationalDisabled"
    CallerInfoFrom:
      type: "object"
      properties:
        phoneNumber:
          type: "string"
        name:
          type: "string"
        location:
          type: "string"
    CallerInfoTo:
      type: "object"
      properties:
        phoneNumber:
          type: "string"
        name:
          type: "string"
        location:
          type: "string"
        messageStatus:
          type: "string"
          enum:
            - "Sent"
            - "SendingFailed"
            - "Queued"
        faxErrorCode:
          type: "string"
          enum:
            - "Undefined"
            - "NoFaxSendPermission"
            - "NoInternationalPermission"
            - "NoFaxMachine"
            - "OutgoingCallError"
            - "RenderingFailed"
            - "TooManyPages"
            - "ReturnToDBQueue"
            - "NoCallTime"
            - "WrongNumber"
            - "ProhibitedNumber"
            - "InternalError"
            - "FaxSendingProhibited"
            - "ThePhoneIsBlacklisted"
            - "UserNotFound"
            - "ConvertError"
            - "DBGeneralError"
            - "SkypeBillingFailed"
            - "AccountSuspended"
            - "ProhibitedDestination"
            - "InternationalDisabled"
    BulkAssignItem:
      type: "object"
      properties:
        departmentId:
          type: "string"
        addedExtensionIds:
          type: "array"
          items:
            type: "string"
        removedExtensionIds:
          type: "array"
          items:
            type: "string"
    StateResource:
      type: "object"
      properties:
        uri:
          type: "string"
          format: "uri"
        id:
          type: "string"
        name:
          type: "string"
        isoCode:
          type: "string"
        country:
          $ref: "#/definitions/VersionedResource"
    ContentDisposition:
      type: "object"
      properties:
        type:
          type: "string"
        fileName:
          type: "string"
        creationDate:
          type: "string"
          format: "date-time"
        modificationDate:
          type: "string"
          format: "date-time"
        readDate:
          type: "string"
          format: "date-time"
        size:
          type: "integer"
          format: "int64"
    ForwardingNumbersResource:
      type: "object"
      properties:
        uri:
          type: "string"
          format: "uri"
        records:
          type: "array"
          items:
            $ref: "#/definitions/ForwardingNumberResource"
        paging:
          $ref: "#/definitions/Paging"
        navigation:
          $ref: "#/definitions/Navigation"
    ForwardingNumberResource:
      type: "object"
      properties:
        uri:
          type: "string"
          format: "uri"
        id:
          type: "string"
        phoneNumber:
          type: "string"
        label:
          type: "string"
        features:
          type: "array"
          items:
            type: "string"
            enum:
              - "CallFlip"
              - "CallForwarding"
        flipNumber:
          type: "string"
          pattern: "[1-8]"
    MeetingResponseResource:
      type: "object"
      properties:
        uri:
          type: "string"
          format: "uri"
        uuid:
          type: "string"
        id:
          type: "string"
        topic:
          type: "string"
        meetingType:
          type: "string"
        password:
          type: "string"
        status:
          type: "string"
        links:
          $ref: "#/definitions/MeetingLinks"
        schedule:
          $ref: "#/definitions/MeetingScheduleResource"
        allowJoinBeforeHost:
          type: "boolean"
          default: false
        startHostVideo:
          type: "boolean"
          default: false
        startParticipantsVideo:
          type: "boolean"
          default: false
        audioOptions:
          type: "array"
          items:
            type: "string"
    FeeChargeResource:
      type: "object"
      properties:
        description:
          type: "string"
        amount:
          type: "number"
        feature:
          type: "string"
    PaymentInfoAddressResource:
      type: "object"
      properties:
        country:
          type: "string"
        state:
          type: "string"
        city:
          type: "string"
        street:
          type: "string"
        zip:
          type: "string"
    PropertiesDelegate:
      type: "object"
      properties:
        propertyNames:
          type: "array"
          items:
            type: "string"
    SecretQuestionsInfoResource:
      type: "object"
      properties:
        uri:
          type: "string"
          format: "uri"
        records:
          type: "array"
          items:
            $ref: "#/definitions/SecretQuestionInfoResource"
        paging:
          $ref: "#/definitions/Paging"
        navigation:
          $ref: "#/definitions/Navigation"
    ExtensionWithRolesResource:
      type: "object"
      properties:
        uri:
          type: "string"
          format: "uri"
        extensionId:
          type: "string"
        roles:
          type: "array"
          items:
            $ref: "#/definitions/AssignedRoleResource"
    ConversationResource:
      type: "object"
      properties:
        id:
          type: "string"
          readOnly: true
        typingNotifications:
          $ref: "#/definitions/DeliveryModeResource"
        uri:
          type: "string"
          format: "uri"
    Address:
      type: "object"
      properties:
        country:
          type: "string"
        state:
          type: "string"
        city:
          type: "string"
        street:
          type: "string"
        zip:
          type: "string"
    ExtensionReferenceResource:
      type: "object"
      properties:
        id:
          type: "string"
        partnerId:
          type: "string"
    ConferencingNumberResource:
      type: "object"
      properties:
        uri:
          type: "string"
          format: "uri"
        phoneNumber:
          type: "string"
        country:
          $ref: "#/definitions/CountryResource"
        location:
          type: "string"
        hasGreeting:
          type: "boolean"
          default: false
        default:
          type: "boolean"
          default: false
    ReservePhoneNumbersRecordsResource:
      type: "object"
      properties:
        records:
          type: "array"
          items:
            $ref: "#/definitions/ReservePhoneNumberResource"
    DetailedCallInfo:
      type: "object"
      properties:
        callId:
          type: "string"
        toTag:
          type: "string"
        fromTag:
          type: "string"
        remoteUri:
          type: "string"
        localUri:
          type: "string"
        rcSessionId:
          type: "string"
    ReservationDate:
      type: "object"
      properties:
        date:
          type: "string"
          format: "date-time"
        max:
          type: "boolean"
          default: false
        min:
          type: "boolean"
          default: false
    GroupContactsCollection:
      type: "object"
      properties:
        uri:
          type: "string"
          format: "uri"
        records:
          type: "array"
          items:
            $ref: "#/definitions/PersonalContactResource"
        paging:
          $ref: "#/definitions/Paging"
        navigation:
          $ref: "#/definitions/Navigation"
    SubResource:
      type: "object"
      properties:
        uri:
          type: "string"
          format: "uri"
        resourceDescription:
          type: "string"
        parentId:
          type: "integer"
          format: "int64"
        subId:
          type: "integer"
          format: "int64"
        subVer:
          $ref: "#/definitions/ApiVersionResource"
    PhoneNumbersRecordsResource:
      type: "object"
      properties:
        uri:
          type: "string"
          format: "uri"
        records:
          type: "array"
          items:
            $ref: "#/definitions/PhoneNumberResource"
    Messages:
      type: "object"
      properties:
        uri:
          type: "string"
          format: "uri"
        records:
          type: "array"
          items:
            $ref: "#/definitions/MessageInfoResource"
        paging:
          $ref: "#/definitions/Paging"
        navigation:
          $ref: "#/definitions/Navigation"
    UserGroupManagerResource:
      type: "object"
      properties:
        uri:
          type: "string"
          format: "uri"
        id:
          type: "string"
        extensionNumber:
          type: "string"
        firstName:
          type: "string"
        lastName:
          type: "string"
    StatesResource:
      type: "object"
      properties:
        uri:
          type: "string"
          format: "uri"
        records:
          type: "array"
          items:
            $ref: "#/definitions/StateResource"
        paging:
          $ref: "#/definitions/Paging"
        navigation:
          $ref: "#/definitions/Navigation"
    ShippingResource:
      type: "object"
      properties:
        address:
          $ref: "#/definitions/EmergencyServiceAddressResource"
        method:
          $ref: "#/definitions/MethodResource"
        status:
          type: "string"
        carrier:
          type: "string"
        trackingNumber:
          type: "string"
    ServicePlan:
      type: "object"
      properties:
        id:
          type: "string"
        name:
          type: "string"
        edition:
          type: "string"
          enum:
            - "Unknown"
            - "Standard"
            - "Premium"
            - "Enterprise"
            - "Unlimited"
            - "HighUsage"
    ActivePermissionResource:
      type: "object"
      properties:
        permission:
          $ref: "#/definitions/PermissionIdResource"
        effectiveRole:
          $ref: "#/definitions/RoleIdResource"
        scopes:
          type: "array"
          items:
            type: "string"
    AnsweringRuleResource:
      type: "object"
      properties:
        uri:
          type: "string"
          format: "uri"
        id:
          type: "string"
        type:
          type: "string"
          enum:
            - "BusinessHours"
            - "AfterHours"
            - "Custom"
        name:
          type: "string"
          minLength: 0
          maxLength: 30
        enabled:
          type: "boolean"
          default: false
        schedule:
          $ref: "#/definitions/ScheduleResource"
        callers:
          type: "array"
          items:
            $ref: "#/definitions/CallerResource"
        calledNumbers:
          type: "array"
          items:
            $ref: "#/definitions/PhoneNumberResource"
        callHandlingAction:
          type: "string"
          enum:
            - "ForwardCalls"
            - "TakeMessagesOnly"
            - "PlayAnnouncementOnly"
            - "UnconditionalForwarding"
            - "AgentQueue"
            - "Unknown"
        forwarding:
          $ref: "#/definitions/AnsweringForwardingResource"
        unconditionalForwarding:
          $ref: "#/definitions/UnconditionalForwardingResource"
        voicemail:
          $ref: "#/definitions/VoicemailSettingsResource"
    PermissionResource:
      type: "object"
      properties:
        uri:
          type: "string"
          format: "uri"
        id:
          type: "string"
        displayName:
          type: "string"
        description:
          type: "string"
        assignable:
          type: "boolean"
          default: false
        readOnly:
          type: "boolean"
          default: false
        category:
          $ref: "#/definitions/PermissionCategoryIdResource"
        includedPermissions:
          type: "array"
          items:
            $ref: "#/definitions/PermissionIdResource"
    ClientInfoResource:
      type: "object"
      properties:
        uri:
          type: "string"
          format: "uri"
        client:
          $ref: "#/definitions/ClientResource"
        provisioning:
          $ref: "#/definitions/ProvisioningResource"
    ExtensionIdResource:
      type: "object"
      properties:
        uri:
          type: "string"
          format: "uri"
        id:
          type: "string"
        extensionNumber:
          type: "string"
    ApplicationResource:
      type: "object"
      properties:
        id:
          type: "string"
        name:
          type: "string"
        description:
          type: "string"
        organization:
          $ref: "#/definitions/OrganizationResource"
        scope:
          type: "string"
        platformType:
          type: "string"
        permissions:
          type: "array"
          items:
            $ref: "#/definitions/PermissionResource"
    PresencePermissions:
      type: "object"
      properties:
        targetExtensionId:
          type: "string"
        subscriberExtensionId:
          type: "string"
        canReadPresenceStatus:
          type: "boolean"
          default: false
        canReadPresenceSettings:
          type: "boolean"
          default: false
        canPickup:
          type: "boolean"
          default: false
    DepartmentBulkAssignResource:
      type: "object"
      properties:
        items:
          type: "array"
          items:
            $ref: "#/definitions/BulkAssignItem"
    SignupInfoResource:
      type: "object"
      properties:
        tosAccepted:
          type: "boolean"
          default: false
        signupState:
          type: "array"
          items:
            type: "string"
            enum:
              - "AccountCreated"
              - "BillingEntered"
              - "CreditCardApproved"
              - "AccountConfirmed"
              - "PhoneVerificationRequired"
              - "PhoneVerificationPassed"
        verificationReason:
          type: "string"
          enum:
            - "CC_Failed"
            - "Phone_Suspicious"
            - "CC_Phone_Not_Match"
            - "AVS_Not_Available"
            - "MaxMind"
            - "CC_Blacklisted"
            - "Email_Blacklisted"
            - "Phone_Blacklisted"
            - "Cookie_Blacklisted"
            - "Device_Blacklisted"
            - "IP_Blacklisted"
            - "Agent_Instance_Blacklisted"
            - "Charge_Limit"
            - "Other_Country"
            - "Unknown"
    FormDataContentDisposition:
      type: "object"
      properties:
        type:
          type: "string"
        fileName:
          type: "string"
        creationDate:
          type: "string"
          format: "date-time"
        modificationDate:
          type: "string"
          format: "date-time"
        readDate:
          type: "string"
          format: "date-time"
        size:
          type: "integer"
          format: "int64"
        name:
          type: "string"
    BlacklistEntryResource:
      type: "object"
      properties:
        uri:
          type: "string"
          format: "uri"
        id:
          type: "string"
        phoneNumber:
          type: "string"
        name:
          type: "string"
    InvoiceSettingsResource:
      type: "object"
      properties:
        maxAmountPerFirstMonth:
          type: "integer"
          format: "int64"
        maxAmountPerMonth:
          type: "integer"
          format: "int64"
        paymentTerm:
          type: "integer"
          format: "int64"
        period:
          type: "integer"
          format: "int64"
        address:
          $ref: "#/definitions/Address"
    NumberPortingRequest:
      type: "object"
      properties:
        rcAccountId:
          type: "integer"
          format: "int64"
        rcOrderId:
          type: "integer"
          format: "int64"
        orderStatus:
          type: "string"
        timestamp:
          type: "string"
        jcode:
          type: "string"
        completionDate:
          type: "string"
        transferDate:
          type: "string"
    AnsweringRulesResource:
      type: "object"
      properties:
        uri:
          type: "string"
          format: "uri"
        records:
          type: "array"
          items:
            $ref: "#/definitions/AnsweringRuleResource"
        paging:
          $ref: "#/definitions/Paging"
        navigation:
          $ref: "#/definitions/Navigation"
    AcceptableLanguageTag:
      type: "object"
      properties:
        tag:
          type: "string"
        primaryTag:
          type: "string"
        subTags:
          type: "string"
        quality:
          type: "integer"
          format: "int32"
        asLocale:
          $ref: "#/definitions/Locale"
    CustomDataResource:
      type: "object"
      properties:
        uri:
          type: "string"
          format: "uri"
        id:
          type: "string"
        value:
          type: "string"
        lastModifiedTime:
          type: "string"
          format: "date-time"
        attachment:
          $ref: "#/definitions/AttachmentInfo"
    ServiceParameterResource:
      type: "object"
      properties:
        id:
          type: "string"
        value:
          type: "string"
        accountId:
          type: "string"
    LanguageInfoResources:
      type: "object"
      properties:
        uri:
          type: "string"
          format: "uri"
        records:
          type: "array"
          items:
            $ref: "#/definitions/LanguageInfoResource"
        paging:
          $ref: "#/definitions/Paging"
        navigation:
          $ref: "#/definitions/Navigation"
    AccountLimits:
      type: "object"
      properties:
        freeSoftPhoneLinesPerExtension:
          type: "integer"
          description: "The maximum number of free softphone phone lines per user extension"
        meetingSize:
          type: "integer"
          description: "The maximum number of participants in RingCentral Meeting hosted by this account's user"
        maxMonitoredExtensionsPerUser:
          type: "integer"
          description: "The maximum number of extensions which can be included in the list of users monitored for Presence"
        maxExtensionNumberLength:
          type: "integer"
          description: "Maximum length for extension numbers of an account; depends on account type. The default value is 5"
          default: 5
    ResourceLink:
      type: "object"
      properties:
        uri:
          type: "string"
          format: "uri"
    Paging:
      type: "object"
      properties:
        page:
          type: "integer"
          format: "int32"
        totalPages:
          type: "integer"
          format: "int32"
        perPage:
          type: "integer"
          format: "int32"
        totalElements:
          type: "integer"
          format: "int32"
        pageStart:
          type: "integer"
          format: "int32"
        pageEnd:
          type: "integer"
          format: "int32"
    Addon:
      type: "object"
      properties:
        id:
          type: "string"
        name:
          type: "string"
        count:
          type: "integer"
          format: "int32"
    Navigation:
      type: "object"
      properties:
        nextPage:
          $ref: "#/definitions/ResourceLink"
        previousPage:
          $ref: "#/definitions/ResourceLink"
        firstPage:
          $ref: "#/definitions/ResourceLink"
        lastPage:
          $ref: "#/definitions/ResourceLink"
    ShippingOptionResource:
      type: "object"
      properties:
        uri:
          type: "string"
          format: "uri"
        method:
          $ref: "#/definitions/ShippingMethod"
        quantity:
          type: "integer"
          format: "int32"
        price:
          type: "number"
          format: "double"
    CountryResource:
      type: "object"
      properties:
        uri:
          type: "string"
          format: "uri"
        id:
          type: "string"
        name:
          type: "string"
        isoCode:
          type: "string"
        callingCode:
          type: "string"
        emergencyCalling:
          type: "boolean"
          default: false
        numberSelling:
          type: "boolean"
          default: false
        loginAllowed:
          type: "boolean"
          default: false
    RegistrationRequest:
      type: "object"
      properties:
        device:
          $ref: "#/definitions/DeviceToRegister"
        sipInfo:
          type: "array"
          items:
            $ref: "#/definitions/SipDetailsToRegister"
    Reason:
      type: "object"
      properties:
        id:
          type: "string"
        message:
          type: "string"
    CallerResource:
      type: "object"
      properties:
        callerId:
          type: "string"
          minLength: 0
          maxLength: 127
        name:
          type: "string"
    BrandResource:
      type: "object"
      properties:
        uri:
          type: "string"
          format: "uri"
        id:
          type: "string"
        name:
          type: "string"
        homeCountry:
          $ref: "#/definitions/CountryResource"
        currency:
          $ref: "#/definitions/Currency"
    Type:
      type: "object"
      properties:
        typeName:
          type: "string"
    MessageInfoResource:
      type: "object"
      properties:
        uri:
          type: "string"
          format: "uri"
        id:
          type: "string"
        to:
          type: "array"
          items:
            $ref: "#/definitions/CallerInfo"
        from:
          $ref: "#/definitions/CallerInfo"
        type:
          type: "string"
          enum:
            - "EMail"
            - "VoiceMail"
            - "Fax"
            - "Text"
            - "SMS"
            - "Pager"
            - "Unknown"
        creationTime:
          type: "string"
          format: "date-time"
        readStatus:
          type: "string"
          enum:
            - "Read"
            - "Unread"
        priority:
          type: "string"
          enum:
            - "Normal"
            - "High"
        attachments:
          type: "array"
          items:
            $ref: "#/definitions/MessageAttachmentInfo"
        direction:
          type: "string"
          enum:
            - "Inbound"
            - "Outbound"
        availability:
          type: "string"
          enum:
            - "Alive"
            - "Deleted"
            - "Purged"
        subject:
          type: "string"
        messageStatus:
          type: "string"
          enum:
            - "Queued"
            - "Sent"
            - "Delivered"
            - "DeliveryFailed"
            - "SendingFailed"
            - "Received"
        faxResolution:
          type: "string"
          enum:
            - "Undefined"
            - "High"
            - "Low"
        faxPageCount:
          type: "integer"
          format: "int32"
        deliveryErrorCode:
          type: "string"
        smsDeliveryTime:
          type: "string"
          format: "date-time"
        smsSendingAttemptsCount:
          type: "integer"
          format: "int64"
        conversationId:
          type: "integer"
          format: "int64"
        conversation:
          $ref: "#/definitions/ConversationResource"
        lastModifiedTime:
          type: "string"
          format: "date-time"
        pgToDepartment:
          type: "boolean"
          default: false
        vmTranscriptionStatus:
          type: "string"
          enum:
            - "InProgress"
            - "CompletedPartially"
            - "Completed"
            - "TimedOut"
            - "Failed"
            - "NotAvailable"
            - "Unknown"
        sourceFilePath:
          type: "string"
        coverIndex:
          type: "integer"
          format: "int32"
        coverPageText:
          type: "string"
    DeliveryModeResource:
      type: "object"
      properties:
        transportType:
          type: "string"
          enum:
            - "PUBNUB"
            - "APNS"
            - "PUBNUB_TO_APNS"
            - "PUBNUB_TO_APNS_VOIP"
            - "PUBNUB_TO_GCM"
            - "PUBNUB_TO_GCM_VOIP"
            - "WEB_HOOK"
        encryption:
          type: "boolean"
          default: false
        address:
          type: "string"
        subscriberKey:
          type: "string"
        publisherKey:
          type: "string"
        encryptionAlgorithm:
          type: "string"
        encryptionKey:
          type: "string"
        authKey:
          type: "string"
        cipherKey:
          type: "string"
        registrationId:
          type: "string"
        certificateName:
          type: "string"
    ContactsInput:
      type: "object"
      properties:
        records:
          type: "array"
          items:
            $ref: "#/definitions/PersonalContactResource"
    PermissionIdResource:
      type: "object"
      properties:
        uri:
          type: "string"
          format: "uri"
        id:
          type: "string"
    LanguageResource:
      type: "object"
      properties:
        id:
          type: "string"
        name:
          type: "string"
        localeCode:
          type: "string"
    DeviceModelExtResource:
      type: "object"
      properties:
        sku:
          type: "string"
          description: "Device identification number (stock keeping unit) in the format TP-ID [-AT-AC], where TP is device type (HP for RC HardPhone, DV for all other devices including softphone); ID - device model ID; AT -addon type ID; AC - addon count (if any). For example 'HP-56-2-2'"
        type:
          type: "string"
          description: "Device type. The default value is 'HardPhone'"
          enum:
            - "SoftPhone"
            - "HardPhone"
            - "OtherPhone"
        model:
          description: "HardPhone model information"
          $ref: "#/definitions/DeviceModelResource"
    DeviceModelResource:
      type: "object"
      properties:
        id:
          type: "string"
        name:
          type: "string"
        addons:
          type: "array"
          items:
            $ref: "#/definitions/Addon"
    ExtensionGrantResource:
      type: "object"
      properties:
        uri:
          type: "string"
          format: "uri"
        extension:
          $ref: "#/definitions/InlinedExtensionResource"
        callPickup:
          type: "boolean"
          default: false
        callMonitoring:
          type: "boolean"
          default: false
    PermissionCategoryResource:
      type: "object"
      properties:
        uri:
          type: "string"
          format: "uri"
        id:
          type: "string"
        displayName:
          type: "string"
        description:
          type: "string"
    SessionsResource:
      type: "object"
      properties:
        uri:
          type: "string"
          format: "uri"
        records:
          type: "array"
          items:
            $ref: "#/definitions/VersionedResource"
    EntityTag:
      type: "object"
      properties:
        value:
          type: "string"
        weak:
          type: "boolean"
          default: false
    RecordsCollectionResourceSubscriptionResponse:
      type: "object"
      properties:
        uri:
          type: "string"
          format: "uri"
        records:
          type: "array"
          items:
            $ref: "#/definitions/SubscriptionResponse"
    ShippingOptionsResource:
      type: "object"
      properties:
        uri:
          type: "string"
          format: "uri"
        records:
          type: "array"
          items:
            $ref: "#/definitions/ShippingOptionResource"
        paging:
          $ref: "#/definitions/Paging"
        navigation:
          $ref: "#/definitions/Navigation"
    RoleIdResource:
      type: "object"
      properties:
        uri:
          type: "string"
          format: "uri"
        id:
          type: "string"
    BulkProvisionUnassignedExtensionsRequestResource:
      type: "object"
      properties:
        items:
          type: "array"
          items:
            $ref: "#/definitions/BulkProvisionExtensionResource"
    StackTraceElement:
      type: "object"
      properties:
        methodName:
          type: "string"
        fileName:
          type: "string"
        lineNumber:
          type: "integer"
          format: "int32"
        className:
          type: "string"
        nativeMethod:
          type: "boolean"
          default: false
    UserGroupIdResource:
      type: "object"
      properties:
        uri:
          type: "string"
          format: "uri"
        id:
          type: "string"
    AccountServiceInfoResource:
      type: "object"
      properties:
        uri:
          type: "string"
          format: "uri"
        servicePlanName:
          type: "string"
        brand:
          $ref: "#/definitions/Brand"
        servicePlan:
          $ref: "#/definitions/ServicePlan"
        targetServicePlan:
          $ref: "#/definitions/ServicePlan"
        billingPlan:
          $ref: "#/definitions/BillingPlanResource"
        serviceFeatures:
          type: "array"
          items:
            $ref: "#/definitions/ServiceFeatureValue"
        limits:
          $ref: "#/definitions/AccountLimitsResource"
    CallLogRecordResource:
      type: "object"
      properties:
        uri:
          type: "string"
          format: "uri"
        id:
          type: "string"
        sessionId:
          type: "string"
        startTime:
          type: "string"
          format: "date-time"
        duration:
          type: "integer"
          format: "int64"
        type:
          type: "string"
          enum:
            - "Voice"
            - "Fax"
        direction:
          type: "string"
          enum:
            - "Inbound"
            - "Outbound"
        action:
          type: "string"
        result:
          type: "string"
        to:
          $ref: "#/definitions/CallerInfo"
        from:
          $ref: "#/definitions/CallerInfo"
        recording:
          $ref: "#/definitions/CallLogRecordingResource"
    PatternWithGroups:
      type: "object"
      properties:
        regex:
          type: "string"
        groupIndexes:
          type: "array"
          items:
            type: "integer"
            format: "int32"
    SubscriptionRequest:
      type: "object"
      properties:
        eventFilters:
          type: "array"
          items:
            type: "string"
        deliveryMode:
          $ref: "#/definitions/DeliveryModeResource"
        expiresIn:
          type: "integer"
          format: "int64"
    MeetingLinks:
      type: "object"
      properties:
        startUri:
          type: "string"
        joinUri:
          type: "string"
    ParsedNumberResource:
      type: "object"
      properties:
        uri:
          type: "string"
          format: "uri"
        originalString:
          type: "string"
        country:
          $ref: "#/definitions/CountryResource"
        areaCode:
          type: "string"
        subscriberNumber:
          type: "string"
        formattedNational:
          type: "string"
        formattedInternational:
          type: "string"
        dialable:
          type: "string"
        e164:
          type: "string"
        special:
          type: "boolean"
          default: false
        normalized:
          type: "string"
        tollFree:
          type: "boolean"
          default: false
        subAddress:
          type: "string"
        dtmfPostfix:
          type: "string"
    DevicesResource:
      type: "object"
      properties:
        uri:
          type: "string"
          format: "uri"
        records:
          type: "array"
          items:
            $ref: "#/definitions/DeviceResource"
        paging:
          $ref: "#/definitions/Paging"
        navigation:
          $ref: "#/definitions/Navigation"
    RoleResource:
      type: "object"
      properties:
        uri:
          type: "string"
          format: "uri"
        id:
          type: "string"
        displayName:
          type: "string"
          minLength: 0
          maxLength: 128
          pattern: "^((?!(<|>|\\/|\\\")).)*$"
        description:
          type: "string"
          minLength: 0
          maxLength: 2000
          pattern: "^((?!(<|>|\\/|\\\")).)*$"
        custom:
          type: "boolean"
          default: false
        scope:
          type: "string"
        hidden:
          type: "boolean"
          default: false
        lastUpdated:
          type: "string"
          format: "date-time"
        permissions:
          type: "array"
          items:
            $ref: "#/definitions/PermissionIdResource"
    AcceptableMediaType:
      type: "object"
      properties:
        type:
          type: "string"
        subtype:
          type: "string"
        quality:
          type: "integer"
          format: "int32"
        wildcardType:
          type: "boolean"
          default: false
        wildcardSubtype:
          type: "boolean"
          default: false
    PhoneNumberStringsResource:
      type: "object"
      properties:
        uri:
          type: "string"
          format: "uri"
        originalStrings:
          type: "array"
          items:
            type: "string"
    PermissionCategoryIdResource:
      type: "object"
      properties:
        uri:
          type: "string"
          format: "uri"
        id:
          type: "string"
    UpdatePresenceLinesResponse:
      type: "object"
      properties:
        uri:
          type: "string"
          description: "Canonical URI of the monitored lines (extensions) resource"
        records:
          type: "array"
          description: "List of lines (extensions) the presence of which is monitored by the user. The first two lines always indicate the user's extension presence, they cannot be changed"
          items:
            $ref: "#/definitions/LineInfo"
        navigation:
          description: "Information on navigation"
          $ref: "#/definitions/NavigationInfo"
        paging:
          description: "Information on paging"
          $ref: "#/definitions/PagingInfo"
    UpdatePresenceLinesRequest:
      type: "object"
      properties:
        records:
          type: "array"
          items:
            $ref: "#/definitions/PresenceLineInfo"
    PresenceLineInfo:
      type: "object"
      properties:
        id:
          type: "string"
        extension:
          $ref: "#/definitions/PresenceExtensionInfo"
    PresenceExtensionInfo:
      type: "object"
      properties:
        id:
          type: "string"
    PresenceLinesNavigationResource:
      type: "object"
      properties:
        uri:
          type: "string"
          format: "uri"
        records:
          type: "array"
          items:
            $ref: "#/definitions/PresenceLineResource"
        paging:
          $ref: "#/definitions/Paging"
        navigation:
          $ref: "#/definitions/Navigation"
    CallLogRecordingInfoResource:
      type: "object"
      properties:
        uri:
          type: "string"
          format: "uri"
        id:
          type: "string"
        contentUri:
          type: "string"
          format: "uri"
        contentType:
          type: "string"
        duration:
          type: "integer"
          format: "int64"
    Reference:
      type: "object"
      properties:
        type:
          type: "string"
          enum:
            - "PartnerId"
            - "CustomerDirectoryId"
        ref:
          type: "string"
    SipInfoResource:
      type: "object"
      properties:
        uri:
          type: "string"
          format: "uri"
        domain:
          type: "string"
        outboundProxy:
          type: "string"
        userName:
          type: "string"
        password:
          type: "string"
        authorizationId:
          type: "string"
    UserGroupResource:
      type: "object"
      properties:
        uri:
          type: "string"
          format: "uri"
        id:
          type: "string"
          pattern: "^\\d+$"
        displayName:
          type: "string"
          minLength: 0
          maxLength: 128
          pattern: "^((?!(<|>|\\/|\\\")).)*$"
        description:
          type: "string"
          minLength: 0
          maxLength: 2000
          pattern: "^((?!(<|>|\\/|\\\")).)*$"
        managers:
          type: "array"
          items:
            $ref: "#/definitions/UserGroupManagerResource"
        members:
          type: "array"
          items:
            $ref: "#/definitions/ExtensionIdResource"
    NavigableCollectionResourceUserGroupResource:
      type: "object"
      properties:
        uri:
          type: "string"
          format: "uri"
        records:
          type: "array"
          items:
            $ref: "#/definitions/UserGroupResource"
        paging:
          $ref: "#/definitions/Paging"
        navigation:
          $ref: "#/definitions/Navigation"
    PaymentInfoResource:
      type: "object"
      properties:
        uri:
          type: "string"
          format: "uri"
        paymentType:
          type: "string"
          enum:
            - "Card"
            - "Invoice"
        card:
          $ref: "#/definitions/PaymentInfoCardResource"
        invoiceSettings:
          $ref: "#/definitions/InvoiceSettingsResource"
    ServicePlanResource:
      type: "object"
      properties:
        uri:
          type: "string"
          format: "uri"
        id:
          type: "string"
        name:
          type: "string"
        edition:
          type: "string"
          enum:
            - "Unknown"
            - "Standard"
            - "Premium"
            - "Enterprise"
            - "Unlimited"
            - "HighUsage"
        brand:
          $ref: "#/definitions/BrandResource"
        type:
          type: "string"
          enum:
            - "Regular"
            - "UserBased"
            - "Unknown"
        serviceFeatures:
          type: "array"
          items:
            $ref: "#/definitions/ServiceFeatureValue"
        limits:
          $ref: "#/definitions/AccountLimitsResource"
    DepartmentResource:
      type: "object"
      properties:
        uri:
          type: "string"
          format: "uri"
        id:
          type: "string"
        extensionNumber:
          type: "string"
    OrganizationResource:
      type: "object"
      properties:
        id:
          type: "string"
        name:
          type: "string"
    BulkProvisionUnassignedExtensionsResponseResource:
      type: "object"
      properties:
        items:
          type: "array"
          items:
            $ref: "#/definitions/ExtensionAssignmentResult"
    WebUrisResource:
      type: "object"
      properties:
        expressSetupMobile:
          type: "string"
        signUp:
          type: "string"
        support:
          type: "string"
        meetingsAppDownload:
          type: "string"
        mobileWebUsers:
          type: "string"
        mobileWebBilling:
          type: "string"
        mobileWebPhoneSystem:
          type: "string"
        mobileWebUserSettings:
          type: "string"
        mobileWebTellAFriend:
          type: "string"
        mobileWebChangePassword:
          type: "string"
        mobileWebInternationalCalling:
          type: "string"
        mobileWebCallHandling:
          type: "string"
        mobileWebNotifications:
          type: "string"
        mobileWebReporting:
          type: "string"
        mobileWebResetPassword:
          type: "string"
        mobileWebTrialUpgrade:
          type: "string"
        serviceWebHome:
          type: "string"
        serviceWebPhoneSystem:
          type: "string"
        serviceWebUserSettings:
          type: "string"
        serviceWebBilling:
          type: "string"
        serviceWebTellAFriend:
          type: "string"
        serviceWebChangePassword:
          type: "string"
        serviceWebResetPassword:
          type: "string"
        appDownload:
          type: "string"
        appDownloadFile:
          type: "string"
        expiresIn:
          type: "integer"
          format: "int64"
        eula:
          type: "string"
        emergencyDisclaimer:
          type: "string"
    Principal:
      type: "object"
      properties:
        name:
          type: "string"
    Locale:
      type: "object"
      properties:
        language:
          type: "string"
        country:
          type: "string"
        displayCountry:
          type: "string"
        displayLanguage:
          type: "string"
        displayName:
          type: "string"
        displayScript:
          type: "string"
        displayVariant:
          type: "string"
        extensionKeys:
          type: "array"
          items:
            type: "string"
        iso3Country:
          type: "string"
        iso3Language:
          type: "string"
        script:
          type: "string"
        unicodeLocaleAttributes:
          type: "array"
          items:
            type: "string"
        unicodeLocaleKeys:
          type: "array"
          items:
            type: "string"
        variant:
          type: "string"
    ProfileImageResource:
      type: "object"
      properties:
        uri:
          type: "string"
          format: "uri"
        etag:
          type: "string"
        contentType:
          type: "string"
        lastModified:
          type: "string"
          format: "date-time"
        scales:
          type: "array"
          items:
            $ref: "#/definitions/ScaledProfileImageResource"
    PhoneNumbersResource:
      type: "object"
      properties:
        uri:
          type: "string"
          format: "uri"
        records:
          type: "array"
          items:
            $ref: "#/definitions/PhoneNumberResource"
        paging:
          $ref: "#/definitions/Paging"
        navigation:
          $ref: "#/definitions/Navigation"
    DeviceInstance:
      type: "object"
      properties:
        id:
          type: "string"
        serial:
          type: "string"
        trackingNumber:
          type: "string"
        shippingCarrier:
          type: "string"
        rmaNumber:
          type: "string"
    AnsweringForwardingResource:
      type: "object"
      properties:
        notifyMySoftPhones:
          type: "boolean"
          default: false
        notifyAdminSoftPhones:
          type: "boolean"
          default: false
        softPhonesRingCount:
          type: "integer"
          format: "int32"
        ringingMode:
          type: "string"
          enum:
            - "Sequentially"
            - "Simultaneously"
        rules:
          type: "array"
          items:
            $ref: "#/definitions/AnsweringForwardingRuleResource"
    ResourceModelComponent:
      type: "object"
      properties:
        components:
          type: "array"
          items:
            $ref: "#/definitions/ResourceModelComponent"
    CallLogRecords:
      type: "object"
      properties:
        uri:
          type: "string"
          format: "uri"
        records:
          type: "array"
          items:
            $ref: "#/definitions/CallLogRecordResource"
        paging:
          $ref: "#/definitions/Paging"
        navigation:
          $ref: "#/definitions/Navigation"
    ClientInfoSpecialNumbersResource:
      type: "object"
      properties:
        uri:
          type: "string"
          format: "uri"
        records:
          type: "array"
          items:
            $ref: "#/definitions/ClientInfoSpecialNumberResource"
        paging:
          $ref: "#/definitions/Paging"
        navigation:
          $ref: "#/definitions/Navigation"
    MeetingRequestResource:
      type: "object"
      properties:
        topic:
          type: "string"
        meetingType:
          type: "string"
        schedule:
          $ref: "#/definitions/MeetingScheduleResource"
        password:
          type: "string"
        host:
          $ref: "#/definitions/HostInfoRequest"
        allowJoinBeforeHost:
          type: "boolean"
          default: false
        startHostVideo:
          type: "boolean"
          default: false
        startParticipantsVideo:
          type: "boolean"
          default: false
        audioOptions:
          type: "array"
          items:
            type: "string"
    HostInfoRequest:
      type: "object"
      properties:
        id:
          type: "string"
          description: "Internal identifier of an extension which is assigned to be a meeting host. The default value is currently logged-in extension identifier"
    DeviceResource:
      type: "object"
      properties:
        id:
          type: "string"
          description: "Internal identifier of a device"
        uri:
          type: "string"
          format: "uri"
          description: "Canonical URI of a device"
        sku:
          type: "string"
          description: "Device identification number (stock keeping unit) in the format TP-ID [-AT-AC], where TP is device type (HP for RC HardPhone, DV for all other devices including softphone); ID - device model ID; AT -addon type ID; AC - addon count (if any). For example 'HP-56-2-2'"
        type:
          type: "string"
          description: "Device type. The default value is 'HardPhone'"
          enum:
            - "HardPhone"
            - "SoftPhone"
            - "OtherPhone"
        status:
          type: "string"
          description: "Status of a device = ['Online', 'Offline']"
          enum:
            - "Online"
            - "Offline"
        name:
          type: "string"
          description: "Device name. Mandatory if ordering SoftPhone or OtherPhone . Optional for HardPhone . If not specified for HardPhone, then device model name is used as device name"
        serial:
          type: "string"
          description: "Serial number for HardPhone (is returned only when the phone is shipped and provisioned); endpoint_id for softphone and mobile applications"
        computerName:
          type: "string"
          description: "PC name for softphone"
        model:
          description: "HardPhone model information"
          $ref: "#/definitions/DeviceModelResource"
        extension:
          description: "This attribute can be omitted for unassigned devices"
          $ref: "#/definitions/ExtensionResourceIntId"
        phoneLines:
          description: "Phone lines information"
          type: "array"
          items: 
            $ref: "#/definitions/PhoneLineResource"
        emergencyServiceAddress:
          description: " Address for emergency cases. The same emergency address is assigned to all numbers of a single device ,"
          $ref: "#/definitions/EmergencyServiceAddressResource"
        shipping:
          description: "Shipping information, according to which devices (in case of HardPhone ) or e911 stickers (in case of SoftPhone and OtherPhone ) will be delivered to the customer"
          $ref: "#/definitions/ShippingResource"
        boxBillingId:
          type: "integer"
          description: "Box billing identifier of a device. Applicable only for HardPhones. It is an alternative way to identify the device to be ordered. Either model structure, or boxBillingId must be specified for HardPhone"
        linePooling:
          type: "string"
          description: "Pooling type of a deviceHost - device with standalone paid phone line which can be linked to Glip/Softphone instanceGuest - device with a linked phone lineNone - device without a phone line or with specific line (free, BLA, etc.) = ['Host', 'Guest', 'None']"
          enum:
            - "Host"
            - "Guest"
            - "None"
    ReservePhoneNumberResource:
      type: "object"
      properties:
        phoneNumber:
          type: "string"
          description: "Phone number in E.164"
        formattedNumber:
          type: "string"
          description: "Domestic format of a phone number"
        reservedTill:
          description: " Datetime up to which the number is reserved in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z. No value means that number is not reserved anymore"
          type: "string"
        reservationId:
          type: "string"
          description: "nternal identifier of phone number reservation; encoded data including reservation type (by brand, by account, by session), particular brand/account/session data, and reservation date and time"
        status:
          type: "string"
          description: "Phone number status = ['Enabled', 'Pending', 'Disabled'],"
          enum:
            - "Enabled"
            - "Pending"
            - "Disabled"
        error:
          type: "string"
          description: "The error code in case of reservation/un-reservation failure = ['NumberIsAlreadyProvisioned', 'NumberReserved', 'NumberNotAvailable']"
          enum:
            - "NumberIsAlreadyProvisioned"
            - "NumberReserved"
            - "NumberNotAvailable"
    AcceptableToken:
      type: "object"
      properties:
        token:
          type: "string"
        quality:
          type: "integer"
          format: "int32"
    ClientResource:
      type: "object"
      properties:
        detected:
          type: "boolean"
          default: false
        userAgent:
          type: "string"
        appId:
          type: "string"
        appName:
          type: "string"
        appKey:
          type: "string"
        appVersion:
          type: "string"
        locale:
          type: "string"
    PoolResponseResource:
      type: "object"
      properties:
        rendererId:
          type: "string"
        messageId:
          type: "string"
        extensionId:
          type: "string"
        extensionNumber:
          type: "string"
        firstName:
          type: "string"
        lastName:
          type: "string"
        street:
          type: "string"
        city:
          type: "string"
        state:
          type: "string"
        zip:
          type: "string"
        country:
          type: "string"
        countryId:
          type: "string"
        companyName:
          type: "string"
        faxNumber:
          type: "string"
        contactPhone:
          type: "string"
        email:
          type: "string"
        languageCode:
          type: "string"
        languageId:
          type: "string"
        footerType:
          type: "number"
        coverIndex:
          type: "number"
        coverPageText:
          type: "string"
        sourceFiles:
          type: "array"
          items:
            $ref: "#/definitions/File"
        messageServers:
          type: "array"
          items:
            type: "string"
        touchInterval:
          type: "integer"
          format: "int64"
    PoolRequestResource:
      type: "object"
      properties:
        rendererId:
          type: "string"
    MonitoringExtensionsResource:
      type: "object"
      properties:
        uri:
          type: "string"
          format: "uri"
        records:
          type: "array"
          items:
            $ref: "#/definitions/MonitoringExtensionResource"
        paging:
          $ref: "#/definitions/Paging"
        navigation:
          $ref: "#/definitions/Navigation"
    MeetingServiceInfoResource:
      type: "object"
      properties:
        uri:
          type: "string"
          format: "uri"
        supportUri:
          type: "string"
        intlDialInNumbersUri:
          type: "string"
        externalUserInfo:
          $ref: "#/definitions/MeetingExternalUserInfoResource"
        dialInNumbers:
          type: "array"
          items:
            $ref: "#/definitions/DialInNumberResource"
    ExtensionUserGroupsResource:
      type: "object"
      properties:
        uri:
          type: "string"
          format: "uri"
        groups:
          type: "array"
          items:
            $ref: "#/definitions/UserGroupIdResource"
    MeetingsResource:
      type: "object"
      properties:
        uri:
          type: "string"
          format: "uri"
        records:
          type: "array"
          items:
            $ref: "#/definitions/MeetingResponseResource"
        paging:
          $ref: "#/definitions/Paging"
        navigation:
          $ref: "#/definitions/Navigation"
    AnsweringForwardingRuleResource:
      type: "object"
      properties:
        index:
          type: "integer"
          format: "int32"
        ringCount:
          type: "integer"
          format: "int32"
        forwardingNumbers:
          type: "array"
          items:
            $ref: "#/definitions/ForwardingNumberResource"
    RingOutFromInfo:
      type: "object"
      properties:
        phoneNumber:
          type: "string"
        forwardingNumberId:
          type: "string"
    RingOutCountry:
      type: "object"
      properties:
        id:
          type: "string"
    ApiVersionResource:
      type: "object"
      properties:
        uri:
          type: "string"
          format: "uri"
        versionString:
          type: "string"
        releaseDate:
          type: "string"
          format: "date-time"
        uriString:
          type: "string"
    VersionedResource:
      type: "object"
      properties:
        uri:
          type: "string"
          format: "uri"
    File:
      type: "object"
      properties:
        sourceFile:
          type: "string"
        originalFileName:
          type: "string"
    AssignedRoleResource:
      type: "object"
      properties:
        uri:
          type: "string"
          format: "uri"
        id:
          type: "string"
        autoAssigned:
          type: "boolean"
          default: false
        displayName:
          type: "string"
    AuthProfileCheckResource:
      type: "object"
      properties:
        uri:
          type: "string"
          format: "uri"
        successful:
          type: "boolean"
          default: false
        details:
          $ref: "#/definitions/ActivePermissionResource"
    CfaSchedule:
      type: "object"
      properties:
        scheduleId:
          type: "string"
        recurrence:
          $ref: "#/definitions/CfaRecurrence"
        viewType:
          type: "string"
          enum:
            - "Detailed"
            - "Simple"
        attachments:
          $ref: "#/definitions/CfaAttachments"
        recipients:
          type: "array"
          items:
            type: "string"
        pages:
          type: "array"
          items:
            type: "string"
    BulkProvisionExtensionResource:
      type: "object"
      properties:
        uri:
          type: "string"
          format: "uri"
        id:
          type: "string"
        partnerId:
          type: "string"
          minLength: 0
          maxLength: 128
          pattern: "^[\\p{Alnum}\\.\\-_]*$"
        extensionNumber:
          type: "string"
        loginName:
          type: "string"
        contact:
          $ref: "#/definitions/ContactInfo"
        references:
          type: "array"
          items:
            $ref: "#/definitions/Reference"
        name:
          type: "string"
        type:
          type: "string"
          enum:
            - "Unknown"
            - "User"
            - "Department"
            - "Announcement"
            - "Voicemail"
            - "DigitalUser"
            - "VirtualUser"
            - "FaxUser"
            - "PagingOnly"
            - "SharedLinesGroup"
            - "IvrMenu"
            - "ApplicationExtension"
            - "ParkLocation"
        status:
          type: "string"
          enum:
            - "Enabled"
            - "Disabled"
            - "Frozen"
            - "NotActivated"
            - "Unassigned"
        statusInfo:
          $ref: "#/definitions/StatusInfo"
        departments:
          type: "array"
          items:
            $ref: "#/definitions/DepartmentResource"
        serviceFeatures:
          type: "array"
          items:
            $ref: "#/definitions/ServiceFeatureValue"
        regionalSettings:
          $ref: "#/definitions/RegionalSettingsResource"
        setupWizardState:
          type: "string"
          enum:
            - "NotStarted"
            - "Incomplete"
            - "Completed"
            - "Unknown"
        permissions:
          $ref: "#/definitions/ExtensionPermissionsResource"
        password:
          type: "string"
        ivrPin:
          type: "string"
        profileImage:
          $ref: "#/definitions/ProfileImageResource"
    SmsResource:
      type: "object"
      properties:
        country:
          $ref: "#/definitions/CountryResource"
        to:
          type: "array"
          items:
            $ref: "#/definitions/CallerInfo"
        from:
          $ref: "#/definitions/CallerInfo"
        text:
          type: "string"
    PaymentInfoCardHolderResource:
      type: "object"
      properties:
        firstName:
          type: "string"
        lastName:
          type: "string"
        address:
          $ref: "#/definitions/PaymentInfoAddressResource"
    AdbPresenceInfoResource:
      type: "object"
      properties:
        accountId:
          type: "string"
        extensionId:
          type: "string"
        extensionType:
          type: "string"
          enum:
            - "Unknown"
            - "User"
            - "Department"
            - "Announcement"
            - "Voicemail"
            - "DigitalUser"
            - "VirtualUser"
            - "FaxUser"
            - "PagingOnly"
            - "SharedLinesGroup"
            - "ParkLocation"
            - "IvrMenu"
            - "ApplicationExtension"
        extensionStatus:
          type: "string"
          enum:
            - "Enabled"
            - "Disabled"
            - "Frozen"
            - "NotActivated"
        dndStatus:
          type: "string"
          enum:
            - "TakeAllCalls"
            - "DoNotAcceptDepartmentCalls"
            - "TakeDepartmentCallsOnly"
            - "DoNotAcceptAnyCalls"
        userStatus:
          type: "string"
          enum:
            - "Available"
            - "Busy"
            - "Offline"
        message:
          type: "string"
        agentStatus:
          type: "string"
          enum:
            - "Offline"
            - "Online"
            - "Unknown"
        extensionNumber:
          type: "string"
        allowSeeMyPresence:
          type: "boolean"
          default: false
        ringOnMonitoredCall:
          type: "boolean"
          default: false
        pickUpCallsOnHold:
          type: "boolean"
          default: false
        presenceFeatureAvailable:
          type: "boolean"
          default: false
        dndFeatureAvailable:
          type: "boolean"
          default: false
    CfaView:
      type: "object"
      properties:
        name:
          type: "string"
        schedules:
          type: "array"
          items:
            $ref: "#/definitions/CfaSchedule"
    ExtensionWithRolesCollectionResource:
      type: "object"
      properties:
        uri:
          type: "string"
          format: "uri"
        records:
          type: "array"
          items:
            $ref: "#/definitions/ExtensionWithRolesResource"
    ProvisioningResource:
      type: "object"
      properties:
        webUris:
          $ref: "#/definitions/WebUrisResource"
        hints:
          $ref: "#/definitions/HintsResource"
    PromotionCodeResource:
      type: "object"
      properties:
        accountId:
          type: "string"
        promotionCode:
          type: "string"
    ReassignPhoneNumberResource:
      type: "object"
      properties:
        uri:
          type: "string"
          format: "uri"
        id:
          type: "string"
        usageType:
          type: "string"
          enum:
            - "CompanyNumber"
            - "MainCompanyNumber"
            - "AdditionalCompanyNumber"
            - "DirectNumber"
            - "CompanyFaxNumber"
            - "ForwardedNumber"
        extension:
          $ref: "#/definitions/ExtensionReferenceResource"
    IntervalResource:
      type: "object"
      properties:
        from:
          type: "string"
        to:
          type: "string"
    RegistrationResponse:
      type: "object"
      properties:
        uri:
          type: "string"
          format: "uri"
        device:
          $ref: "#/definitions/DeviceResource"
        sipInfo:
          type: "array"
          items:
            $ref: "#/definitions/SipInfo"
        sipFlags:
          $ref: "#/definitions/SipFlags"
    BusinessHoursResource:
      type: "object"
      properties:
        uri:
          type: "string"
          format: "uri"
        schedule:
          $ref: "#/definitions/ScheduleResource"
    ActiveCallInfo:
      type: "object"
      properties:
        id:
          type: "string"
          description: "Internal identifier of a call"
        direction:
          type: "string"
          description: "Call direction"
          enum:
            - "Inbound"
            - "Outbound"
        from:
          type: "string"
          description: "Phone number or extension number of a caller"
        to:
          type: "string"
          description: "Phone number or extension number of a callee"
        telephonyStatus:
          type: "string"
          description: "Telephony call status"
          enum:
            - "NoCall"
            - "CallConnected"
            - "Ringing"
            - "OnHold"
            - "ParkedCall"
        sipData:
          $ref: "#/definitions/DetailedCallInfo"
        sessionId:
          type: "string"
          description: "Internal identifier of a call session"
        terminationType:
          type: "string"
          description: "Type of call termination. Supported for calls in 'NoCall' status. If the returned termination type is 'intermediate' it means the call is not actually ended, the connection is established on one of the devices"
          enum:
            - "final"
            - "intermediate"
    ActiveCallInfoWithoutSIP:
      type: "object"
      properties:
        id:
          type: "string"
          description: "Internal identifier of a call"
        direction:
          type: "string"
          description: "Call direction"
          enum:
            - "Inbound"
            - "Outbound"
        from:
          type: "string"
          description: "Phone number or extension number of a caller"
        to:
          type: "string"
          description: "Phone number or extension number of a callee"
        telephonyStatus:
          type: "string"
          description: "Telephony call status"
          enum:
            - "NoCall"
            - "CallConnected"
            - "Ringing"
            - "OnHold"
            - "ParkedCall"
        sessionId:
          type: "string"
          description: "Internal identifier of a call session"
        terminationType:
          type: "string"
          description: "Type of call termination. Supported for calls in 'NoCall' status. If the returned termination type is 'intermediate' it means the call is not actually ended, the connection is established on one of the devices"
          enum:
            - "final"
            - "intermediate"
    DeviceToRegister:
      type: "object"
      properties:
        id:
          type: "string"
        computerName:
          type: "string"
        appExternalId:
          type: "string"
    LocationResource:
      type: "object"
      properties:
        uri:
          type: "string"
          format: "uri"
        city:
          type: "string"
        areaCode:
          type: "string"
        npa:
          type: "string"
        nxx:
          type: "string"
        state:
          $ref: "#/definitions/VersionedResource"
    FavoriteContactResource:
      type: "object"
      properties:
        uri:
          type: "string"
          format: "uri"
        id:
          type: "string"
        extensionId:
          type: "string"
        contactId:
          type: "string"
    AccountResource:
      type: "object"
      required:
        - "operator"
      properties:
        uri:
          type: "string"
          format: "uri"
        id:
          type: "string"
        serviceInfo:
          $ref: "#/definitions/AccountServiceInfoResource"
        partnerId:
          type: "string"
        operator:
          $ref: "#/definitions/ExtensionResource"
        mainNumber:
          type: "string"
        reservationId:
          type: "string"
        sessionId:
          type: "string"
        status:
          type: "string"
          enum:
            - "Initial"
            - "Unconfirmed"
            - "Confirmed"
            - "Disabled"
        statusInfo:
          $ref: "#/definitions/StatusInfo"
        signupInfo:
          $ref: "#/definitions/SignupInfoResource"
        setupWizardState:
          type: "string"
          enum:
            - "NotStarted"
            - "Incomplete"
            - "Completed"
            - "Unknown"
        testerFlags:
          type: "array"
          items:
            type: "string"
        promotionCode:
          type: "string"
    SecretQuestionInfoResource:
      type: "object"
      properties:
        uri:
          type: "string"
          format: "uri"
        id:
          type: "string"
        questionType:
          type: "integer"
          format: "int32"
        languageId:
          type: "integer"
          format: "int32"
        questionText:
          type: "string"
        showInSignUp:
          type: "boolean"
          default: false
    StatusType:
      type: "object"
      properties:
        family:
          type: "string"
          enum:
            - "INFORMATIONAL"
            - "SUCCESSFUL"
            - "REDIRECTION"
            - "CLIENT_ERROR"
            - "SERVER_ERROR"
            - "OTHER"
        statusCode:
          type: "integer"
          format: "int32"
        reasonPhrase:
          type: "string"
    AddressBookSync:
      type: "object"
      properties:
        uri:
          type: "string"
          format: "uri"
        records:
          type: "array"
          items:
            $ref: "#/definitions/PersonalContactResource"
        syncInfo:
          $ref: "#/definitions/SyncInfo"
        nextPageId:
          type: "integer"
          format: "int64"
        nextPageUri:
          type: "string"
          format: "uri"
    SecurityContext:
      type: "object"
      properties:
        userPrincipal:
          $ref: "#/definitions/Principal"
        secure:
          type: "boolean"
          default: false
        authenticationScheme:
          type: "string"
    SyncCallLogRecords:
      type: "object"
      properties:
        uri:
          type: "string"
          format: "uri"
        records:
          type: "array"
          items:
            $ref: "#/definitions/CallLogRecordResource"
        syncInfo:
          $ref: "#/definitions/SyncInfo"
    EmergencyServiceAddressResource:
      type: "object"
      properties:
        street:
          type: "string"
        street2:
          type: "string"
        city:
          type: "string"
        state:
          type: "string"
        country:
          type: "string"
        zip:
          type: "string"
        customerName:
          type: "string"
    ExtensionUpdateRequest:
      type: "object"
      properties:
        status:
          type: "string"
          enum:
            - "Disabled"
            - "Enabled"
            - "NotActivated"
        statusInfo:
          $ref: "#/definitions/ExtensionStatusInfo"
        reason:
          type: "string"
          description: "Type of suspension"
        comment:
          type: "string"
          description: "Free Form user comment"
        extensionNumber:
          type: "string"
          description: "Extension number available"
        contact:
          $ref: "#/definitions/ContactInfoUpdateRequest"
        regionalSettings:
          $ref: "#/definitions/ExtensionRegionalSettingRequest"
        setupWizardState:
          type: "string"
          enum:
            - "NotStarted"
            - "Incomplete"
            - "Completed"
        partnerId:
          type: "string"
          description: " Extension partner identifier"
        ivrPin:
          type: "string"
          description: "IVR PIN"
        password:
          type: "string"
          description: "Password for extension"
        callQueueInfo:
          $ref: "#/definitions/CallQueueInfoRequest"
          description: "For Department extension type only. Call queue settings"
        transition:
          type: "string"
          description: "For NotActivated extensions only. Welcome email setting"
    ListCompanyAnsweringRuleInfo:
      type: "object"
      properties:
        id:
          type: "string"
          description: "Internal identifier of an answering rule"
        uri:
          type: "string"
          description: "Canonical URI of an answering rule"
        enabled:
          type: "boolean"
          description: "Specifies if the rule is active or inactive. The default value is 'True'"
          default: true
        type:
          type: "string"
          description: "Type of an answering rule, the default value is 'Custom' = ['BusinessHours', 'AfterHours', 'Custom']"
          enum:
            - "BusinessHours"
            - "AfterHours"
            - "Custom"
        name:
          type: "string"
          description: "Name of an answering rule specified by user. Max number of symbols is 30. The default value is 'My Rule N' where 'N' is the first free number"
    CompanyAnsweringRuleUpdate:
      type: "object"
      properties:
        enabled:
          type: "boolean"
          description: "Specifies if the rule is active or inactive. The default value is 'True'"
          default: true
        name:
          type: "string"
          description: "Name of an answering rule specified by user. Max number of symbols is 30. The default value is 'My Rule N' where 'N' is the first free number"
        callers:
          type: "array"
          description: "Answering rule will be applied when calls are received from the specified caller(s)"
          items:
            $ref: "#/definitions/CompanyAnsweringRuleCallersInfoRequest"
        calledNumbers:
          type: "array"
          description: "Answering rule will be applied when calling the specified number(s)"
          items:
            $ref: "#/definitions/CompanyAnsweringRuleCalledNumberInfo"
        schedule:
          description: "Schedule when an answering rule should be applied"
          $ref: "#/definitions/CompanyAnsweringRuleScheduleInfoRequest"
        callHandlingAction:
          type: "string"
          description: "Specifies how incoming calls are forwarded. The default value is 'Operator' 'Operator' - play company greeting and forward to operator extension 'Disconnect' - play company greeting and disconnect 'Bypass' - bypass greeting to go to selected extension = ['Operator', 'Disconnect', 'Bypass']"
          enum:
            - "Operator"
            - "Disconnect"
            - "Bypass"
        extension:
          description: "Extension to which the call is forwarded in 'Bypass' mode"
          $ref: "#/definitions/CompanyAnsweringRuleCallersInfoRequest"
        greetings:
          type: "array"
          description: "Greetings applied for an answering rule; only predefined greetings can be applied, see Dictionary Greeting List"
          items:
            $ref: "#/definitions/GreetingInfo"
    UserBusinessHoursUpdateRequest:
      type: "object"
      properties:
        schedule:
          description: "Schedule when an answering rule is applied"
          $ref: "#/definitions/WeeklyScheduleInfo"
    UserBusinessHoursScheduleInfo:
      type: "object"
      properties:
        weeklyRanges:
          description: "Weekly schedule"
          $ref: "#/definitions/WeeklyScheduleInfo"
    UserBusinessHoursUpdate:
      type: "object"
      properties:
        uri:
          type: "string"
          description: "Canonical URI of a business-hours resource"
        schedule:
          description: "Schedule when an answering rule is applied"
          $ref: "#/definitions/UserBusinessHoursScheduleInfo"
    CustomGreetingRequest:
      type: "object"
      properties:
        type:
          type: "string"
          description: "Type of a greeting, specifying the case when the greeting is played. See Greeting Types = ['Introductory', 'Announcement', 'ConnectingMessage', 'ConnectingAudio', 'Voicemail', 'Unavailable', 'HoldMusic']"
          enum:
            - "Introductory"
            - "Announcement"
            - "ConnectingMessage"
            - "ConnectingAudio"
            - "Voicemail"
            - "Unavailable"
            - "HoldMusic"
        answeringRule:
          description: "nformation on an answering rule that the greeting is applied to"
          $ref: "#/definitions/CustomGreetingAnsweringRuleInfoRequest"
    CustomGreetingAnsweringRuleInfoRequest:
      type: "object"
      properties:
        id:
          type: "string"
          description: "Internal identifier of an answering rule"
    ExtensionUserCredentials:
      type: "object"
      properties:
        secretQuestion:
          description: "Secret question of an extension user"
          $ref: "#/definitions/SecretQuestionInfo"
    ValidateExtensionUserCredentials:
      type: "object"
      properties:
        password:
          type: "string"
          description: "User password of an extension"
        ivrPin:
          type: "string"
          description: "User pin of an extension"
        secretQuestion:
          description: "Secret question of an extension user"
          $ref: "#/definitions/SecretQuestionInfoValidationRequest"
    SecretQuestionInfoValidationRequest:
      type: "object"
      properties:
        id:
          type: "string"
          description: "Internal identifier of a secret question"
        answer:
          type: "string"
          description: "Answer to a secret question"
    VerifyExtensionUserCredentials:
      type: "object"
      properties:
        password:
          type: "string"
          description: "User password of an extension"
        ivrPin:
          type: "string"
          description: "User pin of an extension"
        secretQuestion:
          description: "Secret question of an extension user"
          $ref: "#/definitions/SecretQuestionInfoVerificationRequest"
    SecretQuestionInfoVerificationRequest:
      type: "object"
      properties:
        id:
          type: "string"
          description: "Internal identifier of a secret question"
        answer:
          type: "string"
          description: "Answer to a secret question"
    LicenseList:
      type: "object"
      properties:
        records:
          type: "array"
          description: "List of licenses "
          items:
            $ref: "#/definitions/LicenseInfo"
        paging:
          description: "Information on paging"
          $ref: "#/definitions/PagingInfo"
        navigation:
          description: "Information on navigation"
          $ref: "#/definitions/NavigationInfo"
    LicenseInfo:
      type: "object"
      properties:
        uri:
          type: "string"
          description: "Canonical URI of a license"
        id:
          type: "string"
          description: "Internal identifier of a license"
        type:
          description: "License type data"
          $ref: "#/definitions/LicenseFeatureInfo"
        creationTime:
          type: "string"
          description: "Datetime when license was purchased in ISO 8601 format including timezone, for example 2017-03-10T18:07:52.534Z"
        extension:
          description: "Information on extension to which a license can be assigned"
          $ref: "#/definitions/LicenseExtensionInfo"
    LicenseFeatureInfo:
      type: "object"
      properties:
        id:
          type: "string"
          description: "Internal identifier of an feature"
        name:
          type: "string"
          description: "Full name of a feature"
        limit:
          type: "integer"
          description: "Maximum count of licenses of specific type per account"
    LicenseExtensionInfo:
      type: "object"
      properties:
        id:
          type: "string"
          description: "Internal identifier of an extension"
        uri:
          type: "string"
          description: "Canonical URI of an extension"
        extensionNumber:
          type: "string"
          description: "Number of an extension"
        name:
          type: "string"
          description: "User name of an extension"
    OrderLicensesRequest:
      type: "object"
      properties:
        addedLicenses:
          type: "array"
          description: "List of licenses to be purchased"
          items:
            $ref: "#/definitions/LicenseInfoRequest"
    LicenseInfoRequest:
      type: "object"
      properties:
        type:
          description: "Type of a license"
          $ref: "#/definitions/LicenseTypeInfoRequest"
        quantity:
          type: "integer"
          description: "Quantity of licenses to be purchased"
    LicenseTypeInfoRequest:
      type: "object"
      properties:
        sku:
          type: "string"
          description: "Name of a license type = ['RMS', 'RCN', 'WBR-100', 'WBR-500', 'WBR-1000', 'WBR-3000', 'LRM-50', 'LRM-100', 'LRM-200']"
          enum:
            - "RMS"
            - "RCN"
            - "WBR-100"
            - "WBR-500"
            - "WBR-1000"
            - "WBR-3000"
            - "LRM-50"
            - "LRM-100"
            - "LRM-200"
    ServiceInfoRequest:
      type: "object"
      properties:
        limits:
          description: "Limits which are effective for an account"
          $ref: "#/definitions/AccountLimits"
    AccountServiceInfo:
      type: "object"
      properties:
        uri:
          type: "string"
          description: "Canonical URI of the account Service Info resource"
        servicePlanName:
          type: "string"
          description: "Account Service Plan name"
        brand:
          description: "Information on account brand"
          $ref: "#/definitions/BrandInfo"
        servicePlan:
          description: "Information on account service plan"
          $ref: "#/definitions/ServicePlanInfo"
        billingPlan:
          description: "Information on account billing plan"
          $ref: "#/definitions/BillingPlanInfo"
        serviceFeatures:
          type: "array"
          description: "Service features information, see Service Feature List"
          items:
            $ref: "#/definitions/ServiceFeatureInfo"
        limits:
          description: "Limits which are effective for an account"
          $ref: "#/definitions/AccountLimits"
    LicenseTypes:
      type: "object"
      properties:
        uri:
          type: "string"
          description: "Canonical URI of a license types resource"
        records:
          type: "array"
          description: "List of supported licenses "
          items:
            $ref: "#/definitions/LicenseInfo"
        paging:
          description: "Information on paging"
          $ref: "#/definitions/PagingInfo"
        navigation:
          description: "Information on navigation"
          $ref: "#/definitions/NavigationInfo"
    LicenseTypeInfo:
      type: "object"
      properties:
        id:
          type: "string"
          description: "Internal identifier of a type"
        uri:
          type: "string"
          description: "Canonical URI of a license type resource"
        sku:
          type: "string"
          description: "Short name of a license type"
        name:
          type: "string"
          description: "Full name of a license type"
        assignable:
          type: "string"
          description: "State of a license. Webinars and Large Meetings are assignable"
        feature:
          description: "License feature info"
          $ref: "#/definitions/LicenseFeatureInfo"
    DefaultUserRoleRequest:
      type: "object"
      properties:
        id:
          type: "string"
          description: "Internal identifier of a user role to be set as default, see User Role List"
    AccountDeviceUpdate:
      type: "object"
      properties:
        emergencyServiceAddress:
          description: "Address for emergency cases. The same emergency address is assigned to all numbers of a single device"
          $ref: "#/definitions/EmergencyAddressInfoRequest"
    EmergencyAddressInfoRequest:
      type: "object"
      properties:
        customerName:
          type: "string"
          description: "Name of a customer"
        street:
          type: "string"
          description: "Street address, line 1 - street address, P.O. box, company name, c/o"
        street2:
          type: "string"
          description: "Street address, line 2 - apartment, suite, unit, building, floor, etc"
        city:
          type: "string"
          description: "City name"
        state:
          type: "string"
          description: "State/province name"
        zip:
          type: "string"
          description: "Zip code"
        country:
          type: "string"
          description: "Country name"
    ExtensionCreationRequest:
      type: "object"
      properties:
        contact:
          description: "Contact Information"
          $ref: "#/definitions/ContactInfoUpdateRequest"
        extensionNumber:
          type: "string"
          description: "Number of extension"
        password:
          type: "string"
          description: "Password for extension. If not specified, the password is auto-generated"
        references:
          type: "array"
          description: "List of non-RC internal identifiers assigned to an extension"
          items:
            $ref: "#/definitions/ReferenceInfo"
        regionalSettings:
          description: "Extension region data (timezone, home country, language)"
          $ref: "#/definitions/RegionalSettings"
        setupWizardState:
          type: "string"
          description: "Specifies extension configuration wizard state (web service setup). The default value is 'NotStarted' = ['NotStarted', 'Incomplete', 'Completed']"
          enum:
            - "NotStarted"
            - "Incomplete"
            - "Completed"
        status:
          type: "string"
          description: "Extension current state = ['Enabled', 'Disabled', 'NotActivated', 'Unassigned']"
          enum:
            - "Enabled"
            - "Disabled"
            - "NotActivated"
            - "Unassigned"
        statusInfo:
          description: "Status information (reason, comment). For 'Disabled' status only"
          $ref: "#/definitions/ExtensionStatusInfo"
        type:
          type: "string"
          description: "Extension type = ['User', 'VirtualUser', 'DigitalUser', 'Department']"
          enum:
            - "User"
            - "VirtualUser"
            - "DigitalUser"
            - "Department"
    ContactInfoUpdateRequest:
      type: "object"
      properties:
        firstName:
          type: "string"
          description: "For User extension type only. Extension user first name,"
        lastName:
          type: "string"
          description: "For User extension type only. Extension user last name,"
        company:
          type: "string"
          description: "Extension user company name"
        email:
          type: "string"
          description: "Email of extension user"
        businessPhone:
          type: "string"
          description: "Extension user contact phone number in E.164 format"
        businessAddress:
          $ref: "#/definitions/ContactAddressInfo"
        emailAsLoginName:
          type: "boolean"
          description: " If 'True' then contact email is enabled as login name for this user. Please note that email should be unique in this case. The default value is 'False'"
        pronouncedName:
          $ref: "#/definitions/PronouncedNameInfo"
        department:
          type: "string"
          description: "Extension user department, if any"
    ExtensionRegionalSettingRequest:
      type: "object"
      properties:
        homeCountry:
          $ref: "#/definitions/ExtensionCountryInfoRequest"
        timezone:
          $ref: "#/definitions/ExtensionTimezoneInfoRequest"
        language:
          $ref: "#/definitions/ExtensionLanguageInfoRequest"
        greetingLanguage:
          $ref: "#/definitions/ExtensionGreetingLanguageInfoRequest"
        formattingLocale:
          $ref: "#/definitions/ExtensionFormattingLocaleInfoRequest"
        timeFormat:
          type: "string"
          description: "Time format setting. The default value is '12h' = ['12h', '24h']"
    CallQueueInfoRequest:
      type: "object"
      properties:
        slaGoal:
          type: "integer"
          description: "Target percentage of calls that must be answered by agents within the service level time threshold"
        slaThresholdSeconds:
          type: "integer"
        includeAbandonedCalls:
          type: "boolean"
        abandonedThresholdSeconds:
          type: "integer"
    TransitionInfo:
      type: "object"
      properties:
        sendWelcomeEmail:
          type: "boolean"
          description: "Supported for account confirmation. Specifies whether welcome email is sent. The default value is 'True'"
          default: true
        sendConfirmationEmail:
          type: "boolean"
          description: "Supported for account activation. Specifies whether confirmation email is sent. The default value is 'True'"
          default: true
        shipDevices:
          type: "boolean"
          description: "Specifies whether devices are shipped after successful account confirmation. The default value is 'True'"
          default: true
        activationEmailHash:
          type: "string"
          description: "Supported for account confirmation. Activation email hash code"
    PronouncedNameInfo:
      type: "object"
      properties:
        type:
          type: "string"
          description: "Voice name typeDefault - default extension name; first name and last name specified in user profileTextToSpeech - custom text; user name spelled the way it sounds and specified by userRecorded - custom audio; user name recorded in user's own voice (supported only for extension retrieval) = ['Default', 'TextToSpeech', 'Recorded']"
          enum:
            - "Default"
            - "TextToSpeech"
            - "Recorded"
        text:
          type: "string"
          description: "Custom text"
    ExtensionCountryInfoRequest:
      type: "object"
      properties:
        id:
          type: "string"
          description: "internal Identifier for country"
    ExtensionTimezoneInfoRequest:
      type: "object"
      properties:
        id:
          type: "string"
          description: "internal Identifier for timezone"
    ExtensionLanguageInfoRequest:
      type: "object"
      properties:
        id:
          type: "string"
          description: "internal Identifier of a language"
    ExtensionGreetingLanguageInfoRequest:
      type: "object"
      properties:
        id:
          type: "string"
          description: "internal Identifier of a greeting language"
    ExtensionFormattingLocaleInfoRequest:
      type: "object"
      properties:
        id:
          type: "string"
          description: "Internal Identifier of a formatting language"
    NumberPoolPhoneNumberRequest:
      type: "object"
      properties:
        phoneNumber:
          type: "string"
          description: "Phone number in E.164 format"
        reservedTill:
          type: "string"
          format: "date-time"
          description: "Datetime up to which the number is reserved in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z. If it is omitted or explicitly set to 'null', the number will be un-reserved if it was reserved previously by the same session. Also the values 'Min' and 'Max' are supported. 'Min' is 30 seconds; and 'Max' is 30 days (for reservation by brand) and 20 minutes (for reservation by account/session)"
        reservationId:
          type: "string"
          description: "Internal identifier of a phone number reservation; encoded data including reservation type (by brand, by account, by session), particular brand/account/session data, and reservation date and time"
    ProvisionPhoneNumberRequest:
      type: "object"
      properties:
        extensionId:
          description: "Information on extension which the phone number is added to, only for provisioning extension-level numbers"
          $ref: "#/definitions/ExtensionInfoProvisionPhoneNumbers"
        phoneNumber:
          type: "string"
          description: "Phone number to purchase returned in E.164 (11-digits) format"
        reservationId:
          type: "string"
          description: "Internal identifier of phone number reservation; encoded data including reservation type (by brand, by account, by session), particular brand/account/session data, and reservation date and time"
        label:
          type: "string"
          description: "Custom user name of a phone number, if any. Supported for numbers assigned to Auto-Receptionist, with usage type 'CompanyNumber"
        usageType:
          type: "string"
          enum:
            - "CompanyNumber"
            - "MainCompanyNumber"
            - "AdditionalCompanyNumber"
            - "DirectNumber"
            - "CompanyFaxNumber"
            - "ForwardedNumber"
            - "ForwardedCompanyNumber"
          description: "Usage type of a phone number. The default value is 'DirectNumber'"
        type:
          type: "string"
          enum:
            - "VoiceFax"
            - "VoiceOnly"
            - "FaxOnly"
          description: "Type of a phone number"
        vanityPattern:
          type: "string"
          description: " Vanity pattern that was used to find this number. It should be passed as if it was returned from the Number Lookup call"
    ExtensionUserCredentailsRequest:
      type: "object"
      properties:
        password:
          type: "string"
          description: "User password of an extension"
        ivrPin:
          type: "string"
          description: "User pin of an extension"
        secretQuestion:
          $ref: "#/definitions/ExtensionSecretQuestionInfo"
    ExtensionSecretQuestionInfo:
      type: "object"
      properties:
        id:
          type: "string"
          description: "Internal identifier of a secret question"
        uri:
          type: "string"
          description: "Link to a secret question resource"
        answer:
          type: "string"
          description: "Answer to a secret question"
    NotificationSettingsUpdateRequest:
      type: "object"
      properties:
        emailAddresses:
          type: "array"
          items:
            type: "string"
          description: "List of notification recipient email addresses"
        smsEmailAddresses:
          type: "array"
          items:
            type: "string"
          description: "List of notification recipient email addresses"
        advancedMode:
          type: "boolean"
          description: "Specifies notifications settings mode. If 'True' then advanced mode is on, it allows using different emails and/or phone numbers for each notification type. If 'False' then basic mode is on. Advanced mode settings are returned in both modes, if specified once, but if basic mode is switched on, they are not applied"
        voicemails:
          $ref: "#/definitions/VoicemailsInfo"
        inboundFaxes:
          $ref: "#/definitions/InboundFaxesInfo"
        outboundFaxes:
          $ref: "#/definitions/OutboundFaxesInfo"
        inboundTexts:
          $ref: "#/definitions/InboundTextsInfo"
        missedCalls:
          $ref: "#/definitions/MissedCallsInfo"
    VoicemailsInfo:
      type: "object"
      properties:
        notifyByEmail:
          type: "boolean"
          description: "Email notification flag"
        notifyBySms:
          type: "boolean"
          description: "SMS notification flag"
        advancedEmailAddresses:
          type: "array"
          description: "List of recipient email addresses for voicemail notifications. Returned if specified, in both modes (advanced/basic). Applied in advanced mode only"
          items:
            type: "string"
        advancedSmsEmailAddresses:
          type: "array"
          description: "List of recipient phone numbers for voicemail notifications. Returned if specified, in both modes (advanced/basic). Applied in advanced mode only"
          items:
            type: "string"
        includeAttachment:
          type: "boolean"
          description: "Indicates whether voicemail should be attached to email"
        markAsRead:
          type: "boolean"
          description: "Indicates whether email should be automatically marked as read"
    InboundFaxesInfo:
      type: "object"
      properties:
        notifyByEmail:
          type: "boolean"
          description: "Email notification flag"
        notifyBySms:
          type: "boolean"
          description: "SMS notification flag"
        advancedEmailAddresses:
          type: "array"
          description: "List of recipient email addresses for inbound fax notifications. Returned if specified, in both modes (advanced/basic). Applied in advanced mode only"
          items:
            type: "string"
        advancedSmsEmailAddresses:
          type: "array"
          description: "List of recipient phone numbers for inbound fax notifications. Returned if specified, in both modes (advanced/basic). Applied in advanced mode only"
          items:
            type: "string"
        includeAttachment:
          type: "boolean"
          description: "Indicates whether fax should be attached to email"
        markAsRead:
          type: "boolean"
          description: "Indicates whether email should be automatically marked as read"
    OutboundFaxesInfo:
      type: "object"
      properties:
        notifyByEmail:
          type: "boolean"
          description: "Email notification flag"
        notifyBySms:
          type: "boolean"
          description: "SMS notification flag"
        advancedEmailAddresses:
          type: "array"
          description: "List of recipient email addresses for outbound fax notifications. Returned if specified, in both modes (advanced/basic). Applied in advanced mode only"
          items:
            type: "string"
        advancedSmsEmailAddresses:
          type: "array"
          description: "List of recipient phone numbers for outbound fax notifications. Returned if specified, in both modes (advanced/basic). Applied in advanced mode only"
          items:
            type: "string"
    InboundTextsInfo:
      type: "object"
      properties:
        notifyByEmail:
          type: "boolean"
          description: "Email notification flag"
        notifyBySms:
          type: "boolean"
          description: "SMS notification flag"
        advancedEmailAddresses:
          type: "array"
          description: "List of recipient email addresses for inbound text message notifications. Returned if specified, in both modes (advanced/basic). Applied in advanced mode only"
          items:
            type: "string"
        advancedSmsEmailAddresses:
          type: "array"
          description: "List of recipient phone numbers for inbound text message notifications. Returned if specified, in both modes (advanced/basic). Applied in advanced mode only"
          items:
            type: "string"
    MissedCallsInfo:
      type: "object"
      properties:
        notifyByEmail:
          type: "boolean"
          description: "Email notification flag"
        notifyBySms:
          type: "boolean"
          description: "SMS notification flag"
        advancedEmailAddresses:
          type: "array"
          description: "List of recipient email addresses for missed call notifications. Returned if specified, in both modes (advanced/basic). Applied in advanced mode only"
          items:
            type: "string"
        advancedSmsEmailAddresses:
          type: "array"
          description: "List of recipient phone numbers for missed call notifications. Returned if specified, in both modes (advanced/basic). Applied in advanced mode only"
          items:
            type: "string"
    ExtensionCallerIdInfo:
      type: "object"
      properties:
        uri:
          type: "string"
          description: "Canonical URL of a caller ID resource"
        byDevice:
          type: "array"
          items:
            $ref: "#/definitions/CallerIdByDevice"
            description: "Caller ID settings by device"
        byFeature:
          type: "array"
          items:
            $ref: "#/definitions/CallerIdByFeature"
            description: "Caller ID settings by feature"
    CallerIdByDevice:
      type: "object"
      properties:
        device:
          $ref: "#/definitions/CallerIdDeviceInfo"
        callerId:
          $ref: "#/definitions/CallerIdByDeviceInfo"
    CallerIdByFeature:
      type: "object"
      properties:
        feature:
          type: "string"
          enum:
            - "RingOut"
            - "RingMe"
            - "CallFlip"
            - "FaxNumber"
            - "AdditionalSoftphone"
            - "Alternate"
            - "CommonPhone"
        callerId:
          $ref: "#/definitions/CallerIdByFeatureInfo"
    CallerIdDeviceInfo:
      type: "object"
      properties:
        id:
          type: "string"
          description: "Internal identifier of a device"
        uri:
          type: "string"
          description: "Link to a device resource"
        phoneNumber:
          type: "string"
          description: "Name of a device"
    CallerIdByDeviceInfo:
      type: "object"
      properties:
        type:
          type: "string"
          description: "If 'PhoneNumber' value is specified, then a certain phone number is shown as a caller ID when using this telephony feature. If 'Blocked' value is specified, then a caller ID is hidden. The value 'CurrentLocation' can be specified for 'RingOut' feature only. The default is 'PhoneNumber' = ['PhoneNumber', 'Blocked', 'CurrentLocation']"
        phoneInfo:
          $ref: "#/definitions/CallerIdPhoneInfo"
    CallerIdByFeatureInfo:
      type: "object"
      properties:
        type:
          type: "string"
          description: "If 'PhoneNumber' value is specified, then a certain phone number is shown as a caller ID when using this telephony feature. If 'Blocked' value is specified, then a caller ID is hidden. The value 'CurrentLocation' can be specified for 'RingOut' feature only. The default is 'PhoneNumber' = ['PhoneNumber', 'Blocked', 'CurrentLocation']"
        phoneInfo:
          $ref: "#/definitions/CallerIdPhoneInfo"
    CallerIdPhoneInfo:
      type: "object"
      properties:
        id:
          type: "string"
          description: "Internal identifier of a phone number"
        uri:
          type: "string"
          description: "Link to a phone number resource"
        phoneNumber:
          type: "string"
          description: "Phone number in E.164 (with '+' sign) format"
    CompanyAnsweringRuleRequest:
      type: "object"
      properties:
        name:
          type: "string"
          description: "Name of an answering rule specified by user. Max number of symbols is 30. The default value is 'My Rule N' where 'N' is the first free number"
        enabled:
          type: "boolean"
          description: "Specifies if the rule is active or inactive. The default value is 'True'"
          default: true
        type:
          type: "string"
          description: "Type of an answering rule, the default value is 'Custom' = ['BusinessHours', 'AfterHours', 'Custom']"
          enum:
            - "BusinessHours"
            - "AfterHours"
            - "Custom"
        callers:
          type: "array"
          description: "Answering rule will be applied when calls are received from the specified caller(s)"
          items:
            $ref: "#/definitions/CompanyAnsweringRuleCallersInfoRequest"
        calledNumbers:
          type: "array"
          description: "Answering rule will be applied when calling the specified number(s)"
          items:
            $ref: "#/definitions/CompanyAnsweringRuleCalledNumberInfo"
        schedule:
          description: "Schedule when an answering rule should be applied"
          $ref: "#/definitions/CompanyAnsweringRuleScheduleInfoRequest"
        callHandlingAction:
          type: "string"
          description: "Specifies how incoming calls are forwarded. The default value is 'Operator' 'Operator' - play company greeting and forward to operator extension 'Disconnect' - play company greeting and disconnect 'Bypass' - bypass greeting to go to selected extension = ['Operator', 'Disconnect', 'Bypass']"
          enum:
            - "Operator"
            - "Disconnect"
            - "Bypass"
        extension:
          description: "Extension to which the call is forwarded in 'Bypass' mode"
          $ref: "#/definitions/CompanyAnsweringRuleCallersInfoRequest"
        greetings:
          type: "array"
          description: "Greetings applied for an answering rule; only predefined greetings can be applied, see Dictionary Greeting List"
          items:
            $ref: "#/definitions/GreetingInfo"
    CompanyAnsweringRuleCallersInfoRequest:
      type: "object"
      properties:
        callerId:
          type: "string"
          description: "Phone number of a caller"
        name:
          type: "string"
          description: "Displayed name for a caller ID"
    CompanyAnsweringRuleCalledNumberInfoRequest:
      type: "object"
      properties:
        id:
          type: "string"
          description: "Internal identifier of an account phone number"
    CompanyAnsweringRuleScheduleInfoRequest:
      type: "object"
      properties:
        weeklyRanges:
          description: "Weekly schedule. If specified, ranges cannot be specified"
          $ref: "#/definitions/CompanyAnsweringRuleWeeklyScheduleInfoRequest"
        ranges:
          description: "Specific data ranges. If specified, weeklyRanges cannot be specified"
          $ref: "#/definitions/RangesInfo"
        ref:
          type: "string"
          description: "Reference to Business Hours or After Hours schedule = ['BusinessHours', 'AfterHours']"
          enum:
            - "BusinessHours"
            - "AfterHours"
    CompanyAnsweringRuleExtensionInfoRequest:
      type: "object"
      properties:
        id:
          type: "string"
          description: "Time in format hh:mm"
    GreetingInfo:
      type: "object"
      properties:
        type:
          type: "string"
          description: "Type of a greeting, specifying the case when the greeting is played. See Greeting Types = ['Introductory', 'Announcement', 'ConnectingMessage', 'ConnectingAudio', 'Voicemail', 'Unavailable', 'InterruptPrompt', 'HoldMusic']"
          enum:
            - "Introductory"
            - "Announcement"
            - "ConnectingMessage"
            - "ConnectingAudio"
            - "Voicemail"
            - "Unavailable"
            - "InterruptPrompt"
            - "HoldMusic"
            - "Custom"
            - "Company"
            - "BlockedCallersSpecific"
            - "BlockedCallersAll"
            - "BlockedNoCallerId"
            - "BlockedPayPhones"
            - "StartRecording"
            - "StopRecording"
            - "AutomaticRecording"
        usageType:
          type: "string"
          description: "Usage type of a greeting, specifying if the greeting is applied to user extension or department extension = ['UserExtensionAnsweringRule', 'ExtensionAnsweringRule DepartmentExtensionAnsweringRule']"
          enum:
            - "UserExtensionAnsweringRule"
            - "ExtensionAnsweringRule"
            - "DepartmentExtensionAnsweringRule"
        preset:
          $ref: "#/definitions/PresetInfo"
    CompanyAnsweringRuleWeeklyScheduleInfoRequest:
      type: "object"
      properties:
        monday:
          type: "array"
          description: "Time interval for a particular day"
          items:
            $ref: "#/definitions/CompanyAnsweringRuleTimeIntervalRequest"
        tuesday:
          type: "array"
          description: "Time interval for a particular day"
          items:
            $ref: "#/definitions/CompanyAnsweringRuleTimeIntervalRequest"
        wednesday:
          type: "array"
          description: "Time interval for a particular day"
          items:
            $ref: "#/definitions/CompanyAnsweringRuleTimeIntervalRequest"
        thursday:
          type: "array"
          description: "Time interval for a particular day"
          items:
            $ref: "#/definitions/CompanyAnsweringRuleTimeIntervalRequest"
        friday:
          type: "array"
          description: "Time interval for a particular day"
          items:
            $ref: "#/definitions/CompanyAnsweringRuleTimeIntervalRequest"
        saturday:
          type: "array"
          description: "Time interval for a particular day"
          items:
            $ref: "#/definitions/CompanyAnsweringRuleTimeIntervalRequest"
        sunday:
          type: "array"
          description: "Time interval for a particular day"
          items:
            $ref: "#/definitions/CompanyAnsweringRuleTimeIntervalRequest"
    CompanyAnsweringRuleRangesInfoRequest:
      type: "object"
      properties:
        from:
          type: "string"
          description: "Date and time in format YYYY-MM-DD hh:mm"
        to:
          type: "string"
          description: "Date and time in format YYYY-MM-DD hh:mm"
    PresetInfo:
      type: "object"
      properties:
        uri:
          type: "string"
          description: "Link to a greeting resource"
        id:
          type: "string"
          description: "Internal identifier of greeting"
        name:
          type: "string"
          description: "Name of a greeting"
    CompanyAnsweringRuleTimeIntervalRequest:
      type: "object"
      properties:
        from:
          type: "string"
          description: "Time in format hh:mm"
        to:
          type: "string"
          description: "Time in format hh:mm"
    CompanyAnsweringRuleList:
      type: "object"
      properties:
        uri:
          type: "string"
          description: "Link to an answering rule resource"
        records:
          type: "array"
          description: "List of company answering rules"
          items:
            $ref: "#/definitions/ListCompanyAnsweringRuleInfo"
        paging:
          description: "Information on paging"
          $ref: "#/definitions/PagingInfo"
        navigation:
          description: "Information on navigation"
          $ref: "#/definitions/NavigationInfo"
    CompanyAnsweringRuleInfo:
      type: "object"
      properties:
        id:
          type: "string"
          description: "Internal identifier of an answering rule"
        uri:
          type: "string"
          description: "Canonical URI of an answering rule"
        enabled:
          type: "boolean"
          description: "Specifies if the rule is active or inactive. The default value is 'True'"
          default: true
        type:
          type: "string"
          description: "Type of an answering rule, the default value is 'Custom' = ['BusinessHours', 'AfterHours', 'Custom']"
          enum:
            - "BusinessHours"
            - "AfterHours"
            - "Custom"
        name:
          type: "string"
          description: "Name of an answering rule specified by user. Max number of symbols is 30. The default value is 'My Rule N' where 'N' is the first free number"
        callers:
          type: "array"
          description: "Answering rule will be applied when calls are received from the specified caller(s)"
          items:
            $ref: "#/definitions/CompanyAnsweringRuleCallersInfoRequest"
        calledNumbers:
          type: "array"
          description: "Answering rule will be applied when calling the specified number(s)"
          items:
            $ref: "#/definitions/CompanyAnsweringRuleCalledNumberInfoRequest"
        schedule:
          description: "Schedule when an answering rule should be applied ,"
          $ref: "#/definitions/CompanyAnsweringRuleScheduleInfo"
        callHandlingAction:
          type: "string"
          description: "Specifies how incoming calls are forwarded. The default value is 'Operator' 'Operator' - play company greeting and forward to operator extension 'Disconnect' - play company greeting and disconnect 'Bypass' - bypass greeting to go to selected extension = ['Operator', 'Disconnect', 'Bypass']"
          enum:
            - "Operator"
            - "Disconnect"
            - "Bypass"
        extension:
          description: "Extension to which the call is forwarded in 'Bypass' mode"
          $ref: "#/definitions/CompanyAnsweringRuleCallersInfoRequest"
        greetings:
          type: "array"
          description: "Greetings applied for an answering rule; only predefined greetings can be applied, see Dictionary Greeting List"
          items:
            $ref: "#/definitions/GreetingInfo"
    CompanyAnsweringRuleCalledNumberInfo:
      type: "object"
      properties:
        id:
          type: "string"
          description: "Internal identifier of an account phone number"
    CompanyAnsweringRuleScheduleInfo:
      type: "object"
      properties:
        weeklyRanges:
          description: "Weekly schedule. If specified, ranges cannot be specified"
          $ref: "#/definitions/CompanyAnsweringRuleWeeklyScheduleInfoRequest"
        ranges:
          description: "Specific data ranges. If specified, weeklyRanges cannot be specified"
          $ref: "#/definitions/RangesInfo"
        ref:
          type: "string"
          description: "Reference to Business Hours or After Hours schedule = ['BusinessHours', 'AfterHours']"
          enum:
            - "BusinessHours"
            - "AfterHours"
    UpdateAccountRequest:
      type: "object"
      properties:
        status:
          type: "string"
          description: "Target account status. For account activation - 'Unconfirmed'. For account confirmation - 'Confirmed'. For changing account status - 'Confirmed' or 'Disabled' = ['Unconfirmed', 'Confirmed', 'Disabled'],"
          enum:
            - "Unconfirmed"
            - "Confirmed"
            - "Disabled"
        statusInfo:
          description: "Status information (reason, comment, lifetime). Returned for 'Disabled' status only"
          $ref: "#/definitions/AccountStatusInfo"
        transitionInfo:
          description: "Email notifications setting"
          $ref: "#/definitions/TransitionInfo"
        partnerId:
          type: "string"
          description: "Additional account identifier, developed and applied on the client side"
        serviceInfo:
          description: "Account service information, including brand, service plan and billing plan"
          $ref: "#/definitions/AccountServiceInfo"
        regionalSettings:
          description: "Account level region data (web service Auto-Receptionist settings)"
          $ref: "#/definitions/RegionalSettings"
        operatorId:
          type: "string"
          description: "Identifier of extension to be set as operator for account"
        signupInfo:
          description: "Account sign up data"
          $ref: "#/definitions/SignupInfoResource"
    SiteInfo:
      type: "object"
      properties:
        id:
          type: "string"
          description: "Internal Identifier of a site"
        name:
          type: "string"
          description: "custom name of a site"
    ContactDirectoryEvent:
      type: "object"
      properties:
        id:
          type: "string"
          description: "Internal identifier of an extension"
        eventType:
          type: "string"
          description: "Type of change"
        type:
          type: "string"
          description: "Extension Type"
        status:
          type: "string"
          description: "Status of an extension"
          enum:
            - "Disabled"
            - "Enabled"
            - "NotActivated"
        firstName:
          type: "string"
          description: "First name of an extension user"
        lastName:
          type: "string"
          description: "Last name of an extension user"
        department:
          type: "string"
          description: "Department Name"
        email:
          type: "string"
          description: "Email of an extension user"
        extensionNumber:
          type: "string"
          description: "Extension number"
        account:
          description: "Account data of an extension"
          $ref: "#/definitions/CompanyDirectoryAccountInfo"
        phoneNumbers:
          description: "Extension phone number information"
          $ref: "#/definitions/CompanyDirectoryPhoneNumberInfo"
        site:
          description: "Site Data"
          $ref: "#/definitions/SiteInfo"
        profileImage:
          description: "Extension profile image information. Not returned if profile images are absent for an extension"
          $ref: "#/definitions/CompanyDirectoryProfileImageInfo"
    ExtensionListEvent:
      type: "object"
      properties:
        extensionId:
          type: "string"
          description: "Internal identifier of an extension"
        eventType:
          type: "string"
          description: "Type of extension info change"
          enum:
            - "Create"
            - "Update"
            - "Delete"
    ExtensionInfoEvent:
      type: "object"
      properties:
        extensionId:
          type: "string"
          description: "Internal identifier of an extension"
        eventType:
          type: "string"
          description: "Type of extension info change"
          enum:
            - "Update"
            - "Delete"
        hints:
          type: "array"
          description: "Returned for 'Update' event type only. The possible values are: /nAccountInfo - change of account parameters/nExtensionInfo - change of contact info, service features, departments, status/nPhoneNumber - change of phone numbers/nRole - change of permissions/nProfileImage - change of profile image"
          items:
            type: "string"
    ExtensionGrantListEvent:
      type: "object"
      properties:
        extensionId:
          type: "string"
          description: "Internal identifier of an extension"
    ExtensionFavoritesEvent:
      type: "object"
      properties:
        extensionId:
          type: "string"
          description: "Internal identifier of an extension"
    MessageEvent:
      type: "object"
      properties:
        extensionId:
          type: "string"
          description: "Internal identifier of an extension"
        lastUpdated:
          type: "string"
          format: "date-time"
          description: "Datetime when the message was last modified in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z"
        changes:
          type: "array"
          description: "Message Changes"
          items:
            $ref: "#/definitions/MessageChanges"
    MessageChanges:
      type: "object"
      properties:
        type:
          type: "string"
          description: "Message type"
          enum:
            - "Voicemail"
            - "SMS"
            - "Fax"
            - "Pager"
        newCount:
          type: "integer"
          description: "The number of new messages. Can be omitted if the value is zero"
        updatedCount:
          type: "integer"
          description: "The number of updated messages. Can be omitted if the value is zero"
    NotificationInfo:
      type: "object"
      properties:
        alerts:
          description: "Alert information"
          $ref: "#/definitions/AlertInfo"
        badge:
          type: "string"
          description: "Number of incoming messages"
        sound:
          type: "string"
          description: "Message sound"
        content-available:
          type: "string"
          description: "Content availability"
        category:
          type: "string"
          description: "Category of a message"
    AlertInfo:
      type: "object"
      properties:
        title:
          type: "string"
          description: "Title of a message"
        body:
          type: "string"
          description: "Message Description"
    InboundMessageEvent:
      type: "object"
      properties:
        aps:
          description: "Information on a notification"
          $ref: "#/definitions/NotificationInfo"
        messageId:
          type: "string"
          description: "Internal identifier of an message"
        conversationId:
          type: "string"
          description: "Internal identifier of an conversation"
        from:
          type: "string"
          description: "Sender phone number"
        to:
          type: "string"
          description: "Receiver phone number"
    NotificationRecipientInfo:
      type: "object"
      properties:
        phoneNumber:
          type: "string"
          description: "Phone number in E.164 (with '+' sign) format"
        extensionNumber:
          type: "string"
          description: "Extension number"
        target:
          type: "boolean"
          description: "'True' specifies that message is sent exactly to this recipient. Returned in to field for group MMS. Useful if one extension has several phone numbers"
        location:
          type: "string"
          description: "Contains party location (city, state) if one can be determined from phoneNumber. This property is filled only when phoneNumber is not empty and server can calculate location information from it (for example, this information is unavailable for US toll-free numbers)"
        name:
          type: "string"
          description: "Symbolic name associated with a caller/callee. If the phone does not belong to the known extension, only the location is returned, the name is not determined then"
    SenderInfo:
      type: "object"
      properties:
        phoneNumber:
          type: "string"
          description: "Phone number in E.164 (with '+' sign) format"
        extensionNumber:
          type: "string"
          description: "Extension number"
        location:
          type: "string"
          description: "Contains party location (city, state) if one can be determined from phoneNumber. This property is filled only when phoneNumber is not empty and server can calculate location information from it (for example, this information is unavailable for US toll-free numbers)"
        name:
          type: "string"
          description: "Symbolic name associated with a caller/callee. If the phone does not belong to the known extension, only the location is returned, the name is not determined then"
    InstantMessageEvent:
      type: "object"
      properties:
        id:
          type: "string"
          description: "Internal identifier of an message"
        to:
          type: "array"
          description: "Message receiver(s) information"
          items:
            $ref: "#/definitions/NotificationRecipientInfo"
        from:
          description: "Extension Type"
          $ref: "#/definitions/SenderInfo"
        type:
          type: "string"
          description: "Type of a message. The default value is 'SMS'"
        creationTime:
          type: "string"
          format: "date-time"
          description: "Message creation datetime in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z"
        lastModifiedTime:
          type: "string"
          format: "date-time"
          description: "Datetime when the message was modified in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z"
        readStatus:
          type: "string"
          description: "Status of a message. The default value is 'Unread'"
        priority:
          type: "string"
          description: "The default value is 'Normal'"
        attachments:
          description: "Message attachment data"
          type: "array"
          items:
            $ref: "#/definitions/MessageAttachmentInfo"
        direction:
          type: "string"
          description: "Message direction. The default value is 'Inbound'"
        availability:
          type: "string"
          description: "Message availability status. The default value is 'Alive'"
        subject:
          type: "string"
          description: "Message subject. It replicates message text which is also returned as an attachment"
        messageStatus:
          type: "string"
          description: "Status of a message. The default value is 'Received'"
        conversationId:
          type: "string"
          description: "Identifier of the conversation the message belongs to"
    AccountPresenceEvent:
      type: "object"
      properties:
        extensionId:
          type: "string"
          description: "Internal identifier of an extension. Optional parameter"
          default: "~"
        telephonyStatus:
          type: "string"
          description: "Telephony presence status. Returned if telephony status is changed."
          enum:
          - "NoCall"
          - "CallConnected"
          - "Ringing"
          - "OnHold"
          - "ParkedCall"
        sequence:
          type: "integer"
          description: "Order number of a notification to state the chronology"
        presenceStatus:
          type: "string"
          description: "Aggregated presence status, calculated from a number of sources"
          enum:
          - "Offline"
          - "Busy"
          - "Available"
        userStatus:
          type: "string"
          description: "User-defined presence status (as previously published by the user)"
          enum:
          - "Offline"
          - "Busy"
          - "Available"
        dndStatus:
          type: "string"
          description: "Extended DnD (Do not Disturb) status"
          enum:
          - "TakeAllCalls"
          - "DoNotAcceptAnyCalls"
          - "DoNotAcceptDepartmentCalls"
          - "TakeDepartmentCallsOnly"
        allowSeeMyPresence:
          type: "boolean"
          description: "If 'True' enables other extensions to see the extension presence status"
        ringOnMonitoredCall:
          type: "boolean"
          description: "If 'True' enables to ring extension phone, if any user monitored by this extension is ringing"
        pickUpCallsOnHold:
          type: "boolean"
          description: "If 'True' enables the extension user to pick up a monitored line on hold"
    ExtensionPresenceEvent:
      type: "object"
      properties:
        extensionId:
          type: "string"
          description: "Internal identifier of an extension. Optional parameter"
          default: "~"
        telephonyStatus:
          type: "string"
          description: "Telephony presence status. Returned if telephony status is changed."
          enum:
          - "NoCall"
          - "CallConnected"
          - "Ringing"
          - "OnHold"
          - "ParkedCall"
        sequence:
          type: "integer"
          description: "Order number of a notification to state the chronology"
        presenceStatus:
          type: "string"
          description: "Aggregated presence status, calculated from a number of sources"
          enum:
          - "Offline"
          - "Busy"
          - "Available"
        userStatus:
          type: "string"
          description: "User-defined presence status (as previously published by the user)"
          enum:
          - "Offline"
          - "Busy"
          - "Available"
        dndStatus:
          type: "string"
          description: "Extended DnD (Do not Disturb) status"
          enum:
          - "TakeAllCalls"
          - "DoNotAcceptAnyCalls"
          - "DoNotAcceptDepartmentCalls"
          - "TakeDepartmentCallsOnly"
        allowSeeMyPresence:
          type: "boolean"
          description: "If 'True' enables other extensions to see the extension presence status"
        ringOnMonitoredCall:
          type: "boolean"
          description: "If 'True' enables to ring extension phone, if any user monitored by this extension is ringing"
        pickUpCallsOnHold:
          type: "boolean"
          description: "If 'True' enables the extension user to pick up a monitored line on hold"
    DetailedExtensionPresenceEvent:
      type: "object"
      properties:
        extensionId:
          type: "string"
          description: "Internal identifier of an extension. Optional parameter"
          default: "~"
        telephonyStatus:
          type: "string"
          description: "Telephony presence status. Returned if telephony status is changed."
          enum:
          - "NoCall"
          - "CallConnected"
          - "Ringing"
          - "OnHold"
          - "ParkedCall"
        activeCalls:
          type: "array"
          description: "Collection of Active Call Info"
          items:
            $ref: "#/definitions/ActiveCallInfoWithoutSIP"
        sequence:
          type: "integer"
          description: "Order number of a notification to state the chronology"
        presenceStatus:
          type: "string"
          description: "Aggregated presence status, calculated from a number of sources"
          enum:
          - "Offline"
          - "Busy"
          - "Available"
        userStatus:
          type: "string"
          description: "User-defined presence status (as previously published by the user)"
          enum:
          - "Offline"
          - "Busy"
          - "Available"
        dndStatus:
          type: "string"
          description: "Extended DnD (Do not Disturb) status"
          enum:
          - "TakeAllCalls"
          - "DoNotAcceptAnyCalls"
          - "DoNotAcceptDepartmentCalls"
          - "TakeDepartmentCallsOnly"
        allowSeeMyPresence:
          type: "boolean"
          description: "If 'True' enables other extensions to see the extension presence status"
        ringOnMonitoredCall:
          type: "boolean"
          description: "If 'True' enables to ring extension phone, if any user monitored by this extension is ringing"
        pickUpCallsOnHold:
          type: "boolean"
          description: "If 'True' enables the extension user to pick up a monitored line on hold"
    DetailedExtensionPresenceWithSIPEvent:
      type: "object"
      properties:
        extensionId:
          type: "string"
          description: "Internal identifier of an extension. Optional parameter"
          default: "~"
        telephonyStatus:
          type: "string"
          description: "Telephony presence status. Returned if telephony status is changed."
          enum:
          - "NoCall"
          - "CallConnected"
          - "Ringing"
          - "OnHold"
          - "ParkedCall"
        activeCalls:
          type: "array"
          description: "Collection of Active Call Info"
          items:
            $ref: "#/definitions/ActiveCallInfo"
        sequence:
          type: "integer"
          description: "Order number of a notification to state the chronology"
        presenceStatus:
          type: "string"
          description: "Aggregated presence status, calculated from a number of sources"
          enum:
          - "Offline"
          - "Busy"
          - "Available"
        userStatus:
          type: "string"
          description: "User-defined presence status (as previously published by the user)"
          enum:
          - "Offline"
          - "Busy"
          - "Available"
        dndStatus:
          type: "string"
          description: "Extended DnD (Do not Disturb) status"
          enum:
          - "TakeAllCalls"
          - "DoNotAcceptAnyCalls"
          - "DoNotAcceptDepartmentCalls"
          - "TakeDepartmentCallsOnly"
        allowSeeMyPresence:
          type: "boolean"
          description: "If 'True' enables other extensions to see the extension presence status"
        ringOnMonitoredCall:
          type: "boolean"
          description: "If 'True' enables to ring extension phone, if any user monitored by this extension is ringing"
        pickUpCallsOnHold:
          type: "boolean"
          description: "If 'True' enables the extension user to pick up a monitored line on hold"
    ExtensionFavoritesPresenceEvent:
      type: "object"
      properties:
        extensionId:
          type: "string"
          description: "Internal identifier of an extension. Optional parameter"
          default: "~"
        telephonyStatus:
          type: "string"
          description: "Telephony presence status. Returned if telephony status is changed."
          enum:
          - "NoCall"
          - "CallConnected"
          - "Ringing"
          - "OnHold"
          - "ParkedCall"
        sequence:
          type: "integer"
          description: "Order number of a notification to state the chronology"
        presenceStatus:
          type: "string"
          description: "Aggregated presence status, calculated from a number of sources"
          enum:
          - "Offline"
          - "Busy"
          - "Available"
        userStatus:
          type: "string"
          description: "User-defined presence status (as previously published by the user)"
          enum:
          - "Offline"
          - "Busy"
          - "Available"
        dndStatus:
          type: "string"
          description: "Extended DnD (Do not Disturb) status"
          enum:
          - "TakeAllCalls"
          - "DoNotAcceptAnyCalls"
          - "DoNotAcceptDepartmentCalls"
          - "TakeDepartmentCallsOnly"
        allowSeeMyPresence:
          type: "boolean"
          description: "If 'True' enables other extensions to see the extension presence status"
        ringOnMonitoredCall:
          type: "boolean"
          description: "If 'True' enables to ring extension phone, if any user monitored by this extension is ringing"
        pickUpCallsOnHold:
          type: "boolean"
          description: "If 'True' enables the extension user to pick up a monitored line on hold"
    ExtensionPresenceLineEvent:
      type: "object"
      properties:
        extension:
          description: "Extension information"
          $ref: "#/definitions/ExtensionNotificationInfo"
        sequence:
          type: "integer"
          description: "Order number of a notification to state the chronology"
    ExtensionNotificationInfo:
      type: "object"
      properties:
        id:
          type: "string"
          description: "Internal identifier of the extension"
    APSInfo:
      type: "object"
      properties:
        content-available:
          type: "integer"
          description: "If the value is '1' then notification is turned on even if the application is in background"
          default: 1
    APNSInfo:
      type: "object"
      properties:
        aps:
          description: "Notification priority data"
          $ref: "#/definitions/APSInfo"
    IncomingCallEvent:
      type: "object"
      properties:
        aps:
          description: "Apple Push Notification Service Info"
          $ref: "#/definitions/APSInfo"
        event:
          type: "string"
          description: "Event filter URI"
        uuid:
          type: "string"
          description: "Universally unique identifier of a notification"
        subscriptionId:
          type: "string"
          description: "Internal identifier of a subscription"
        timestamp:
          type: "string"
          description: "The datetime of a call action in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z"
          format: date-time
        extensionId:
          type: "string"
          description: "Internal identifier of an extension"
          default: "~"
        action:
          type: "string"
          description: "Calling action, for example 'StartRing'"
        sessionId:
          type: "string"
          description: "Identifier of a call session"
        serverId:
          type: "string"
          description: "Identifier of a server"
        from:
          type: "string"
          description: "Phone number of a caller"
        fromName:
          type: "string"
          description: "Caller name"
        to:
          type: "string"
          description: "Phone number of a callee"
        toName:
          type: "string"
          description: "Callee name"
        sid:
          type: "string"
          description: "Unique identifier of a session"
        toUrl:
          type: "string"
          description: "SIP proxy registration name"
        srvLvl:
          type: "string"
          description: "User data"
        srvLvlExt:
          type: "string"
          description: "User data"
        recUrl:
          type: "string"
          description: "File containing recorded caller name"
        pn_ttl:
          type: "integer"
          description: "Notification lifetime value in seconds, the default value is 30 seconds"
    MissedCallEvent:
      type: "object"
      properties:
        uuid:
          type: "string"
          description: "Universally unique identifier of a notification"
        pn_apns:
          description: "APNS service info"
          $ref: "#/definitions/APNSInfo"
        event:
          type: "string"
          description: "Event filter URI"
        subscriptionId:
          type: "string"
          description: "Internal identifier of a subscription"
        timestamp:
          type: "string"
          description: "The datetime of a call action in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z"
          format: date-time
        extensionId:
          type: "string"
          description: "Internal identifier of an extension"
          default: "~"
        action:
          type: "string"
          description: "Calling action, for example 'StartRing'"
        sessionId:
          type: "string"
          description: "Identifier of a call session"
        serverId:
          type: "string"
          description: "Identifier of a server"
        from:
          type: "string"
          description: "Phone number of a caller"
        fromName:
          type: "string"
          description: "Caller name"
        to:
          type: "string"
          description: "Phone number of a callee"
        toName:
          type: "string"
          description: "Callee name"
        sid:
          type: "string"
          description: "Unique identifier of a session"
        toUrl:
          type: "string"
          description: "SIP proxy registration name"
        srvLvl:
          type: "string"
          description: "User data"
        srvLvlExt:
          type: "string"
          description: "User data"
        recUrl:
          type: "string"
          description: "File containing recorded caller name"
        pn_ttl:
          type: "integer"
          description: "Notification lifetime value in seconds, the default value is 30 seconds"
    GCMInfo:
      type: "object"
      properties:
        priority:
          type: "string"
          description: "Notification priority, if the value is 'high' then notification is turned on even if the application is in background"
          enum:
            - "high"
            - "normal"
        time_to_live:
          type: "integer"
          description: "Notification lifetime value in seconds, the default value is 30 seconds"
        data:
          description: "GCM data"
          $ref: "#/definitions/GCMData"
    GCMData:
      type: "object"
      properties:
        event:
          type: "string"
          description: "Event filter URI"
        subscriptionId:
          type: "string"
          description: "Internal identifier of a subscription"
        timestamp:
          type: "string"
          description: "The datetime of a call action in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z"
          format: date-time
        extensionId:
          type: "string"
          description: "Internal identifier of an extension"
          default: "~"
        action:
          type: "string"
          description: "Calling action, for example 'StartRing'"
        sessionId:
          type: "string"
          description: "Identifier of a call session"
        serverId:
          type: "string"
          description: "Identifier of a server"
        _from:
          type: "string"
          description: "Phone number of a caller"
        fromName:
          type: "string"
          description: "Caller name"
        to:
          type: "string"
          description: "Phone number of a callee"
        toName:
          type: "string"
          description: "Callee name"
        sid:
          type: "string"
          description: "Unique identifier of a session"
        toUrl:
          type: "string"
          description: "SIP proxy registration name"
        srvLvl:
          type: "string"
          description: "User data"
        srvLvlExt:
          type: "string"
          description: "User data"
    RCVideoNotificationsEvent:
      type: "object"
      properties:
        id:
          type: "string"
          description: "Identifier of a meeting"
        name:
          type: "string"
          description: "Meeting Name"
        start:
          type: "string"
          description: "Datetime of meeting start in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z"
        duration:
          type: "integer"
          description: "Meeting duration"
        participants:
          description: "Meeting participants information"
          $ref: "#/definitions/RCVParticipantsInfo"
        recorded:
          type: "boolean"
          description: "Specifies whether a meeting is recorded or not"
        recording:
          description: "Meeting recording information, if recorded value is 'True'"
          $ref: "#/definitions/RCVRecordingInfo"
    RCVParticipantsInfo:
      type: "object"
      properties:
        account:
          type: "string"
          description: "Participant account"
        extension:
          type: "string"
          description: "Participant extension"
        name:
          type: "string"
          description: "Participant name"
        img:
          type: "string"
          description: "Participant profile image"
    RCVRecordingInfo:
      type: "object"
      properties:
        size:
          type: "integer"
          description: "Meeting record size in bytes"
        duration:
          type: "integer"
          description: "Meeting duration in seconds"
        url:
          type: "string"
          description: "Link to a meeting record"
    GlipGroupsEvent:
      type: "object"
      properties:
        id:
          type: "string"
          description: "Internal identifier of a group"
        type:
          type: "string"
          description: "Type of a group. 'PrivateChat' is a group of 2 members. 'Group' is a chat of 2 and more participants, the membership cannot be changed after group creation. 'Team' is a chat of 1 and more participants, the membership can be modified in future. 'PersonalChat' is a private chat thread of a user"
          enum:
            - "PrivateChat"
            - "Group"
            - "Team"
            - "PersonalChat"
        isPublic:
          type: "boolean"
          description: "For 'Team' group type only. Team access level"
        name:
          type: "string"
          description: "For 'Team' group type only. Team name"
        description:
          type: "string"
          description: "For 'Team' group type only. Team description"
        members:
          type: "array"
          description: "Identifier(s) of group members"
          items:
            type: "string"
        creationTime:
          type: "string"
          format: "date-time"
          description: "Group creation datetime in ISO 8601 format"
        lastModifiedTime:
          type: "string"
          format: "date-time"
          description: "Group last change datetime in ISO 8601 format"
        eventType:
          type: "string"
          description: "Type of a group event. Only the person who joined/was added to a group will receive 'GroupJoined' notification. Only the person who left/was removed from a group will receive 'GroupLeft' notification"
          enum:
            - "GroupRenamed"
            - "GroupJoined"
            - "GroupLeft"
            - "GroupChanged"
    GlipPostEvent:
      type: "object"
      properties:
        id:
          type: "string"
          description: "Internal identifier of a post"
        eventType:
          type: "string"
          description: "Type of a post event"
          enum:
            - "PostAdded"
            - "PostChanged"
            - "PostRemoved"
        groupId:
          type: "string"
          description: "Internal identifier of a group a post belongs to"
        type:
          type: "string"
          description: "Type of a post. 'TextMessage' - an incoming text message; 'PersonJoined' - a message notifying that person has joined a conversation; 'PersonsAdded' - a message notifying that a person(s) were added to a conversation"
          enum:
            - "TextMessage"
            - "PersonJoined"
            - "PersonsAdded"
            - "Card"
        text:
          type: "string"
          description: "For 'TextMessage' post type only. Message text"
        creatorId:
          type: "string"
          description: "Internal identifier of a user - author of a post"
        addedPersonIds:
          type: "array"
          description: "For PersonsAdded post type only. Identifiers of persons added to a group"
          items:
            type: "string"
        removedPersonIds:
          type: "array"
          description: "For PersonsRemoved post type only. Identifiers of persons removed from a group"
          items:
            type: "string"
        mentions:
          type: "array"
          description: "List of at mentions in post text with names."
          items:
            $ref: "#/definitions/GlipMentionsInfo"
        creationTime:
          type: "string"
          format: "date-time"
          description: "Post creation datetime in ISO 8601 format"
        lastModifiedTime:
          type: "string"
          format: "date-time"
          description: "Post last change datetime in ISO 8601 format"
    GlipUnreadMessageCountEvent:
      type: "object"
      properties:
        uuid:
          type: "string"
          description: "Universally unique identifier of a notification"
        pn_apns:
          description: "Apple notification data"
          $ref : "#/definitions/GlipAPNSInfo"
        pn_gcm:
          description: "GCM data"
          $ref : "#/definitions/GCMInfo"
    GlipAPNSInfo:
      type: "object"
      properties:
        aps:
          description: "Apple Push Notification Service Info"
          $ref: "#/definitions/APSInfo"
        timestamp:
          type: "string"
          format: "date-time"
          description: "Datetime of a call action in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z"
        uuid:
          type: "string"
          description: "Universally unique identifier of a notification"
        event:
          type: "string"
          description: "Event filter URI"
        subscriptionId:
          type: "string"
          description: "Internal identifier of a subscription"
        body:
          description: "Unread messages data"
          $ref: "#/definitions/GlipUnreadMessageCountInfo"
    GlipUnreadMessageCountInfo:
      type: "object"
      properties:
        unread:
          type: "integer"
          description: "Count of glip unread messages"