github.com/grokify/go-ringcentral-client@v0.3.31/office/v1/client/api/openapi.yaml

openapi: 3.0.1
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>
  termsOfService: https://developer.ringcentral.com
  title: RingCentral Connect Platform API Explorer
  version: "1.0"
servers:
- url: https://platform.devtest.ringcentral.com/
security:
- OAuth2: []
tags:
- description: ' '
  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
paths:
  /restapi:
    get:
      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
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetVersionsResponse'
          description: Success
      summary: Get API Versions
      tags:
      - API Info
      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:
      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
      parameters:
      - description: API version to be requested, for example 'v1.0'
        in: path
        name: apiVersion
        required: true
        schema:
          type: string
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetVersionResponse'
          description: Success
      summary: Get Version Info
      tags:
      - API Info
      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:
      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
      responses:
        default:
          content: {}
          description: Success
      summary: Get Status
      tags:
      - API Info
      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:
    delete:
      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
      parameters:
      - description: Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
        in: path
        name: accountId
        required: true
        schema:
          default: ~
          type: string
      - description: Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session
        in: path
        name: extensionId
        required: true
        schema:
          default: ~
          type: string
      - 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
        in: query
        name: dateTo
        schema:
          type: string
      - in: query
        name: phoneNumber
        schema:
          type: string
      - in: query
        name: extensionNumber
        schema:
          type: string
      - explode: true
        in: query
        name: type
        schema:
          items:
            enum:
            - Voice
            - Fax
            type: string
          type: array
        style: form
      - explode: true
        in: query
        name: direction
        schema:
          items:
            enum:
            - Inbound
            - Outbound
            type: string
          type: array
        style: form
      - in: query
        name: dateFrom
        schema:
          format: date-time
          type: string
      responses:
        default:
          content: {}
          description: Success
      summary: Delete Call Log Records by Filter
      tags:
      - Call Log
      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
    get:
      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
      parameters:
      - description: Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
        in: path
        name: accountId
        required: true
        schema:
          default: ~
          type: string
      - description: Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session
        in: path
        name: extensionId
        required: true
        schema:
          default: ~
          type: string
      - description: Extension number of a user. If specified, returns call log for a particular extension only. Cannot be specified together with the phoneNumber filter
        in: query
        name: extensionNumber
        schema:
          type: string
      - description: If 'True' then calls from/to blocked numbers are returned. The default value is 'True'
        in: query
        name: showBlocked
        schema:
          type: boolean
      - 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
        in: query
        name: phoneNumber
        schema:
          type: string
      - 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
        explode: true
        in: query
        name: direction
        schema:
          enum:
          - Inbound
          - Outbound
          items:
            type: string
          type: array
        style: form
      - in: query
        name: sessionId
        schema:
          type: string
      - 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
        explode: true
        in: query
        name: type
        schema:
          enum:
          - Voice
          - Fax
          items:
            type: string
          type: array
        style: form
      - 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
        explode: true
        in: query
        name: transport
        schema:
          enum:
          - PSTN
          - VoIP
          items:
            type: string
          type: array
        style: form
      - description: The default value is 'Simple' for both account and extension call log
        explode: true
        in: query
        name: view
        schema:
          enum:
          - Simple
          - Detailed
          items:
            type: string
          type: array
        style: form
      - description: '''True'' if only recorded calls have to be returned'
        in: query
        name: withRecording
        schema:
          type: boolean
      - 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
        in: query
        name: dateTo
        schema:
          format: date-time
          type: string
      - 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
        in: query
        name: dateFrom
        schema:
          format: date-time
          type: string
      - description: Indicates the page number to retrieve. Only positive number values are allowed. Default value is '1'
        in: query
        name: page
        schema:
          type: integer
      - description: Indicates the page size (number of items). If not specified, the value is '100' by default
        in: query
        name: perPage
        schema:
          type: integer
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExtensionCallLogResponse'
          description: Success
      summary: Get Call Log Records by Filter
      tags:
      - Call Log
      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}/call-log-sync:
    get:
      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
      parameters:
      - description: Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
        in: path
        name: accountId
        required: true
        schema:
          default: ~
          type: string
      - description: Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session
        in: path
        name: extensionId
        required: true
        schema:
          default: ~
          type: string
      - description: Type of synchronization. 'FSync' is a default value
        explode: true
        in: query
        name: syncType
        schema:
          enum:
          - FSync
          - ISync
          items:
            type: string
          type: array
        style: form
      - description: Value of syncToken property of last sync request response
        in: query
        name: syncToken
        schema:
          type: string
      - 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
        in: query
        name: dateFrom
        schema:
          type: string
      - 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
        in: query
        name: recordCount
        schema:
          type: integer
      - description: Type of calls to be returned. The default value is 'All'
        explode: true
        in: query
        name: statusGroup
        schema:
          enum:
          - Missed
          - All
          items:
            type: string
          type: array
        style: form
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CallLogSync'
          description: Success
      summary: Call Log Synchronization
      tags:
      - Call Log
      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:
      operationId: getCallRecords
      parameters:
      - explode: false
        in: path
        name: callRecordId
        required: true
        schema:
          items:
            type: string
          type: array
        style: simple
      - in: query
        name: view
        schema:
          enum:
          - Simple
          - Detailed
          type: string
      - in: path
        name: extensionId
        required: true
        schema:
          type: string
      - in: path
        name: accountId
        required: true
        schema:
          type: string
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserCallLogRecord'
          description: successful operation
      summary: Get Call Records by ID
      tags:
      - Call Log
      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:
      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
      parameters:
      - description: Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
        in: path
        name: accountId
        required: true
        schema:
          default: ~
          type: string
      - description: Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session
        in: path
        name: extensionId
        required: true
        schema:
          default: ~
          type: string
      - 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
        explode: true
        in: query
        name: direction
        schema:
          enum:
          - Inbound
          - Outbound
          items:
            type: string
          type: array
        style: form
      - 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
        explode: true
        in: query
        name: type
        schema:
          enum:
          - Voice
          - Fax
          items:
            type: string
          type: array
        style: form
      - description: Indicates the page number to retrieve. Only positive number values are allowed. Default value is '1'
        in: query
        name: page
        schema:
          type: integer
      - description: Indicates the page size (number of items). If not specified, the value is '100' by default
        in: query
        name: perPage
        schema:
          type: integer
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExtensionActiveCallsResponse'
          description: Success
      summary: Get User Active Calls
      tags:
      - Call Log
      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:
    delete:
      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
      parameters:
      - description: Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
        in: path
        name: accountId
        required: true
        schema:
          default: ~
          type: string
      - 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
        in: query
        name: dateTo
        schema:
          type: string
      responses:
        default:
          content: {}
          description: Success
      summary: Delete Call Log Records by Filter
      tags:
      - Call Log
      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
    get:
      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
      parameters:
      - description: Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
        in: path
        name: accountId
        required: true
        schema:
          default: ~
          type: string
      - description: Extension number of a user. If specified, returns call log for a particular extension only. Cannot be specified together with the phoneNumber filter
        in: query
        name: extensionNumber
        schema:
          type: string
      - 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
        in: query
        name: phoneNumber
        schema:
          type: string
      - 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
        explode: true
        in: query
        name: direction
        schema:
          enum:
          - Inbound
          - Outbound
          items:
            type: string
          type: array
        style: form
      - 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
        explode: true
        in: query
        name: type
        schema:
          enum:
          - Voice
          - Fax
          items:
            type: string
          type: array
        style: form
      - description: The default value is 'Simple' for both account and extension call log
        explode: true
        in: query
        name: view
        schema:
          enum:
          - Simple
          - Detailed
          items:
            type: string
          type: array
        style: form
      - description: '''True'' if only recorded calls have to be returned'
        in: query
        name: withRecording
        schema:
          type: boolean
      - 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
        in: query
        name: dateFrom
        schema:
          format: date-time
          type: string
      - 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
        in: query
        name: dateTo
        schema:
          format: date-time
          type: string
      - description: Indicates the page number to retrieve. Only positive number values are allowed. The default value is '1'
        in: query
        name: page
        schema:
          type: integer
      - description: Indicates the page size (number of items). If not specified, the value is '100' by default.
        in: query
        name: perPage
        schema:
          type: integer
      - in: query
        name: sessionId
        schema:
          type: string
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountCallLogResponse'
          description: Success
      summary: Get Call Log Records by Filter
      tags:
      - Call Log
      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
  /restapi/v1.0/account/{accountId}/call-log-sync:
    get:
      operationId: syncAccountCallLog
      parameters:
      - description: Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
        in: path
        name: accountId
        required: true
        schema:
          default: ~
          type: string
      - description: Type of synchronization. 'FSync' is a default value
        explode: true
        in: query
        name: syncType
        schema:
          enum:
          - FSync
          - ISync
          items:
            type: string
          type: array
        style: form
      - description: Value of syncToken property of last sync request response
        in: query
        name: syncToken
        schema:
          type: string
      - 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
        in: query
        name: dateFrom
        schema:
          type: string
      - 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
        in: query
        name: recordCount
        schema:
          type: integer
      - description: Type of calls to be returned. The default value is 'All'
        explode: true
        in: query
        name: statusGroup
        schema:
          enum:
          - Missed
          - All
          items:
            type: string
          type: array
        style: form
      responses:
        default:
          content: {}
          description: Success
      summary: Call Log Synchronization
      tags:
      - Call Log
      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}:
    delete:
      operationId: deleteAccountCallLogRecord
      parameters:
      - description: Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
        in: path
        name: accountId
        required: true
        schema:
          default: ~
          type: string
      - description: Internal identifier of a call log record
        in: path
        name: callRecordId
        required: true
        schema:
          type: integer
      responses:
        default:
          content: {}
          description: Success
      summary: Delete Account Call Log Record(s) by ID
      tags:
      - Call Log
      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
    get:
      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
      parameters:
      - description: Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
        in: path
        name: accountId
        required: true
        schema:
          default: ~
          type: string
      - description: Internal identifier of a call log record
        in: path
        name: callRecordId
        required: true
        schema:
          type: integer
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAccountCallLogRecordResponse'
          description: Success
      summary: Get Account Call Log Record(s) by ID
      tags:
      - Call Log
      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
  /restapi/v1.0/account/{accountId}/active-calls:
    get:
      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
      parameters:
      - description: Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
        in: path
        name: accountId
        required: true
        schema:
          default: ~
          type: string
      - 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
        explode: true
        in: query
        name: direction
        schema:
          enum:
          - Inbound
          - Outbound
          items:
            type: string
          type: array
        style: form
      - 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
        explode: true
        in: query
        name: type
        schema:
          enum:
          - Voice
          - Fax
          items:
            type: string
          type: array
        style: form
      - 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
        explode: true
        in: query
        name: transport
        schema:
          enum:
          - PSTN
          - VoIP
          items:
            type: string
          type: array
        style: form
      - description: Indicates the page number to retrieve. Only positive number values are allowed. Default value is '1'
        in: query
        name: page
        schema:
          type: integer
      - description: Indicates the page size (number of items). If not specified, the value is '100' by default
        in: query
        name: perPage
        schema:
          type: integer
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExtensionActiveCallsResponse'
          description: Success
      summary: Get User Active Calls
      tags:
      - Call Log
      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:
      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
      parameters:
      - description: Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
        in: path
        name: accountId
        required: true
        schema:
          default: ~
          type: string
      - description: Internal identifier of a recording (returned in Call Log)
        in: path
        name: recordingId
        required: true
        schema:
          type: string
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetCallRecordingResponse'
          description: Success
      summary: Get Call Recordings
      tags:
      - Call Log
      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:
      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
      parameters:
      - description: Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
        in: path
        name: accountId
        required: true
        schema:
          default: ~
          type: string
      - description: Internal identifier of a recording (returned in Call Log)
        in: path
        name: recordingId
        required: true
        schema:
          type: string
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Binary'
          description: Success
      summary: Get Call Recordings Data
      tags:
      - Call Log
      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:
      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
      parameters:
      - description: Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
        in: path
        name: accountId
        required: true
        schema:
          default: ~
          type: string
      - description: Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session
        in: path
        name: extensionId
        required: true
        schema:
          default: ~
          type: string
      - description: Usage type of the phone number
        explode: true
        in: query
        name: usageType
        schema:
          enum:
          - MainCompanyNumber
          - AdditionalCompanyNumber
          - CompanyNumber
          - DirectNumber
          - CompanyFaxNumber
          - ForwardedNumber
          items:
            type: string
          type: array
        style: form
      - description: Indicates the page number to retrieve. Only positive number values are allowed. Default value is '1'
        in: query
        name: page
        schema:
          type: integer
      - description: Indicates the page size (number of items). If not specified, the value is '100' by default
        in: query
        name: perPage
        schema:
          type: integer
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetExtensionPhoneNumbersResponse'
          description: Success
      summary: Get Extension Phone Number List
      tags:
      - Phone Numbers
      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:
      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
      parameters:
      - description: Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
        in: path
        name: accountId
        required: true
        schema:
          default: ~
          type: string
      - description: Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session
        in: path
        name: extensionId
        required: true
        schema:
          default: ~
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateSMSMessage'
        description: JSON body
        required: true
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetMessageInfoResponseIntId'
          description: Success
      summary: Create SMS Message
      tags:
      - Messages
      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:
      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
      parameters:
      - description: Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
        in: path
        name: accountId
        required: true
        schema:
          default: ~
          type: string
      - description: Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session
        in: path
        name: extensionId
        required: true
        schema:
          default: ~
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreatePagerMessageRequest'
        description: JSON body
        required: true
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetMessageInfoResponse'
          description: Success
      summary: Create Pager Message
      tags:
      - Messages
      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:
      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>
      operationId: sendFaxMessage
      parameters:
      - description: Internal identifier of a RingCentral account (integer) or tilde (~) to indicate the account which was logged-in within the current session.
        in: path
        name: accountId
        required: true
        schema:
          default: ~
          type: string
      - description: Internal identifier of an extension (integer) or tilde (~) to indicate the extension assigned to the account logged-in within the current session
        in: path
        name: extensionId
        required: true
        schema:
          default: ~
          type: string
      requestBody:
        content:
          multipart/form-data:
            schema:
              properties:
                to:
                  description: To Phone Number
                  items:
                    type: string
                  type: array
                attachment:
                  description: File to upload
                  format: binary
                  type: string
                faxResolution:
                  description: Resolution of Fax
                  enum:
                  - High
                  - Low
                  type: string
                sendTime:
                  description: Optional. Timestamp to send fax at. If not specified (current or the past), the fax is sent immediately
                  format: date-time
                  type: string
                isoCode:
                  description: ISO Code. e.g UK
                  type: string
                coverIndex:
                  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
                  type: integer
                coverPageText:
                  description: Cover page text, entered by the fax sender and printed on the cover page. Maximum length is limited to 1024 symbols
                  type: string
              required:
              - to
        required: true
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FaxResponse'
          description: successful operation
      summary: Create Fax Message
      tags:
      - Messages
      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:
      operationId: getFaxCoverPages
      parameters:
      - description: Indicates the page number to retrieve. Only positive number values are allowed. Default value is '1'
        in: query
        name: page
        schema:
          type: integer
      - description: Indicates the page size (number of items). If not specified, the value is '100' by default
        in: query
        name: perPage
        schema:
          type: integer
      responses:
        default:
          content: {}
          description: successful operation
      summary: Get Fax Cover Pages
      tags:
      - Messages
      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:
    delete:
      operationId: deleteMessagesByFilter
      parameters:
      - explode: true
        in: query
        name: conversationId
        schema:
          items:
            type: string
          type: array
        style: form
      - in: path
        name: extensionId
        required: true
        schema:
          type: string
      - in: path
        name: accountId
        required: true
        schema:
          type: string
      responses:
        default:
          content: {}
          description: successful operation
      summary: Delete Conversations by ID's
      tags:
      - Messages
      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
    get:
      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
      parameters:
      - description: Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
        in: path
        name: accountId
        required: true
        schema:
          default: ~
          type: string
      - description: Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session
        in: path
        name: extensionId
        required: true
        schema:
          default: ~
          type: string
      - description: Specifies the availability status for the resulting messages. Default value is 'Alive'. Multiple values are accepted
        explode: true
        in: query
        name: availability
        schema:
          enum:
          - Alive
          - Deleted
          - Purged
          items:
            type: string
          type: array
        style: form
      - description: Specifies the conversation identifier for the resulting messages
        in: query
        name: conversationId
        schema:
          type: integer
      - 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
        in: query
        name: dateFrom
        schema:
          format: date-time
          type: string
      - 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
        in: query
        name: dateTo
        schema:
          format: date-time
          type: string
      - description: The direction for the resulting messages. If not specified, both inbound and outbound messages are returned. Multiple values are accepted
        explode: true
        in: query
        name: direction
        schema:
          enum:
          - Inbound
          - Outbound
          items:
            type: string
          type: array
        style: form
      - description: If 'True', then the latest messages per every conversation ID are returned
        in: query
        name: distinctConversations
        schema:
          type: boolean
      - description: The type of the resulting messages. If not specified, all messages without message type filtering are returned. Multiple values are accepted
        explode: true
        in: query
        name: messageType
        schema:
          enum:
          - Fax
          - SMS
          - VoiceMail
          - Pager
          - Text
          items:
            type: string
          type: array
        style: form
      - description: The read status for the resulting messages. Multiple values are accepted
        explode: true
        in: query
        name: readStatus
        schema:
          enum:
          - Read
          - Unread
          items:
            type: string
          type: array
        style: form
      - description: Indicates the page number to retrieve. Only positive number values are allowed. Default value is '1'
        in: query
        name: page
        schema:
          type: integer
      - description: Indicates the page size (number of items). If not specified, the value is '100' by default
        in: query
        name: perPage
        schema:
          type: integer
      - description: The phone number. If specified, messages are returned for this particular phone number only
        in: query
        name: phoneNumber
        schema:
          type: string
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetMessageList'
          description: Success
      summary: Get Message List
      tags:
      - Messages
      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
  /restapi/v1.0/account/{accountId}/extension/{extensionId}/message-store/{messageId}:
    delete:
      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
      parameters:
      - description: Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
        in: path
        name: accountId
        required: true
        schema:
          default: ~
          type: string
      - description: Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session
        in: path
        name: extensionId
        required: true
        schema:
          default: ~
          type: string
      - description: Internal identifier of a message
        in: path
        name: messageId
        required: true
        schema:
          type: integer
      - description: If the value is 'True', then the message is purged immediately with all the attachments. The default value is 'False'
        in: query
        name: purge
        schema:
          type: boolean
      - description: Internal identifier of a message thread
        in: query
        name: conversationId
        schema:
          type: integer
      responses:
        default:
          content: {}
          description: Success
      summary: Delete Message(s) by ID
      tags:
      - Messages
      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
    get:
      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
      parameters:
      - description: Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
        in: path
        name: accountId
        required: true
        schema:
          default: ~
          type: string
      - description: Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session
        in: path
        name: extensionId
        required: true
        schema:
          default: ~
          type: string
      - description: Internal identifier of a message
        in: path
        name: messageId
        required: true
        schema:
          type: integer
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetMessageInfoResponse'
          description: Success
      summary: Get Message(s) by ID
      tags:
      - Messages
      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:
      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
      parameters:
      - description: Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
        in: path
        name: accountId
        required: true
        schema:
          default: ~
          type: string
      - description: Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session
        in: path
        name: extensionId
        required: true
        schema:
          default: ~
          type: string
      - description: Internal identifier of a message
        in: path
        name: messageId
        required: true
        schema:
          type: integer
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateMessageRequest'
        description: JSON body
        required: true
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetMessageInfoResponse'
          description: Success
      summary: Update Message(s) by ID
      tags:
      - Messages
      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:
      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
      parameters:
      - description: Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
        in: path
        name: accountId
        required: true
        schema:
          default: ~
          type: string
      - description: Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session
        in: path
        name: extensionId
        required: true
        schema:
          default: ~
          type: string
      - description: Internal identifier of a message attachment
        in: path
        name: attachmentId
        required: true
        schema:
          type: integer
      - description: Internal identifier of a message
        in: path
        name: messageId
        required: true
        schema:
          type: integer
      - in: header
        name: Range
        schema:
          type: string
      responses:
        default:
          content: {}
          description: Success
      summary: Get Message Attachment
      tags:
      - Messages
      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:
      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
      parameters:
      - description: Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
        in: path
        name: accountId
        required: true
        schema:
          default: ~
          type: string
      - description: Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session
        in: path
        name: extensionId
        required: true
        schema:
          default: ~
          type: string
      - description: Conversation identifier for the resulting messages. Meaningful for SMS and Pager messages only.
        in: query
        name: conversationId
        schema:
          type: integer
      - 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
        in: query
        name: dateFrom
        schema:
          type: string
      - 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
        in: query
        name: dateTo
        schema:
          type: string
      - description: Direction for the resulting messages. If not specified, both inbound and outbound messages are returned. Multiple values are accepted
        explode: true
        in: query
        name: direction
        schema:
          enum:
          - Inbound
          - Outbound
          items:
            type: string
          type: array
        style: form
      - description: If 'True', then the latest messages per every conversation ID are returned
        in: query
        name: distinctConversations
        schema:
          type: boolean
      - description: Type for the resulting messages. If not specified, all types of messages are returned. Multiple values are accepted
        explode: true
        in: query
        name: messageType
        schema:
          enum:
          - Fax
          - SMS
          - VoiceMail
          - Pager
          - Text
          items:
            type: string
          type: array
        style: form
      - description: Limits the number of records to be returned (works in combination with dateFrom and dateTo if specified)
        in: query
        name: recordCount
        schema:
          type: integer
      - description: Value of syncToken property of last sync request response
        in: query
        name: syncToken
        schema:
          type: string
      - description: Type of message synchronization
        explode: true
        in: query
        name: syncType
        schema:
          enum:
          - FSync
          - ISync
          items:
            type: string
          type: array
        style: form
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetMessageSyncResponse'
          description: Success
      summary: Get Message Sync
      tags:
      - Messages
      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:
      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
      parameters:
      - description: Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
        in: path
        name: accountId
        required: true
        schema:
          default: ~
          type: string
      - description: Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session
        in: path
        name: extensionId
        required: true
        schema:
          default: ~
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MakeRingOutRequest'
        description: JSON body
        required: true
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetRingOutStatusResponseIntId'
          description: Success
      summary: Make RingOut Call
      tags:
      - RingOut
      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:
      deprecated: true
      operationId: createDirectRingOut
      parameters:
      - in: path
        name: accountId
        required: true
        schema:
          type: string
      - in: path
        name: extensionId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RingOutResource'
        required: true
      responses:
        default:
          content: {}
          description: successful operation
      tags:
      - RingOut
      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}:
    delete:
      deprecated: true
      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
      parameters:
      - description: Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
        in: path
        name: accountId
        required: true
        schema:
          default: ~
          type: string
      - description: Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session
        in: path
        name: extensionId
        required: true
        schema:
          default: ~
          type: string
      - description: Internal identifier of a RingOut call
        in: path
        name: ringoutId
        required: true
        schema:
          type: integer
      responses:
        default:
          content: {}
          description: Success
      summary: Cancel RingOut Call
      tags:
      - RingOut
      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
    get:
      deprecated: true
      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
      parameters:
      - description: Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
        in: path
        name: accountId
        required: true
        schema:
          default: ~
          type: string
      - description: Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session
        in: path
        name: extensionId
        required: true
        schema:
          default: ~
          type: string
      - description: Internal identifier of a RingOut call
        in: path
        name: ringoutId
        required: true
        schema:
          type: integer
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetRingOutStatusResponse'
          description: Success
      summary: Get Status of RingOut Call
      tags:
      - RingOut
      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
  /restapi/v1.0/account/{accountId}/extension/{extensionId}/ring-out:
    post:
      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
      parameters:
      - description: Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
        in: path
        name: accountId
        required: true
        schema:
          default: ~
          type: string
      - description: Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session
        in: path
        name: extensionId
        required: true
        schema:
          default: ~
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MakeRingOutRequest'
        description: JSON body
        required: true
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetRingOutStatusResponse'
          description: Success
      summary: Make RingOut Call
      tags:
      - RingOut
      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:
      operationId: createDirectRingOutNew
      parameters:
      - in: path
        name: accountId
        required: true
        schema:
          type: string
      - in: path
        name: extensionId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RingOutResource'
        required: true
      responses:
        default:
          content: {}
          description: successful operation
      summary: Make Direct RingOut Call
      tags:
      - RingOut
      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}:
    delete:
      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
      parameters:
      - description: Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
        in: path
        name: accountId
        required: true
        schema:
          default: ~
          type: string
      - description: Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session
        in: path
        name: extensionId
        required: true
        schema:
          default: ~
          type: string
      - description: Internal identifier of a RingOut call
        in: path
        name: ringoutId
        required: true
        schema:
          type: integer
      responses:
        default:
          content: {}
          description: Success
      summary: Cancel RingOut Call
      tags:
      - RingOut
      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
    get:
      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
      parameters:
      - description: Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
        in: path
        name: accountId
        required: true
        schema:
          default: ~
          type: string
      - description: Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session
        in: path
        name: extensionId
        required: true
        schema:
          default: ~
          type: string
      - description: Internal identifier of a RingOut call
        in: path
        name: ringoutId
        required: true
        schema:
          type: integer
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetRingOutStatusResponse'
          description: Success
      summary: Get Status of RingOut Call
      tags:
      - RingOut
      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
  /restapi/v1.0/account/{accountId}/extension/{extensionId}/address-book/contact:
    get:
      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
      parameters:
      - description: Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
        in: path
        name: accountId
        required: true
        schema:
          default: ~
          type: string
      - description: Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session
        in: path
        name: extensionId
        required: true
        schema:
          default: ~
          type: string
      - description: If specified, only contacts whose First name or Last name start with the mentioned substring are returned. Case-insensitive
        in: query
        name: startsWith
        schema:
          type: string
      - description: Sorts results by the specified property. The default is 'First Name'
        explode: true
        in: query
        name: sortBy
        schema:
          enum:
          - FirstName
          - LastName
          - Company
          items:
            type: string
          type: array
        style: form
      - description: Indicates the page number to retrieve. Only positive number values are allowed. Default value is '1'
        in: query
        name: page
        schema:
          type: integer
      - description: Indicates the page size (number of items). If not specified, the value is '100' by default
        in: query
        name: perPage
        schema:
          type: integer
      - explode: true
        in: query
        name: phoneNumber
        schema:
          items:
            type: string
          type: array
        style: form
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContactList'
          description: Success
      summary: Get Contacts
      tags:
      - User Contacts
      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:
      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
      parameters:
      - description: Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
        in: path
        name: accountId
        required: true
        schema:
          default: ~
          type: string
      - description: Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session
        in: path
        name: extensionId
        required: true
        schema:
          default: ~
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PersonalContactResource'
        required: false
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PersonalContactResource'
          description: Success
      summary: Create Contact
      tags:
      - User Contacts
      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}:
    delete:
      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
      parameters:
      - description: Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
        in: path
        name: accountId
        required: true
        schema:
          default: ~
          type: string
      - description: Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session
        in: path
        name: extensionId
        required: true
        schema:
          default: ~
          type: string
      - description: Internal identifier of a contact record in the RingCentral database
        in: path
        name: contactId
        required: true
        schema:
          type: integer
      responses:
        default:
          content: {}
          description: Success
      summary: Delete Contact(s) by ID
      tags:
      - User Contacts
      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
    get:
      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
      parameters:
      - description: Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
        in: path
        name: accountId
        required: true
        schema:
          default: ~
          type: string
      - description: Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session
        in: path
        name: extensionId
        required: true
        schema:
          default: ~
          type: string
      - description: Internal identifier of a contact record in the RingCentral database
        in: path
        name: contactId
        required: true
        schema:
          type: integer
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PersonalContactResource'
          description: Success
      summary: Get Contact(s) by ID
      tags:
      - User Contacts
      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:
      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
      parameters:
      - description: Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
        in: path
        name: accountId
        required: true
        schema:
          default: ~
          type: string
      - description: Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session
        in: path
        name: extensionId
        required: true
        schema:
          default: ~
          type: string
      - description: Internal identifier of a contact record in the RingCentral database
        in: path
        name: contactId
        required: true
        schema:
          type: integer
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PersonalContactResource'
        required: false
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PersonalContactResource'
          description: Success
      summary: Update Contact(s) by ID
      tags:
      - User Contacts
      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:
      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
      parameters:
      - description: Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
        in: path
        name: accountId
        required: true
        schema:
          default: ~
          type: string
      - description: Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session
        in: path
        name: extensionId
        required: true
        schema:
          default: ~
          type: string
      - description: Type of synchronization. The default value is 'FSync'
        explode: true
        in: query
        name: syncType
        schema:
          enum:
          - FSync
          - ISync
          items:
            type: string
          type: array
        style: form
      - description: Value of syncToken property of the last sync request response
        in: query
        name: syncToken
        schema:
          type: string
      - 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
        in: query
        name: perPage
        schema:
          type: integer
      - description: Internal identifier of a page. It can be obtained from the 'nextPageId' parameter passed in response body
        in: query
        name: pageId
        schema:
          type: integer
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AddressBookSync'
          description: Success
      summary: Address Book Synchronization
      tags:
      - User Contacts
      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:
      operationId: contactFavorite
      parameters:
      - description: Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
        in: path
        name: accountId
        required: true
        schema:
          default: ~
          type: string
      - description: Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session
        in: path
        name: extensionId
        required: true
        schema:
          default: ~
          type: string
      responses:
        default:
          content: {}
          description: successful operation
      summary: Get Favorite Contacts
      tags:
      - User Contacts
      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:
      operationId: createContacts
      parameters:
      - description: Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
        in: path
        name: accountId
        required: true
        schema:
          default: ~
          type: string
      - description: Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session
        in: path
        name: extensionId
        required: true
        schema:
          default: ~
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FavoriteCollection'
        required: false
      responses:
        default:
          content: {}
          description: successful operation
      summary: Update Favorite Contacts
      tags:
      - User Contacts
      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:
      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>'
      operationId: listCompanyDirectoryContacts
      parameters:
      - description: Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
        in: path
        name: accountId
        required: true
        schema:
          default: ~
          type: string
      - description: Indicates the page number to retrieve. Only positive number values are allowed. Default value is '1'
        in: query
        name: page
        schema:
          format: int64
          type: integer
      - 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'
        in: query
        name: perPage
        schema:
          format: int64
          type: integer
      - description: If 'True' then only contacts of current account are returned, if 'False' then all contacts of all federation accounts are returned
        in: query
        name: excludeFederatedContacts
        schema:
          type: boolean
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompanyDirectoryContacts'
          description: Success
      summary: Get Company Directory
      tags:
      - Company Contacts
      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:
      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>
      operationId: loadCompanyDirectoryContact
      parameters:
      - description: Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
        in: path
        name: accountId
        required: true
        schema:
          default: ~
          type: string
      - description: Internal identifier of an extension
        in: path
        name: contactId
        required: true
        schema:
          type: string
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContactInfo'
          description: Success
      summary: Get Company Directory Contact
      tags:
      - Company Contacts
      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:
      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>
      operationId: loadCompanyDirectoryFederation
      parameters:
      - description: Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
        in: path
        name: accountId
        required: true
        schema:
          default: ~
          type: string
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FederationInfo'
          description: Success
      summary: Get Account Federation
      tags:
      - Company Contacts
      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:
      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>
      operationId: loadCompanyDirectoryFederationConflicts
      parameters:
      - description: Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
        in: path
        name: accountId
        required: true
        schema:
          default: ~
          type: string
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FederationConflicts'
          description: Success
      summary: Get Account Federation Conflicts
      tags:
      - Company Contacts
      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:
      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>
      operationId: loadCompanyDirectoryExtensionNumbers
      parameters:
      - description: Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
        in: path
        name: accountId
        required: true
        schema:
          default: ~
          type: string
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FederationExtensionNumbers'
          description: Success
      summary: Get Existing Extension Numbers
      tags:
      - Company Contacts
      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:
      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>
      operationId: listExtensions
      parameters:
      - description: Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
        in: path
        name: accountId
        required: true
        schema:
          default: ~
          type: string
      - description: Indicates the page number to retrieve. Only positive number values are allowed. Default value is '1'
        in: query
        name: page
        schema:
          format: int64
          type: integer
      - description: Indicates the page size (number of items). If not specified, the value is '100' by default.
        in: query
        name: perPage
        schema:
          format: int64
          type: integer
      - allowEmptyValue: true
        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
        explode: true
        in: query
        name: status
        schema:
          enum:
          - Enabled
          - Disabled
          - NotActivated
          - Unassigned
          items:
            type: string
          type: array
        style: form
      - allowEmptyValue: true
        description: Extension type. Multiple values are supported
        explode: true
        in: query
        name: type
        schema:
          enum:
          - User
          - FaxUser
          - VirtualUser
          - DigitalUser
          - Department
          - Announcement
          - Voicemail
          - SharedLinesGroup
          - PagingOnly
          - IvrMenu
          - ApplicationExtension
          - ParkLocation
          - Limited
          - Bot
          items:
            type: string
          type: array
        style: form
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetExtensionListResponse'
          description: Success
      summary: Get Extensions
      tags:
      - Company Contacts
      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:
      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>
      operationId: createExtension
      parameters:
      - description: Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
        in: path
        name: accountId
        required: true
        schema:
          default: ~
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExtensionCreationRequest'
        description: JSON body
        required: true
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExtensionInfo'
          description: Success
      summary: Create Extension
      tags:
      - Company Contacts
      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:
      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>'
      operationId: createBotExtension
      parameters:
      - description: Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
        in: path
        name: accountId
        required: true
        schema:
          default: ~
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BotExtensionCreationRequest'
        description: JSON body
        required: true
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BotExtensionCreation'
          description: Success
      summary: Create Bot Extension
      tags:
      - Company Contacts
      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:
      operationId: accountPresence
      parameters:
      - in: path
        name: accountId
        required: true
        schema:
          type: string
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountPresenceInfo'
          description: successful operation
      summary: Get all user statuses
      tags:
      - Presence
      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:
      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
      parameters:
      - description: Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
        in: path
        name: accountId
        required: true
        schema:
          default: ~
          type: string
      - description: Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session
        in: path
        name: extensionId
        required: true
        schema:
          default: ~
          type: string
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetPresenceInfo'
          description: Success
      summary: Get User Status
      tags:
      - Presence
      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:
      operationId: updatePresenceStatus
      parameters:
      - description: Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
        in: path
        name: accountId
        required: true
        schema:
          default: ~
          type: string
      - description: Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session
        in: path
        name: extensionId
        required: true
        schema:
          default: ~
          type: string
      requestBody:
        content:
          multipart/mixed:
            schema:
              $ref: '#/components/schemas/PresenceInfoResource'
          application/json:
            schema:
              $ref: '#/components/schemas/PresenceInfoResource'
        required: true
      responses:
        default:
          content:
            multipart/mixed:
              schema:
                $ref: '#/components/schemas/PresenceInfoResource'
            application/json:
              schema:
                $ref: '#/components/schemas/PresenceInfoResource'
          description: successful operation
      summary: Update User Status
      tags:
      - Presence
      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:
      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
      parameters:
      - description: Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
        in: path
        name: accountId
        required: true
        schema:
          default: ~
          type: string
      - description: Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session
        in: path
        name: extensionId
        required: true
        schema:
          default: ~
          type: string
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetMonitoredExtensionsResponse'
          description: Success
      summary: Get Monitored Extensions
      tags:
      - Presence
      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:
      operationId: updatePresenceLines
      parameters:
      - description: Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
        in: path
        name: accountId
        required: true
        schema:
          default: ~
          type: string
      - description: Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session
        in: path
        name: extensionId
        required: true
        schema:
          default: ~
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdatePresenceLinesRequest'
        required: true
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdatePresenceLinesResponse'
          description: successful operation
      summary: Update Monitored Extensions
      tags:
      - Presence
      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:
      operationId: getPresenceLine
      parameters:
      - in: path
        name: lineId
        required: true
        schema:
          type: string
      - description: Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session
        in: path
        name: extensionId
        required: true
        schema:
          default: ~
          type: string
      - description: Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
        in: path
        name: accountId
        required: true
        schema:
          default: ~
          type: string
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PresenceLineResource'
          description: successful operation
      summary: Get Monitored Extensions by Id
      tags:
      - Presence
      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:
      operationId: getMonitoringExtensions
      parameters:
      - description: Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session
        in: path
        name: extensionId
        required: true
        schema:
          default: ~
          type: string
      - in: path
        name: accountId
        required: true
        schema:
          type: string
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MonitoringExtensionsResource'
          description: successful operation
      summary: Get User Presence Permissions
      tags:
      - Presence
      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:
      operationId: putMonitoringExtensions
      parameters:
      - description: Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session
        in: path
        name: extensionId
        required: true
        schema:
          default: ~
          type: string
      - in: path
        name: accountId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserPresencePermissionsUpdateRequest'
        required: true
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MonitoringExtensionsResource'
          description: successful operation
      summary: Update User Presence Permissions
      tags:
      - Presence
      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:
      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>
      operationId: loadCompany
      parameters:
      - description: Internal identifier of an RC account/Glip company, or tilde (~) to indicate a company the current user belongs to
        in: path
        name: companyId
        required: true
        schema:
          type: string
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GlipCompany'
          description: Success
      summary: Get Company Info
      tags:
      - Glip
      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:
      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>
      operationId: loadGroupList
      parameters:
      - allowEmptyValue: true
        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
        explode: true
        in: query
        name: type
        schema:
          enum:
          - PrivateChat
          - Group
          - Team
          items:
            type: string
          type: array
        style: form
      - description: Token of a page to be returned, see Glip Navigation Info
        in: query
        name: pageToken
        schema:
          type: string
      - description: Max numbers of records to be returned. The default/maximum value is 250
        in: query
        name: recordCount
        schema:
          format: int64
          type: integer
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GlipGroupList'
          description: Success
      summary: Get User Groups
      tags:
      - Glip
      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:
      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>
      operationId: createGroup
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GlipCreateGroup'
        description: JSON body
        required: true
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GlipGroupInfo'
          description: Success
      summary: Create Group
      tags:
      - Glip
      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:
      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>
      operationId: loadGroup
      parameters:
      - description: Internal identifier of a group to be returned, the maximum number of IDs is 30
        in: path
        name: groupId
        required: true
        schema:
          type: string
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GlipGroupInfo'
          description: Success
      summary: Get Group
      tags:
      - Glip
      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:
      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>'
      operationId: updateGroup
      parameters:
      - description: Internal identifier of a group to be edited
        in: path
        name: groupId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EditGroupRequest'
        description: JSON body
        required: true
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GlipGroupInfo'
          description: Success
      summary: Edit Group Members
      tags:
      - Glip
      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:
      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>
      operationId: loadPerson
      parameters:
      - description: Internal identifier of a user to be returned, the maximum number of IDs is 30
        in: path
        name: personId
        required: true
        schema:
          type: string
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GlipPersonInfo'
          description: Success
      summary: Get Person
      tags:
      - Glip
      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:
      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>
      operationId: loadPosts
      parameters:
      - description: Identifier of a group to filter posts
        in: path
        name: groupId
        required: true
        schema:
          type: string
      - description: Token of a page to be returned, see Glip Navigation Info
        in: query
        name: pageToken
        schema:
          type: string
      - description: Max numbers of records to be returned. The default/maximum value is 250
        in: query
        name: recordCount
        schema:
          format: int64
          type: integer
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GlipPosts'
          description: Success
      summary: Get Posts
      tags:
      - Glip
      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:
      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>
      operationId: createPost
      parameters:
      - description: Id of a group to send post
        in: path
        name: groupId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GlipCreatePost'
        description: JSON body
        required: true
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GlipPostInfo'
          description: Success
      summary: Create Post
      tags:
      - Glip
      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:
      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>
      operationId: createGlipFile
      parameters:
      - description: Internal identifier of a group the post with file attached will be added to
        in: query
        name: groupId
        schema:
          type: string
      requestBody:
        content:
          multipart/form-data:
            schema:
              properties:
                body:
                  description: The file to upload
                  format: binary
                  type: string
                name:
                  description: Name of a file attached
                  type: string
              required:
              - body
        required: true
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostGlipFile'
          description: Success
      summary: Upload File
      tags:
      - Glip
      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:
      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>
      operationId: loadGlipFile
      parameters:
      - description: Internal identifier of file.
        in: path
        name: fileId
        required: true
        schema:
          type: string
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostGlipFile'
          description: Success
      summary: Get File Info
      tags:
      - Glip
      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:
      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>
      operationId: loadUnreadMessageCount
      parameters:
      - description: List of attributes to be returned. To return unread message count 'unreadPostsCount' and 'tooManyUnreadPosts' should be specified
        in: query
        name: fields
        schema:
          type: string
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GlipUnreadMessageCount'
          description: Success
      summary: Glip Unread Message Count
      tags:
      - Glip
      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:
      operationId: getLiveMeetings
      parameters:
      - in: path
        name: accountId
        required: true
        schema:
          type: string
      - in: path
        name: extensionId
        required: true
        schema:
          type: string
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MeetingsResource'
          description: successful operation
      summary: Get Scheduled Meetings
      tags:
      - Meetings
      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:
      operationId: createMeeting
      parameters:
      - in: path
        name: accountId
        required: true
        schema:
          type: string
      - in: path
        name: extensionId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MeetingRequestResource'
        required: true
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MeetingResponseResource'
          description: successful operation
      summary: Create Meetings
      tags:
      - Meetings
      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}:
    delete:
      operationId: deleteMeeting
      parameters:
      - in: path
        name: meetingId
        required: true
        schema:
          type: string
      - in: path
        name: extensionId
        required: true
        schema:
          type: string
      - in: path
        name: accountId
        required: true
        schema:
          type: string
      responses:
        default:
          content: {}
          description: successful operation
      summary: Delete Meeting
      tags:
      - Meetings
      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
    get:
      operationId: getMeetingDetails
      parameters:
      - in: path
        name: accountId
        required: true
        schema:
          type: string
      - in: path
        name: extensionId
        required: true
        schema:
          type: string
      - in: path
        name: meetingId
        required: true
        schema:
          type: string
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MeetingResponseResource'
          description: successful operation
      summary: Get Meeting Info
      tags:
      - Meetings
      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:
      operationId: updateMeeting
      parameters:
      - in: path
        name: accountId
        required: true
        schema:
          type: string
      - in: path
        name: extensionId
        required: true
        schema:
          type: string
      - in: path
        name: meetingId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MeetingRequestResource'
        required: true
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MeetingResponseResource'
          description: successful operation
      summary: Update Meeting
      tags:
      - Meetings
      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:
      operationId: endMeeting
      parameters:
      - in: path
        name: meetingId
        required: true
        schema:
          type: string
      - in: path
        name: extensionId
        required: true
        schema:
          type: string
      - in: path
        name: accountId
        required: true
        schema:
          type: string
      responses:
        default:
          content: {}
          description: successful operation
      summary: End Meeting
      tags:
      - Meetings
      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:
      operationId: getMeetingServiceInfo
      parameters:
      - in: path
        name: extensionId
        required: true
        schema:
          type: string
      - in: path
        name: accountId
        required: true
        schema:
          type: string
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MeetingServiceInfoResource'
          description: successful operation
      summary: Get Meeting Service Info
      tags:
      - Meetings
      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:
      operationId: getSubscriptions
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RecordsCollectionResourceSubscriptionResponse'
          description: successful operation
      summary: Get Subscriptions
      tags:
      - Push Notifications
      x-api-group: subscription
      x-throttling-group: Light
      x-metered-api: true
      x-metering-group: System
      x-access-level: Public
    post:
      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
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateSubscriptionRequest'
        description: JSON body
        required: true
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubscriptionInfo'
          description: Success
      summary: Create Subscription
      tags:
      - Push Notifications
      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}:
    delete:
      description: <p style='font-style:italic;'></p><p>Cancels the existent subscription.</p><h4>Usage Plan Group</h4><p>Medium</p>
      operationId: deleteSubscription
      parameters:
      - description: Internal identifier of a subscription
        in: path
        name: subscriptionId
        required: true
        schema:
          type: string
      responses:
        default:
          content: {}
          description: Success
      summary: Cancel Subscription
      tags:
      - Push Notifications
      x-api-group: subscription
      x-throttling-group: Medium
      x-metered-api: true
      x-metering-group: System
      x-access-level: Public
    get:
      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
      parameters:
      - description: Internal identifier of a subscription
        in: path
        name: subscriptionId
        required: true
        schema:
          type: integer
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubscriptionInfo'
          description: Success
      summary: Get Subscription
      tags:
      - Push Notifications
      x-api-group: subscription
      x-throttling-group: Light
      x-metered-api: true
      x-metering-group: System
      x-access-level: Public
    put:
      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
      parameters:
      - description: Internal identifier of a subscription
        in: path
        name: subscriptionId
        required: true
        schema:
          type: string
      - description: If 'True' then aggregated presence status is returned in a notification payload
        in: query
        name: aggregated
        schema:
          type: boolean
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ModifySubscriptionRequest'
        description: JSON body
        required: true
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubscriptionInfo'
          description: Success
      summary: Renew Subscription / Update Event Filters
      tags:
      - Push Notifications
      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:
      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
      parameters:
      - in: path
        name: subscriptionId
        required: true
        schema:
          type: string
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubscriptionInfo'
          description: successful operation
      summary: Renew Subscription
      tags:
      - Push Notifications
      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:
      operationId: getProfile
      parameters:
      - in: path
        name: extensionId
        required: true
        schema:
          type: string
      - in: path
        name: accountId
        required: true
        schema:
          type: string
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthProfileResource'
          description: successful operation
      summary: Get User Permissions
      tags:
      - Roles and Permissions
      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:
      operationId: checkPermission
      parameters:
      - in: query
        name: permissionId
        schema:
          type: string
      - in: query
        name: targetExtensionId
        schema:
          type: string
      - in: path
        name: extensionId
        required: true
        schema:
          type: string
      - in: path
        name: accountId
        required: true
        schema:
          type: string
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthProfileCheckResource'
          description: successful operation
      summary: Check User Permissions
      tags:
      - Roles and Permissions
      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:
      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>
      operationId: loadUserRole
      parameters:
      - description: Internal identifier of an account
        in: path
        name: accountId
        required: true
        schema:
          default: ~
          type: string
      responses:
        default:
          content: {}
          description: Success
      summary: Get Default User Role
      tags:
      - Roles and Permissions
      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:
      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>
      operationId: updateUserRole
      parameters:
      - description: Internal identifier of an account
        in: path
        name: accountId
        required: true
        schema:
          default: ~
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DefaultUserRoleRequest'
        description: JSON body
        required: true
      responses:
        default:
          content: {}
          description: Success
      summary: Set Default User Role
      tags:
      - Roles and Permissions
      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:
      operationId: listSystemRoles
      parameters:
      - in: query
        name: page
        schema:
          default: "1"
          type: string
      - in: query
        name: perPage
        schema:
          default: "100"
          type: string
      - in: query
        name: servicePlanId
        schema:
          type: string
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RolesCollectionResource'
          description: successful operation
      summary: Get Standard User Roles
      tags:
      - Roles and Permissions
      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:
      operationId: getSystemRole
      parameters:
      - in: path
        name: roleId
        required: true
        schema:
          type: string
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RoleResource'
          description: successful operation
      summary: Get User Role
      tags:
      - Roles and Permissions
      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:
      operationId: listPermissions
      parameters:
      - in: query
        name: page
        schema:
          default: "1"
          type: string
      - in: query
        name: perPage
        schema:
          default: "100"
          type: string
      - in: query
        name: assignable
        schema:
          type: boolean
      - in: query
        name: servicePlanId
        schema:
          type: string
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PermissionCollectionResource'
          description: successful operation
      summary: Get Permissions
      tags:
      - Roles and Permissions
      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:
      operationId: getPermission
      parameters:
      - in: path
        name: permissionId
        required: true
        schema:
          type: string
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PermissionResource'
          description: successful operation
      summary: Get Permission Info
      tags:
      - Roles and Permissions
      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:
      operationId: listPermissionCategories
      parameters:
      - in: query
        name: page
        schema:
          default: "1"
          type: string
      - in: query
        name: perPage
        schema:
          default: "100"
          type: string
      - in: query
        name: servicePlanId
        schema:
          type: string
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PermissionCategoryCollectionResource'
          description: successful operation
      summary: Get Permissions Categories
      tags:
      - Roles and Permissions
      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:
      operationId: getPermissionCategory
      parameters:
      - in: path
        name: permissionCategoryId
        required: true
        schema:
          type: string
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PermissionCategoryResource'
          description: successful operation
      summary: Get Permission Category
      tags:
      - Roles and Permissions
      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:
      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
      parameters:
      - description: Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
        in: path
        name: accountId
        required: true
        schema:
          default: ~
          type: string
      - description: Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session
        in: path
        name: extensionId
        required: true
        schema:
          default: ~
          type: string
      - description: Indicates the page number to retrieve. Only positive number values are allowed. Default value is '1'
        in: query
        name: page
        schema:
          type: integer
      - description: Indicates the page size (number of items). If not specified, the value is '100' by default
        in: query
        name: perPage
        schema:
          type: integer
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetExtensionForwardingNumberListResponse'
          description: Success
      summary: Get Forwarding Numbers
      tags:
      - Call Handling Settings
      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:
      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
      parameters:
      - description: Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
        in: path
        name: accountId
        required: true
        schema:
          default: ~
          type: string
      - description: Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session
        in: path
        name: extensionId
        required: true
        schema:
          default: ~
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateForwardingNumberRequest'
        description: JSON body
        required: true
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForwardingNumberInfo'
          description: Success
      summary: Create Forwarding Numbers
      tags:
      - Call Handling Settings
      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}:
    delete:
      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
      parameters:
      - description: Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
        in: path
        name: accountId
        required: true
        schema:
          default: ~
          type: string
      - description: Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session
        in: path
        name: extensionId
        required: true
        schema:
          default: ~
          type: string
      - description: Internal identifier of a forwarding number
        in: path
        name: forwardingNumberId
        required: true
        schema:
          type: string
      responses:
        default:
          content: {}
          description: Success
      summary: Delete Forwarding Number
      tags:
      - Call Handling Settings
      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
    get:
      operationId: getForwardingNumber
      parameters:
      - in: path
        name: forwardingNumberId
        required: true
        schema:
          type: string
      - in: path
        name: extensionId
        required: true
        schema:
          type: string
      - in: path
        name: accountId
        required: true
        schema:
          type: string
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForwardingNumberResource'
          description: successful operation
      summary: Get Forwarding Number
      tags:
      - Call Handling Settings
      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:
      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
      parameters:
      - description: Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
        in: path
        name: accountId
        required: true
        schema:
          default: ~
          type: string
      - description: Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session
        in: path
        name: extensionId
        required: true
        schema:
          default: ~
          type: string
      - description: Internal identifier of a forwarding number; returned in response in the id field
        in: path
        name: forwardingNumberId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateForwardingNumberRequest'
        description: JSON body
        required: true
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForwardingNumberInfo'
          description: Success
      summary: Update Forwarding Numbers
      tags:
      - Call Handling Settings
      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:
      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
      parameters:
      - description: Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
        in: path
        name: accountId
        required: true
        schema:
          default: ~
          type: string
      - description: Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session
        in: path
        name: extensionId
        required: true
        schema:
          default: ~
          type: string
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BlockedNumbersList'
          description: Success
      summary: Get Blocked Numbers
      tags:
      - Call Handling Settings
      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:
      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
      parameters:
      - description: Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
        in: path
        name: accountId
        required: true
        schema:
          default: ~
          type: string
      - description: Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session
        in: path
        name: extensionId
        required: true
        schema:
          default: ~
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BlockedNumberInfo'
        required: false
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BlockedNumberInfo'
          description: Success
      summary: Add Blocked Numbers
      tags:
      - Call Handling Settings
      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}:
    delete:
      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
      parameters:
      - description: Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
        in: path
        name: accountId
        required: true
        schema:
          default: ~
          type: string
      - description: Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session
        in: path
        name: extensionId
        required: true
        schema:
          default: ~
          type: string
      - description: Internal identifiers of a blocked number list entry
        in: path
        name: blockedNumberId
        required: true
        schema:
          type: integer
      responses:
        default:
          content: {}
          description: Success
      summary: Delete Blocked Number
      tags:
      - Call Handling Settings
      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
    get:
      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
      parameters:
      - description: Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
        in: path
        name: accountId
        required: true
        schema:
          default: ~
          type: string
      - description: Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session
        in: path
        name: extensionId
        required: true
        schema:
          default: ~
          type: string
      - description: Internal identifiers of a blocked number list entry
        in: path
        name: blockedNumberId
        required: true
        schema:
          type: integer
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BlockedNumberInfo'
          description: Success
      summary: Get Blocked Number
      tags:
      - Call Handling Settings
      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:
      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
      parameters:
      - description: Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
        in: path
        name: accountId
        required: true
        schema:
          default: ~
          type: string
      - description: Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session
        in: path
        name: extensionId
        required: true
        schema:
          default: ~
          type: string
      - description: Internal identifier of a blocked number list entry
        in: path
        name: blockedNumberId
        required: true
        schema:
          type: integer
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BlockedNumberInfo'
        required: false
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BlockedNumberInfo'
          description: Success
      summary: Update Blocked Number
      tags:
      - Call Handling Settings
      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:
      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
      parameters:
      - description: Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
        in: path
        name: accountId
        required: true
        schema:
          default: ~
          type: string
      - description: Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session
        in: path
        name: extensionId
        required: true
        schema:
          default: ~
          type: string
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetUserBusinessHoursResponse'
          description: Success
      summary: Get User Business Hours
      tags:
      - Call Handling Settings
      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:
      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>
      operationId: updateUserBusinessHours
      parameters:
      - description: Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
        in: path
        name: accountId
        required: true
        schema:
          default: ~
          type: string
      - description: Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session
        in: path
        name: extensionId
        required: true
        schema:
          default: ~
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserBusinessHoursUpdateRequest'
        description: JSON body
        required: true
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserBusinessHoursUpdate'
          description: Success
      summary: Update User Business Hours
      tags:
      - Call Handling Settings
      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:
      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
      parameters:
      - description: Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
        in: path
        name: accountId
        required: true
        schema:
          default: ~
          type: string
      - description: Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session
        in: path
        name: extensionId
        required: true
        schema:
          default: ~
          type: string
      - in: query
        name: page
        schema:
          default: "1"
          type: string
      - in: query
        name: perPage
        schema:
          default: "100"
          type: string
      responses:
        default:
          content: {}
          description: Success
      summary: Get Call Handling Rules
      tags:
      - Call Handling Settings
      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:
      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
      parameters:
      - description: Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
        in: path
        name: accountId
        required: true
        schema:
          default: ~
          type: string
      - description: Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session
        in: path
        name: extensionId
        required: true
        schema:
          default: ~
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateAnsweringRuleRequest'
        description: JSON body
        required: true
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AnsweringRuleInfo'
          description: Success
      summary: Create Custom Call Handling Rules
      tags:
      - Call Handling Settings
      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}:
    delete:
      operationId: deleteAnsweringRule
      parameters:
      - description: Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
        in: path
        name: accountId
        required: true
        schema:
          default: ~
          type: string
      - description: Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session
        in: path
        name: extensionId
        required: true
        schema:
          default: ~
          type: string
      - description: Internal identifier of an answering rule
        in: path
        name: ruleId
        required: true
        schema:
          type: string
      responses:
        default:
          content: {}
          description: successful operation
      summary: Delete Call Handling Rule
      tags:
      - Call Handling Settings
      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
    get:
      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
      parameters:
      - description: Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
        in: path
        name: accountId
        required: true
        schema:
          default: ~
          type: string
      - description: Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session
        in: path
        name: extensionId
        required: true
        schema:
          default: ~
          type: string
      - 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
        in: path
        name: ruleId
        required: true
        schema:
          type: string
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AnsweringRuleInfo'
          description: Success
      summary: Get Call Handling Rule
      tags:
      - Call Handling Settings
      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:
      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
      parameters:
      - description: Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
        in: path
        name: accountId
        required: true
        schema:
          default: ~
          type: string
      - description: Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session
        in: path
        name: extensionId
        required: true
        schema:
          default: ~
          type: string
      - description: Internal identifier of an answering rule
        in: path
        name: ruleId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateAnsweringRuleRequest'
        description: JSON body
        required: true
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AnsweringRuleInfo'
          description: Success
      summary: Update Custom Call Handling Rule
      tags:
      - Call Handling Settings
      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:
      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
      parameters:
      - description: Indicates the page number to retrieve. Only positive number values are allowed. Default value is '1'
        in: query
        name: page
        schema:
          type: integer
      - description: Indicates the page size (number of items). If not specified, the value is '100' by default
        in: query
        name: perPage
        schema:
          type: integer
      - description: Type of a greeting, specifying the case when the greeting is played
        in: query
        name: type
        schema:
          enum:
          - Introductory
          - Announcement
          - ConnectingMessage
          - ConnectingAudio
          - Voicemail
          - Unavailable
          - HoldMusic
          - Company
          type: string
      - description: Usage type of a greeting, specifying if the greeting is applied for user extension or department extension
        in: query
        name: usageType
        schema:
          enum:
          - UserExtensionAnsweringRule
          - ExtensionAnsweringRule
          - DepartmentExtensionAnsweringRule
          - CompanyAnsweringRule
          - CompanyAfterHoursAnsweringRule
          type: string
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DictionaryGreetingList'
          description: successful operation
      summary: Get Standard Greetings
      tags:
      - Call Handling Settings
      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:
      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
      parameters:
      - in: path
        name: greetingId
        required: true
        schema:
          type: string
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DictionaryGreetingInfo'
          description: successful operation
      summary: Get Greeting Info
      tags:
      - Call Handling Settings
      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:
      operationId: createGreeting
      parameters:
      - description: Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
        in: path
        name: accountId
        required: true
        schema:
          default: ~
          type: string
      - description: Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session
        in: path
        name: extensionId
        required: true
        schema:
          default: ~
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomGreetingRequest'
        required: false
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomCompanyGreetingInfo'
          description: successful operation
      summary: Create User Custom Greeting
      tags:
      - Call Handling Settings
      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:
      operationId: getGreetingByID
      parameters:
      - description: Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
        in: path
        name: accountId
        required: true
        schema:
          default: ~
          type: string
      - description: Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session
        in: path
        name: extensionId
        required: true
        schema:
          default: ~
          type: string
      - in: path
        name: greetingId
        required: true
        schema:
          type: integer
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomCompanyGreetingInfo'
          description: successful operation
      summary: Get Custom Greeting Info
      tags:
      - Call Handling Settings
      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:
      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
      parameters:
      - description: Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
        in: path
        name: accountId
        required: true
        schema:
          default: ~
          type: string
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompanyBusinessHours'
          description: Success
      summary: Get Company Business Hours
      tags:
      - Call Handling Settings
      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:
      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
      parameters:
      - description: Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
        in: path
        name: accountId
        required: true
        schema:
          default: ~
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CompanyBusinessHoursUpdateRequest'
        description: JSON body
        required: true
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompanyBusinessHours'
          description: Success
      summary: Update Company Business Hours
      tags:
      - Call Handling Settings
      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:
      operationId: getCompanyGreeting
      parameters:
      - description: Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
        in: path
        name: accountId
        required: true
        schema:
          default: ~
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomCompanyGreetingRequest'
        description: JSON body
        required: true
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomCompanyGreetingInfo'
          description: successful operation
      summary: Create Custom Company Greeting
      tags:
      - Call Handling Settings
      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:
    get:
      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>
      operationId: listCompanyAnsweringRule
      parameters:
      - description: Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
        in: path
        name: accountId
        required: true
        schema:
          default: ~
          type: string
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompanyAnsweringRuleList'
          description: Success
      summary: Get Company Call Handling Rules
      tags:
      - Call Handling Settings
      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
    post:
      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>
      operationId: createCompanyAnsweringRuleInfo
      parameters:
      - description: Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
        in: path
        name: accountId
        required: true
        schema:
          default: ~
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CompanyAnsweringRuleRequest'
        description: JSON body
        required: true
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompanyAnsweringRuleInfo'
          description: Success
      summary: Create Company Call Handling Rule
      tags:
      - Call Handling Settings
      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}/answering-rule/{ruleId}:
    get:
      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>
      operationId: loadCompanyAnsweringRuleInfo
      parameters:
      - description: Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
        in: path
        name: accountId
        required: true
        schema:
          default: ~
          type: string
      - 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
        in: path
        name: ruleId
        required: true
        schema:
          type: string
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompanyAnsweringRuleInfo'
          description: Success
      summary: Get Company Call Handling Rule
      tags:
      - Call Handling Settings
      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:
      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>
      operationId: updateCompanyAnsweringRuleInfo
      parameters:
      - description: Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
        in: path
        name: accountId
        required: true
        schema:
          default: ~
          type: string
      - 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
        in: path
        name: ruleId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CompanyAnsweringRuleUpdate'
        description: JSON body
        required: true
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompanyAnsweringRuleInfo'
          description: Success
      summary: Update Company Call Handling Rule
      tags:
      - Call Handling Settings
      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:
      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>
      operationId: createIVRMenu
      parameters:
      - in: path
        name: accountId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IVRMenuInfo'
        description: JSON body
        required: true
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IVRMenuInfo'
          description: Success
      summary: Create IVR Menu
      tags:
      - Call Handling Settings
      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:
      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>
      operationId: getIVRMenuById
      parameters:
      - in: path
        name: accountId
        required: true
        schema:
          type: string
      - in: path
        name: ivrMenuId
        required: true
        schema:
          type: string
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IVRMenuInfo'
          description: Success
      summary: Get IVR Menu
      tags:
      - Call Handling Settings
      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:
      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>
      parameters:
      - in: path
        name: accountId
        required: true
        schema:
          type: string
      - in: path
        name: ivrMenuId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IVRMenuInfo'
        description: JSON body
        required: true
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IVRMenuInfo'
          description: Success
      summary: Update IVR Menu
      tags:
      - Call Handling Settings
      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:
    get:
      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>
      operationId: getIVRPrompts
      parameters:
      - in: path
        name: accountId
        required: true
        schema:
          type: string
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IVRPrompts'
          description: Success
      summary: Get IVR Prompts
      tags:
      - Call Handling Settings
      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
    post:
      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>
      operationId: createPrompts
      parameters:
      - in: path
        name: accountId
        required: true
        schema:
          type: string
      requestBody:
        content:
          multipart/form-data:
            schema:
              properties:
                attachment:
                  description: Audio file that will be used as a prompt. Attachment cannot be empty, only audio files are supported
                  format: binary
                  type: string
                name:
                  description: Description of file contents.
                  type: string
              required:
              - attachment
        required: true
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PromptInfo'
          description: Success
      summary: Create IVR Prompt
      tags:
      - Call Handling Settings
      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
  /restapi/v1.0/account/{accountId}/ivr-prompts/{promptId}:
    delete:
      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>
      operationId: deleteIVRPrompt
      parameters:
      - in: path
        name: accountId
        required: true
        schema:
          type: string
      - in: path
        name: promptId
        required: true
        schema:
          type: string
      responses:
        default:
          content: {}
          description: Success
      summary: Delete IVR Prompt
      tags:
      - Call Handling Settings
      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
    get:
      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>
      operationId: getIVRPrompt
      parameters:
      - in: path
        name: accountId
        required: true
        schema:
          type: string
      - in: path
        name: promptId
        required: true
        schema:
          type: string
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PromptInfo'
          description: Success
      summary: Get IVR Prompt
      tags:
      - Call Handling Settings
      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}/content:
    get:
      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>
      operationId: getIVRPromptContent
      parameters:
      - in: path
        name: accountId
        required: true
        schema:
          type: string
      - in: path
        name: promptId
        required: true
        schema:
          type: string
      responses:
        default:
          content: {}
          description: Success
      summary: Get IVR Prompt Content
      tags:
      - Call Handling Settings
      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:
      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
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientApiResponse'
          description: Success
      summary: Get App Settings
      tags:
      - Application Settings
      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:
      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
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateSipRegistrationRequest'
        description: JSON body
        required: true
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateSipRegistrationResponse'
          description: Success
      summary: Register SIP Device
      tags:
      - Application Settings
      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:
      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
        name: bannerType
        required: true
        schema:
          default: LeaderBoard
          type: string
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InProductMessages'
          description: Success
      summary: Get In Product Message List
      tags:
      - Application Settings
      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}:
    delete:
      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
      parameters:
      - 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
        in: path
        name: key
        required: true
        schema:
          type: integer
      responses:
        default:
          content: {}
          description: successful operation
      summary: Delete Custom Data
      tags:
      - Application Settings
      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
    get:
      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
      parameters:
      - 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
        in: path
        name: key
        required: true
        schema:
          type: integer
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomDataResource'
          description: successful operation
      summary: Get Custom Data
      tags:
      - Application Settings
      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:
      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
      parameters:
      - 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
        in: path
        name: key
        required: true
        schema:
          type: integer
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomDataRequest'
        description: JSON body
        required: true
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomDataApiResponse'
          description: Success
      summary: Create/Update Custom Data
      tags:
      - Application Settings
      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:
      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
      parameters:
      - in: path
        name: key
        required: true
        schema:
          type: string
      - in: header
        name: Range
        schema:
          type: string
      responses:
        default:
          content: {}
          description: successful operation
      summary: Get Custom Data Attachment
      tags:
      - Application Settings
      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:
      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.
      parameters:
      - description: Internal identifier of a country. If not specified, the response is returned for the brand country
        in: query
        name: countryId
        schema:
          type: integer
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NavigationInfo'
          description: Success
      summary: Get Special Numbers Calling Limitation
      tags:
      - Application Settings
      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:
      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
      responses:
        default:
          content: {}
          description: Success
      summary: Get Phonedata
      tags:
      - Application Settings
      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}:
    delete:
      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
      parameters:
      - in: path
        name: extensionId
        required: true
        schema:
          type: string
      - in: path
        name: accountId
        required: true
        schema:
          type: string
      responses:
        default:
          content: {}
          description: successful operation
      summary: Delete Extension
      tags:
      - User Settings
      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
    get:
      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
      parameters:
      - description: Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
        in: path
        name: accountId
        required: true
        schema:
          default: ~
          type: string
      - description: Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session
        in: path
        name: extensionId
        required: true
        schema:
          default: ~
          type: string
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetExtensionInfoResponse'
          description: Success
      summary: Get Extension Info
      tags:
      - User Settings
      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:
      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
      parameters:
      - description: Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
        in: path
        name: accountId
        required: true
        schema:
          default: ~
          type: string
      - description: Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session
        in: path
        name: extensionId
        required: true
        schema:
          default: ~
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExtensionUpdateRequest'
        description: JSON body
        required: true
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetExtensionInfoResponse'
          description: Success
      summary: Update Extension
      tags:
      - User Settings
      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
  /restapi/v1.0/account/{accountId}/extension/{extensionId}/caller-id:
    get:
      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>
      operationId: loadExtensionCallerId
      parameters:
      - description: Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
        in: path
        name: accountId
        required: true
        schema:
          default: ~
          type: string
      - description: Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session
        in: path
        name: extensionId
        required: true
        schema:
          default: ~
          type: string
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExtensionCallerIdInfo'
          description: Success
      summary: Get Extension Caller ID
      tags:
      - User Settings
      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:
      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>
      operationId: updateExtensionCallerId
      parameters:
      - description: Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
        in: path
        name: accountId
        required: true
        schema:
          default: ~
          type: string
      - description: Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session
        in: path
        name: extensionId
        required: true
        schema:
          default: ~
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExtensionCallerIdInfo'
        description: JSON body
        required: true
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExtensionCallerIdInfo'
          description: Success
      summary: Update Extension Caller ID
      tags:
      - User Settings
      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:
      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>
      operationId: loadExtensionUserCredentials
      parameters:
      - description: Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
        in: path
        name: accountId
        required: true
        schema:
          default: ~
          type: string
      - description: Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session
        in: path
        name: extensionId
        required: true
        schema:
          default: ~
          type: string
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExtensionUserCredentials'
          description: Success
      summary: Get User Credentials
      tags:
      - User Settings
      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:
      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>
      operationId: updateExtensionUserCredentials
      parameters:
      - description: Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
        in: path
        name: accountId
        required: true
        schema:
          default: ~
          type: string
      - description: Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session
        in: path
        name: extensionId
        required: true
        schema:
          default: ~
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExtensionUserCredentailsRequest'
        description: JSON body
        required: true
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExtensionUserCredentials'
          description: Success
      summary: Update User Credentials
      tags:
      - User Settings
      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:
      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>
      operationId: validateExtensionUserCredentials
      parameters:
      - description: Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
        in: path
        name: accountId
        required: true
        schema:
          default: ~
          type: string
      - description: Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session
        in: path
        name: extensionId
        required: true
        schema:
          default: ~
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ValidateExtensionUserCredentials'
        description: JSON body
        required: true
      responses:
        default:
          content: {}
          description: Success
      summary: Validate User Credentials
      tags:
      - User Settings
      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:
      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>
      operationId: verifyExtensionUserCredentials
      parameters:
      - description: Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
        in: path
        name: accountId
        required: true
        schema:
          default: ~
          type: string
      - description: Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session
        in: path
        name: extensionId
        required: true
        schema:
          default: ~
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/VerifyExtensionUserCredentials'
        description: JSON body
        required: true
      responses:
        default:
          content: {}
          description: Success
      summary: Verify Extension User Credentials
      tags:
      - User Settings
      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:
      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
      parameters:
      - in: query
        name: signupOnly
        schema:
          default: false
          type: boolean
      - in: query
        name: page
        schema:
          default: "1"
          type: string
      - in: query
        name: perPage
        schema:
          default: "100"
          type: string
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetSecretQuestionListResponse'
          description: Success
      summary: Get Secret Questions
      tags:
      - User Settings
      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:
      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
      parameters:
      - description: Internal identifier of a question
        in: path
        name: questionId
        required: true
        schema:
          type: integer
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecretQuestionInfo'
          description: Success
      summary: Get Secret Question
      tags:
      - User Settings
      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:
      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
      parameters:
      - description: Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
        in: path
        name: accountId
        required: true
        schema:
          default: ~
          type: string
      - description: Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session
        in: path
        name: extensionId
        required: true
        schema:
          default: ~
          type: string
      - description: Indicates the page number to retrieve. Only positive number values are allowed. Default value is '1'
        in: query
        name: page
        schema:
          type: integer
      - description: Indicates the page size (number of items). If not specified, the value is '100' by default
        in: query
        name: perPage
        schema:
          type: integer
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetExtensionGrantListResponse'
          description: Success
      summary: Get Extension Grants
      tags:
      - User Settings
      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:
      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
      parameters:
      - description: Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
        in: path
        name: accountId
        required: true
        schema:
          default: ~
          type: string
      - description: Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session
        in: path
        name: extensionId
        required: true
        schema:
          type: string
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationSettings'
          description: Success
      summary: Get Notification Settings
      tags:
      - User Settings
      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:
      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
      parameters:
      - description: Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
        in: path
        name: accountId
        required: true
        schema:
          default: ~
          type: string
      - description: Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session
        in: path
        name: extensionId
        required: true
        schema:
          type: integer
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NotificationSettingsUpdateRequest'
        required: true
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationSettings'
          description: Success
      summary: Update Notification Settings
      tags:
      - User Settings
      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:
      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
      parameters:
      - in: path
        name: extensionId
        required: true
        schema:
          type: string
      - in: path
        name: accountId
        required: true
        schema:
          type: string
      responses:
        default:
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/Binary'
            image/png:
              schema:
                $ref: '#/components/schemas/Binary'
            image/jpeg:
              schema:
                $ref: '#/components/schemas/Binary'
            image/gif:
              schema:
                $ref: '#/components/schemas/Binary'
          description: successful operation
      summary: Get User Profile Image
      tags:
      - User Settings
      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:
      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
      parameters:
      - in: path
        name: extensionId
        required: true
        schema:
          type: string
      - in: path
        name: accountId
        required: true
        schema:
          type: string
      requestBody:
        content:
          multipart/form-data:
            schema:
              properties:
                image:
                  format: binary
                  type: string
              required:
              - image
        required: true
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Binary'
          description: successful operation
      summary: Upload User Profile Image
      tags:
      - User Settings
      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:
      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
      parameters:
      - in: path
        name: extensionId
        required: true
        schema:
          type: string
      - in: path
        name: accountId
        required: true
        schema:
          type: string
      requestBody:
        content:
          multipart/form-data:
            schema:
              properties:
                image:
                  format: binary
                  type: string
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Binary'
          description: successful operation
      summary: Update User Profile Image
      tags:
      - User Settings
      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:
      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
      parameters:
      - description: Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
        in: path
        name: accountId
        required: true
        schema:
          default: ~
          type: string
      - description: Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session
        in: path
        name: extensionId
        required: true
        schema:
          default: ~
          type: string
      - description: Dimensions of a profile image which will be returned in response. If this path parameter is not specified in request URI then
        in: path
        name: scaleSize
        required: true
        schema:
          type: string
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Binary'
          description: Success
      summary: Get Extension Profile Image (Scaled)
      tags:
      - User Settings
      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:
      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
      parameters:
      - description: Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
        in: path
        name: accountId
        required: true
        schema:
          default: ~
          type: string
      - description: Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session
        in: path
        name: extensionId
        required: true
        schema:
          default: ~
          type: string
      - description: Internal identifier of a country. If not specified, the response is returned for the brand country
        in: query
        name: countryId
        schema:
          type: string
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetConferencingInfoResponse'
          description: Success
      summary: Get User Conferencing Settings
      tags:
      - User Settings
      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:
      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
      parameters:
      - description: Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
        in: path
        name: accountId
        required: true
        schema:
          default: ~
          type: string
      - description: Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session
        in: path
        name: extensionId
        required: true
        schema:
          default: ~
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateConferencingInfoRequest'
        description: JSON body
        required: true
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetConferencingInfoResponse'
          description: Success
      summary: Update User Conferencing Settings
      tags:
      - User Settings
      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}:
    delete:
      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
      parameters:
      - in: path
        name: accountId
        required: true
        schema:
          type: string
      responses:
        default:
          content: {}
          description: successful operation
      summary: Delete Account
      tags:
      - Company Settings
      x-api-group: account
      x-throttling-group: Medium
      x-metered-api: true
      x-metering-group: System
      x-app-permission: Accounts
      x-access-level: Internal
    get:
      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
      parameters:
      - description: Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
        in: path
        name: accountId
        required: true
        schema:
          default: ~
          type: string
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAccountInfoResponse'
          description: Success
      summary: Get Company Info
      tags:
      - Company Settings
      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:
      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
      parameters:
      - in: path
        name: accountId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateAccountRequest'
        description: JSON body
        required: true
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAccountInfoResponse'
          description: successful operation
      summary: Update Company
      tags:
      - Company Settings
      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
  /restapi/v1.0/account/{accountId}/business-address:
    get:
      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
      parameters:
      - description: Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
        in: path
        name: accountId
        required: true
        schema:
          default: ~
          type: string
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAccountInfoResponse'
          description: Success
      summary: Get Company Business Address
      tags:
      - Company Settings
      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:
      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
      parameters:
      - description: Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
        in: path
        name: accountId
        required: true
        schema:
          default: ~
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ModifyAccountBusinessAddressRequest'
        description: JSON body
        required: true
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountBusinessAddressResource'
          description: Success
      summary: Update Company Business Address
      tags:
      - Company Settings
      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:
      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
      parameters:
      - description: Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
        in: path
        name: accountId
        required: true
        schema:
          default: ~
          type: string
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetServiceInfoResponse'
          description: Success
      summary: Get Account Service Info
      tags:
      - Company Settings
      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:
      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>'
      operationId: updateServiceInfo
      parameters:
      - description: Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
        in: path
        name: accountId
        required: true
        schema:
          default: ~
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ServiceInfoRequest'
        description: JSON body
        required: true
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountServiceInfo'
          description: Success
      summary: Update Account Service Info [Beta]
      tags:
      - Company Settings
      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:
      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
      parameters:
      - description: Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
        in: path
        name: accountId
        required: true
        schema:
          default: ~
          type: string
      - description: Indicates the page number to retrieve. Only positive number values are allowed. Default value is '1'
        in: query
        name: page
        schema:
          type: integer
      - description: Indicates the page size (number of items). If not specified, the value is '100' by default
        in: query
        name: perPage
        schema:
          type: integer
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetDialingPlanInfo'
          description: Success
      summary: Get Available Dialing Plans
      tags:
      - Company Settings
      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:
      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
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LanguageList'
          description: Success
      summary: Get Language List
      tags:
      - Regional Settings
      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:
      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
      parameters:
      - description: Internal identifier of a language
        in: path
        name: languageId
        required: true
        schema:
          type: integer
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LanguageInfo'
          description: Success
      summary: Get Language
      tags:
      - Regional Settings
      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:
      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
      parameters:
      - description: Specifies whether login with the phone numbers of this country is enabled or not
        in: query
        name: loginAllowed
        schema:
          type: boolean
      - description: Indicates whether signup/billing is allowed for a country. If not specified all countries are returned (according to other filters specified if any)
        in: query
        name: signupAllowed
        schema:
          type: boolean
      - description: Specifies if RingCentral sells phone numbers of this country
        in: query
        name: numberSelling
        schema:
          type: boolean
      - description: Indicates the page number to retrieve. Only positive number values are allowed. Default value is '1'
        in: query
        name: page
        schema:
          type: integer
      - description: Indicates the page size (number of items). If not specified, the value is '100' by default
        in: query
        name: perPage
        schema:
          type: integer
      - description: Specifies if free phone line for softphone is available for a country or not
        in: query
        name: freeSoftphoneLine
        schema:
          type: boolean
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetCountryListResponse'
          description: Success
      summary: Get Country List
      tags:
      - Regional Settings
      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:
      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
      parameters:
      - description: Internal identifier of a country
        in: path
        name: countryId
        required: true
        schema:
          type: integer
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetCountryInfoDictionaryResponse'
          description: Success
      summary: Get Country
      tags:
      - Regional Settings
      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:
      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
      parameters:
      - description: Sorts results by the specified property. The default value is 'City'
        explode: true
        in: query
        name: orderBy
        schema:
          enum:
          - Npa
          - City
          items:
            type: string
          type: array
        style: form
      - description: Indicates the page number to retrieve. Only positive number values are allowed. Default value is '1'.
        in: query
        name: page
        schema:
          type: integer
      - description: Indicates the page size (number of items). If not specified, the value is '100' by default.
        in: query
        name: perPage
        schema:
          type: integer
      - description: Internal identifier of a state
        in: query
        name: stateId
        schema:
          type: string
      - description: Specifies if nxx codes are returned
        in: query
        name: withNxx
        schema:
          type: boolean
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetLocationListResponse'
          description: Success
      summary: Get Location List
      tags:
      - Regional Settings
      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:
      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
      parameters:
      - description: Internal identifier of a country
        in: query
        name: countryId
        schema:
          type: integer
      - description: Indicates the page number to retrieve. Only positive number values are allowed. Default value is '1'.
        in: query
        name: page
        schema:
          type: integer
      - description: Indicates the page size (number of items). If not specified, the value is '100' by default
        in: query
        name: perPage
        schema:
          type: integer
      - description: If 'True', the list of states with phone numbers available for buying is returned. The default value is 'False'
        in: query
        name: withPhoneNumbers
        schema:
          type: boolean
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetStateListResponse'
          description: Success
      summary: Get State List
      tags:
      - Regional Settings
      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:
      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
      parameters:
      - description: Internal identifier of a state
        in: path
        name: stateId
        required: true
        schema:
          type: integer
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetStateInfoResponse'
          description: Success
      summary: Get State
      tags:
      - Regional Settings
      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:
      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
      parameters:
      - description: Indicates the page number to retrieve. Only positive number values are allowed. Default value is '1'
        in: query
        name: page
        schema:
          type: string
      - description: Indicates the page size (number of items). If not specified, the value is '100' by default
        in: query
        name: perPage
        schema:
          type: string
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetTimezoneListResponse'
          description: Success
      summary: Get Timezone List
      tags:
      - Regional Settings
      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:
      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
      parameters:
      - description: Internal identifier of a timezone
        in: path
        name: timezoneId
        required: true
        schema:
          type: integer
      - description: Indicates the page number to retrieve. Only positive number values are allowed. Default value is '1'
        in: query
        name: page
        schema:
          type: integer
      - description: Indicates the page size (number of items). If not specified, the value is '100' by default
        in: query
        name: perPage
        schema:
          type: integer
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetTimezoneInfoResponse'
          description: Success
      summary: Get Timezone
      tags:
      - Regional Settings
      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:
      operationId: getBrandInfo
      parameters:
      - in: path
        name: brandId
        required: true
        schema:
          type: string
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BrandResource'
          description: successful operation
      summary: Get Brand Info
      tags:
      - Account Provisioning
      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:
      operationId: getServicePlanInfo
      parameters:
      - in: path
        name: servicePlanId
        required: true
        schema:
          type: string
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServicePlanResource'
          description: successful operation
      summary: Get Service Plan
      tags:
      - Account Provisioning
      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:
      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
      parameters:
      - description: Area code of the location
        in: query
        name: areaCode
        schema:
          type: integer
      - description: Two-letter country code, complying with the ISO standard
        in: query
        name: countryCode
        schema:
          type: string
      - description: Internal identifier of a country; '1'- the US; '39' - Canada; '224' - the UK. The default value is '1'
        in: query
        name: countryId
        schema:
          type: string
      - 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)
        in: query
        name: exclude
        schema:
          type: string
      - 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'
        in: query
        name: extendedSearch
        schema:
          type: boolean
      - description: LINE pattern for vanity or wildcard search. Digits, Latin characters and asterisks are allowed (usually 4 characters)
        in: query
        name: line
        schema:
          type: string
      - 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.
        in: query
        name: numberPattern
        schema:
          type: string
      - description: NXX pattern for vanity or wildcard search. Digits, Latin characters and asterisks are allowed (usually 3 characters)
        in: query
        name: nxx
        schema:
          type: string
      - description: Area code (mandatory). For example, 800, 844, 855, 866, 877, 888 for North America; and 647 for Canada
        in: query
        name: npa
        schema:
          type: string
      - description: Payment type. Default is 'Local' (it should correlate with the npa provided)
        explode: true
        in: query
        name: paymentType
        schema:
          enum:
          - TollFree
          - Local
          items:
            type: string
          type: array
        style: form
      - description: Indicates the page size (number of items). If not specified, the value is '10' by default
        in: query
        name: perPage
        schema:
          type: integer
      - description: Internal identifier of a phone number provider. Supported if brand is specified. If specified, area code and nxx are optional
        in: query
        name: providerId
        schema:
          type: integer
      - 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.
        in: query
        name: smsEnabled
        schema:
          type: boolean
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PhoneNumbers'
          description: Success
      summary: Get Numbers
      tags:
      - Account Provisioning
      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:
      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
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NumberPoolPhoneNumberRequest'
        description: JSON body
        required: true
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReservePhoneNumbersRecordsResource'
          description: Success
      summary: Reserve/ Un-reserve Numbers
      tags:
      - Account Provisioning
      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:
      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
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateAccountRequest'
        description: JSON body
        required: true
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAccountInfoResponse'
          description: Success
      summary: Create Account
      tags:
      - Account Provisioning
      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:
      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
      parameters:
      - description: Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
        in: path
        name: accountId
        required: true
        schema:
          default: ~
          type: string
      - description: Indicates the page number to retrieve. Only positive number values are allowed. Default value is '1'
        in: query
        name: page
        schema:
          type: integer
      - description: Indicates the page size (number of items). If not specified, the value is '100' by default
        in: query
        name: perPage
        schema:
          type: integer
      - description: Usage type of the phone number
        explode: true
        in: query
        name: usageType
        schema:
          enum:
          - MainCompanyNumber
          - AdditionalCompanyNumber
          - CompanyNumber
          - DirectNumber
          - CompanyFaxNumber
          - ForwardedNumber
          - ForwardedCompanyNumber
          - ContactCenterNumber
          items:
            type: string
          type: array
        style: form
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountPhoneNumbers'
          description: Success
      summary: Get All Company Phone Numbers
      tags:
      - Account Provisioning
      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:
      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
      parameters:
      - description: Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
        in: path
        name: accountId
        required: true
        schema:
          default: ~
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProvisionPhoneNumberRequest'
        description: JSON body
        required: true
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PhoneNumberInfo'
          description: Success
      summary: Provision Phone Numbers
      tags:
      - Account Provisioning
      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}:
    delete:
      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
      parameters:
      - in: path
        name: phoneNumberId
        required: true
        schema:
          format: int64
          type: integer
      - in: path
        name: accountId
        required: true
        schema:
          type: string
      responses:
        default:
          content: {}
          description: successful operation
      summary: Delete Phone Number
      tags:
      - Account Provisioning
      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
    get:
      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
      parameters:
      - description: Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
        in: path
        name: accountId
        required: true
        schema:
          default: ~
          type: string
      - description: Internal identifier of a phone number
        in: path
        name: phoneNumberId
        required: true
        schema:
          type: integer
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PhoneNumberInfo'
          description: Success
      summary: Get Phone Number
      tags:
      - Account Provisioning
      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:
      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
      parameters:
      - in: path
        name: phoneNumberId
        required: true
        schema:
          format: int64
          type: integer
      - in: path
        name: accountId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ReassignPhoneNumberResource'
        required: false
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PhoneNumberResource'
          description: successful operation
      summary: Reassign Phone Number
      tags:
      - Account Provisioning
      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:
      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
      parameters:
      - 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
        in: query
        name: homeCountry
        schema:
          type: string
      - description: The default value is 'False'. If 'True', the numbers that are closer to the home country are given higher priority
        in: query
        name: nationalAsPriority
        schema:
          type: boolean
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ParsePhoneNumberRequest'
        description: JSON body
        required: true
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ParsePhoneNumberResponse'
          description: Success
      summary: Parse Phone Number
      tags:
      - Account Provisioning
      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:
      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
      parameters:
      - description: Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
        in: path
        name: accountId
        required: true
        schema:
          default: ~
          type: string
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAccountDevicesResponse'
          description: Success
      summary: Get Account Devices
      tags:
      - Account Provisioning
      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:
      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
      parameters:
      - description: Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
        in: path
        name: accountId
        required: true
        schema:
          default: ~
          type: string
      - description: Internal identifier of a device
        in: path
        name: deviceId
        required: true
        schema:
          type: string
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetDeviceInfoResponse'
          description: Success
      summary: Get Device Info
      tags:
      - Account Provisioning
      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:
      operationId: updateDevice
      parameters:
      - in: path
        name: accountId
        required: true
        schema:
          type: string
      - in: path
        name: deviceId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AccountDeviceUpdate'
        required: true
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeviceResource'
          description: successful operation
      summary: Update Device
      tags:
      - Account Provisioning
      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:
      operationId: getExtensionFreeNumbers
      parameters:
      - in: path
        name: accountId
        required: true
        schema:
          type: string
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BulkProvisionUnassignedExtensionsResponseResource'
          description: successful operation
      summary: Get Free Extension Numbers
      tags:
      - Account Provisioning
      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:
      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
      parameters:
      - description: Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
        in: path
        name: accountId
        required: true
        schema:
          default: ~
          type: string
      - description: Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session
        in: path
        name: extensionId
        required: true
        schema:
          default: ~
          type: string
      - description: Pooling type of a device
        in: query
        name: linePooling
        schema:
          enum:
          - Host
          - Guest
          - None
          type: string
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetExtensionDevicesResponse'
          description: Success
      summary: Get User Device Info
      tags:
      - Account Provisioning
      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:
      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
      parameters:
      - description: Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
        in: path
        name: accountId
        required: true
        schema:
          default: ~
          type: string
      - 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'
        in: query
        name: async
        schema:
          default: false
          type: boolean
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeviceResource'
        required: false
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeviceOrderCreation'
          description: Success
      summary: Create Device Order
      tags:
      - Account Provisioning
      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:
      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
      parameters:
      - description: Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
        in: path
        name: accountId
        required: true
        schema:
          default: ~
          type: string
      - description: Internal identifier of an order
        in: path
        name: orderId
        required: true
        schema:
          type: integer
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeviceOrder'
          description: Success
      summary: Get Device Order by ID
      tags:
      - Account Provisioning
      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:
      operationId: getDeviceModels
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeviceModelExtsResource'
          description: successful operation
      summary: Get Device Catalog
      tags:
      - Account Provisioning
      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:
      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
      parameters:
      - in: query
        name: servicePlanId
        schema:
          type: integer
      - in: query
        name: brandId
        schema:
          type: integer
      - in: query
        name: quantity
        schema:
          format: int32
          maximum: 10000
          minimum: 1
          type: integer
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DictionaryShippingOptions'
          description: Success
      summary: Get Shipping Options
      tags:
      - Account Provisioning
      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:
      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>
      operationId: listLicenses
      parameters:
      - description: Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
        in: path
        name: accountId
        required: true
        schema:
          default: ~
          type: string
      - description: Indicates the page number to retrieve. Only positive number values are allowed. The default value is '1'
        in: query
        name: page
        schema:
          format: int64
          type: integer
      - description: Indicates the page size (number of items). If not specified, the value is '25' by default
        in: query
        name: perPage
        schema:
          format: int64
          type: integer
      - description: Internal identifier of a license type. If not specified account licenses of all types are returned
        in: query
        name: typeId
        schema:
          format: int64
          type: integer
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LicenseList'
          description: Success
      summary: Get License List
      tags:
      - Account Provisioning
      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:
      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>'
      operationId: createLicensesOrder
      parameters:
      - description: Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
        in: path
        name: accountId
        required: true
        schema:
          default: ~
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OrderLicensesRequest'
        description: JSON body
        required: true
      responses:
        default:
          content: {}
          description: Success
      summary: Order Licenses
      tags:
      - Account Provisioning
      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}:
    delete:
      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>'
      operationId: deleteLicense
      parameters:
      - description: Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
        in: path
        name: accountId
        required: true
        schema:
          default: ~
          type: string
      - description: Internal identifier of a license
        in: path
        name: licenseId
        required: true
        schema:
          type: string
      responses:
        default:
          content: {}
          description: Success
      summary: Delete License
      tags:
      - Account Provisioning
      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
    get:
      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>
      operationId: loadLicense
      parameters:
      - description: Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
        in: path
        name: accountId
        required: true
        schema:
          default: ~
          type: string
      - description: Internal identifier of a license
        in: path
        name: licenseId
        required: true
        schema:
          type: string
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LicenseInfo'
          description: Success
      summary: Get License
      tags:
      - Account Provisioning
      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
  /restapi/v1.0/dictionary/license-types:
    get:
      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>
      operationId: listLicenseTypes
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LicenseTypes'
          description: Success
      summary: Get License Types
      tags:
      - Account Provisioning
      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:
      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
      parameters:
      - description: Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
        in: path
        name: accountId
        required: true
        schema:
          default: ~
          type: string
      - description: Internal identifier of a Department extension (same as extensionId but only the ID of a department extension is valid)
        in: path
        name: departmentId
        required: true
        schema:
          type: integer
      - description: Indicates the page number to retrieve. Only positive number values are allowed. Default value is '1'
        in: query
        name: page
        schema:
          type: integer
      - description: Indicates the page size (number of items). If not specified, the value is '100' by default
        in: query
        name: perPage
        schema:
          type: integer
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DepartmentMemberList'
          description: Success
      summary: Get Department Member List
      tags:
      - Account Provisioning
      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:
      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
      parameters:
      - in: path
        name: accountId
        required: true
        schema:
          default: ~
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DepartmentBulkAssignResource'
        required: false
      responses:
        default:
          content: {}
          description: successful operation
      summary: Edit Call Queue Members
      tags:
      - Account Provisioning
      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:
      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>
      operationId: getPagingOnlyGroupUsers
      parameters:
      - in: path
        name: accountId
        required: true
        schema:
          type: string
      - in: path
        name: pagingOnlyGroupId
        required: true
        schema:
          type: string
      - description: Indicates the page number to retrieve. Only positive number values are allowed. Default value is '1'
        in: query
        name: page
        schema:
          type: integer
      - description: Indicates the page size (number of items). If not specified, the value is '100' by default
        in: query
        name: perPage
        schema:
          type: integer
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagingOnlyGroupUsers'
          description: Success
      summary: Get Paging Only Group Users
      tags:
      - Account Provisioning
      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:
      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>
      operationId: getPagingOnlyGroupDevices
      parameters:
      - in: path
        name: accountId
        required: true
        schema:
          type: string
      - in: path
        name: pagingOnlyGroupId
        required: true
        schema:
          type: string
      - description: Indicates the page number to retrieve. Only positive number values are allowed. Default value is '1'
        in: query
        name: page
        schema:
          type: integer
      - description: Indicates the page size (number of items). If not specified, the value is '100' by default
        in: query
        name: perPage
        schema:
          type: integer
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagingOnlyGroupDevices'
          description: Success
      summary: Get Paging Only Group Devices
      tags:
      - Account Provisioning
      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:
      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>
      operationId: updatePagingOnlyGroupUsersAndDevices
      parameters:
      - in: path
        name: accountId
        required: true
        schema:
          type: string
      - in: path
        name: pagingOnlyGroupId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EditPagingGroupRequest'
        required: false
      responses:
        default:
          content: {}
          description: Success
      summary: Edit Paging Group Users & Devices
      tags:
      - Account Provisioning
      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:
      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>
      operationId: getParkLocationUsers
      parameters:
      - in: path
        name: accountId
        required: true
        schema:
          type: string
      - in: path
        name: parkLocationId
        required: true
        schema:
          type: string
      - description: Indicates the page number to retrieve. Only positive number values are allowed. Default value is '1'
        in: query
        name: page
        schema:
          type: integer
      - description: Indicates the page size (number of items). If not specified, the value is '100' by default
        in: query
        name: perPage
        schema:
          type: integer
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ParkLocationResponse'
          description: Success
      summary: Get Park Location Users
      tags:
      - Account Provisioning
      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:
      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>
      operationId: updateParkLocationUsers
      parameters:
      - in: path
        name: accountId
        required: true
        schema:
          type: string
      - in: path
        name: parkLocationId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EditParkLocationRequest'
        required: false
      responses:
        default:
          content: {}
          description: Success
      summary: Adds and/or removes park location users
      tags:
      - Account Provisioning
      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:
      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>
      operationId: getServiceProviderConfig
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceProviderConfig'
            application/scim+json:
              schema:
                $ref: '#/components/schemas/ServiceProviderConfig'
          description: Success
      summary: Get Service Provider Config
      tags:
      - SCIM
      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:
      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>
      operationId: listUsers
      parameters:
      - description: only support 'userName' or 'email' filter expressions for now
        in: query
        name: filter
        schema:
          enum:
          - userName
          - email
          type: string
      - description: page size
        in: query
        name: count
        schema:
          default: 100
          format: int32
          type: integer
      - description: start index (1-based)
        in: query
        name: startIndex
        schema:
          default: 1
          format: int32
          type: integer
      responses:
        400:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SCIMErrorResponse'
            application/scim+json:
              schema:
                $ref: '#/components/schemas/SCIMErrorResponse'
          description: bad request
        401:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SCIMErrorResponse'
            application/scim+json:
              schema:
                $ref: '#/components/schemas/SCIMErrorResponse'
          description: authorization failure
        403:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SCIMErrorResponse'
            application/scim+json:
              schema:
                $ref: '#/components/schemas/SCIMErrorResponse'
          description: permissions denied
        429:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SCIMErrorResponse'
            application/scim+json:
              schema:
                $ref: '#/components/schemas/SCIMErrorResponse'
          description: too many requests
        500:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SCIMErrorResponse'
            application/scim+json:
              schema:
                $ref: '#/components/schemas/SCIMErrorResponse'
          description: internal server error
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetUserListResponse'
            application/scim+json:
              schema:
                $ref: '#/components/schemas/GetUserListResponse'
          description: Success
      summary: Get User List
      tags:
      - SCIM
      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:
      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>
      operationId: createUser
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserCreationRequest'
          application/scim+json:
            schema:
              $ref: '#/components/schemas/UserCreationRequest'
        description: a new user without 'id'
        required: true
      responses:
        400:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SCIMErrorResponse'
            application/scim+json:
              schema:
                $ref: '#/components/schemas/SCIMErrorResponse'
          description: bad request
        401:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SCIMErrorResponse'
            application/scim+json:
              schema:
                $ref: '#/components/schemas/SCIMErrorResponse'
          description: authorization failure
        403:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SCIMErrorResponse'
            application/scim+json:
              schema:
                $ref: '#/components/schemas/SCIMErrorResponse'
          description: permissions denied
        404:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SCIMErrorResponse'
            application/scim+json:
              schema:
                $ref: '#/components/schemas/SCIMErrorResponse'
          description: not found
        409:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SCIMErrorResponse'
            application/scim+json:
              schema:
                $ref: '#/components/schemas/SCIMErrorResponse'
          description: duplicate email
        429:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SCIMErrorResponse'
            application/scim+json:
              schema:
                $ref: '#/components/schemas/SCIMErrorResponse'
          description: too many requests
        500:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SCIMErrorResponse'
            application/scim+json:
              schema:
                $ref: '#/components/schemas/SCIMErrorResponse'
          description: internal server error
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserInfo'
            application/scim+json:
              schema:
                $ref: '#/components/schemas/UserInfo'
          description: Success
      summary: Create User
      tags:
      - SCIM
      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:
      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>
      operationId: searchUsersViaPost
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SCIMSearchRequestInfo'
          application/scim+json:
            schema:
              $ref: '#/components/schemas/SCIMSearchRequestInfo'
        description: search parameters
        required: false
      responses:
        400:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SCIMErrorResponse'
            application/scim+json:
              schema:
                $ref: '#/components/schemas/SCIMErrorResponse'
          description: bad request
        401:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SCIMErrorResponse'
            application/scim+json:
              schema:
                $ref: '#/components/schemas/SCIMErrorResponse'
          description: authorization failure
        403:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SCIMErrorResponse'
            application/scim+json:
              schema:
                $ref: '#/components/schemas/SCIMErrorResponse'
          description: permissions denied
        429:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SCIMErrorResponse'
            application/scim+json:
              schema:
                $ref: '#/components/schemas/SCIMErrorResponse'
          description: too many requests
        500:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SCIMErrorResponse'
            application/scim+json:
              schema:
                $ref: '#/components/schemas/SCIMErrorResponse'
          description: internal server error
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetUserListResponse'
            application/scim+json:
              schema:
                $ref: '#/components/schemas/GetUserListResponse'
          description: successful operation
      summary: search or list users
      tags:
      - SCIM
  /scim/v2/Users/{id}:
    delete:
      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>
      operationId: deleteUser
      parameters:
      - description: Internal identifier of a user
        in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        401:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SCIMErrorResponse'
            application/scim+json:
              schema:
                $ref: '#/components/schemas/SCIMErrorResponse'
          description: authorization failure
        403:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SCIMErrorResponse'
            application/scim+json:
              schema:
                $ref: '#/components/schemas/SCIMErrorResponse'
          description: permissions denied
        404:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SCIMErrorResponse'
            application/scim+json:
              schema:
                $ref: '#/components/schemas/SCIMErrorResponse'
          description: not found
        429:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SCIMErrorResponse'
            application/scim+json:
              schema:
                $ref: '#/components/schemas/SCIMErrorResponse'
          description: too many requests
        500:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SCIMErrorResponse'
            application/scim+json:
              schema:
                $ref: '#/components/schemas/SCIMErrorResponse'
          description: internal server error
        default:
          content: {}
          description: Success
      summary: Delete User
      tags:
      - SCIM
      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
    get:
      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>
      operationId: getUserById
      parameters:
      - description: Internal identifier of a user
        in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        400:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SCIMErrorResponse'
            application/scim+json:
              schema:
                $ref: '#/components/schemas/SCIMErrorResponse'
          description: bad request
        401:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SCIMErrorResponse'
            application/scim+json:
              schema:
                $ref: '#/components/schemas/SCIMErrorResponse'
          description: authorization failure
        403:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SCIMErrorResponse'
            application/scim+json:
              schema:
                $ref: '#/components/schemas/SCIMErrorResponse'
          description: permissions denied
        429:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SCIMErrorResponse'
            application/scim+json:
              schema:
                $ref: '#/components/schemas/SCIMErrorResponse'
          description: too many requests
        500:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SCIMErrorResponse'
            application/scim+json:
              schema:
                $ref: '#/components/schemas/SCIMErrorResponse'
          description: internal server error
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserInfo'
            application/scim+json:
              schema:
                $ref: '#/components/schemas/UserInfo'
          description: Success
      summary: Get User
      tags:
      - SCIM
      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
    patch:
      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>
      operationId: patchUser
      parameters:
      - description: Internal identifier of a user
        in: path
        name: id
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SCIMUserPatch'
          application/scim+json:
            schema:
              $ref: '#/components/schemas/SCIMUserPatch'
        description: patch operations list
        required: false
      responses:
        400:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SCIMErrorResponse'
            application/scim+json:
              schema:
                $ref: '#/components/schemas/SCIMErrorResponse'
          description: bad request
        401:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SCIMErrorResponse'
            application/scim+json:
              schema:
                $ref: '#/components/schemas/SCIMErrorResponse'
          description: authorization failure
        403:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SCIMErrorResponse'
            application/scim+json:
              schema:
                $ref: '#/components/schemas/SCIMErrorResponse'
          description: permissions denied
        404:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SCIMErrorResponse'
            application/scim+json:
              schema:
                $ref: '#/components/schemas/SCIMErrorResponse'
          description: not found
        429:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SCIMErrorResponse'
            application/scim+json:
              schema:
                $ref: '#/components/schemas/SCIMErrorResponse'
          description: too many requests
        500:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SCIMErrorResponse'
            application/scim+json:
              schema:
                $ref: '#/components/schemas/SCIMErrorResponse'
          description: internal server error
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserInfo'
            application/scim+json:
              schema:
                $ref: '#/components/schemas/UserInfo'
          description: Success
      summary: Partially update/patch a user
      tags:
      - SCIM
      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
    put:
      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>
      operationId: updateUser
      parameters:
      - description: Internal identifier of a user
        in: path
        name: id
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserUpdateRequest'
          application/scim+json:
            schema:
              $ref: '#/components/schemas/UserUpdateRequest'
        description: An Exisiting User
        required: true
      responses:
        400:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SCIMErrorResponse'
            application/scim+json:
              schema:
                $ref: '#/components/schemas/SCIMErrorResponse'
          description: bad request
        401:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SCIMErrorResponse'
            application/scim+json:
              schema:
                $ref: '#/components/schemas/SCIMErrorResponse'
          description: authorization failure
        403:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SCIMErrorResponse'
            application/scim+json:
              schema:
                $ref: '#/components/schemas/SCIMErrorResponse'
          description: permissions denied
        404:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SCIMErrorResponse'
            application/scim+json:
              schema:
                $ref: '#/components/schemas/SCIMErrorResponse'
          description: not found
        409:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SCIMErrorResponse'
            application/scim+json:
              schema:
                $ref: '#/components/schemas/SCIMErrorResponse'
          description: duplicate email
        429:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SCIMErrorResponse'
            application/scim+json:
              schema:
                $ref: '#/components/schemas/SCIMErrorResponse'
          description: too many requests
        500:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SCIMErrorResponse'
            application/scim+json:
              schema:
                $ref: '#/components/schemas/SCIMErrorResponse'
          description: internal server error
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserInfo'
            application/scim+json:
              schema:
                $ref: '#/components/schemas/UserInfo'
          description: Success
      summary: Update or replace user
      tags:
      - SCIM
      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
  /restapi/v1.0/account/{accountId}/extension/{extensionId}/reporting/settings:
    get:
      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>
      operationId: loadReportingSettings
      parameters:
      - description: Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
        in: path
        name: accountId
        required: true
        schema:
          default: ~
          type: string
      - description: Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session
        in: path
        name: extensionId
        required: true
        schema:
          default: ~
          type: string
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReportingSettings'
          description: Success
      summary: Get Reporting Settings
      tags:
      - Reporting
      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:
      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>
      operationId: updateReportingSettings
      parameters:
      - description: Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
        in: path
        name: accountId
        required: true
        schema:
          default: ~
          type: string
      - description: Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session
        in: path
        name: extensionId
        required: true
        schema:
          default: ~
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SetReportingSettingsRequest'
        description: JSON body
        required: true
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReportingSettings'
          description: Success
      summary: Update Reporting Settings
      tags:
      - Reporting
      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
components:
  schemas:
    GroupsCollection:
      properties:
        uri:
          format: uri
          type: string
        records:
          items:
            $ref: '#/components/schemas/GroupResource'
          type: array
        paging:
          $ref: '#/components/schemas/Paging'
        navigation:
          $ref: '#/components/schemas/Navigation'
      type: object
    NavigableCollectionResourceExtensionIdResource:
      properties:
        uri:
          format: uri
          type: string
        records:
          items:
            $ref: '#/components/schemas/ExtensionIdResource'
          type: array
        paging:
          $ref: '#/components/schemas/Paging'
        navigation:
          $ref: '#/components/schemas/Navigation'
      type: object
    CompanyDirectoryContactInfo:
      example:
        firstName: firstName
        lastName: lastName
        extensionNumber: extensionNumber
        name: name
        id: id
        profileImage:
          etag: etag
          uri: uri
        type: User
        department: department
        email: email
        account:
          id: id
        phoneNumbers:
        - phoneNumber: phoneNumber
          hidden: true
          type: VoiceFax
          usageType: MobileNumber
        - phoneNumber: phoneNumber
          hidden: true
          type: VoiceFax
          usageType: MobileNumber
        status: Enabled
      properties:
        id:
          description: Internal identifier of an extension
          type: string
        type:
          description: Type of an extension
          enum:
          - User
          - Department
          - Announcement
          - Voicemail
          - SharedLinesGroup
          - PagingOnly
          - IvrMenu
          - ParkLocation
          - Limited
          type: string
        status:
          description: Status of an extension
          enum:
          - Enabled
          - Disabled
          - NotActivated
          type: string
        firstName:
          description: User extension first name
          type: string
        lastName:
          description: User extension last name
          type: string
        name:
          description: Name of an extension
          type: string
        department:
          description: Department name of an extension
          type: string
        email:
          description: Email of an extension
          type: string
        extensionNumber:
          description: Number of an extension
          type: string
        account:
          $ref: '#/components/schemas/CompanyDirectoryAccountInfo'
        phoneNumbers:
          description: Extension phone numbers information
          items:
            $ref: '#/components/schemas/CompanyDirectoryPhoneNumberInfo'
          type: array
        profileImage:
          $ref: '#/components/schemas/CompanyDirectoryProfileImageInfo'
      type: object
    InstantMessageEvent:
      properties:
        id:
          description: Internal identifier of an message
          type: string
        to:
          description: Message receiver(s) information
          items:
            $ref: '#/components/schemas/NotificationRecipientInfo'
          type: array
        from:
          $ref: '#/components/schemas/SenderInfo'
        type:
          description: Type of a message. The default value is 'SMS'
          type: string
        creationTime:
          description: Message creation datetime in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z
          format: date-time
          type: string
        lastModifiedTime:
          description: Datetime when the message was modified in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z
          format: date-time
          type: string
        readStatus:
          description: Status of a message. The default value is 'Unread'
          type: string
        priority:
          description: The default value is 'Normal'
          type: string
        attachments:
          description: Message attachment data
          items:
            $ref: '#/components/schemas/MessageAttachmentInfo'
          type: array
        direction:
          description: Message direction. The default value is 'Inbound'
          type: string
        availability:
          description: Message availability status. The default value is 'Alive'
          type: string
        subject:
          description: Message subject. It replicates message text which is also returned as an attachment
          type: string
        messageStatus:
          description: Status of a message. The default value is 'Received'
          type: string
        conversationId:
          description: Identifier of the conversation the message belongs to
          type: string
      type: object
    ExtensionInfoSIP:
      properties:
        id:
          description: Internal identifier of an extension
          type: string
        uri:
          description: Canonical URI of an extension
          type: string
        extensionNumber:
          description: Extension number
          type: string
      type: object
    CountriesResource:
      properties:
        uri:
          format: uri
          type: string
        records:
          items:
            $ref: '#/components/schemas/CountryResource'
          type: array
        paging:
          $ref: '#/components/schemas/Paging'
        navigation:
          $ref: '#/components/schemas/Navigation'
      type: object
    CallLogRecordLegInfo:
      example:
        duration: 6
        result: Unknown
        extension:
          id: id
          uri: uri
        legType: legType
        action: Unknown
        recording:
          contentUri: contentUri
          id: id
          type: Automatic
          uri: uri
        startTime: 2000-01-23T04:56:07.000+00:00
        from:
          phoneNumber: phoneNumber
          extensionNumber: extensionNumber
          name: name
          location: location
          device:
            id: id
            uri: uri
        to:
          phoneNumber: phoneNumber
          extensionNumber: extensionNumber
          name: name
          location: location
          device:
            id: id
            uri: uri
        transport: PSTN
        type: Voice
        direction: Inbound
      properties:
        action:
          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
          type: string
        direction:
          description: Call direction
          enum:
          - Inbound
          - Outbound
          type: string
        duration:
          description: Call duration in seconds
          type: integer
        extension:
          $ref: '#/components/schemas/ExtensionInfoCallLog'
        legType:
          description: Leg type
          type: string
        startTime:
          description: The call start datetime in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z
          format: date-time
          type: string
        type:
          description: Call type
          enum:
          - Voice
          - Fax
          type: string
        result:
          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
          type: string
        from:
          $ref: '#/components/schemas/CallLogCallerInfo'
        to:
          $ref: '#/components/schemas/CallLogCallerInfo'
        transport:
          description: Call transport
          enum:
          - PSTN
          - VoIP
          type: string
        recording:
          $ref: '#/components/schemas/RecordingInfo'
      type: object
    AccountSignupInfoRequest:
      example:
        marketingAccepted: true
      properties:
        marketingAccepted:
          description: ' Specifies whether marketing information is sent to the user'
          type: boolean
      type: object
    NotificationDeliveryMode:
      example:
        address: address
        encryption: true
        secretKey: secretKey
        subscriberKey: subscriberKey
        transportType: PubNub
        encryptionKey: encryptionKey
        encryptionAlgorithm: encryptionAlgorithm
      properties:
        transportType:
          description: Notifications transportation provider name. 'APNS' (Apple Push Notifications Service)
          enum:
          - PubNub
          - APNS
          - PubNub/APNS/VoIP
          type: string
        encryption:
          description: Optional parameter. Specifies if the message will be encrypted or not. For APNS transport type the value is always  false
          type: boolean
        address:
          description: PubNub channel name. For APNS transport type - internal identifier of a device  device_token
          type: string
        subscriberKey:
          description: PubNub subscriber credentials required to subscribe to the channel
          type: string
        secretKey:
          description: PubNub subscriber credentials required to subscribe to the channel. Optional (for PubNub transport type only)
          type: string
        encryptionAlgorithm:
          description: Encryption algorithm 'AES' (for PubNub transport type only)
          type: string
        encryptionKey:
          description: Key for notification message decryption (for PubNub transport type only)
          type: string
      type: object
    ExtensionInfoProvisionPhoneNumbers:
      example:
        id: id
        partnerId: partnerId
      properties:
        id:
          description: Internal identifier of an extension
          type: string
        partnerId:
          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
          type: string
      type: object
    PhoneNumberResourceIntId:
      example:
        country:
          callingCode: callingCode
          numberSelling: false
          isoCode: isoCode
          emergencyCalling: false
          name: name
          id: id
          uri: http://example.com/aeiou
          loginAllowed: false
        extension:
          setupWizardState: NotStarted
          statusInfo:
            reason: reason
            till: 2000-01-23T04:56:07.000+00:00
            comment: comment
          references:
          - ref: ref
            type: PartnerId
          - ref: ref
            type: PartnerId
          profileImage:
            scales:
            - uri: http://example.com/aeiou
            - uri: http://example.com/aeiou
            etag: etag
            lastModified: 2000-01-23T04:56:07.000+00:00
            uri: http://example.com/aeiou
            contentType: contentType
          type: Unknown
          uri: http://example.com/aeiou
          ivrPin: ivrPin
          password: password
          serviceFeatures:
          - reason: Available
            featureName: featureName
            enabled: false
          - reason: Available
            featureName: featureName
            enabled: false
          extensionNumber: extensionNumber
          permissions:
            admin:
              enabled: false
            uri: http://example.com/aeiou
            internationalCalling:
              enabled: false
            freeSoftPhoneDigitalLine:
              enabled: false
          loginName: loginName
          contact:
            firstName: firstName
            lastName: lastName
            company: company
            businessPhone: businessPhone
            businessAddress:
              zip: zip
              country: country
              city: city
              street: street
              state: state
            email: email
          name: name
          regionalSettings:
            timezone:
              name: name
              description: description
              id: id
              uri: http://example.com/aeiou
            greetingLanguage:
              localeCode: localeCode
              name: name
              id: id
            formattingLocale:
              localeCode: localeCode
              name: name
              id: id
            language:
              localeCode: localeCode
              name: name
              id: id
            homeCountry:
              callingCode: callingCode
              numberSelling: false
              isoCode: isoCode
              emergencyCalling: false
              name: name
              id: id
              uri: http://example.com/aeiou
              loginAllowed: false
          id: id
          partnerId: partnerId
          departments:
          - extensionNumber: extensionNumber
            id: id
            uri: http://example.com/aeiou
          - extensionNumber: extensionNumber
            id: id
            uri: http://example.com/aeiou
          status: Enabled
        phoneNumber: phoneNumber
        location: location
        id: 1
        label: label
        type: VoiceFax
        paymentType: External
        status: status
        usageType: CompanyNumber
      properties:
        id:
          description: Internal identifier of a phone number
          format: int64
          type: integer
        country:
          $ref: '#/components/schemas/CountryResource'
        extension:
          $ref: '#/components/schemas/ExtensionResource'
        label:
          description: Custom user name of a phone number, if any. Supported for numbers assigned to Auto-Receptionist, with usage type 'CompanyNumber'
          type: string
        location:
          description: Location (City, State). Filled for local US numbers
          type: string
        paymentType:
          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
          type: string
        phoneNumber:
          description: Phone number
          maxLength: 128
          minLength: 0
          type: string
        status:
          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: string
        usageType:
          enum:
          - CompanyNumber
          - MainCompanyNumber
          - AdditionalCompanyNumber
          - DirectNumber
          - CompanyFaxNumber
          - ForwardedNumber
          - ForwardedCompanyNumber
          - ContactCenterNumber
          type: string
        type:
          description: Type of a phone number
          enum:
          - VoiceFax
          - FaxOnly
          - VoiceOnly
          type: string
      type: object
    FederationInfo:
      example:
        lastModifiedTime: 2000-01-23T04:56:07.000+00:00
        creationTime: 2000-01-23T04:56:07.000+00:00
        displayName: displayName
        id: id
        accounts:
        - companyName: companyName
          federatedName: federatedName
          linkCreationTime: linkCreationTime
          id: id
          mainNumber:
            formattedPhoneNumber: formattedPhoneNumber
            phoneNumber: phoneNumber
          conflictCount: 0
        - companyName: companyName
          federatedName: federatedName
          linkCreationTime: linkCreationTime
          id: id
          mainNumber:
            formattedPhoneNumber: formattedPhoneNumber
            phoneNumber: phoneNumber
          conflictCount: 0
      properties:
        id:
          description: Internal identifier of a federation
          type: string
        displayName:
          description: Name of a federation
          type: string
        creationTime:
          description: Datetime of federation creation, in ISO 8601 format, for example 2016-03-10T18:07:52.534Z
          format: date-time
          type: string
        lastModifiedTime:
          description: Datetime of the last change of federation composition, in ISO 8601 format, for example 2016-03-10T18:07:52.534Z
          format: date-time
          type: string
        accounts:
          description: List of countries which can be selected for a dialing plan
          items:
            $ref: '#/components/schemas/FederationAccountInfo'
          type: array
      type: object
    BotExtensionCreation:
      example:
        extensionNumber: extensionNumber
        name: name
        applicationKey: applicationKey
        creatorId: creatorId
        id: id
        uri: uri
      properties:
        uri:
          description: Link to a bot extension resource
          type: string
        id:
          description: Internal identifier of a bot extension
          type: string
        extensionNumber:
          description: Bot extension number
          type: string
        name:
          description: Bot name (equals to extension first name)
          type: string
        applicationKey:
          description: Identifier key of a bot application
          type: string
        creatorId:
          description: User extension identifier
          type: string
      type: object
    SIPInfoRequest:
      example:
        transport: UDP
      properties:
        transport:
          description: Supported transport. SIP info will be returned for this transport if supported
          enum:
          - UDP
          - TCP
          - TLS
          - WS
          - WSS
          type: string
      type: object
    SyncMessages:
      properties:
        uri:
          format: uri
          type: string
        records:
          items:
            $ref: '#/components/schemas/MessageInfoResource'
          type: array
        syncInfo:
          $ref: '#/components/schemas/SyncInfo'
      type: object
    DeviceModelExtsResource:
      example:
        records:
        - model:
            addons:
            - name: name
              count: 0
              id: id
            - name: name
              count: 0
              id: id
            name: name
            id: id
          sku: sku
          type: SoftPhone
        - model:
            addons:
            - name: name
              count: 0
              id: id
            - name: name
              count: 0
              id: id
            name: name
            id: id
          sku: sku
          type: SoftPhone
        uri: http://example.com/aeiou
      properties:
        uri:
          description: Canonical URI of a device
          format: uri
          type: string
        records:
          description: Devices data
          items:
            $ref: '#/components/schemas/DeviceModelExtResource'
          type: array
      type: object
    ExtensionUserCredentailsRequest:
      example:
        ivrPin: ivrPin
        secretQuestion:
          answer: answer
          id: id
          uri: uri
        password: password
      properties:
        password:
          description: User password of an extension
          type: string
        ivrPin:
          description: User pin of an extension
          type: string
        secretQuestion:
          $ref: '#/components/schemas/ExtensionSecretQuestionInfo'
      type: object
    ExtensionGrantsResource:
      properties:
        uri:
          format: uri
          type: string
        records:
          items:
            $ref: '#/components/schemas/ExtensionGrantResource'
          type: array
        paging:
          $ref: '#/components/schemas/Paging'
        navigation:
          $ref: '#/components/schemas/Navigation'
      type: object
    ExtensionCallLogResponse:
      example:
        navigation:
          previousPage:
            uri: uri
          firstPage:
            uri: uri
          lastPage:
            uri: uri
          nextPage:
            uri: uri
        records:
        - lastModifiedTime: 2000-01-23T04:56:07.000+00:00
          recording:
            contentUri: contentUri
            id: id
            type: Automatic
            uri: uri
          sessionId: sessionId
          transport: PSTN
          type: Voice
          uri: uri
          result: Unknown
          duration: 0
          legs:
          - duration: 6
            result: Unknown
            extension:
              id: id
              uri: uri
            legType: legType
            action: Unknown
            recording:
              contentUri: contentUri
              id: id
              type: Automatic
              uri: uri
            startTime: 2000-01-23T04:56:07.000+00:00
            from:
              phoneNumber: phoneNumber
              extensionNumber: extensionNumber
              name: name
              location: location
              device:
                id: id
                uri: uri
            to:
              phoneNumber: phoneNumber
              extensionNumber: extensionNumber
              name: name
              location: location
              device:
                id: id
                uri: uri
            transport: PSTN
            type: Voice
            direction: Inbound
          - duration: 6
            result: Unknown
            extension:
              id: id
              uri: uri
            legType: legType
            action: Unknown
            recording:
              contentUri: contentUri
              id: id
              type: Automatic
              uri: uri
            startTime: 2000-01-23T04:56:07.000+00:00
            from:
              phoneNumber: phoneNumber
              extensionNumber: extensionNumber
              name: name
              location: location
              device:
                id: id
                uri: uri
            to:
              phoneNumber: phoneNumber
              extensionNumber: extensionNumber
              name: name
              location: location
              device:
                id: id
                uri: uri
            transport: PSTN
            type: Voice
            direction: Inbound
          action: Unknown
          from:
            phoneNumber: phoneNumber
            extensionNumber: extensionNumber
            name: name
            location: location
            device:
              id: id
              uri: uri
          startTime: 2000-01-23T04:56:07.000+00:00
          id: id
          to:
            phoneNumber: phoneNumber
            extensionNumber: extensionNumber
            name: name
            location: location
            device:
              id: id
              uri: uri
          direction: Inbound
        - lastModifiedTime: 2000-01-23T04:56:07.000+00:00
          recording:
            contentUri: contentUri
            id: id
            type: Automatic
            uri: uri
          sessionId: sessionId
          transport: PSTN
          type: Voice
          uri: uri
          result: Unknown
          duration: 0
          legs:
          - duration: 6
            result: Unknown
            extension:
              id: id
              uri: uri
            legType: legType
            action: Unknown
            recording:
              contentUri: contentUri
              id: id
              type: Automatic
              uri: uri
            startTime: 2000-01-23T04:56:07.000+00:00
            from:
              phoneNumber: phoneNumber
              extensionNumber: extensionNumber
              name: name
              location: location
              device:
                id: id
                uri: uri
            to:
              phoneNumber: phoneNumber
              extensionNumber: extensionNumber
              name: name
              location: location
              device:
                id: id
                uri: uri
            transport: PSTN
            type: Voice
            direction: Inbound
          - duration: 6
            result: Unknown
            extension:
              id: id
              uri: uri
            legType: legType
            action: Unknown
            recording:
              contentUri: contentUri
              id: id
              type: Automatic
              uri: uri
            startTime: 2000-01-23T04:56:07.000+00:00
            from:
              phoneNumber: phoneNumber
              extensionNumber: extensionNumber
              name: name
              location: location
              device:
                id: id
                uri: uri
            to:
              phoneNumber: phoneNumber
              extensionNumber: extensionNumber
              name: name
              location: location
              device:
                id: id
                uri: uri
            transport: PSTN
            type: Voice
            direction: Inbound
          action: Unknown
          from:
            phoneNumber: phoneNumber
            extensionNumber: extensionNumber
            name: name
            location: location
            device:
              id: id
              uri: uri
          startTime: 2000-01-23T04:56:07.000+00:00
          id: id
          to:
            phoneNumber: phoneNumber
            extensionNumber: extensionNumber
            name: name
            location: location
            device:
              id: id
              uri: uri
          direction: Inbound
        paging:
          perPage: 5
          pageStart: 5
          pageEnd: 2
          totalPages: 7
          page: 1
          totalElements: 9
      properties:
        records:
          description: List of call log records
          items:
            $ref: '#/components/schemas/CallLogRecord'
          type: array
        navigation:
          $ref: '#/components/schemas/NavigationInfo'
        paging:
          $ref: '#/components/schemas/PagingInfo'
      required:
      - navigation
      - paging
      - records
      type: object
    ServiceFeatureValue:
      example:
        reason: Available
        featureName: featureName
        enabled: false
      properties:
        featureName:
          type: string
        enabled:
          default: false
          type: boolean
        reason:
          enum:
          - Available
          - AccountTypeLimitation
          - ExtensionTypeLimitation
          - AccountLimitation
          - ExtensionLimitation
          - InsufficientPermissions
          - ApplicationLimitation
          type: string
      type: object
    RegionalSettingsResource:
      example:
        timezone:
          name: name
          description: description
          id: id
          uri: http://example.com/aeiou
        greetingLanguage:
          localeCode: localeCode
          name: name
          id: id
        formattingLocale:
          localeCode: localeCode
          name: name
          id: id
        language:
          localeCode: localeCode
          name: name
          id: id
        homeCountry:
          callingCode: callingCode
          numberSelling: false
          isoCode: isoCode
          emergencyCalling: false
          name: name
          id: id
          uri: http://example.com/aeiou
          loginAllowed: false
      properties:
        timezone:
          $ref: '#/components/schemas/TimezoneResource'
        homeCountry:
          $ref: '#/components/schemas/CountryResource'
        language:
          $ref: '#/components/schemas/LanguageResource'
        greetingLanguage:
          $ref: '#/components/schemas/LanguageResource'
        formattingLocale:
          $ref: '#/components/schemas/LanguageResource'
      type: object
    UriTemplate:
      properties:
        template:
          type: string
        pattern:
          $ref: '#/components/schemas/PatternWithGroups'
        templateVariables:
          items:
            type: string
          type: array
        numberOfExplicitRegexes:
          format: int32
          type: integer
        numberOfRegexGroups:
          format: int32
          type: integer
        numberOfExplicitCharacters:
          format: int32
          type: integer
        numberOfTemplateVariables:
          format: int32
          type: integer
      type: object
    CallerIdByDeviceInfo:
      example:
        phoneInfo:
          phoneNumber: phoneNumber
          id: id
          uri: uri
        type: type
      properties:
        type:
          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']
          type: string
        phoneInfo:
          $ref: '#/components/schemas/CallerIdPhoneInfo'
      type: object
    ContactInfoUpdateRequest:
      example:
        firstName: firstName
        lastName: lastName
        emailAsLoginName: true
        pronouncedName:
          text: text
          type: Default
        company: company
        businessPhone: businessPhone
        businessAddress:
          zip: zip
          country: country
          city: city
          street: street
          state: state
        department: department
        email: email
      properties:
        firstName:
          description: For User extension type only. Extension user first name,
          type: string
        lastName:
          description: For User extension type only. Extension user last name,
          type: string
        company:
          description: Extension user company name
          type: string
        email:
          description: Email of extension user
          type: string
        businessPhone:
          description: Extension user contact phone number in E.164 format
          type: string
        businessAddress:
          $ref: '#/components/schemas/ContactAddressInfo'
        emailAsLoginName:
          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'''
          type: boolean
        pronouncedName:
          $ref: '#/components/schemas/PronouncedNameInfo'
        department:
          description: Extension user department, if any
          type: string
      type: object
    ProfileImageInfo:
      example:
        scales:
        - uri: uri
        - uri: uri
        etag: etag
        lastModified: 2000-01-23T04:56:07.000+00:00
        uri: uri
        contentType: contentType
      properties:
        uri:
          description: Link to a profile image. If an image is not uploaded for an extension, only uri is returned
          type: string
        etag:
          description: Identifier of an image
          type: string
        lastModified:
          description: The datetime when an image was last updated in ISO 8601 format, for example 2016-03-10T18:07:52.534Z
          format: date-time
          type: string
        contentType:
          description: The type of an image
          type: string
        scales:
          description: List of URIs to profile images in different dimensions
          items:
            $ref: '#/components/schemas/ProfileImageInfoURI'
          type: array
      required:
      - uri
      type: object
    AddonInfo:
      example:
        count: count
        id: id
      properties:
        id:
          type: string
        count:
          type: string
      type: object
    TranscriptionResult:
      properties:
        STTId:
          type: string
        ExternalId:
          type: string
        Status:
          format: int32
          type: integer
        Mailbox:
          type: string
        TranscriptionText:
          type: string
        Message:
          type: string
        MessageLength:
          type: string
        Confidence:
          type: string
      type: object
    ExtensionGrantListEvent:
      properties:
        extensionId:
          description: Internal identifier of an extension
          type: string
      type: object
    SCIMUserPatch:
      properties:
        Operations:
          description: patch operations list
          items:
            $ref: '#/components/schemas/PatchOperationInfo'
          type: array
        schemas:
          items:
            enum:
            - urn:ietf:params:scim:api:messages:2.0:PatchOp
            type: string
          type: array
      required:
      - Operations
      - schemas
      type: object
    BrandInfo:
      example:
        name: name
        id: id
        homeCountry:
          name: name
          id: id
          uri: uri
      properties:
        id:
          description: Internal identifier of a brand
          type: string
        name:
          description: 'Brand name, for example  RingCentral UK ,  ClearFax '
          type: string
        homeCountry:
          $ref: '#/components/schemas/CountryInfo'
      type: object
    CustomGreetingAnsweringRuleInfoRequest:
      example:
        id: id
      properties:
        id:
          description: Internal identifier of an answering rule
          type: string
      type: object
    MakeRingOutRequest:
      example:
        country:
          id: id
        from:
          phoneNumber: phoneNumber
          forwardingNumberId: forwardingNumberId
        playPrompt: true
        to:
          phoneNumber: phoneNumber
        callerId:
          phoneNumber: phoneNumber
      properties:
        from:
          $ref: '#/components/schemas/MakeRingOutCallerInfoRequestFrom'
        to:
          $ref: '#/components/schemas/MakeRingOutCallerInfoRequestTo'
        callerId:
          $ref: '#/components/schemas/MakeRingOutCallerInfoRequestTo'
        playPrompt:
          description: The audio prompt that the calling party hears when the call is connected
          type: boolean
        country:
          $ref: '#/components/schemas/MakeRingOutCountryInfo'
      required:
      - from
      - to
      type: object
    ConferencePhoneNumberInfo:
      example:
        default: true
        phoneNumber: phoneNumber
      properties:
        phoneNumber:
          description: Dial-in phone number to connect to a conference
          type: string
        default:
          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'
          type: boolean
      type: object
    RuleInfoCreateRuleRequest:
      properties:
        index:
          description: Forwarding number (or group) ordinal
          type: integer
        ringCount:
          description: Number of rings for a forwarding number (or group)
          type: integer
        forwardingNumbers:
          description: Forwarding number (or group) data
          items:
            $ref: '#/components/schemas/ForwardingNumberInfoRulesCreateRuleRequest'
          type: array
      type: object
    SpecialNumberInfo:
      properties:
        phoneNumber:
          description: Service phone number in N11 code format
          type: string
        description:
          description: Description of a special number
          type: string
        features:
          $ref: '#/components/schemas/SpecialNumberFeaturesInfo'
      required:
      - features
      type: object
    CallLogRecordingResource:
      properties:
        uri:
          format: uri
          type: string
        id:
          type: string
        type:
          type: string
        contentUri:
          type: string
      type: object
    CallerInfoFrom:
      example:
        phoneNumber: phoneNumber
        name: name
        location: location
      properties:
        phoneNumber:
          type: string
        name:
          type: string
        location:
          type: string
      type: object
    PagingGroupExtensionInfo:
      example:
        extensionNumber: extensionNumber
        name: name
        id: id
        uri: uri
      properties:
        id:
          description: Internal identifier of a paging group user extension
          type: string
        uri:
          description: Link to a paging group user extension
          type: string
        extensionNumber:
          description: Extension number of a paging group user
          type: string
        name:
          description: Name of a paging group user
          type: string
      type: object
    DictionaryGreetingInfo:
      example:
        navigation:
          previousPage:
            uri: uri
          firstPage:
            uri: uri
          lastPage:
            uri: uri
          nextPage:
            uri: uri
        contentUri: contentUri
        name: name
        paging:
          perPage: 5
          pageStart: 5
          pageEnd: 2
          totalPages: 7
          page: 1
          totalElements: 9
        id: id
        text: text
        type: Introductory
        category: Music
        uri: uri
        usageType: UserExtensionAnsweringRule
      properties:
        id:
          description: Internal identifier of a greeting
          type: string
        uri:
          description: Link to a greeting
          type: string
        name:
          description: Name of a greeting
          type: string
        usageType:
          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
          type: string
        text:
          description: Text of a greeting, if any
          type: string
        contentUri:
          description: Link to a greeting content (audio file), if any
          type: string
        type:
          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
          type: string
        category:
          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
          type: string
        navigation:
          $ref: '#/components/schemas/NavigationInfo'
        paging:
          $ref: '#/components/schemas/PagingInfo'
      type: object
    AssignedRolesResource:
      properties:
        uri:
          format: uri
          type: string
        records:
          items:
            $ref: '#/components/schemas/AssignedRoleResource'
          type: array
      type: object
    AlertInfo:
      properties:
        title:
          description: Title of a message
          type: string
        body:
          description: Message Description
          type: string
      type: object
    EmergencyAddressInfo:
      example:
        zip: zip
        country: country
        city: city
        street: street
        street2: street2
        state: state
        customerName: customerName
      properties:
        customerName:
          description: Name of a customer
          type: string
        street:
          description: Street address, line 1 - street address, P.O. box, company name, c/o
          type: string
        street2:
          description: Street address, line 2 - apartment, suite, unit, building, floor, etc.
          type: string
        city:
          description: City name
          type: string
        state:
          description: State/province name
          type: string
        zip:
          description: Zip code
          type: string
        country:
          description: Country name
          type: string
      type: object
    GetStateListResponse:
      example:
        navigation:
          previousPage:
            uri: uri
          firstPage:
            uri: uri
          lastPage:
            uri: uri
          nextPage:
            uri: uri
        records:
        - country:
            id: id
            uri: uri
          isoCode: isoCode
          name: name
          id: id
          uri: uri
        - country:
            id: id
            uri: uri
          isoCode: isoCode
          name: name
          id: id
          uri: uri
        paging:
          perPage: 5
          pageStart: 5
          pageEnd: 2
          totalPages: 7
          page: 1
          totalElements: 9
      properties:
        records:
          description: List of states
          items:
            $ref: '#/components/schemas/GetStateInfoResponse'
          type: array
        navigation:
          $ref: '#/components/schemas/NavigationInfo'
        paging:
          $ref: '#/components/schemas/PagingInfo'
      required:
      - navigation
      - paging
      - records
      type: object
    VersioningResource:
      properties:
        uri:
          format: uri
          type: string
        resourceDescription:
          type: string
        id:
          type: string
        ver:
          $ref: '#/components/schemas/ApiVersionResource'
      type: object
    LineInfo:
      example:
        extension:
          extensionNumber: extensionNumber
          id: id
          type: User
          uri: uri
        id: id
        uri: uri
      properties:
        id:
          description: Internal identifier of a monitored extension
          type: string
        uri:
          description: Canonical URI of a monitored extension
          type: string
        extension:
          $ref: '#/components/schemas/ExtensionInfoMonitoredLines'
      type: object
    AccountBusinessAddressResource:
      example:
        company: company
        businessAddress:
          zip: zip
          country: country
          city: city
          street: street
          state: state
        uri: http://example.com/aeiou
        email: email
      properties:
        uri:
          format: uri
          type: string
        businessAddress:
          $ref: '#/components/schemas/ContactAddressInfo'
        company:
          type: string
        email:
          type: string
      type: object
    ReportingAttachmentInfo:
      example:
        pdf: true
        csv: true
      properties:
        csv:
          description: Specifies whether to include CSV version of the report
          type: boolean
        pdf:
          description: Specifies whether to include PDF version of the report
          type: boolean
      type: object
    DictionaryGreetingList:
      example:
        records:
        - navigation:
            previousPage:
              uri: uri
            firstPage:
              uri: uri
            lastPage:
              uri: uri
            nextPage:
              uri: uri
          contentUri: contentUri
          name: name
          paging:
            perPage: 5
            pageStart: 5
            pageEnd: 2
            totalPages: 7
            page: 1
            totalElements: 9
          id: id
          text: text
          type: Introductory
          category: Music
          uri: uri
          usageType: UserExtensionAnsweringRule
        - navigation:
            previousPage:
              uri: uri
            firstPage:
              uri: uri
            lastPage:
              uri: uri
            nextPage:
              uri: uri
          contentUri: contentUri
          name: name
          paging:
            perPage: 5
            pageStart: 5
            pageEnd: 2
            totalPages: 7
            page: 1
            totalElements: 9
          id: id
          text: text
          type: Introductory
          category: Music
          uri: uri
          usageType: UserExtensionAnsweringRule
        uri: uri
      properties:
        uri:
          description: Canonical URI of greetings list resource
          type: string
        records:
          description: List of greetings
          items:
            $ref: '#/components/schemas/DictionaryGreetingInfo'
          type: array
      type: object
    FaxResendInfo:
      properties:
        originalMessageId:
          format: int64
          type: integer
        sendTime:
          format: date-time
          type: string
        to:
          items:
            $ref: '#/components/schemas/CallerInfo'
          type: array
      required:
      - originalMessageId
      type: object
    ExtensionInfoCallLog:
      example:
        id: id
        uri: uri
      properties:
        id:
          description: Internal identifier of an extension
          type: string
        uri:
          description: Canonical URI of an extension
          type: string
      type: object
    BlockedNumberInfo:
      example:
        phoneNumber: phoneNumber
        name: name
        id: id
        uri: uri
      properties:
        id:
          description: Internal identifier of a blocked number
          type: string
        uri:
          description: Canonical URI of a blocked number
          type: string
        name:
          description: Name assigned by a user to a blocked phone number
          type: string
        phoneNumber:
          description: Phone number to be blocked
          type: string
      type: object
    FaxResponse:
      example:
        readStatus: Read
        faxResolution: High
        attachments:
        - filename: filename
          size: 5
          vmDuration: 1
          id: 6
          type: AudioRecording
          uri: uri
          contentType: contentType
        - filename: filename
          size: 5
          vmDuration: 1
          id: 6
          type: AudioRecording
          uri: uri
          contentType: contentType
        lastModifiedTime: 2000-01-23T04:56:07.000+00:00
        creationTime: 2000-01-23T04:56:07.000+00:00
        coverIndex: 1
        availability: Alive
        type: type
        priority: Normal
        uri: uri
        messageStatus: Queued
        faxPageCount: 6
        coverPageText: coverPageText
        from:
          phoneNumber: phoneNumber
          name: name
          location: location
        id: 0
        to:
        - messageStatus: Sent
          phoneNumber: phoneNumber
          faxErrorCode: Undefined
          name: name
          location: location
        - messageStatus: Sent
          phoneNumber: phoneNumber
          faxErrorCode: Undefined
          name: name
          location: location
        direction: Inbound
      properties:
        id:
          description: Internal identifier of a message
          format: int64
          type: integer
        uri:
          description: Canonical URI of a message
          type: string
        type:
          description: Message type - 'Fax'
          type: string
        from:
          $ref: '#/components/schemas/CallerInfoFrom'
        to:
          description: Recipient information
          items:
            $ref: '#/components/schemas/CallerInfoTo'
          type: array
        creationTime:
          description: Message creation datetime in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z
          format: date-time
          type: string
        readStatus:
          description: Message read status
          enum:
          - Read
          - Unread
          type: string
        priority:
          description: Message priority
          enum:
          - Normal
          - High
          type: string
        attachments:
          description: The list of message attachments
          items:
            $ref: '#/components/schemas/MessageAttachmentInfoIntId'
          type: array
        direction:
          description: Message direction
          enum:
          - Inbound
          - Outbound
          type: string
        availability:
          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
          type: string
        messageStatus:
          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
          type: string
        faxResolution:
          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
          type: string
        faxPageCount:
          description: Page count in a fax message
          type: integer
        lastModifiedTime:
          description: Datetime when the message was modified on server in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z
          format: date-time
          type: string
        coverIndex:
          description: Cover page identifier. For the list of available cover page identifiers please call the method Fax Cover Pages
          type: integer
        coverPageText:
          description: Cover page text, entered by the fax sender and printed on the cover page. Maximum length is limited to 1024 symbols
          type: string
      type: object
    HintsResource:
      properties:
        userCredentialState:
          $ref: '#/components/schemas/HintResource'
        trialState:
          $ref: '#/components/schemas/HintResource'
        appVersionUpgrade:
          $ref: '#/components/schemas/HintResource'
      type: object
    NewCookie:
      properties:
        name:
          type: string
        value:
          type: string
        version:
          format: int32
          type: integer
        path:
          type: string
        domain:
          type: string
        comment:
          type: string
        maxAge:
          format: int32
          type: integer
        expiry:
          format: date-time
          type: string
        secure:
          default: false
          type: boolean
        httpOnly:
          default: false
          type: boolean
      type: object
    AdminNoticeResource:
      properties:
        subjectCode:
          type: string
        message:
          type: string
      type: object
    CompanyAnsweringRuleUpdate:
      example:
        schedule:
          ref: BusinessHours
          ranges:
            from: 2000-01-23T04:56:07.000+00:00
            to: 2000-01-23T04:56:07.000+00:00
          weeklyRanges:
            sunday:
            - from: from
              to: to
            - from: from
              to: to
            saturday:
            - from: from
              to: to
            - from: from
              to: to
            tuesday:
            - from: from
              to: to
            - from: from
              to: to
            wednesday:
            - from: from
              to: to
            - from: from
              to: to
            thursday:
            - from: from
              to: to
            - from: from
              to: to
            friday:
            - from: from
              to: to
            - from: from
              to: to
            monday:
            - from: from
              to: to
            - from: from
              to: to
        extension:
          name: name
          callerId: callerId
        name: name
        callers:
        - name: name
          callerId: callerId
        - name: name
          callerId: callerId
        greetings:
        - preset:
            name: name
            id: id
            uri: uri
          type: Introductory
          usageType: UserExtensionAnsweringRule
        - preset:
            name: name
            id: id
            uri: uri
          type: Introductory
          usageType: UserExtensionAnsweringRule
        enabled: true
        callHandlingAction: Operator
        calledNumbers:
        - id: id
        - id: id
      properties:
        enabled:
          default: true
          description: Specifies if the rule is active or inactive. The default value is 'True'
          type: boolean
        name:
          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
          type: string
        callers:
          description: Answering rule will be applied when calls are received from the specified caller(s)
          items:
            $ref: '#/components/schemas/CompanyAnsweringRuleCallersInfoRequest'
          type: array
        calledNumbers:
          description: Answering rule will be applied when calling the specified number(s)
          items:
            $ref: '#/components/schemas/CompanyAnsweringRuleCalledNumberInfo'
          type: array
        schedule:
          $ref: '#/components/schemas/CompanyAnsweringRuleScheduleInfoRequest'
        callHandlingAction:
          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
          type: string
        extension:
          $ref: '#/components/schemas/CompanyAnsweringRuleCallersInfoRequest'
        greetings:
          description: Greetings applied for an answering rule; only predefined greetings can be applied, see Dictionary Greeting List
          items:
            $ref: '#/components/schemas/GreetingInfo'
          type: array
      type: object
    PhoneNumbers:
      example:
        records:
        - formattedNumber: formattedNumber
          phoneNumber: phoneNumber
          rank: 0
          vanityPattern: vanityPattern
        - formattedNumber: formattedNumber
          phoneNumber: phoneNumber
          rank: 0
          vanityPattern: vanityPattern
        uri: uri
      properties:
        uri:
          description: Canonical URI of the phone numbers resource
          type: string
        records:
          description: List of phone numbers filtered by the specified criteria
          items:
            $ref: '#/components/schemas/LookupPhoneNumberInfo'
          type: array
      type: object
    PhoneNumberResource:
      example:
        country:
          callingCode: callingCode
          numberSelling: false
          isoCode: isoCode
          emergencyCalling: false
          name: name
          id: id
          uri: http://example.com/aeiou
          loginAllowed: false
        extension:
          setupWizardState: NotStarted
          statusInfo:
            reason: reason
            till: 2000-01-23T04:56:07.000+00:00
            comment: comment
          references:
          - ref: ref
            type: PartnerId
          - ref: ref
            type: PartnerId
          profileImage:
            scales:
            - uri: http://example.com/aeiou
            - uri: http://example.com/aeiou
            etag: etag
            lastModified: 2000-01-23T04:56:07.000+00:00
            uri: http://example.com/aeiou
            contentType: contentType
          type: Unknown
          uri: http://example.com/aeiou
          ivrPin: ivrPin
          password: password
          serviceFeatures:
          - reason: Available
            featureName: featureName
            enabled: false
          - reason: Available
            featureName: featureName
            enabled: false
          extensionNumber: extensionNumber
          permissions:
            admin:
              enabled: false
            uri: http://example.com/aeiou
            internationalCalling:
              enabled: false
            freeSoftPhoneDigitalLine:
              enabled: false
          loginName: loginName
          contact:
            firstName: firstName
            lastName: lastName
            company: company
            businessPhone: businessPhone
            businessAddress:
              zip: zip
              country: country
              city: city
              street: street
              state: state
            email: email
          name: name
          regionalSettings:
            timezone:
              name: name
              description: description
              id: id
              uri: http://example.com/aeiou
            greetingLanguage:
              localeCode: localeCode
              name: name
              id: id
            formattingLocale:
              localeCode: localeCode
              name: name
              id: id
            language:
              localeCode: localeCode
              name: name
              id: id
            homeCountry:
              callingCode: callingCode
              numberSelling: false
              isoCode: isoCode
              emergencyCalling: false
              name: name
              id: id
              uri: http://example.com/aeiou
              loginAllowed: false
          id: id
          partnerId: partnerId
          departments:
          - extensionNumber: extensionNumber
            id: id
            uri: http://example.com/aeiou
          - extensionNumber: extensionNumber
            id: id
            uri: http://example.com/aeiou
          status: Enabled
        phoneNumber: phoneNumber
        location: location
        id: id
        label: label
        type: VoiceFax
        paymentType: External
        status: status
        usageType: CompanyNumber
      properties:
        id:
          description: Internal identifier of a phone number
          type: string
        country:
          $ref: '#/components/schemas/CountryResource'
        extension:
          $ref: '#/components/schemas/ExtensionResource'
        label:
          description: Custom user name of a phone number, if any. Supported for numbers assigned to Auto-Receptionist, with usage type 'CompanyNumber'
          type: string
        location:
          description: Location (City, State). Filled for local US numbers
          type: string
        paymentType:
          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
          type: string
        phoneNumber:
          description: Phone number
          maxLength: 128
          minLength: 0
          type: string
        status:
          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: string
        usageType:
          enum:
          - CompanyNumber
          - MainCompanyNumber
          - AdditionalCompanyNumber
          - DirectNumber
          - CompanyFaxNumber
          - ForwardedNumber
          - ForwardedCompanyNumber
          - ContactCenterNumber
          type: string
        type:
          description: Type of a phone number
          enum:
          - VoiceFax
          - FaxOnly
          - VoiceOnly
          type: string
      type: object
    ServicePlanInfo:
      example:
        name: name
        edition: edition
        id: id
      properties:
        id:
          description: Internal identifier of a service plan
          type: string
        name:
          description: Name of a service plan
          type: string
        edition:
          description: Edition of a service plan
          type: string
      type: object
    ModifySubscriptionRequest:
      example:
        eventFilters:
        - eventFilters
        - eventFilters
      properties:
        eventFilters:
          description: Collection of URIs to API resources (see Event Types). Mandatory field
          items:
            type: string
          type: array
      type: object
    TesterFlagsResource:
      properties:
        tester:
          default: false
          type: boolean
        autoDelete:
          default: false
          type: boolean
        noBilling:
          default: false
          type: boolean
        noBillingLimit:
          default: false
          type: boolean
      type: object
    CallerIdByFeature:
      example:
        feature: RingOut
        callerId:
          phoneInfo:
            phoneNumber: phoneNumber
            id: id
            uri: uri
          type: type
      properties:
        feature:
          enum:
          - RingOut
          - RingMe
          - CallFlip
          - FaxNumber
          - AdditionalSoftphone
          - Alternate
          - CommonPhone
          type: string
        callerId:
          $ref: '#/components/schemas/CallerIdByFeatureInfo'
      type: object
    AccessValidationResource:
      properties:
        uri:
          format: uri
          type: string
        applicationId:
          type: string
        endpointId:
          type: string
        sessionId:
          type: string
        credentialType:
          enum:
          - Password
          - IvrPin
          - ExternalSso
          - NativeId
          - ExternalId
          - None
          - AIToken
          type: string
        scope:
          items:
            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
            type: string
          type: array
        accountId:
          type: string
        extensionId:
          type: string
        brandId:
          type: string
        tierId:
          type: string
      type: object
    CfaSettingsResource:
      properties:
        views:
          items:
            $ref: '#/components/schemas/CfaView'
          type: array
      type: object
    LocationInfo:
      example:
        areaCode: areaCode
        city: city
        state: state
        uri: uri
        npa: npa
        nxx: nxx
      properties:
        uri:
          description: Canonical URI of a location
          type: string
        areaCode:
          description: Area code of the location
          type: string
        city:
          description: Official name of the city, belonging to the certain state
          type: string
        npa:
          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
          type: string
        nxx:
          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
          type: string
        state:
          description: ID and URI of the state this location belongs to, see State Info
          type: string
      type: object
    UserGroupBulkAssignResource:
      properties:
        items:
          items:
            $ref: '#/components/schemas/BulkAssignItem'
          type: array
      type: object
    PermissionCategoryCollectionResource:
      example:
        navigation:
          previousPage:
            uri: http://example.com/aeiou
          firstPage:
            uri: http://example.com/aeiou
          lastPage:
            uri: http://example.com/aeiou
          nextPage:
            uri: http://example.com/aeiou
        records:
        - displayName: displayName
          description: description
          id: id
          uri: http://example.com/aeiou
        - displayName: displayName
          description: description
          id: id
          uri: http://example.com/aeiou
        paging:
          perPage: 1
          pageStart: 5
          pageEnd: 2
          totalPages: 6
          page: 0
          totalElements: 5
        uri: http://example.com/aeiou
      properties:
        uri:
          format: uri
          type: string
        records:
          items:
            $ref: '#/components/schemas/PermissionCategoryResource'
          type: array
        paging:
          $ref: '#/components/schemas/Paging'
        navigation:
          $ref: '#/components/schemas/Navigation'
      type: object
    NameInfo:
      example:
        givenName: givenName
        familyName: familyName
      properties:
        givenName:
          description: User first name
          type: string
        familyName:
          description: User last name
          type: string
      type: object
    GetCallRecordingResponse:
      example:
        duration: 0
        contentUri: contentUri
        id: id
        contentType: contentType
      properties:
        id:
          description: Internal identifier of the call recording
          type: string
        contentUri:
          description: Link to the call recording binary content
          type: string
        contentType:
          description: Call recording file format. Supported format is audio/x-wav
          type: string
        duration:
          description: Recorded call duration
          type: integer
      type: object
    IncomingCallEvent:
      properties:
        aps:
          $ref: '#/components/schemas/APSInfo'
        event:
          description: Event filter URI
          type: string
        uuid:
          description: Universally unique identifier of a notification
          type: string
        subscriptionId:
          description: Internal identifier of a subscription
          type: string
        timestamp:
          description: The datetime of a call action in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z
          format: date-time
          type: string
        extensionId:
          default: ~
          description: Internal identifier of an extension
          type: string
        action:
          description: Calling action, for example 'StartRing'
          type: string
        sessionId:
          description: Identifier of a call session
          type: string
        serverId:
          description: Identifier of a server
          type: string
        from:
          description: Phone number of a caller
          type: string
        fromName:
          description: Caller name
          type: string
        to:
          description: Phone number of a callee
          type: string
        toName:
          description: Callee name
          type: string
        sid:
          description: Unique identifier of a session
          type: string
        toUrl:
          description: SIP proxy registration name
          type: string
        srvLvl:
          description: User data
          type: string
        srvLvlExt:
          description: User data
          type: string
        recUrl:
          description: File containing recorded caller name
          type: string
        pn_ttl:
          description: Notification lifetime value in seconds, the default value is 30 seconds
          type: integer
      type: object
    SecretQuestionInfo:
      example:
        showInSignUp: true
        languageId: languageId
        id: id
        questionType: 0
        questionText: questionText
      properties:
        id:
          description: Internal identifier of a question
          type: string
        questionType:
          description: Internal identifier of a question type
          type: integer
        languageId:
          description: Internal identifier of a question language
          type: string
        questionText:
          description: Text of a secret question shown to the end user
          type: string
        showInSignUp:
          description: Specifies if the question is used during signup
          type: boolean
      type: object
    CompanyDirectoryProfileImageInfo:
      example:
        etag: etag
        uri: uri
      properties:
        uri:
          description: Link to a profile image resource
          type: string
        etag:
          description: Internal identifier of an image
          type: string
      type: object
    PaymentInfoCardResource:
      properties:
        cardType:
          type: string
        number:
          type: string
        securityCode:
          type: string
        expiry:
          type: string
        token:
          type: string
        holder:
          $ref: '#/components/schemas/PaymentInfoCardHolderResource'
      type: object
    CallerInfoTo:
      example:
        messageStatus: Sent
        phoneNumber: phoneNumber
        faxErrorCode: Undefined
        name: name
        location: location
      properties:
        phoneNumber:
          type: string
        name:
          type: string
        location:
          type: string
        messageStatus:
          enum:
          - Sent
          - SendingFailed
          - Queued
          type: string
        faxErrorCode:
          enum:
          - Undefined
          - NoFaxSendPermission
          - NoInternationalPermission
          - NoFaxMachine
          - OutgoingCallError
          - RenderingFailed
          - TooManyPages
          - ReturnToDBQueue
          - NoCallTime
          - WrongNumber
          - ProhibitedNumber
          - InternalError
          - FaxSendingProhibited
          - ThePhoneIsBlacklisted
          - UserNotFound
          - ConvertError
          - DBGeneralError
          - SkypeBillingFailed
          - AccountSuspended
          - ProhibitedDestination
          - InternationalDisabled
          type: string
      type: object
    PatchOperationInfo:
      properties:
        op:
          enum:
          - add
          - replace
          - remove
          type: string
        path:
          type: string
        value:
          description: corresponding 'value' of that field specified by 'path'
          properties: {}
          type: object
      required:
      - op
      type: object
    GetMonitoredExtensionsResponse:
      example:
        navigation:
          previousPage:
            uri: uri
          firstPage:
            uri: uri
          lastPage:
            uri: uri
          nextPage:
            uri: uri
        records:
        - extension:
            extensionNumber: extensionNumber
            id: id
            type: User
            uri: uri
          id: id
          uri: uri
        - extension:
            extensionNumber: extensionNumber
            id: id
            type: User
            uri: uri
          id: id
          uri: uri
        paging:
          perPage: 5
          pageStart: 5
          pageEnd: 2
          totalPages: 7
          page: 1
          totalElements: 9
        uri: uri
      properties:
        uri:
          description: Canonical URI of the monitored lines (extensions) resource
          type: string
        records:
          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: '#/components/schemas/LineInfo'
          type: array
        navigation:
          $ref: '#/components/schemas/NavigationInfo'
        paging:
          $ref: '#/components/schemas/PagingInfo'
      required:
      - navigation
      - paging
      - records
      type: object
    AddressBookResource:
      properties:
        uri:
          format: uri
          type: string
        contacts:
          $ref: '#/components/schemas/ResourceLink'
        groups:
          $ref: '#/components/schemas/ResourceLink'
      type: object
    TimezoneInfo:
      example:
        name: name
        description: description
        id: id
        uri: uri
      properties:
        id:
          description: Internal identifier of a timezone
          type: string
        uri:
          description: Canonical URI of a timezone
          type: string
        name:
          description: Short name of a timezone
          type: string
        description:
          description: Meaningful description of the timezone
          type: string
      type: object
    ShippingMethod:
      example:
        name: name
        id: id
      properties:
        id:
          description: Internal identifier of the shipping method
          type: string
        name:
          description: Name/description of the shipping method
          type: string
      type: object
    ClientProvisioningHintsInfo:
      example:
        trialState:
          expiresIn: 0
          actionRequired: true
        appVersionUpgrade:
          expiresIn: 0
          actionRequired: true
        userCredentialState:
          expiresIn: 0
          actionRequired: true
      properties:
        trialState:
          $ref: '#/components/schemas/ClientProvisioningHintInfo'
        userCredentialState:
          $ref: '#/components/schemas/ClientProvisioningHintInfo'
        appVersionUpgrade:
          $ref: '#/components/schemas/ClientProvisioningHintInfo'
      type: object
    DeviceOrderResource:
      properties:
        accountId:
          type: string
        requestNumber:
          type: string
        distributorName:
          type: string
        trackingNumber:
          type: string
        shippingCarrier:
          type: string
        devices:
          items:
            $ref: '#/components/schemas/DeviceInstance'
          type: array
      type: object
    CallLogSync:
      example:
        records:
        - lastModifiedTime: 2000-01-23T04:56:07.000+00:00
          recording:
            contentUri: contentUri
            id: id
            type: Automatic
            uri: uri
          sessionId: sessionId
          transport: PSTN
          type: Voice
          uri: uri
          result: Unknown
          duration: 0
          legs:
          - duration: 6
            result: Unknown
            extension:
              id: id
              uri: uri
            legType: legType
            action: Unknown
            recording:
              contentUri: contentUri
              id: id
              type: Automatic
              uri: uri
            startTime: 2000-01-23T04:56:07.000+00:00
            from:
              phoneNumber: phoneNumber
              extensionNumber: extensionNumber
              name: name
              location: location
              device:
                id: id
                uri: uri
            to:
              phoneNumber: phoneNumber
              extensionNumber: extensionNumber
              name: name
              location: location
              device:
                id: id
                uri: uri
            transport: PSTN
            type: Voice
            direction: Inbound
          - duration: 6
            result: Unknown
            extension:
              id: id
              uri: uri
            legType: legType
            action: Unknown
            recording:
              contentUri: contentUri
              id: id
              type: Automatic
              uri: uri
            startTime: 2000-01-23T04:56:07.000+00:00
            from:
              phoneNumber: phoneNumber
              extensionNumber: extensionNumber
              name: name
              location: location
              device:
                id: id
                uri: uri
            to:
              phoneNumber: phoneNumber
              extensionNumber: extensionNumber
              name: name
              location: location
              device:
                id: id
                uri: uri
            transport: PSTN
            type: Voice
            direction: Inbound
          action: Unknown
          from:
            phoneNumber: phoneNumber
            extensionNumber: extensionNumber
            name: name
            location: location
            device:
              id: id
              uri: uri
          startTime: 2000-01-23T04:56:07.000+00:00
          id: id
          to:
            phoneNumber: phoneNumber
            extensionNumber: extensionNumber
            name: name
            location: location
            device:
              id: id
              uri: uri
          direction: Inbound
        - lastModifiedTime: 2000-01-23T04:56:07.000+00:00
          recording:
            contentUri: contentUri
            id: id
            type: Automatic
            uri: uri
          sessionId: sessionId
          transport: PSTN
          type: Voice
          uri: uri
          result: Unknown
          duration: 0
          legs:
          - duration: 6
            result: Unknown
            extension:
              id: id
              uri: uri
            legType: legType
            action: Unknown
            recording:
              contentUri: contentUri
              id: id
              type: Automatic
              uri: uri
            startTime: 2000-01-23T04:56:07.000+00:00
            from:
              phoneNumber: phoneNumber
              extensionNumber: extensionNumber
              name: name
              location: location
              device:
                id: id
                uri: uri
            to:
              phoneNumber: phoneNumber
              extensionNumber: extensionNumber
              name: name
              location: location
              device:
                id: id
                uri: uri
            transport: PSTN
            type: Voice
            direction: Inbound
          - duration: 6
            result: Unknown
            extension:
              id: id
              uri: uri
            legType: legType
            action: Unknown
            recording:
              contentUri: contentUri
              id: id
              type: Automatic
              uri: uri
            startTime: 2000-01-23T04:56:07.000+00:00
            from:
              phoneNumber: phoneNumber
              extensionNumber: extensionNumber
              name: name
              location: location
              device:
                id: id
                uri: uri
            to:
              phoneNumber: phoneNumber
              extensionNumber: extensionNumber
              name: name
              location: location
              device:
                id: id
                uri: uri
            transport: PSTN
            type: Voice
            direction: Inbound
          action: Unknown
          from:
            phoneNumber: phoneNumber
            extensionNumber: extensionNumber
            name: name
            location: location
            device:
              id: id
              uri: uri
          startTime: 2000-01-23T04:56:07.000+00:00
          id: id
          to:
            phoneNumber: phoneNumber
            extensionNumber: extensionNumber
            name: name
            location: location
            device:
              id: id
              uri: uri
          direction: Inbound
        syncInfo:
          syncTime: 2000-01-23T04:56:07.000+00:00
          syncToken: syncToken
          syncType: FSync
      properties:
        records:
          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
          items:
            $ref: '#/components/schemas/CallLogRecord'
          type: array
        syncInfo:
          $ref: '#/components/schemas/SyncInfoCallLog'
      type: object
    InternalMessageResource:
      properties:
        to:
          items:
            $ref: '#/components/schemas/CallerInfo'
          type: array
        from:
          $ref: '#/components/schemas/CallerInfo'
        text:
          type: string
        replyOn:
          format: int64
          type: integer
      type: object
    CallLogRecord:
      example:
        lastModifiedTime: 2000-01-23T04:56:07.000+00:00
        recording:
          contentUri: contentUri
          id: id
          type: Automatic
          uri: uri
        sessionId: sessionId
        transport: PSTN
        type: Voice
        uri: uri
        result: Unknown
        duration: 0
        legs:
        - duration: 6
          result: Unknown
          extension:
            id: id
            uri: uri
          legType: legType
          action: Unknown
          recording:
            contentUri: contentUri
            id: id
            type: Automatic
            uri: uri
          startTime: 2000-01-23T04:56:07.000+00:00
          from:
            phoneNumber: phoneNumber
            extensionNumber: extensionNumber
            name: name
            location: location
            device:
              id: id
              uri: uri
          to:
            phoneNumber: phoneNumber
            extensionNumber: extensionNumber
            name: name
            location: location
            device:
              id: id
              uri: uri
          transport: PSTN
          type: Voice
          direction: Inbound
        - duration: 6
          result: Unknown
          extension:
            id: id
            uri: uri
          legType: legType
          action: Unknown
          recording:
            contentUri: contentUri
            id: id
            type: Automatic
            uri: uri
          startTime: 2000-01-23T04:56:07.000+00:00
          from:
            phoneNumber: phoneNumber
            extensionNumber: extensionNumber
            name: name
            location: location
            device:
              id: id
              uri: uri
          to:
            phoneNumber: phoneNumber
            extensionNumber: extensionNumber
            name: name
            location: location
            device:
              id: id
              uri: uri
          transport: PSTN
          type: Voice
          direction: Inbound
        action: Unknown
        from:
          phoneNumber: phoneNumber
          extensionNumber: extensionNumber
          name: name
          location: location
          device:
            id: id
            uri: uri
        startTime: 2000-01-23T04:56:07.000+00:00
        id: id
        to:
          phoneNumber: phoneNumber
          extensionNumber: extensionNumber
          name: name
          location: location
          device:
            id: id
            uri: uri
        direction: Inbound
      properties:
        id:
          description: Internal identifier of a cal log record
          type: string
        uri:
          description: Canonical URI of a call log record
          type: string
        sessionId:
          description: Internal identifier of a call session
          type: string
        from:
          $ref: '#/components/schemas/CallLogCallerInfo'
        to:
          $ref: '#/components/schemas/CallLogCallerInfo'
        type:
          description: Call type
          enum:
          - Voice
          - Fax
          type: string
        direction:
          description: Call direction
          enum:
          - Inbound
          - Outbound
          type: string
        action:
          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
          type: string
        result:
          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
          type: string
        startTime:
          description: The call start datetime in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z
          format: date-time
          type: string
        duration:
          description: Call duration in seconds
          type: integer
        recording:
          $ref: '#/components/schemas/RecordingInfo'
        lastModifiedTime:
          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
          format: date-time
          type: string
        transport:
          description: For 'Detailed' view only. Call transport
          enum:
          - PSTN
          - VoIP
          type: string
        legs:
          description: For 'Detailed' view only. Leg description
          items:
            $ref: '#/components/schemas/CallLogRecordLegInfo'
          type: array
      required:
      - legs
      type: object
    MetaInfo:
      example:
        created: 2000-01-23T04:56:07.000+00:00
        location: location
        lastModified: 2000-01-23T04:56:07.000+00:00
        resourceType: User
      properties:
        resourceType:
          description: User type
          enum:
          - User
          - Group
          type: string
        created:
          description: Datetime of user creation in ISO 8601 format, for example 2016-03-10T18:07:52.534Z
          format: date-time
          type: string
        lastModified:
          description: Datetime of the last change of user information in ISO 8601 format,for example 2016-03-10T18:07:52.534Z
          format: date-time
          type: string
        location:
          description: resource location URI
          type: string
      type: object
    InlinedExtensionResource:
      example:
        extensionNumber: extensionNumber
        id: id
        type: Unknown
        uri: http://example.com/aeiou
      properties:
        uri:
          format: uri
          type: string
        extensionNumber:
          type: string
        id:
          type: string
        type:
          enum:
          - Unknown
          - User
          - Department
          - Announcement
          - Voicemail
          - DigitalUser
          - VirtualUser
          - FaxUser
          - PagingOnly
          - SharedLinesGroup
          - IvrMenu
          - ApplicationExtension
          - ParkLocation
          type: string
      type: object
    NavigationInfoURI:
      example:
        uri: uri
      properties:
        uri:
          type: string
      type: object
    ConflictsInfo:
      example:
        firstName: firstName
        lastName: lastName
        id: id
        account:
          federatedName: federatedName
          id: id
      properties:
        id:
          description: Internal identifier of a conflicting extension assigned to another account of the current federation
          type: string
        firstName:
          description: Extension user first name
          type: string
        lastName:
          description: Extension user last name
          type: string
        account:
          $ref: '#/components/schemas/FederationConflictsAccountInfo'
      type: object
    CallLogCallerInfo:
      example:
        phoneNumber: phoneNumber
        extensionNumber: extensionNumber
        name: name
        location: location
        device:
          id: id
          uri: uri
      properties:
        phoneNumber:
          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
          type: string
        extensionNumber:
          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
          type: string
        location:
          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)
          type: string
        name:
          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
          type: string
        device:
          $ref: '#/components/schemas/CallLogRecordDeviceInfo'
      type: object
    SubscriptionInfo:
      example:
        expiresIn: 0
        eventFilters:
        - eventFilters
        - eventFilters
        creationTime: 2000-01-23T04:56:07.000+00:00
        deliveryMode:
          address: address
          encryption: true
          secretKey: secretKey
          subscriberKey: subscriberKey
          transportType: PubNub
          encryptionKey: encryptionKey
          encryptionAlgorithm: encryptionAlgorithm
        expirationTime: 2000-01-23T04:56:07.000+00:00
        id: id
        uri: uri
        status: Active
      properties:
        id:
          description: Internal identifier of a subscription
          type: string
        uri:
          description: Canonical URI of a subscription
          type: string
        eventFilters:
          description: Collection of URIs to API resources (message-store/presence/detailed presence)
          items:
            type: string
          type: array
        expirationTime:
          description: Subscription expiration datetime in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z
          format: date-time
          type: string
        expiresIn:
          description: Subscription lifetime in seconds. The default value is 900
          type: integer
        status:
          description: Subscription status
          enum:
          - Active
          - Suspended
          type: string
        creationTime:
          description: Subscription creation datetime in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z
          format: date-time
          type: string
        deliveryMode:
          $ref: '#/components/schemas/NotificationDeliveryMode'
      required:
      - deliveryMode
      type: object
    OutboundFaxesInfo:
      example:
        notifyBySms: true
        notifyByEmail: true
        advancedEmailAddresses:
        - advancedEmailAddresses
        - advancedEmailAddresses
        advancedSmsEmailAddresses:
        - advancedSmsEmailAddresses
        - advancedSmsEmailAddresses
      properties:
        notifyByEmail:
          description: Email notification flag
          type: boolean
        notifyBySms:
          description: SMS notification flag
          type: boolean
        advancedEmailAddresses:
          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
          type: array
        advancedSmsEmailAddresses:
          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
          type: array
      type: object
    EditParkLocationRequest:
      example:
        addedUserIds:
        - addedUserIds
        - addedUserIds
        removedUserIds:
        - removedUserIds
        - removedUserIds
      properties:
        addedUserIds:
          description: List of users that will be allowed to park/unpark calls using the specified park location
          items:
            type: string
          type: array
        removedUserIds:
          description: List of users that will be unallowed to park/unpark calls using the specified park location
          items:
            type: string
          type: array
      type: object
    GetDialingPlanCountryInfo:
      example:
        callingCode: callingCode
        isoCode: isoCode
        name: name
        id: id
        uri: uri
      properties:
        id:
          description: Internal identifier of a country
          type: string
        uri:
          description: Canonical URI of a country
          type: string
        callingCode:
          description: Country calling code defined by ITU-T recommendations E.123 and E.164, see Calling Codes
          type: string
        isoCode:
          description: Country code according to the ISO standard, see ISO 3166
          type: string
        name:
          description: Official name of a country
          type: string
      type: object
    VoicemailInfo:
      example:
        recipient:
          id: id
          uri: uri
        enabled: true
      properties:
        enabled:
          description: If 'True' then voicemails are allowed to be received
          type: boolean
        recipient:
          $ref: '#/components/schemas/RecipientInfo'
      type: object
    SaveRequestResource:
      properties:
        rendererId:
          type: string
        messageId:
          type: string
        status:
          type: string
        resultFile:
          type: string
      type: object
    ContactDirectoryEvent:
      properties:
        id:
          description: Internal identifier of an extension
          type: string
        eventType:
          description: Type of change
          type: string
        type:
          description: Extension Type
          type: string
        status:
          description: Status of an extension
          enum:
          - Disabled
          - Enabled
          - NotActivated
          type: string
        firstName:
          description: First name of an extension user
          type: string
        lastName:
          description: Last name of an extension user
          type: string
        department:
          description: Department Name
          type: string
        email:
          description: Email of an extension user
          type: string
        extensionNumber:
          description: Extension number
          type: string
        account:
          $ref: '#/components/schemas/CompanyDirectoryAccountInfo'
        phoneNumbers:
          $ref: '#/components/schemas/CompanyDirectoryPhoneNumberInfo'
        site:
          $ref: '#/components/schemas/SiteInfo'
        profileImage:
          $ref: '#/components/schemas/CompanyDirectoryProfileImageInfo'
      type: object
    ReportingPagesInfo:
      example:
        name: name
        attrX: attrX
      properties:
        name:
          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
          type: string
        attrX:
          description: CFA-defined filter values/page parameters
          type: string
      required:
      - name
      type: object
    ExtensionResource:
      example:
        setupWizardState: NotStarted
        statusInfo:
          reason: reason
          till: 2000-01-23T04:56:07.000+00:00
          comment: comment
        references:
        - ref: ref
          type: PartnerId
        - ref: ref
          type: PartnerId
        profileImage:
          scales:
          - uri: http://example.com/aeiou
          - uri: http://example.com/aeiou
          etag: etag
          lastModified: 2000-01-23T04:56:07.000+00:00
          uri: http://example.com/aeiou
          contentType: contentType
        type: Unknown
        uri: http://example.com/aeiou
        ivrPin: ivrPin
        password: password
        serviceFeatures:
        - reason: Available
          featureName: featureName
          enabled: false
        - reason: Available
          featureName: featureName
          enabled: false
        extensionNumber: extensionNumber
        permissions:
          admin:
            enabled: false
          uri: http://example.com/aeiou
          internationalCalling:
            enabled: false
          freeSoftPhoneDigitalLine:
            enabled: false
        loginName: loginName
        contact:
          firstName: firstName
          lastName: lastName
          company: company
          businessPhone: businessPhone
          businessAddress:
            zip: zip
            country: country
            city: city
            street: street
            state: state
          email: email
        name: name
        regionalSettings:
          timezone:
            name: name
            description: description
            id: id
            uri: http://example.com/aeiou
          greetingLanguage:
            localeCode: localeCode
            name: name
            id: id
          formattingLocale:
            localeCode: localeCode
            name: name
            id: id
          language:
            localeCode: localeCode
            name: name
            id: id
          homeCountry:
            callingCode: callingCode
            numberSelling: false
            isoCode: isoCode
            emergencyCalling: false
            name: name
            id: id
            uri: http://example.com/aeiou
            loginAllowed: false
        id: id
        partnerId: partnerId
        departments:
        - extensionNumber: extensionNumber
          id: id
          uri: http://example.com/aeiou
        - extensionNumber: extensionNumber
          id: id
          uri: http://example.com/aeiou
        status: Enabled
      properties:
        uri:
          format: uri
          type: string
        id:
          type: string
        partnerId:
          maxLength: 128
          minLength: 0
          pattern: ^[\p{Alnum}\.\-_]*$
          type: string
        extensionNumber:
          type: string
        loginName:
          type: string
        contact:
          $ref: '#/components/schemas/ContactInfo'
        references:
          items:
            $ref: '#/components/schemas/Reference'
          type: array
        name:
          type: string
        type:
          enum:
          - Unknown
          - User
          - Department
          - Announcement
          - Voicemail
          - DigitalUser
          - VirtualUser
          - FaxUser
          - PagingOnly
          - SharedLinesGroup
          - IvrMenu
          - ApplicationExtension
          - ParkLocation
          type: string
        status:
          enum:
          - Enabled
          - Disabled
          - Frozen
          - NotActivated
          - Unassigned
          type: string
        statusInfo:
          $ref: '#/components/schemas/StatusInfo'
        departments:
          items:
            $ref: '#/components/schemas/DepartmentResource'
          type: array
        serviceFeatures:
          items:
            $ref: '#/components/schemas/ServiceFeatureValue'
          type: array
        regionalSettings:
          $ref: '#/components/schemas/RegionalSettingsResource'
        setupWizardState:
          enum:
          - NotStarted
          - Incomplete
          - Completed
          - Unknown
          type: string
        permissions:
          $ref: '#/components/schemas/ExtensionPermissionsResource'
        password:
          type: string
        ivrPin:
          type: string
        profileImage:
          $ref: '#/components/schemas/ProfileImageResource'
      type: object
    TaskInfo:
      example:
        lastModifiedTime: 2000-01-23T04:56:07.000+00:00
        creationTime: 2000-01-23T04:56:07.000+00:00
        id: id
        uri: uri
        status: Accepted
      properties:
        id:
          description: Internal identifier of a task
          type: string
        uri:
          description: Link to a task resource
          type: string
        status:
          description: Device order status
          enum:
          - Accepted
          - Failed
          type: string
        creationTime:
          description: Task creation time
          format: date-time
          type: string
        lastModifiedTime:
          description: Time of task last modification
          format: date-time
          type: string
      type: object
    ServiceInfo:
      example:
        servicePlan:
          name: name
          edition: edition
          id: id
        billingPlan:
          duration: duration
          name: name
          id: id
          durationUnit: Month
          type: Initial
        targetServicePlan:
          name: name
          id: id
        uri: uri
        brand:
          name: name
          id: id
          homeCountry:
            name: name
            id: id
            uri: uri
      properties:
        uri:
          description: Canonical URI of a service info resource
          type: string
        billingPlan:
          $ref: '#/components/schemas/BillingPlanInfo'
        brand:
          $ref: '#/components/schemas/BrandInfo'
        servicePlan:
          $ref: '#/components/schemas/ServicePlanInfo'
        targetServicePlan:
          $ref: '#/components/schemas/TargetServicePlanInfo'
      type: object
    ContactsCollection:
      properties:
        uri:
          format: uri
          type: string
        records:
          items:
            $ref: '#/components/schemas/PersonalContactResource'
          type: array
        paging:
          $ref: '#/components/schemas/Paging'
        navigation:
          $ref: '#/components/schemas/Navigation'
        groups:
          $ref: '#/components/schemas/ResourceLink'
      type: object
    SipInfo:
      properties:
        transport:
          enum:
          - UDP
          - TCP
          - TLS
          - WS
          - WSS
          type: string
        certificate:
          type: string
        username:
          type: string
        password:
          type: string
        authorizationId:
          type: string
        domain:
          type: string
        outboundProxy:
          type: string
        wsProxy:
          type: string
      type: object
    FavoriteCollection:
      example:
        records:
        - contactId: contactId
          id: id
          uri: http://example.com/aeiou
          extensionId: extensionId
        - contactId: contactId
          id: id
          uri: http://example.com/aeiou
          extensionId: extensionId
        uri: http://example.com/aeiou
      properties:
        uri:
          format: uri
          type: string
        records:
          items:
            $ref: '#/components/schemas/FavoriteContactResource'
          type: array
      type: object
    SubscriptionResponse:
      example:
        expiresIn: 0
        eventFilters:
        - eventFilters
        - eventFilters
        creationTime: 2000-01-23T04:56:07.000+00:00
        deliveryMode:
          authKey: authKey
          address: address
          encryption: false
          subscriberKey: subscriberKey
          registrationId: registrationId
          certificateName: certificateName
          transportType: PUBNUB
          encryptionKey: encryptionKey
          cipherKey: cipherKey
          publisherKey: publisherKey
          encryptionAlgorithm: encryptionAlgorithm
        expirationTime: 2000-01-23T04:56:07.000+00:00
        blacklistedData:
          blacklistedAt: 2000-01-23T04:56:07.000+00:00
          reason: reason
        id: id
        uri: http://example.com/aeiou
        status: status
      properties:
        uri:
          format: uri
          type: string
        id:
          type: string
        creationTime:
          format: date-time
          type: string
        status:
          type: string
        eventFilters:
          items:
            type: string
          type: array
        expirationTime:
          format: date-time
          type: string
        expiresIn:
          format: int64
          type: integer
        deliveryMode:
          $ref: '#/components/schemas/DeliveryModeResource'
        blacklistedData:
          $ref: '#/components/schemas/NotificationBlacklistedData'
      type: object
    NumberPoolPhoneNumberRequest:
      example:
        phoneNumber: phoneNumber
        reservationId: reservationId
        reservedTill: 2000-01-23T04:56:07.000+00:00
      properties:
        phoneNumber:
          description: Phone number in E.164 format
          type: string
        reservedTill:
          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)
          format: date-time
          type: string
        reservationId:
          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
          type: string
      type: object
    CustomDataApiResponse:
      example:
        lastModifiedTime: lastModifiedTime
        attachment:
          uri: uri
          contentType: contentType
        id: id
        uri: uri
        value: value
      properties:
        id:
          description: Custom data access key
          type: string
        uri:
          description: Link to the custom data
          type: string
        value:
          description: Description of custom data
          type: string
        lastModifiedTime:
          description: Time of the last change in custom data
          type: string
        attachment:
          $ref: '#/components/schemas/CustomDataAttachmentInfo'
      required:
      - id
      - lastModifiedTime
      - uri
      type: object
    GlipMessageAttachmentInfo:
      example:
        imageUri: imageUri
        color: color
        author:
          name: name
          uri: uri
          iconUri: iconUri
        intro: intro
        id: id
        text: text
        footnote:
          text: text
          time: 2000-01-23T04:56:07.000+00:00
          iconUri: iconUri
        type: Card
        title: title
        thumbnailUri: thumbnailUri
        fields:
        - style: Short
          title: title
          value: value
        - style: Short
          title: title
          value: value
        fallback: fallback
      properties:
        id:
          description: Internal identifier of an attachment
          type: string
        type:
          default: Card
          description: Type of an attachment
          type: string
        fallback:
          description: A string of default text that will be rendered in the case that the client does not support Interactive Messages
          type: string
        color:
          description: A Hex color code that determines the color of the side border of the Interactive Message
          type: string
        intro:
          description: A pretext to the message
          type: string
        author:
          $ref: '#/components/schemas/GlipMessageAttachmentAuthorInfo'
        title:
          description: Message title
          type: string
        text:
          description: A large string field (up to 1000 chars) to be displayed as the body of a message (Supports GlipDown)
          type: string
        imageUri:
          description: url used to display a single image at the bottom of a message
          type: string
        thumbnailUri:
          description: url used to display a thumbnail to the right of a message (82x82)
          type: string
        fields:
          description: Information on navigation
          items:
            $ref: '#/components/schemas/GlipMessageAttachmentFieldsInfo'
          type: array
        footnote:
          $ref: '#/components/schemas/GlipMessageAttachmentFootnoteInfo'
      type: object
    MeetingScheduleResource:
      example:
        durationInMinutes: 0
        timeZone:
          name: name
          description: description
          id: id
          uri: http://example.com/aeiou
        startTime: startTime
      properties:
        startTime:
          type: string
        durationInMinutes:
          format: int32
          type: integer
        timeZone:
          $ref: '#/components/schemas/TimezoneResource'
      type: object
    SiteInfo:
      properties:
        id:
          description: Internal Identifier of a site
          type: string
        name:
          description: custom name of a site
          type: string
      type: object
    IVRMenuPromptInfo:
      example:
        mode: Audio
        language:
          id: id
          uri: uri
        audio:
          localeCode: localeCode
          name: name
          id: id
          uri: uri
        text: text
      properties:
        mode:
          description: 'Prompt mode: custom media or text = [''Audio'', ''TextToSpeech'']'
          enum:
          - Audio
          - TextToSpeech
          type: string
        audio:
          $ref: '#/components/schemas/PromptLanguageInfo'
        text:
          description: For 'TextToSpeech' mode only. Prompt text
          type: string
        language:
          $ref: '#/components/schemas/AudioPromptInfo'
      type: object
    NotificationSettingsUpdateRequest:
      example:
        advancedMode: true
        emailAddresses:
        - emailAddresses
        - emailAddresses
        outboundFaxes:
          notifyBySms: true
          notifyByEmail: true
          advancedEmailAddresses:
          - advancedEmailAddresses
          - advancedEmailAddresses
          advancedSmsEmailAddresses:
          - advancedSmsEmailAddresses
          - advancedSmsEmailAddresses
        missedCalls:
          notifyBySms: true
          notifyByEmail: true
          advancedEmailAddresses:
          - advancedEmailAddresses
          - advancedEmailAddresses
          advancedSmsEmailAddresses:
          - advancedSmsEmailAddresses
          - advancedSmsEmailAddresses
        smsEmailAddresses:
        - smsEmailAddresses
        - smsEmailAddresses
        voicemails:
          notifyBySms: true
          includeAttachment: true
          notifyByEmail: true
          advancedEmailAddresses:
          - advancedEmailAddresses
          - advancedEmailAddresses
          advancedSmsEmailAddresses:
          - advancedSmsEmailAddresses
          - advancedSmsEmailAddresses
          markAsRead: true
        inboundTexts:
          notifyBySms: true
          notifyByEmail: true
          advancedEmailAddresses:
          - advancedEmailAddresses
          - advancedEmailAddresses
          advancedSmsEmailAddresses:
          - advancedSmsEmailAddresses
          - advancedSmsEmailAddresses
        inboundFaxes:
          notifyBySms: true
          includeAttachment: true
          notifyByEmail: true
          advancedEmailAddresses:
          - advancedEmailAddresses
          - advancedEmailAddresses
          advancedSmsEmailAddresses:
          - advancedSmsEmailAddresses
          - advancedSmsEmailAddresses
          markAsRead: true
      properties:
        emailAddresses:
          description: List of notification recipient email addresses
          items:
            type: string
          type: array
        smsEmailAddresses:
          description: List of notification recipient email addresses
          items:
            type: string
          type: array
        advancedMode:
          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
          type: boolean
        voicemails:
          $ref: '#/components/schemas/VoicemailsInfo'
        inboundFaxes:
          $ref: '#/components/schemas/InboundFaxesInfo'
        outboundFaxes:
          $ref: '#/components/schemas/OutboundFaxesInfo'
        inboundTexts:
          $ref: '#/components/schemas/InboundTextsInfo'
        missedCalls:
          $ref: '#/components/schemas/MissedCallsInfo'
      type: object
    LocationsResource:
      properties:
        uri:
          format: uri
          type: string
        records:
          items:
            $ref: '#/components/schemas/LocationResource'
          type: array
        paging:
          $ref: '#/components/schemas/Paging'
        navigation:
          $ref: '#/components/schemas/Navigation'
      type: object
    TimezoneResource:
      example:
        name: name
        description: description
        id: id
        uri: http://example.com/aeiou
      properties:
        uri:
          format: uri
          type: string
        id:
          type: string
        name:
          type: string
        description:
          type: string
      type: object
    CompanyAnsweringRuleList:
      example:
        navigation:
          previousPage:
            uri: uri
          firstPage:
            uri: uri
          lastPage:
            uri: uri
          nextPage:
            uri: uri
        records:
        - name: name
          id: id
          type: BusinessHours
          uri: uri
          enabled: true
        - name: name
          id: id
          type: BusinessHours
          uri: uri
          enabled: true
        paging:
          perPage: 5
          pageStart: 5
          pageEnd: 2
          totalPages: 7
          page: 1
          totalElements: 9
        uri: uri
      properties:
        uri:
          description: Link to an answering rule resource
          type: string
        records:
          description: List of company answering rules
          items:
            $ref: '#/components/schemas/ListCompanyAnsweringRuleInfo'
          type: array
        paging:
          $ref: '#/components/schemas/PagingInfo'
        navigation:
          $ref: '#/components/schemas/NavigationInfo'
      type: object
    VoicemailsInfo:
      example:
        notifyBySms: true
        includeAttachment: true
        notifyByEmail: true
        advancedEmailAddresses:
        - advancedEmailAddresses
        - advancedEmailAddresses
        advancedSmsEmailAddresses:
        - advancedSmsEmailAddresses
        - advancedSmsEmailAddresses
        markAsRead: true
      properties:
        notifyByEmail:
          description: Email notification flag
          type: boolean
        notifyBySms:
          description: SMS notification flag
          type: boolean
        advancedEmailAddresses:
          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
          type: array
        advancedSmsEmailAddresses:
          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
          type: array
        includeAttachment:
          description: Indicates whether voicemail should be attached to email
          type: boolean
        markAsRead:
          description: Indicates whether email should be automatically marked as read
          type: boolean
      type: object
    GetPresenceInfo:
      example:
        allowSeeMyPresence: true
        dndStatus: TakeAllCalls
        extension:
          extensionNumber: extensionNumber
          id: id
          uri: uri
        pickUpCallsOnHold: true
        userStatus: Offline
        telephonyStatus: NoCall
        ringOnMonitoredCall: true
        message: message
        presenceStatus: Offline
        uri: uri
        activeCalls:
        - sipData:
            callId: callId
            fromTag: fromTag
            remoteUri: remoteUri
            toTag: toTag
            localUri: localUri
            rcSessionId: rcSessionId
          telephonyStatus: NoCall
          terminationType: final
          from: from
          id: id
          to: to
          sessionId: sessionId
          direction: Inbound
        - sipData:
            callId: callId
            fromTag: fromTag
            remoteUri: remoteUri
            toTag: toTag
            localUri: localUri
            rcSessionId: rcSessionId
          telephonyStatus: NoCall
          terminationType: final
          from: from
          id: id
          to: to
          sessionId: sessionId
          direction: Inbound
      properties:
        uri:
          description: Canonical URI of a presence info resource
          type: string
        allowSeeMyPresence:
          description: If 'True' enables other extensions to see the extension presence status
          type: boolean
        dndStatus:
          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
          type: string
        extension:
          $ref: '#/components/schemas/GetPresenceExtensionInfo'
        message:
          description: Custom status message (as previously published by user)
          type: string
        pickUpCallsOnHold:
          description: If 'True' enables the extension user to pick up a monitored line on hold
          type: boolean
        presenceStatus:
          description: Aggregated presence status, calculated from a number of sources
          enum:
          - Offline
          - Busy
          - Available
          type: string
        ringOnMonitoredCall:
          description: If 'True' enables to ring extension phone, if any user monitored by this extension is ringing
          type: boolean
        telephonyStatus:
          description: Telephony presence status
          enum:
          - NoCall
          - CallConnected
          - Ringing
          - OnHold
          - ParkedCall
          type: string
        userStatus:
          description: User-defined presence status (as previously published by the user)
          enum:
          - Offline
          - Busy
          - Available
          type: string
        activeCalls:
          description: Information on active calls
          items:
            $ref: '#/components/schemas/ActiveCallInfo'
          type: array
      type: object
    GetVersionResponse:
      example:
        versionString: versionString
        releaseDate: releaseDate
        uriString: uriString
        uri: uri
      properties:
        uri:
          description: Canonical URI of the version info resource
          type: string
        versionString:
          description: Version of the RingCentral REST API
          type: string
        releaseDate:
          description: Release date of this version
          type: string
        uriString:
          description: URI part determining the current version
          type: string
      type: object
    PromptLanguageInfo:
      example:
        localeCode: localeCode
        name: name
        id: id
        uri: uri
      properties:
        uri:
          description: Link to prompt language
          type: string
        id:
          description: Internal identifier of an language
          type: string
        name:
          description: Language name
          type: string
        localeCode:
          description: Language locale code
          type: string
      type: object
    MakeRingOutCountryInfo:
      example:
        id: id
      properties:
        id:
          description: Dialing plan country identifier
          type: string
      type: object
    Brand:
      properties:
        id:
          type: string
        name:
          type: string
        homeCountry:
          $ref: '#/components/schemas/HomeCountry'
      type: object
    ExtensionFavoritesPresenceEvent:
      properties:
        extensionId:
          default: ~
          description: Internal identifier of an extension. Optional parameter
          type: string
        telephonyStatus:
          description: Telephony presence status. Returned if telephony status is changed.
          enum:
          - NoCall
          - CallConnected
          - Ringing
          - OnHold
          - ParkedCall
          type: string
        sequence:
          description: Order number of a notification to state the chronology
          type: integer
        presenceStatus:
          description: Aggregated presence status, calculated from a number of sources
          enum:
          - Offline
          - Busy
          - Available
          type: string
        userStatus:
          description: User-defined presence status (as previously published by the user)
          enum:
          - Offline
          - Busy
          - Available
          type: string
        dndStatus:
          description: Extended DnD (Do not Disturb) status
          enum:
          - TakeAllCalls
          - DoNotAcceptAnyCalls
          - DoNotAcceptDepartmentCalls
          - TakeDepartmentCallsOnly
          type: string
        allowSeeMyPresence:
          description: If 'True' enables other extensions to see the extension presence status
          type: boolean
        ringOnMonitoredCall:
          description: If 'True' enables to ring extension phone, if any user monitored by this extension is ringing
          type: boolean
        pickUpCallsOnHold:
          description: If 'True' enables the extension user to pick up a monitored line on hold
          type: boolean
      type: object
    CustomCompanyGreetingInfo:
      example:
        answeringRule:
          id: id
          uri: uri
        contentUri: contentUri
        id: id
        type: Company
        uri: uri
        contentType: WAV
      properties:
        uri:
          description: Link to an extension custom greeting
          type: string
        id:
          description: Internal identifier of an answering rule
          type: string
        type:
          description: Internal identifier of an answering rule
          enum:
          - Company
          type: string
        contentType:
          description: Content media type in WAV/MP3 format
          enum:
          - WAV
          - MP3
          type: string
        contentUri:
          description: Link to a greeting content (audio file)
          type: string
        answeringRule:
          $ref: '#/components/schemas/CustomGreetingAnsweringRuleInfo'
      type: object
    CompanyAnsweringRuleInfo:
      example:
        schedule:
          ref: BusinessHours
          ranges:
            from: 2000-01-23T04:56:07.000+00:00
            to: 2000-01-23T04:56:07.000+00:00
          weeklyRanges:
            sunday:
            - from: from
              to: to
            - from: from
              to: to
            saturday:
            - from: from
              to: to
            - from: from
              to: to
            tuesday:
            - from: from
              to: to
            - from: from
              to: to
            wednesday:
            - from: from
              to: to
            - from: from
              to: to
            thursday:
            - from: from
              to: to
            - from: from
              to: to
            friday:
            - from: from
              to: to
            - from: from
              to: to
            monday:
            - from: from
              to: to
            - from: from
              to: to
        extension:
          name: name
          callerId: callerId
        name: name
        id: id
        callers:
        - name: name
          callerId: callerId
        - name: name
          callerId: callerId
        greetings:
        - preset:
            name: name
            id: id
            uri: uri
          type: Introductory
          usageType: UserExtensionAnsweringRule
        - preset:
            name: name
            id: id
            uri: uri
          type: Introductory
          usageType: UserExtensionAnsweringRule
        type: BusinessHours
        uri: uri
        enabled: true
        callHandlingAction: Operator
        calledNumbers:
        - id: id
        - id: id
      properties:
        id:
          description: Internal identifier of an answering rule
          type: string
        uri:
          description: Canonical URI of an answering rule
          type: string
        enabled:
          default: true
          description: Specifies if the rule is active or inactive. The default value is 'True'
          type: boolean
        type:
          description: Type of an answering rule, the default value is 'Custom' = ['BusinessHours', 'AfterHours', 'Custom']
          enum:
          - BusinessHours
          - AfterHours
          - Custom
          type: string
        name:
          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
          type: string
        callers:
          description: Answering rule will be applied when calls are received from the specified caller(s)
          items:
            $ref: '#/components/schemas/CompanyAnsweringRuleCallersInfoRequest'
          type: array
        calledNumbers:
          description: Answering rule will be applied when calling the specified number(s)
          items:
            $ref: '#/components/schemas/CompanyAnsweringRuleCalledNumberInfoRequest'
          type: array
        schedule:
          $ref: '#/components/schemas/CompanyAnsweringRuleScheduleInfo'
        callHandlingAction:
          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
          type: string
        extension:
          $ref: '#/components/schemas/CompanyAnsweringRuleCallersInfoRequest'
        greetings:
          description: Greetings applied for an answering rule; only predefined greetings can be applied, see Dictionary Greeting List
          items:
            $ref: '#/components/schemas/GreetingInfo'
          type: array
      type: object
    GetCountryInfoNumberParser:
      example:
        callingCode: callingCode
        emergencyCalling: true
        isoCode: isoCode
        name: name
        id: id
        uri: uri
      properties:
        id:
          description: Internal identifier of a country
          type: string
        uri:
          description: Canonical URI of a country
          type: string
        callingCode:
          description: Country calling code defined by ITU-T recommendations E.123 and E.164, see Calling Codes
          type: string
        emergencyCalling:
          description: Emergency calling feature availability/emergency address requirement indicator
          type: boolean
        isoCode:
          description: Country code according to the ISO standard, see ISO 3166
          type: string
        name:
          description: Official name of a country
          type: string
      type: object
    GCMData:
      properties:
        event:
          description: Event filter URI
          type: string
        subscriptionId:
          description: Internal identifier of a subscription
          type: string
        timestamp:
          description: The datetime of a call action in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z
          format: date-time
          type: string
        extensionId:
          default: ~
          description: Internal identifier of an extension
          type: string
        action:
          description: Calling action, for example 'StartRing'
          type: string
        sessionId:
          description: Identifier of a call session
          type: string
        serverId:
          description: Identifier of a server
          type: string
        _from:
          description: Phone number of a caller
          type: string
        fromName:
          description: Caller name
          type: string
        to:
          description: Phone number of a callee
          type: string
        toName:
          description: Callee name
          type: string
        sid:
          description: Unique identifier of a session
          type: string
        toUrl:
          description: SIP proxy registration name
          type: string
        srvLvl:
          description: User data
          type: string
        srvLvlExt:
          description: User data
          type: string
      type: object
    ClientApplicationInfo:
      example:
        appVersion: appVersion
        appPlatform: appPlatform
        appName: appName
        appId: appId
        detected: true
        userAgent: userAgent
        appPlatformVersion: appPlatformVersion
        locale: locale
      properties:
        detected:
          description: '''True'', if the server succeeded detecting application info,
            sufficient to return provisioning info'
          type: boolean
        userAgent:
          description: The value of 'User-Agent' header, as it was passed in request
          type: string
        appId:
          description: Application identifier (from authorization session)
          type: string
        appName:
          description: Application name (from authorization session, but must match 'User-Agent')
          type: string
        appVersion:
          description: Application version (parsed from 'User-Agent')
          type: string
        appPlatform:
          description: 'Application platform operation system (parsed from ''User-Agent'':
            Windows, MacOS, Android, iOS'
          type: string
        appPlatformVersion:
          description: Application platform operation system version (parsed from 'User-Agent')
          type: string
        locale:
          description: Locale, parsed from 'Accept-Language'. Currently en-GB and en-US locales are supported. The default value is en-US
          type: string
      required:
      - detected
      type: object
    ClientProvisioningWebUriInfo:
      example:
        mobileWebTellAFriend: mobileWebTellAFriend
        mobileWebInternationalCalling: mobileWebInternationalCalling
        mobileWebResetPassword: mobileWebResetPassword
        appDownload: appDownload
        mobileWebPhoneSystem: mobileWebPhoneSystem
        serviceWebTellAFriend: serviceWebTellAFriend
        serviceWebPhoneSystem: serviceWebPhoneSystem
        mobileWebReporting: mobileWebReporting
        mobileWebBilling: mobileWebBilling
        serviceWebResetPassword: serviceWebResetPassword
        signUp: signUp
        meetingsAppDownload: meetingsAppDownload
        mobileWebCallHandling: mobileWebCallHandling
        mobileWebTrialUpgrade: mobileWebTrialUpgrade
        mobileWebUserSettings: mobileWebUserSettings
        serviceWebUserSettings: serviceWebUserSettings
        serviceWebBilling: serviceWebBilling
        appDownloadFile: appDownloadFile
        serviceWebHome: serviceWebHome
        expressSetupMobile: expressSetupMobile
        support: support
        mobileWebNotifications: mobileWebNotifications
      properties:
        appDownload:
          description: Link to web page with the application description. Returned if the application needs to be updated, together with the appVersionUpgrade hint
          type: string
        appDownloadFile:
          description: Link to the application distributive package. Returned if the application needs to be updated, together with the appVersionUpgrade hint
          type: string
        expressSetupMobile:
          description: Link to express setup page (mobile application)
          type: string
        meetingsAppDownload:
          description: Link to the RC Meetings application distributive package
          type: string
        mobileWebBilling:
          description: Link to billing page (mobile application)
          type: string
        mobileWebCallHandling:
          description: Link to call handling page (mobile application)
          type: string
        mobileWebInternationalCalling:
          description: Link to international calling page (mobile application)
          type: string
        mobileWebNotifications:
          description: Link to notifications page (mobile application)
          type: string
        mobileWebPhoneSystem:
          description: Link to phone system settings page (mobile application)
          type: string
        mobileWebReporting:
          description: Link to reports page (mobile application)
          type: string
        mobileWebResetPassword:
          description: Link to reset password page (mobile application)
          type: string
        mobileWebTellAFriend:
          description: Link to  Tell A Friend  page (mobile application)
          type: string
        mobileWebTrialUpgrade:
          description: Link to upgrade trial account (mobile application)
          type: string
        mobileWebUserSettings:
          description: Link to user settings page (mobile application)
          type: string
        serviceWebBilling:
          description: Link to billing page (web application)
          type: string
        serviceWebHome:
          description: Link to home page (web application)
          type: string
        serviceWebPhoneSystem:
          description: Link to phone system settings page (web application)
          type: string
        serviceWebResetPassword:
          description: Link to reset password page (web application)
          type: string
        serviceWebTellAFriend:
          description: Link to  Tell A Friend  page (web application)
          type: string
        serviceWebUserSettings:
          description: Link to user settings page (web application)
          type: string
        signUp:
          description: Link to sign up page (web application)
          type: string
        support:
          description: Link to support page (web application)
          type: string
      type: object
    PhoneNumberInfoConferencing:
      example:
        hasGreeting: true
        country:
          callingCode: callingCode
          emergencyCalling: true
          isoCode: isoCode
          name: name
          id: id
          uri: uri
        default: true
        phoneNumber: phoneNumber
        location: location
      properties:
        country:
          $ref: '#/components/schemas/GetCountryInfoConferencing'
        default:
          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'
          type: boolean
        hasGreeting:
          description: '''True'' if the greeting message is played on this number'
          type: boolean
        location:
          description: Location (city, region, state) of a conference phone number
          type: string
        phoneNumber:
          description: Dial-in phone number to connect to a conference
          type: string
      type: object
    ListCompanyAnsweringRuleInfo:
      example:
        name: name
        id: id
        type: BusinessHours
        uri: uri
        enabled: true
      properties:
        id:
          description: Internal identifier of an answering rule
          type: string
        uri:
          description: Canonical URI of an answering rule
          type: string
        enabled:
          default: true
          description: Specifies if the rule is active or inactive. The default value is 'True'
          type: boolean
        type:
          description: Type of an answering rule, the default value is 'Custom' = ['BusinessHours', 'AfterHours', 'Custom']
          enum:
          - BusinessHours
          - AfterHours
          - Custom
          type: string
        name:
          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
          type: string
      type: object
    RuleInfo:
      example:
        forwardingNumbers:
        - phoneNumber: phoneNumber
          id: id
          label: label
          uri: uri
        - phoneNumber: phoneNumber
          id: id
          label: label
          uri: uri
        ringCount: 1
        index: 6
      properties:
        index:
          description: Forwarding number (or group) ordinal
          type: integer
        ringCount:
          description: Number of rings for a forwarding number (or group)
          type: integer
        forwardingNumbers:
          description: Forwarding number (or group) data
          items:
            $ref: '#/components/schemas/ForwardingNumberInfoRules'
          type: array
      type: object
    GetAccountCallLogRecordResponse:
      example:
        result: Unknown
        duration: 0
        action: Unknown
        recording:
          contentUri: contentUri
          id: id
          type: Automatic
          uri: uri
        from:
          phoneNumber: phoneNumber
          extensionNumber: extensionNumber
          name: name
          location: location
          device:
            id: id
            uri: uri
        startTime: 2000-01-23T04:56:07.000+00:00
        id: id
        sessionId: sessionId
        to:
          phoneNumber: phoneNumber
          extensionNumber: extensionNumber
          name: name
          location: location
          device:
            id: id
            uri: uri
        type: Voice
        uri: uri
        direction: Inbound
      properties:
        id:
          description: Internal identifier of a cal log record
          type: string
        uri:
          description: Canonical URI of a call log record
          type: string
        sessionId:
          description: Internal identifier of a call session
          type: string
        from:
          $ref: '#/components/schemas/CallLogCallerInfo'
        to:
          $ref: '#/components/schemas/CallLogCallerInfo'
        type:
          description: Call type
          enum:
          - Voice
          - Fax
          type: string
        direction:
          description: Call direction
          enum:
          - Inbound
          - Outbound
          type: string
        action:
          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
          type: string
        result:
          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
          type: string
        startTime:
          description: The call start datetime in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z
          format: date-time
          type: string
        duration:
          description: Call duration in seconds
          type: integer
        recording:
          $ref: '#/components/schemas/RecordingInfo'
      type: object
    ViewInfoReporting:
      example:
        pages:
        - name: name
          attrX: attrX
        - name: name
          attrX: attrX
        schedules:
        - recurrence:
          - pattern: Daily
            value: "0"
          - pattern: Daily
            value: "0"
          attachments:
          - pdf: true
            csv: true
          - pdf: true
            csv: true
          pages:
          - pages
          - pages
          recipients:
          - recipients
          - recipients
          viewType: Detailed
          scheduleId: scheduleId
        - recurrence:
          - pattern: Daily
            value: "0"
          - pattern: Daily
            value: "0"
          attachments:
          - pdf: true
            csv: true
          - pdf: true
            csv: true
          pages:
          - pages
          - pages
          recipients:
          - recipients
          - recipients
          viewType: Detailed
          scheduleId: scheduleId
        name: name
      properties:
        name:
          description: User-defined name of a 'View'. The maximum value is 255
          type: string
        pages:
          description: List of pages, the max amount is 10
          items:
            $ref: '#/components/schemas/PagesInfoReporting'
          type: array
        schedules:
          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: '#/components/schemas/SchedulesInfoReporting'
          type: array
      required:
      - name
      - pages
      type: object
    ModelInfo:
      example:
        addons:
        - count: count
          id: id
        - count: count
          id: id
        name: name
        id: id
      properties:
        id:
          description: Addon identifier. For HardPhones of certain types, which are compatible with this addon identifier
          type: string
        name:
          description: Device name
          type: string
        addons:
          description: Addons description
          items:
            $ref: '#/components/schemas/AddonInfo'
          type: array
      required:
      - addons
      type: object
    PhoneNumberForProvisioningResource:
      properties:
        phoneNumber:
          type: string
        vanityPattern:
          type: string
        source:
          enum:
          - Internal
          - External
          type: string
        type:
          enum:
          - VoiceOnly
          - FaxOnly
          - VoiceFax
          type: string
        usageType:
          enum:
          - MainCompanyNumber
          - AdditionalCompanyNumber
          - CompanyFaxNumber
          - CompanyNumber
          - DirectNumber
          type: string
        extension:
          $ref: '#/components/schemas/ExtensionReferenceResource'
        reservationId:
          type: string
      type: object
    GlipMentionsInfo:
      example:
        name: name
        id: id
        type: Person
      properties:
        id:
          description: Id of the user
          type: string
        type:
          description: Type of mentions
          enum:
          - Person
          - Team
          - File
          - Link
          - Event
          - Task
          - Note
          - Card
          type: string
        name:
          description: Name of the user
          type: string
      type: object
    MethodResource:
      example:
        name: name
        id: id
      properties:
        id:
          type: string
        name:
          type: string
      type: object
    UserInfo:
      example:
        emails:
        - type: work
          value: value
        - type: work
          value: value
        addresses:
        - country: country
          streetAddress: streetAddress
          postalCode: postalCode
          locality: locality
          region: region
          type: work
        - country: country
          streetAddress: streetAddress
          postalCode: postalCode
          locality: locality
          region: region
          type: work
        meta:
          created: 2000-01-23T04:56:07.000+00:00
          location: location
          lastModified: 2000-01-23T04:56:07.000+00:00
          resourceType: User
        schemas:
        - schemas
        - schemas
        name:
          givenName: givenName
          familyName: familyName
        active: false
        externalId: externalId
        id: id
        userName: userName
        photos:
        - type: photo
          value: value
        - type: photo
          value: value
        phoneNumbers:
        - type: work
          value: value
        - type: work
          value: value
        urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:
          department: department
      properties:
        active:
          default: false
          description: Status of a user
          type: boolean
        addresses:
          description: User addresses
          items:
            $ref: '#/components/schemas/AddressInfo'
          type: array
        emails:
          description: User email addresses
          items:
            $ref: '#/components/schemas/EmailInfo'
          type: array
        externalId:
          description: External identifier of a user
          type: string
        id:
          description: Internal identifier of a user
          type: string
        name:
          $ref: '#/components/schemas/NameInfo'
        phoneNumbers:
          description: User phone numbers
          items:
            $ref: '#/components/schemas/PhoneNumberInfoRequest'
          type: array
        photos:
          items:
            $ref: '#/components/schemas/PhotoInfo'
          type: array
        schemas:
          description: Specification links
          items:
            type: string
          type: array
        urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:
          $ref: '#/components/schemas/EnterpriseUser'
        userName:
          description: User mailbox. Must be same as work type email address
          type: string
        meta:
          $ref: '#/components/schemas/MetaInfo'
      type: object
    CreateSipRegistrationResponse:
      example:
        sipFlags:
        - outboundCallsEnabled: True
          voipFeatureEnabled: True
          voipCountryBlocked: True
        - outboundCallsEnabled: True
          voipFeatureEnabled: True
          voipCountryBlocked: True
        sipInfo:
        - password: password
          authorizationId: authorizationId
          domain: domain
          certificate: certificate
          transport: UDP
          outboundProxy: outboundProxy
          username: username
        - password: password
          authorizationId: authorizationId
          domain: domain
          certificate: certificate
          transport: UDP
          outboundProxy: outboundProxy
          username: username
      properties:
        sipInfo:
          description: SIP settings for device
          items:
            $ref: '#/components/schemas/SIPInfoResponse'
          type: array
        sipFlags:
          description: SIP flags data
          items:
            $ref: '#/components/schemas/SIPFlagsRespones'
          type: array
      required:
      - sipFlags
      - sipInfo
      type: object
    VoicemailSettingsResource:
      properties:
        enabled:
          default: false
          type: boolean
        recipient:
          $ref: '#/components/schemas/ExtensionResource'
      type: object
    HomeCountryResource:
      properties:
        uri:
          format: uri
          type: string
        id:
          type: string
        name:
          type: string
        isoCode:
          type: string
        callingCode:
          type: string
      type: object
    PhoneNumberInfoIntId:
      example:
        country:
          name: name
          id: id
          uri: uri
        extension:
          extensionNumber: extensionNumber
          id: id
          partnerId: partnerId
          uri: uri
        phoneNumber: phoneNumber
        location: location
        id: 6
        label: label
        type: VoiceFax
        paymentType: External
        status: status
        usageType: MainCompanyNumber
      properties:
        id:
          description: Internal identifier of a phone number
          format: int64
          type: integer
        country:
          $ref: '#/components/schemas/CountryInfo'
        extension:
          $ref: '#/components/schemas/ExtensionInfo'
        label:
          description: Custom user name of a phone number, if any. Supported for numbers assigned to Auto-Receptionist, with usage type 'CompanyNumber'
          type: string
        location:
          description: Location (City, State). Filled for local US numbers
          type: string
        paymentType:
          description: Payment type. 'External' is returned for forwarded numbers which are not terminated in the RingCentral phone system
          enum:
          - External
          - TollFree
          - Local
          type: string
        phoneNumber:
          description: Phone number
          type: string
        status:
          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: string
        type:
          description: Phone number type
          enum:
          - VoiceFax
          - FaxOnly
          - VoiceOnly
          type: string
        usageType:
          description: Usage type of the phone number
          enum:
          - MainCompanyNumber
          - AdditionalCompanyNumber
          - CompanyNumber
          - DirectNumber
          - CompanyFaxNumber
          - ForwardedNumber
          - ForwardedCompanyNumber
          - ContactCenterNumber
          type: string
      type: object
    CompanyDirectoryContacts:
      example:
        records:
        - firstName: firstName
          lastName: lastName
          extensionNumber: extensionNumber
          name: name
          id: id
          profileImage:
            etag: etag
            uri: uri
          type: User
          department: department
          email: email
          account:
            id: id
          phoneNumbers:
          - phoneNumber: phoneNumber
            hidden: true
            type: VoiceFax
            usageType: MobileNumber
          - phoneNumber: phoneNumber
            hidden: true
            type: VoiceFax
            usageType: MobileNumber
          status: Enabled
        - firstName: firstName
          lastName: lastName
          extensionNumber: extensionNumber
          name: name
          id: id
          profileImage:
            etag: etag
            uri: uri
          type: User
          department: department
          email: email
          account:
            id: id
          phoneNumbers:
          - phoneNumber: phoneNumber
            hidden: true
            type: VoiceFax
            usageType: MobileNumber
          - phoneNumber: phoneNumber
            hidden: true
            type: VoiceFax
            usageType: MobileNumber
          status: Enabled
        paging:
          perPage: 5
          pageStart: 5
          pageEnd: 2
          totalPages: 7
          page: 1
          totalElements: 9
      properties:
        records:
          description: List of countries which can be selected for a dialing plan
          items:
            $ref: '#/components/schemas/CompanyDirectoryContactInfo'
          type: array
        paging:
          $ref: '#/components/schemas/PagingInfo'
      required:
      - paging
      - records
      type: object
    DepartmentMemberList:
      example:
        navigation:
          previousPage:
            uri: uri
          firstPage:
            uri: uri
          lastPage:
            uri: uri
          nextPage:
            uri: uri
        records:
        - extensionNumber: extensionNumber
          id: id
          partnerId: partnerId
          uri: uri
        - extensionNumber: extensionNumber
          id: id
          partnerId: partnerId
          uri: uri
        paging:
          perPage: 5
          pageStart: 5
          pageEnd: 2
          totalPages: 7
          page: 1
          totalElements: 9
      properties:
        records:
          description: List of department members extensions
          items:
            $ref: '#/components/schemas/ExtensionInfo'
          type: array
        navigation:
          $ref: '#/components/schemas/NavigationInfo'
        paging:
          $ref: '#/components/schemas/PagingInfo'
      type: object
    ScaledProfileImageResource:
      example:
        uri: http://example.com/aeiou
      properties:
        uri:
          format: uri
          type: string
      type: object
    FaxCallerInfo:
      properties:
        phoneNumber:
          description: Recipient information. Phone number property is mandatory. Optional for resend fax request
          type: string
      type: object
    BlacklistEntriesResource:
      properties:
        uri:
          format: uri
          type: string
        records:
          items:
            $ref: '#/components/schemas/BlacklistEntryResource'
          type: array
        paging:
          $ref: '#/components/schemas/Paging'
        navigation:
          $ref: '#/components/schemas/Navigation'
      type: object
    TimezonesResource:
      properties:
        uri:
          format: uri
          type: string
        records:
          items:
            $ref: '#/components/schemas/TimezoneResource'
          type: array
        paging:
          $ref: '#/components/schemas/Paging'
        navigation:
          $ref: '#/components/schemas/Navigation'
      type: object
    GetCountryInfoState:
      example:
        id: id
        uri: uri
      properties:
        id:
          description: Internal identifier of a state
          type: string
        uri:
          description: Canonical URI of a state
          type: string
      type: object
    HomeCountry:
      properties:
        id:
          type: string
        uri:
          format: uri
          type: string
        name:
          type: string
        isoCode:
          type: string
        callingCode:
          type: string
      type: object
    PresenceLineResource:
      example:
        extension:
          extensionNumber: extensionNumber
          id: id
          type: Unknown
          uri: http://example.com/aeiou
        id: id
      properties:
        id:
          type: string
        extension:
          $ref: '#/components/schemas/InlinedExtensionResource'
      type: object
    MakeRingOutCallerInfoRequestFrom:
      example:
        phoneNumber: phoneNumber
        forwardingNumberId: forwardingNumberId
      properties:
        phoneNumber:
          description: Phone number in E.164 format
          type: string
        forwardingNumberId:
          description: Internal identifier of a forwarding number; returned in response in the id field. Can be specified instead of the phoneNumber attribute
          type: string
      type: object
    CreateSMSMessage:
      properties:
        from:
          $ref: '#/components/schemas/MessageStoreCallerInfoRequest'
        to:
          description: Receiver of an SMS message. The phoneNumber property must be filled
          items:
            $ref: '#/components/schemas/MessageStoreCallerInfoRequest'
          type: array
        text:
          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
          type: string
      required:
      - from
      - text
      - to
      type: object
    DeviceOrder:
      example:
        devices:
        - extension:
            setupWizardState: NotStarted
            statusInfo:
              reason: reason
              till: 2000-01-23T04:56:07.000+00:00
              comment: comment
            references:
            - ref: ref
              type: PartnerId
            - ref: ref
              type: PartnerId
            profileImage:
              scales:
              - uri: http://example.com/aeiou
              - uri: http://example.com/aeiou
              etag: etag
              lastModified: 2000-01-23T04:56:07.000+00:00
              uri: http://example.com/aeiou
              contentType: contentType
            type: Unknown
            uri: http://example.com/aeiou
            ivrPin: ivrPin
            password: password
            serviceFeatures:
            - reason: Available
              featureName: featureName
              enabled: false
            - reason: Available
              featureName: featureName
              enabled: false
            extensionNumber: extensionNumber
            permissions:
              admin:
                enabled: false
              uri: http://example.com/aeiou
              internationalCalling:
                enabled: false
              freeSoftPhoneDigitalLine:
                enabled: false
            loginName: loginName
            contact:
              firstName: firstName
              lastName: lastName
              company: company
              businessPhone: businessPhone
              businessAddress:
                zip: zip
                country: country
                city: city
                street: street
                state: state
              email: email
            name: name
            regionalSettings:
              timezone:
                name: name
                description: description
                id: id
                uri: http://example.com/aeiou
              greetingLanguage:
                localeCode: localeCode
                name: name
                id: id
              formattingLocale:
                localeCode: localeCode
                name: name
                id: id
              language:
                localeCode: localeCode
                name: name
                id: id
              homeCountry:
                callingCode: callingCode
                numberSelling: false
                isoCode: isoCode
                emergencyCalling: false
                name: name
                id: id
                uri: http://example.com/aeiou
                loginAllowed: false
            id: 6
            partnerId: partnerId
            departments:
            - extensionNumber: extensionNumber
              id: id
              uri: http://example.com/aeiou
            - extensionNumber: extensionNumber
              id: id
              uri: http://example.com/aeiou
            status: Enabled
          phoneLines:
          - lineType: Unknown
            phoneInfo:
              country:
                callingCode: callingCode
                numberSelling: false
                isoCode: isoCode
                emergencyCalling: false
                name: name
                id: id
                uri: http://example.com/aeiou
                loginAllowed: false
              extension:
                setupWizardState: NotStarted
                statusInfo:
                  reason: reason
                  till: 2000-01-23T04:56:07.000+00:00
                  comment: comment
                references:
                - ref: ref
                  type: PartnerId
                - ref: ref
                  type: PartnerId
                profileImage:
                  scales:
                  - uri: http://example.com/aeiou
                  - uri: http://example.com/aeiou
                  etag: etag
                  lastModified: 2000-01-23T04:56:07.000+00:00
                  uri: http://example.com/aeiou
                  contentType: contentType
                type: Unknown
                uri: http://example.com/aeiou
                ivrPin: ivrPin
                password: password
                serviceFeatures:
                - reason: Available
                  featureName: featureName
                  enabled: false
                - reason: Available
                  featureName: featureName
                  enabled: false
                extensionNumber: extensionNumber
                permissions:
                  admin:
                    enabled: false
                  uri: http://example.com/aeiou
                  internationalCalling:
                    enabled: false
                  freeSoftPhoneDigitalLine:
                    enabled: false
                loginName: loginName
                contact:
                  firstName: firstName
                  lastName: lastName
                  company: company
                  businessPhone: businessPhone
                  businessAddress:
                    zip: zip
                    country: country
                    city: city
                    street: street
                    state: state
                  email: email
                name: name
                regionalSettings:
                  timezone:
                    name: name
                    description: description
                    id: id
                    uri: http://example.com/aeiou
                  greetingLanguage:
                    localeCode: localeCode
                    name: name
                    id: id
                  formattingLocale:
                    localeCode: localeCode
                    name: name
                    id: id
                  language:
                    localeCode: localeCode
                    name: name
                    id: id
                  homeCountry:
                    callingCode: callingCode
                    numberSelling: false
                    isoCode: isoCode
                    emergencyCalling: false
                    name: name
                    id: id
                    uri: http://example.com/aeiou
                    loginAllowed: false
                id: id
                partnerId: partnerId
                departments:
                - extensionNumber: extensionNumber
                  id: id
                  uri: http://example.com/aeiou
                - extensionNumber: extensionNumber
                  id: id
                  uri: http://example.com/aeiou
                status: Enabled
              phoneNumber: phoneNumber
              location: location
              id: 1
              label: label
              type: VoiceFax
              paymentType: External
              status: status
              usageType: CompanyNumber
            emergencyAddress:
              localOnly: true
              required: true
          - lineType: Unknown
            phoneInfo:
              country:
                callingCode: callingCode
                numberSelling: false
                isoCode: isoCode
                emergencyCalling: false
                name: name
                id: id
                uri: http://example.com/aeiou
                loginAllowed: false
              extension:
                setupWizardState: NotStarted
                statusInfo:
                  reason: reason
                  till: 2000-01-23T04:56:07.000+00:00
                  comment: comment
                references:
                - ref: ref
                  type: PartnerId
                - ref: ref
                  type: PartnerId
                profileImage:
                  scales:
                  - uri: http://example.com/aeiou
                  - uri: http://example.com/aeiou
                  etag: etag
                  lastModified: 2000-01-23T04:56:07.000+00:00
                  uri: http://example.com/aeiou
                  contentType: contentType
                type: Unknown
                uri: http://example.com/aeiou
                ivrPin: ivrPin
                password: password
                serviceFeatures:
                - reason: Available
                  featureName: featureName
                  enabled: false
                - reason: Available
                  featureName: featureName
                  enabled: false
                extensionNumber: extensionNumber
                permissions:
                  admin:
                    enabled: false
                  uri: http://example.com/aeiou
                  internationalCalling:
                    enabled: false
                  freeSoftPhoneDigitalLine:
                    enabled: false
                loginName: loginName
                contact:
                  firstName: firstName
                  lastName: lastName
                  company: company
                  businessPhone: businessPhone
                  businessAddress:
                    zip: zip
                    country: country
                    city: city
                    street: street
                    state: state
                  email: email
                name: name
                regionalSettings:
                  timezone:
                    name: name
                    description: description
                    id: id
                    uri: http://example.com/aeiou
                  greetingLanguage:
                    localeCode: localeCode
                    name: name
                    id: id
                  formattingLocale:
                    localeCode: localeCode
                    name: name
                    id: id
                  language:
                    localeCode: localeCode
                    name: name
                    id: id
                  homeCountry:
                    callingCode: callingCode
                    numberSelling: false
                    isoCode: isoCode
                    emergencyCalling: false
                    name: name
                    id: id
                    uri: http://example.com/aeiou
                    loginAllowed: false
                id: id
                partnerId: partnerId
                departments:
                - extensionNumber: extensionNumber
                  id: id
                  uri: http://example.com/aeiou
                - extensionNumber: extensionNumber
                  id: id
                  uri: http://example.com/aeiou
                status: Enabled
              phoneNumber: phoneNumber
              location: location
              id: 1
              label: label
              type: VoiceFax
              paymentType: External
              status: status
              usageType: CompanyNumber
            emergencyAddress:
              localOnly: true
              required: true
          type: HardPhone
          uri: http://example.com/aeiou
          emergencyServiceAddress:
            zip: zip
            country: country
            city: city
            street: street
            street2: street2
            state: state
            customerName: customerName
          shipping:
            carrier: carrier
            address:
              zip: zip
              country: country
              city: city
              street: street
              street2: street2
              state: state
              customerName: customerName
            method:
              name: name
              id: id
            trackingNumber: trackingNumber
            status: status
          boxBillingId: 5
          serial: serial
          computerName: computerName
          linePooling: Host
          name: name
          model:
            addons:
            - name: name
              count: 0
              id: id
            - name: name
              count: 0
              id: id
            name: name
            id: id
          id: id
          sku: sku
          status: Online
        - extension:
            setupWizardState: NotStarted
            statusInfo:
              reason: reason
              till: 2000-01-23T04:56:07.000+00:00
              comment: comment
            references:
            - ref: ref
              type: PartnerId
            - ref: ref
              type: PartnerId
            profileImage:
              scales:
              - uri: http://example.com/aeiou
              - uri: http://example.com/aeiou
              etag: etag
              lastModified: 2000-01-23T04:56:07.000+00:00
              uri: http://example.com/aeiou
              contentType: contentType
            type: Unknown
            uri: http://example.com/aeiou
            ivrPin: ivrPin
            password: password
            serviceFeatures:
            - reason: Available
              featureName: featureName
              enabled: false
            - reason: Available
              featureName: featureName
              enabled: false
            extensionNumber: extensionNumber
            permissions:
              admin:
                enabled: false
              uri: http://example.com/aeiou
              internationalCalling:
                enabled: false
              freeSoftPhoneDigitalLine:
                enabled: false
            loginName: loginName
            contact:
              firstName: firstName
              lastName: lastName
              company: company
              businessPhone: businessPhone
              businessAddress:
                zip: zip
                country: country
                city: city
                street: street
                state: state
              email: email
            name: name
            regionalSettings:
              timezone:
                name: name
                description: description
                id: id
                uri: http://example.com/aeiou
              greetingLanguage:
                localeCode: localeCode
                name: name
                id: id
              formattingLocale:
                localeCode: localeCode
                name: name
                id: id
              language:
                localeCode: localeCode
                name: name
                id: id
              homeCountry:
                callingCode: callingCode
                numberSelling: false
                isoCode: isoCode
                emergencyCalling: false
                name: name
                id: id
                uri: http://example.com/aeiou
                loginAllowed: false
            id: 6
            partnerId: partnerId
            departments:
            - extensionNumber: extensionNumber
              id: id
              uri: http://example.com/aeiou
            - extensionNumber: extensionNumber
              id: id
              uri: http://example.com/aeiou
            status: Enabled
          phoneLines:
          - lineType: Unknown
            phoneInfo:
              country:
                callingCode: callingCode
                numberSelling: false
                isoCode: isoCode
                emergencyCalling: false
                name: name
                id: id
                uri: http://example.com/aeiou
                loginAllowed: false
              extension:
                setupWizardState: NotStarted
                statusInfo:
                  reason: reason
                  till: 2000-01-23T04:56:07.000+00:00
                  comment: comment
                references:
                - ref: ref
                  type: PartnerId
                - ref: ref
                  type: PartnerId
                profileImage:
                  scales:
                  - uri: http://example.com/aeiou
                  - uri: http://example.com/aeiou
                  etag: etag
                  lastModified: 2000-01-23T04:56:07.000+00:00
                  uri: http://example.com/aeiou
                  contentType: contentType
                type: Unknown
                uri: http://example.com/aeiou
                ivrPin: ivrPin
                password: password
                serviceFeatures:
                - reason: Available
                  featureName: featureName
                  enabled: false
                - reason: Available
                  featureName: featureName
                  enabled: false
                extensionNumber: extensionNumber
                permissions:
                  admin:
                    enabled: false
                  uri: http://example.com/aeiou
                  internationalCalling:
                    enabled: false
                  freeSoftPhoneDigitalLine:
                    enabled: false
                loginName: loginName
                contact:
                  firstName: firstName
                  lastName: lastName
                  company: company
                  businessPhone: businessPhone
                  businessAddress:
                    zip: zip
                    country: country
                    city: city
                    street: street
                    state: state
                  email: email
                name: name
                regionalSettings:
                  timezone:
                    name: name
                    description: description
                    id: id
                    uri: http://example.com/aeiou
                  greetingLanguage:
                    localeCode: localeCode
                    name: name
                    id: id
                  formattingLocale:
                    localeCode: localeCode
                    name: name
                    id: id
                  language:
                    localeCode: localeCode
                    name: name
                    id: id
                  homeCountry:
                    callingCode: callingCode
                    numberSelling: false
                    isoCode: isoCode
                    emergencyCalling: false
                    name: name
                    id: id
                    uri: http://example.com/aeiou
                    loginAllowed: false
                id: id
                partnerId: partnerId
                departments:
                - extensionNumber: extensionNumber
                  id: id
                  uri: http://example.com/aeiou
                - extensionNumber: extensionNumber
                  id: id
                  uri: http://example.com/aeiou
                status: Enabled
              phoneNumber: phoneNumber
              location: location
              id: 1
              label: label
              type: VoiceFax
              paymentType: External
              status: status
              usageType: CompanyNumber
            emergencyAddress:
              localOnly: true
              required: true
          - lineType: Unknown
            phoneInfo:
              country:
                callingCode: callingCode
                numberSelling: false
                isoCode: isoCode
                emergencyCalling: false
                name: name
                id: id
                uri: http://example.com/aeiou
                loginAllowed: false
              extension:
                setupWizardState: NotStarted
                statusInfo:
                  reason: reason
                  till: 2000-01-23T04:56:07.000+00:00
                  comment: comment
                references:
                - ref: ref
                  type: PartnerId
                - ref: ref
                  type: PartnerId
                profileImage:
                  scales:
                  - uri: http://example.com/aeiou
                  - uri: http://example.com/aeiou
                  etag: etag
                  lastModified: 2000-01-23T04:56:07.000+00:00
                  uri: http://example.com/aeiou
                  contentType: contentType
                type: Unknown
                uri: http://example.com/aeiou
                ivrPin: ivrPin
                password: password
                serviceFeatures:
                - reason: Available
                  featureName: featureName
                  enabled: false
                - reason: Available
                  featureName: featureName
                  enabled: false
                extensionNumber: extensionNumber
                permissions:
                  admin:
                    enabled: false
                  uri: http://example.com/aeiou
                  internationalCalling:
                    enabled: false
                  freeSoftPhoneDigitalLine:
                    enabled: false
                loginName: loginName
                contact:
                  firstName: firstName
                  lastName: lastName
                  company: company
                  businessPhone: businessPhone
                  businessAddress:
                    zip: zip
                    country: country
                    city: city
                    street: street
                    state: state
                  email: email
                name: name
                regionalSettings:
                  timezone:
                    name: name
                    description: description
                    id: id
                    uri: http://example.com/aeiou
                  greetingLanguage:
                    localeCode: localeCode
                    name: name
                    id: id
                  formattingLocale:
                    localeCode: localeCode
                    name: name
                    id: id
                  language:
                    localeCode: localeCode
                    name: name
                    id: id
                  homeCountry:
                    callingCode: callingCode
                    numberSelling: false
                    isoCode: isoCode
                    emergencyCalling: false
                    name: name
                    id: id
                    uri: http://example.com/aeiou
                    loginAllowed: false
                id: id
                partnerId: partnerId
                departments:
                - extensionNumber: extensionNumber
                  id: id
                  uri: http://example.com/aeiou
                - extensionNumber: extensionNumber
                  id: id
                  uri: http://example.com/aeiou
                status: Enabled
              phoneNumber: phoneNumber
              location: location
              id: 1
              label: label
              type: VoiceFax
              paymentType: External
              status: status
              usageType: CompanyNumber
            emergencyAddress:
              localOnly: true
              required: true
          type: HardPhone
          uri: http://example.com/aeiou
          emergencyServiceAddress:
            zip: zip
            country: country
            city: city
            street: street
            street2: street2
            state: state
            customerName: customerName
          shipping:
            carrier: carrier
            address:
              zip: zip
              country: country
              city: city
              street: street
              street2: street2
              state: state
              customerName: customerName
            method:
              name: name
              id: id
            trackingNumber: trackingNumber
            status: status
          boxBillingId: 5
          serial: serial
          computerName: computerName
          linePooling: Host
          name: name
          model:
            addons:
            - name: name
              count: 0
              id: id
            - name: name
              count: 0
              id: id
            name: name
            id: id
          id: id
          sku: sku
          status: Online
        id: id
        uri: uri
      properties:
        id:
          description: Identifier of a device
          type: string
        uri:
          description: Canonical URI of an order resource
          type: string
        devices:
          description: List of devices ordered
          items:
            $ref: '#/components/schemas/DeviceResource'
          type: array
      type: object
    PresenceLineInfo:
      example:
        extension:
          id: id
        id: id
      properties:
        id:
          type: string
        extension:
          $ref: '#/components/schemas/PresenceExtensionInfo'
      type: object
    BillingStatementResource:
      properties:
        fees:
          items:
            $ref: '#/components/schemas/FeeChargeResource'
          type: array
        charges:
          items:
            $ref: '#/components/schemas/FeeChargeResource'
          type: array
        totalCharges:
          type: number
        totalFees:
          type: number
        subtotal:
          type: number
        currency:
          type: string
      type: object
    APNSInfo:
      properties:
        aps:
          $ref: '#/components/schemas/APSInfo'
      type: object
    BulkAssignItem:
      example:
        removedExtensionIds:
        - removedExtensionIds
        - removedExtensionIds
        departmentId: departmentId
        addedExtensionIds:
        - addedExtensionIds
        - addedExtensionIds
      properties:
        departmentId:
          type: string
        addedExtensionIds:
          items:
            type: string
          type: array
        removedExtensionIds:
          items:
            type: string
          type: array
      type: object
    StateResource:
      properties:
        uri:
          format: uri
          type: string
        id:
          type: string
        name:
          type: string
        isoCode:
          type: string
        country:
          $ref: '#/components/schemas/VersionedResource'
      type: object
    BulkSupported:
      example:
        maxPayloadSize: 6
        maxOperations: 0
        supported: false
      properties:
        maxOperations:
          format: int32
          type: integer
        maxPayloadSize:
          format: int32
          type: integer
        supported:
          default: false
          type: boolean
      type: object
    FormattingLocaleInfo:
      description: Official name of a formatting language
      example:
        localeCode: localeCode
        name: name
        id: id
      properties:
        id:
          description: Internal identifier of a formatting language
          type: string
        localeCode:
          description: Localization code of a formatting language
          type: string
        name:
          type: string
      type: object
    MeetingResponseResource:
      example:
        uri: http://example.com/aeiou
        uuid: uuid
        meetingType: meetingType
        startHostVideo: false
        startParticipantsVideo: false
        audioOptions:
        - audioOptions
        - audioOptions
        schedule:
          durationInMinutes: 0
          timeZone:
            name: name
            description: description
            id: id
            uri: http://example.com/aeiou
          startTime: startTime
        password: password
        topic: topic
        links:
          startUri: startUri
          joinUri: joinUri
        id: id
        allowJoinBeforeHost: false
        status: status
      properties:
        uri:
          format: uri
          type: string
        uuid:
          type: string
        id:
          type: string
        topic:
          type: string
        meetingType:
          type: string
        password:
          type: string
        status:
          type: string
        links:
          $ref: '#/components/schemas/MeetingLinks'
        schedule:
          $ref: '#/components/schemas/MeetingScheduleResource'
        allowJoinBeforeHost:
          default: false
          type: boolean
        startHostVideo:
          default: false
          type: boolean
        startParticipantsVideo:
          default: false
          type: boolean
        audioOptions:
          items:
            type: string
          type: array
      type: object
    FeeChargeResource:
      properties:
        description:
          type: string
        amount:
          type: number
        feature:
          type: string
      type: object
    CallerIdByFeatureInfo:
      example:
        phoneInfo:
          phoneNumber: phoneNumber
          id: id
          uri: uri
        type: type
      properties:
        type:
          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']
          type: string
        phoneInfo:
          $ref: '#/components/schemas/CallerIdPhoneInfo'
      type: object
    ValidateExtensionUserCredentials:
      example:
        ivrPin: ivrPin
        secretQuestion:
          answer: answer
          id: id
        password: password
      properties:
        password:
          description: User password of an extension
          type: string
        ivrPin:
          description: User pin of an extension
          type: string
        secretQuestion:
          $ref: '#/components/schemas/SecretQuestionInfoValidationRequest'
      type: object
    AddressInfoRequest:
      properties:
        streetAddress:
          description: User street address
          type: string
        locality:
          description: User city
          type: string
        region:
          description: User state/region
          type: string
        postalCode:
          description: User postal code
          type: string
        country:
          description: User country
          type: string
        type:
          description: Address type
          type: string
      type: object
    PhotoInfo:
      example:
        type: photo
        value: value
      properties:
        value:
          type: string
        type:
          enum:
          - photo
          type: string
      type: object
    InboundFaxesInfo:
      example:
        notifyBySms: true
        includeAttachment: true
        notifyByEmail: true
        advancedEmailAddresses:
        - advancedEmailAddresses
        - advancedEmailAddresses
        advancedSmsEmailAddresses:
        - advancedSmsEmailAddresses
        - advancedSmsEmailAddresses
        markAsRead: true
      properties:
        notifyByEmail:
          description: Email notification flag
          type: boolean
        notifyBySms:
          description: SMS notification flag
          type: boolean
        advancedEmailAddresses:
          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
          type: array
        advancedSmsEmailAddresses:
          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
          type: array
        includeAttachment:
          description: Indicates whether fax should be attached to email
          type: boolean
        markAsRead:
          description: Indicates whether email should be automatically marked as read
          type: boolean
      type: object
    ConversationResource:
      properties:
        id:
          readOnly: true
          type: string
        typingNotifications:
          $ref: '#/components/schemas/DeliveryModeResource'
        uri:
          format: uri
          type: string
      type: object
    Address:
      properties:
        country:
          type: string
        state:
          type: string
        city:
          type: string
        street:
          type: string
        zip:
          type: string
      type: object
    ExtensionReferenceResource:
      example:
        id: id
        partnerId: partnerId
      properties:
        id:
          type: string
        partnerId:
          type: string
      type: object
    InboundTextsInfo:
      example:
        notifyBySms: true
        notifyByEmail: true
        advancedEmailAddresses:
        - advancedEmailAddresses
        - advancedEmailAddresses
        advancedSmsEmailAddresses:
        - advancedSmsEmailAddresses
        - advancedSmsEmailAddresses
      properties:
        notifyByEmail:
          description: Email notification flag
          type: boolean
        notifyBySms:
          description: SMS notification flag
          type: boolean
        advancedEmailAddresses:
          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
          type: array
        advancedSmsEmailAddresses:
          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
          type: array
      type: object
    LicenseExtensionInfo:
      example:
        extensionNumber: extensionNumber
        name: name
        id: id
        uri: uri
      properties:
        id:
          description: Internal identifier of an extension
          type: string
        uri:
          description: Canonical URI of an extension
          type: string
        extensionNumber:
          description: Number of an extension
          type: string
        name:
          description: User name of an extension
          type: string
      type: object
    CreateSubscriptionRequest:
      example:
        expiresIn: 0
        eventFilters:
        - eventFilters
        - eventFilters
        deliveryMode:
          address: address
          encryption: true
          registrationId: registrationId
          certificateName: certificateName
          transportType: PubNub
      properties:
        eventFilters:
          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
          type: array
        deliveryMode:
          $ref: '#/components/schemas/NotificationDeliveryModeRequest'
        expiresIn:
          description: Subscription lifetime in seconds. Max value is 7 days (604800 sec)
          type: integer
      required:
      - deliveryMode
      type: object
    ConferencingNumberResource:
      properties:
        uri:
          format: uri
          type: string
        phoneNumber:
          type: string
        country:
          $ref: '#/components/schemas/CountryResource'
        location:
          type: string
        hasGreeting:
          default: false
          type: boolean
        default:
          default: false
          type: boolean
      type: object
    CallLogRecordDeviceInfo:
      example:
        id: id
        uri: uri
      properties:
        id:
          description: Internal identifier of a device
          type: string
        uri:
          description: string to a device
          type: string
      type: object
    DetailedCallInfo:
      example:
        callId: callId
        fromTag: fromTag
        remoteUri: remoteUri
        toTag: toTag
        localUri: localUri
        rcSessionId: rcSessionId
      properties:
        callId:
          type: string
        toTag:
          type: string
        fromTag:
          type: string
        remoteUri:
          type: string
        localUri:
          type: string
        rcSessionId:
          type: string
      type: object
    GlipMessageAttachmentFieldsInfo:
      example:
        style: Short
        title: title
        value: value
      properties:
        title:
          description: Title for an individual field
          type: string
        value:
          description: Field Value (Supports Markdown)
          type: string
        style:
          description: A style used to flag fields that should span the width of the message, Defaults to 'Short' (Not full width)
          enum:
          - Short
          - Long
          type: string
      type: object
    ReservationDate:
      properties:
        date:
          format: date-time
          type: string
        max:
          default: false
          type: boolean
        min:
          default: false
          type: boolean
      type: object
    FederationMainNumberInfo:
      example:
        formattedPhoneNumber: formattedPhoneNumber
        phoneNumber: phoneNumber
      properties:
        phoneNumber:
          description: Main company number of an account in E.164 format
          type: string
        formattedPhoneNumber:
          description: Main company number of an account formatted as consistent with the home country of the current extension
          type: string
      type: object
    CreateForwardingNumberRequest:
      example:
        phoneNumber: phoneNumber
        label: label
      properties:
        phoneNumber:
          description: Forwarding/Call flip phone number
          type: string
        label:
          description: Forwarding/Call flip number title
          type: string
      type: object
    FilterSupported:
      example:
        maxResults: 1
        supported: false
      properties:
        maxResults:
          format: int32
          type: integer
        supported:
          default: false
          type: boolean
      type: object
    GroupContactsCollection:
      properties:
        uri:
          format: uri
          type: string
        records:
          items:
            $ref: '#/components/schemas/PersonalContactResource'
          type: array
        paging:
          $ref: '#/components/schemas/Paging'
        navigation:
          $ref: '#/components/schemas/Navigation'
      type: object
    ContactInfo:
      example:
        firstName: firstName
        lastName: lastName
        company: company
        businessPhone: businessPhone
        businessAddress:
          zip: zip
          country: country
          city: city
          street: street
          state: state
        email: email
      properties:
        firstName:
          description: For User extension type only. Extension user first name
          type: string
        lastName:
          description: For User extension type only. Extension user last name
          type: string
        company:
          description: Extension user company name
          type: string
        email:
          description: Email of extension user
          type: string
        businessPhone:
          description: Extension user contact phone number
          type: string
        businessAddress:
          $ref: '#/components/schemas/ContactAddressInfo'
      type: object
    ShippingAddressInfo:
      example:
        zip: zip
        country: country
        city: city
        street: street
        street2: street2
        state: state
        customerName: customerName
      properties:
        customerName:
          description: Name of a receiver
          type: string
        street:
          description: Street address, line 1 - street address, P.O. box, company name, c/o
          type: string
        street2:
          description: Street address, line 2 - apartment, suite, unit, building, floor, etc.
          type: string
        city:
          description: City name
          type: string
        state:
          description: State/province name
          type: string
        zip:
          description: Zip code
          type: string
        country:
          description: Country name
          type: string
      type: object
    RegionalSettings:
      example:
        timezone:
          name: name
          description: description
          id: id
          uri: uri
        timeFormat: 12h
        greetingLanguage:
          localeCode: localeCode
          name: name
          id: id
        formattingLocale:
          localeCode: localeCode
          name: name
          id: id
        language:
          localeCode: localeCode
          ui: true
          greeting: true
          name: name
          formattingLocale: true
          id: id
          uri: uri
        homeCountry:
          name: name
          id: id
          uri: uri
      properties:
        homeCountry:
          $ref: '#/components/schemas/CountryInfo'
        timezone:
          $ref: '#/components/schemas/TimezoneInfo'
        language:
          $ref: '#/components/schemas/LanguageInfo'
        greetingLanguage:
          $ref: '#/components/schemas/GreetingLanguageInfo'
        formattingLocale:
          $ref: '#/components/schemas/FormattingLocaleInfo'
        timeFormat:
          description: Time format setting. The default value is '12h' = ['12h', '24h']
          enum:
          - 12h
          - 24h
          type: string
      type: object
    GetExtensionCallLogRecordResponse:
      properties:
        id:
          description: Internal identifier of a cal log record
          type: string
        uri:
          description: Canonical URI of a call log record
          type: string
        sessionId:
          description: Internal identifier of a call session
          type: string
        from:
          $ref: '#/components/schemas/CallLogCallerInfo'
        to:
          $ref: '#/components/schemas/CallLogCallerInfo'
        type:
          description: Call type
          enum:
          - Voice
          - Fax
          type: string
        direction:
          description: Call direction
          enum:
          - Inbound
          - Outbound
          type: string
        action:
          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
          type: string
        result:
          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
          type: string
        startTime:
          description: The call start datetime in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z
          format: date-time
          type: string
        duration:
          description: Call duration in seconds
          type: integer
        recording:
          $ref: '#/components/schemas/RecordingInfo'
      type: object
    GetRingOutStatusResponse:
      example:
        id: id
        uri: uri
        status:
          calleeStatus: Invalid
          callStatus: Invalid
          callerStatus: Invalid
      properties:
        id:
          description: Internal identifier of a RingOut call
          type: string
        uri:
          type: string
        status:
          $ref: '#/components/schemas/RingOutStatusInfo'
      type: object
    Messages:
      properties:
        uri:
          format: uri
          type: string
        records:
          items:
            $ref: '#/components/schemas/MessageInfoResource'
          type: array
        paging:
          $ref: '#/components/schemas/Paging'
        navigation:
          $ref: '#/components/schemas/Navigation'
      type: object
    ShippingResource:
      example:
        carrier: carrier
        address:
          zip: zip
          country: country
          city: city
          street: street
          street2: street2
          state: state
          customerName: customerName
        method:
          name: name
          id: id
        trackingNumber: trackingNumber
        status: status
      properties:
        address:
          $ref: '#/components/schemas/EmergencyServiceAddressResource'
        method:
          $ref: '#/components/schemas/MethodResource'
        status:
          type: string
        carrier:
          type: string
        trackingNumber:
          type: string
      type: object
    SIPInfoResponse:
      example:
        password: password
        authorizationId: authorizationId
        domain: domain
        certificate: certificate
        transport: UDP
        outboundProxy: outboundProxy
        username: username
      properties:
        username:
          description: User credentials
          type: string
        password:
          description: User password
          type: string
        authorizationId:
          description: Identifier for SIP authorization
          type: string
        domain:
          description: SIP domain
          type: string
        outboundProxy:
          description: SIP outbound proxy
          type: string
        transport:
          description: Preferred transport. SIP info will be returned for this transport if supported
          enum:
          - UDP
          - TCP
          - TLS
          - WS
          - WSS
          type: string
        certificate:
          description: For TLS transport only Base64 encoded certificate
          type: string
      type: object
    PermissionResource:
      example:
        includedPermissions:
        - id: id
          uri: http://example.com/aeiou
        - id: id
          uri: http://example.com/aeiou
        displayName: displayName
        description: description
        readOnly: false
        id: id
        category:
          id: id
          uri: http://example.com/aeiou
        uri: http://example.com/aeiou
        assignable: false
      properties:
        uri:
          format: uri
          type: string
        id:
          type: string
        displayName:
          type: string
        description:
          type: string
        assignable:
          default: false
          type: boolean
        readOnly:
          default: false
          type: boolean
        category:
          $ref: '#/components/schemas/PermissionCategoryIdResource'
        includedPermissions:
          items:
            $ref: '#/components/schemas/PermissionIdResource'
          type: array
      type: object
    LanguageList:
      example:
        navigation:
          previousPage:
            uri: uri
          firstPage:
            uri: uri
          lastPage:
            uri: uri
          nextPage:
            uri: uri
        records:
        - localeCode: localeCode
          ui: true
          greeting: true
          name: name
          formattingLocale: true
          id: id
          uri: uri
        - localeCode: localeCode
          ui: true
          greeting: true
          name: name
          formattingLocale: true
          id: id
          uri: uri
        paging:
          perPage: 5
          pageStart: 5
          pageEnd: 2
          totalPages: 7
          page: 1
          totalElements: 9
        uri: uri
      properties:
        uri:
          description: Canonical URI of the language list resource
          type: string
        records:
          description: Language data
          items:
            $ref: '#/components/schemas/LanguageInfo'
          type: array
        navigation:
          $ref: '#/components/schemas/NavigationInfo'
        paging:
          $ref: '#/components/schemas/PagingInfo'
      type: object
    ExtensionNotificationInfo:
      properties:
        id:
          description: Internal identifier of the extension
          type: string
      type: object
    GlipCompany:
      example:
        lastModifiedTime: lastModifiedTime
        creationTime: creationTime
        domain: domain
        name: name
        id: id
      properties:
        id:
          description: Internal identifier of an RC account/Glip company, or tilde (~) to indicate a company the current user belongs to
          type: string
        name:
          description: Name of a company
          type: string
        domain:
          description: Domain name of a company
          type: string
        creationTime:
          description: Datetime of creation in ISO 8601 format
          type: string
        lastModifiedTime:
          description: Datetime of last modification in ISO 8601 format
          type: string
      required:
      - creationTime
      - id
      - lastModifiedTime
      type: object
    SyncInfoCallLog:
      example:
        syncTime: 2000-01-23T04:56:07.000+00:00
        syncToken: syncToken
        syncType: FSync
      properties:
        syncType:
          description: Type of synchronization
          enum:
          - FSync
          - ISync
          type: string
        syncToken:
          description: Synchronization token
          type: string
        syncTime:
          description: The last synchronization datetime in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z
          format: date-time
          type: string
      type: object
    CallerIdDeviceInfo:
      example:
        phoneNumber: phoneNumber
        id: id
        uri: uri
      properties:
        id:
          description: Internal identifier of a device
          type: string
        uri:
          description: Link to a device resource
          type: string
        phoneNumber:
          description: Name of a device
          type: string
      type: object
    IVRMenuInfo:
      example:
        extensionNumber: extensionNumber
        name: name
        id: id
        uri: uri
        prompt:
          mode: Audio
          language:
            id: id
            uri: uri
          audio:
            localeCode: localeCode
            name: name
            id: id
            uri: uri
          text: text
        actions:
        - input: input
          extension:
            id: id
            uri: uri
          phoneNumber: phoneNumber
          action: Connect
        - input: input
          extension:
            id: id
            uri: uri
          phoneNumber: phoneNumber
          action: Connect
      properties:
        id:
          description: Internal identifier of an IVR Menu extension
          type: string
        uri:
          description: Link to an IVR Menu extension resource
          type: string
        name:
          description: First name of an IVR Menu user
          type: string
        extensionNumber:
          description: Number of an IVR Menu extension
          type: string
        prompt:
          $ref: '#/components/schemas/IVRMenuPromptInfo'
        actions:
          description: Keys handling settings
          items:
            $ref: '#/components/schemas/IVRMenuActionsInfo'
          type: array
      type: object
    DepartmentBulkAssignResource:
      example:
        items:
        - removedExtensionIds:
          - removedExtensionIds
          - removedExtensionIds
          departmentId: departmentId
          addedExtensionIds:
          - addedExtensionIds
          - addedExtensionIds
        - removedExtensionIds:
          - removedExtensionIds
          - removedExtensionIds
          departmentId: departmentId
          addedExtensionIds:
          - addedExtensionIds
          - addedExtensionIds
      properties:
        items:
          items:
            $ref: '#/components/schemas/BulkAssignItem'
          type: array
      type: object
    SignupInfoResource:
      example:
        tosAccepted: false
        signupState:
        - AccountCreated
        - AccountCreated
        verificationReason: CC_Failed
      properties:
        tosAccepted:
          default: false
          type: boolean
        signupState:
          items:
            enum:
            - AccountCreated
            - BillingEntered
            - CreditCardApproved
            - AccountConfirmed
            - PhoneVerificationRequired
            - PhoneVerificationPassed
            type: string
          type: array
        verificationReason:
          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
          type: string
      type: object
    CallersInfoRequest:
      example:
        name: name
        callerId: callerId
      properties:
        callerId:
          description: Phone number of a caller
          type: string
        name:
          description: Contact name of a caller
          type: string
      type: object
    FormDataContentDisposition:
      properties:
        type:
          type: string
        fileName:
          type: string
        creationDate:
          format: date-time
          type: string
        modificationDate:
          format: date-time
          type: string
        readDate:
          format: date-time
          type: string
        size:
          format: int64
          type: integer
        name:
          type: string
      type: object
    LicenseInfo:
      example:
        extension:
          extensionNumber: extensionNumber
          name: name
          id: id
          uri: uri
        creationTime: creationTime
        id: id
        type:
          name: name
          limit: 0
          id: id
        uri: uri
      properties:
        uri:
          description: Canonical URI of a license
          type: string
        id:
          description: Internal identifier of a license
          type: string
        type:
          $ref: '#/components/schemas/LicenseFeatureInfo'
        creationTime:
          description: Datetime when license was purchased in ISO 8601 format including timezone, for example 2017-03-10T18:07:52.534Z
          type: string
        extension:
          $ref: '#/components/schemas/LicenseExtensionInfo'
      type: object
    WeeklyScheduleInfo:
      example:
        sunday:
        - from: 2000-01-23T04:56:07.000+00:00
          to: 2000-01-23T04:56:07.000+00:00
        - from: 2000-01-23T04:56:07.000+00:00
          to: 2000-01-23T04:56:07.000+00:00
        saturday:
        - from: 2000-01-23T04:56:07.000+00:00
          to: 2000-01-23T04:56:07.000+00:00
        - from: 2000-01-23T04:56:07.000+00:00
          to: 2000-01-23T04:56:07.000+00:00
        tuesday:
        - from: 2000-01-23T04:56:07.000+00:00
          to: 2000-01-23T04:56:07.000+00:00
        - from: 2000-01-23T04:56:07.000+00:00
          to: 2000-01-23T04:56:07.000+00:00
        wednesday:
        - from: 2000-01-23T04:56:07.000+00:00
          to: 2000-01-23T04:56:07.000+00:00
        - from: 2000-01-23T04:56:07.000+00:00
          to: 2000-01-23T04:56:07.000+00:00
        thursday:
        - from: 2000-01-23T04:56:07.000+00:00
          to: 2000-01-23T04:56:07.000+00:00
        - from: 2000-01-23T04:56:07.000+00:00
          to: 2000-01-23T04:56:07.000+00:00
        friday:
        - from: 2000-01-23T04:56:07.000+00:00
          to: 2000-01-23T04:56:07.000+00:00
        - from: 2000-01-23T04:56:07.000+00:00
          to: 2000-01-23T04:56:07.000+00:00
        monday:
        - from: 2000-01-23T04:56:07.000+00:00
          to: 2000-01-23T04:56:07.000+00:00
        - from: 2000-01-23T04:56:07.000+00:00
          to: 2000-01-23T04:56:07.000+00:00
      properties:
        monday:
          description: Time intervals for a particular day
          items:
            $ref: '#/components/schemas/TimeInterval'
          type: array
        tuesday:
          description: Time intervals for a particular day
          items:
            $ref: '#/components/schemas/TimeInterval'
          type: array
        wednesday:
          description: Time intervals for a particular day
          items:
            $ref: '#/components/schemas/TimeInterval'
          type: array
        thursday:
          description: Time intervals for a particular day
          items:
            $ref: '#/components/schemas/TimeInterval'
          type: array
        friday:
          description: Time intervals for a particular day
          items:
            $ref: '#/components/schemas/TimeInterval'
          type: array
        saturday:
          description: Time intervals for a particular day
          items:
            $ref: '#/components/schemas/TimeInterval'
          type: array
        sunday:
          description: Time intervals for a particular day
          items:
            $ref: '#/components/schemas/TimeInterval'
          type: array
      type: object
    CustomDataResource:
      example:
        lastModifiedTime: 2000-01-23T04:56:07.000+00:00
        attachment:
          uri: http://example.com/aeiou
          contentType: contentType
        id: id
        uri: http://example.com/aeiou
        value: value
      properties:
        uri:
          format: uri
          type: string
        id:
          type: string
        value:
          type: string
        lastModifiedTime:
          format: date-time
          type: string
        attachment:
          $ref: '#/components/schemas/AttachmentInfo'
      type: object
    UserBusinessHoursUpdate:
      example:
        schedule:
          weeklyRanges:
            sunday:
            - from: 2000-01-23T04:56:07.000+00:00
              to: 2000-01-23T04:56:07.000+00:00
            - from: 2000-01-23T04:56:07.000+00:00
              to: 2000-01-23T04:56:07.000+00:00
            saturday:
            - from: 2000-01-23T04:56:07.000+00:00
              to: 2000-01-23T04:56:07.000+00:00
            - from: 2000-01-23T04:56:07.000+00:00
              to: 2000-01-23T04:56:07.000+00:00
            tuesday:
            - from: 2000-01-23T04:56:07.000+00:00
              to: 2000-01-23T04:56:07.000+00:00
            - from: 2000-01-23T04:56:07.000+00:00
              to: 2000-01-23T04:56:07.000+00:00
            wednesday:
            - from: 2000-01-23T04:56:07.000+00:00
              to: 2000-01-23T04:56:07.000+00:00
            - from: 2000-01-23T04:56:07.000+00:00
              to: 2000-01-23T04:56:07.000+00:00
            thursday:
            - from: 2000-01-23T04:56:07.000+00:00
              to: 2000-01-23T04:56:07.000+00:00
            - from: 2000-01-23T04:56:07.000+00:00
              to: 2000-01-23T04:56:07.000+00:00
            friday:
            - from: 2000-01-23T04:56:07.000+00:00
              to: 2000-01-23T04:56:07.000+00:00
            - from: 2000-01-23T04:56:07.000+00:00
              to: 2000-01-23T04:56:07.000+00:00
            monday:
            - from: 2000-01-23T04:56:07.000+00:00
              to: 2000-01-23T04:56:07.000+00:00
            - from: 2000-01-23T04:56:07.000+00:00
              to: 2000-01-23T04:56:07.000+00:00
        uri: uri
      properties:
        uri:
          description: Canonical URI of a business-hours resource
          type: string
        schedule:
          $ref: '#/components/schemas/UserBusinessHoursScheduleInfo'
      type: object
    MessageEvent:
      properties:
        extensionId:
          description: Internal identifier of an extension
          type: string
        lastUpdated:
          description: Datetime when the message was last modified in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z
          format: date-time
          type: string
        changes:
          description: Message Changes
          items:
            $ref: '#/components/schemas/MessageChanges'
          type: array
      type: object
    LicenseInfoRequest:
      example:
        quantity: 0
        type:
          sku: RMS
      properties:
        type:
          $ref: '#/components/schemas/LicenseTypeInfoRequest'
        quantity:
          description: Quantity of licenses to be purchased
          type: integer
      type: object
    BulkProvisionUnassignedExtensionsRequestResource:
      properties:
        items:
          items:
            $ref: '#/components/schemas/BulkProvisionExtensionResource'
          type: array
      type: object
    StackTraceElement:
      properties:
        methodName:
          type: string
        fileName:
          type: string
        lineNumber:
          format: int32
          type: integer
        className:
          type: string
        nativeMethod:
          default: false
          type: boolean
      type: object
    UserGroupIdResource:
      properties:
        uri:
          format: uri
          type: string
        id:
          type: string
      type: object
    EmailInfoRequest:
      properties:
        value:
          description: Email address
          type: string
        type:
          description: Email address type
          type: string
      type: object
    GlipUnreadMessageCountEvent:
      properties:
        uuid:
          description: Universally unique identifier of a notification
          type: string
        pn_apns:
          $ref: '#/components/schemas/GlipAPNSInfo'
        pn_gcm:
          $ref: '#/components/schemas/GCMInfo'
      type: object
    CallLogRecordResource:
      properties:
        uri:
          format: uri
          type: string
        id:
          type: string
        sessionId:
          type: string
        startTime:
          format: date-time
          type: string
        duration:
          format: int64
          type: integer
        type:
          enum:
          - Voice
          - Fax
          type: string
        direction:
          enum:
          - Inbound
          - Outbound
          type: string
        action:
          type: string
        result:
          type: string
        to:
          $ref: '#/components/schemas/CallerInfo'
        from:
          $ref: '#/components/schemas/CallerInfo'
        recording:
          $ref: '#/components/schemas/CallLogRecordingResource'
      type: object
    CallQueueInfo:
      example:
        slaThresholdSeconds: 1
        abandonedThresholdSeconds: 5
        slaGoal: 6
        includeAbandonedCalls: true
      properties:
        slaGoal:
          description: Target percentage of calls that must be answered by agents within the service level time threshold
          type: integer
        slaThresholdSeconds:
          description: Period of time in seconds that is considered to be an acceptable service level
          type: integer
        includeAbandonedCalls:
          description: If 'True' abandoned calls (hanged up prior to being served) are included into service level calculation
          type: boolean
        abandonedThresholdSeconds:
          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
          type: integer
      type: object
    LanguageInfo:
      example:
        localeCode: localeCode
        ui: true
        greeting: true
        name: name
        formattingLocale: true
        id: id
        uri: uri
      properties:
        id:
          description: Internal identifier of a language
          type: string
        uri:
          description: Canonical URI of a language
          type: string
        greeting:
          description: Indicates whether a language is available as greeting language
          type: boolean
        formattingLocale:
          description: Indicates whether a language is available as formatting locale
          type: boolean
        localeCode:
          description: Localization code of a language
          type: string
        name:
          description: Official name of a language
          type: string
        ui:
          description: Indicates whether a language is available as UI language
          type: boolean
      type: object
    GetConferencingInfoResponse:
      example:
        mode: mode
        phoneNumber: phoneNumber
        tapToJoinUri: tapToJoinUri
        hostCode: hostCode
        uri: uri
        participantCode: participantCode
        allowJoinBeforeHost: true
        phoneNumbers:
        - hasGreeting: true
          country:
            callingCode: callingCode
            emergencyCalling: true
            isoCode: isoCode
            name: name
            id: id
            uri: uri
          default: true
          phoneNumber: phoneNumber
          location: location
        - hasGreeting: true
          country:
            callingCode: callingCode
            emergencyCalling: true
            isoCode: isoCode
            name: name
            id: id
            uri: uri
          default: true
          phoneNumber: phoneNumber
          location: location
      properties:
        uri:
          description: Canonical URI of a conferencing
          type: string
        allowJoinBeforeHost:
          description: Determines if host user allows conference participants to join before the host
          type: boolean
        hostCode:
          description: Access code for a host user
          type: string
        mode:
          description: Internal parameter specifying conferencing engine
          type: string
        participantCode:
          description: Access code for any participant
          type: string
        phoneNumber:
          description: Primary conference phone number for user's home country returned in E.164 (11-digits) format
          type: string
        tapToJoinUri:
          description: Short URL leading to the service web page Tap to Join for audio conference bridge
          type: string
        phoneNumbers:
          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: '#/components/schemas/PhoneNumberInfoConferencing'
          type: array
      type: object
    DevicesResource:
      properties:
        uri:
          format: uri
          type: string
        records:
          items:
            $ref: '#/components/schemas/DeviceResource'
          type: array
        paging:
          $ref: '#/components/schemas/Paging'
        navigation:
          $ref: '#/components/schemas/Navigation'
      type: object
    ParsePhoneNumberResponse:
      example:
        special: true
        country:
        - callingCode: callingCode
          emergencyCalling: true
          isoCode: isoCode
          name: name
          id: id
          uri: uri
        - callingCode: callingCode
          emergencyCalling: true
          isoCode: isoCode
          name: name
          id: id
          uri: uri
        areaCode: areaCode
        dialable: dialable
        e164: e164
        formattedInternational: formattedInternational
        normalized: normalized
        originalString: originalString
        formattedNational: formattedNational
        uri: uri
        homeCountry:
        - callingCode: callingCode
          emergencyCalling: true
          isoCode: isoCode
          name: name
          id: id
          uri: uri
        - callingCode: callingCode
          emergencyCalling: true
          isoCode: isoCode
          name: name
          id: id
          uri: uri
        phoneNumbers:
        - special: true
          country:
          - callingCode: callingCode
            emergencyCalling: true
            isoCode: isoCode
            name: name
            id: id
            uri: uri
          - callingCode: callingCode
            emergencyCalling: true
            isoCode: isoCode
            name: name
            id: id
            uri: uri
          areaCode: areaCode
          dialable: dialable
          e164: e164
          formattedInternational: formattedInternational
          normalized: normalized
          originalString: originalString
          formattedNational: formattedNational
        - special: true
          country:
          - callingCode: callingCode
            emergencyCalling: true
            isoCode: isoCode
            name: name
            id: id
            uri: uri
          - callingCode: callingCode
            emergencyCalling: true
            isoCode: isoCode
            name: name
            id: id
            uri: uri
          areaCode: areaCode
          dialable: dialable
          e164: e164
          formattedInternational: formattedInternational
          normalized: normalized
          originalString: originalString
          formattedNational: formattedNational
      properties:
        uri:
          description: Canonical URI of a resource
          type: string
        homeCountry:
          description: Information on a user home country
          items:
            $ref: '#/components/schemas/GetCountryInfoNumberParser'
          type: array
        phoneNumbers:
          description: Parsed phone numbers data
          items:
            $ref: '#/components/schemas/PhoneNumberInfoNumberParser'
          type: array
        originalString:
          description: One of the numbers to be parsed, passed as a string in response
          type: string
        areaCode:
          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
          type: string
        formattedNational:
          description: Domestic format of a phone number
          type: string
        formattedInternational:
          description: International format of a phone number
          type: string
        dialable:
          description: Dialing format of a phone number
          type: string
        e164:
          description: E.164 (11-digits) format of a phone number
          type: string
        special:
          description: ' True  if the number is in a special format (for example N11
            code)'
          type: boolean
        normalized:
          description: E.164 (11-digits) format of a phone number without the plus sign ('+')
          type: string
        country:
          description: Information on a country the phone number belongs to
          items:
            $ref: '#/components/schemas/GetCountryInfoNumberParser'
          type: array
      required:
      - homeCountry
      - phoneNumbers
      type: object
    ExtensionCreationRequest:
      example:
        password: password
        setupWizardState: NotStarted
        statusInfo:
          reason: Voluntarily
          comment: comment
        references:
        - ref: ref
          type: PartnerId
        - ref: ref
          type: PartnerId
        extensionNumber: extensionNumber
        contact:
          firstName: firstName
          lastName: lastName
          emailAsLoginName: true
          pronouncedName:
            text: text
            type: Default
          company: company
          businessPhone: businessPhone
          businessAddress:
            zip: zip
            country: country
            city: city
            street: street
            state: state
          department: department
          email: email
        regionalSettings:
          timezone:
            name: name
            description: description
            id: id
            uri: uri
          timeFormat: 12h
          greetingLanguage:
            localeCode: localeCode
            name: name
            id: id
          formattingLocale:
            localeCode: localeCode
            name: name
            id: id
          language:
            localeCode: localeCode
            ui: true
            greeting: true
            name: name
            formattingLocale: true
            id: id
            uri: uri
          homeCountry:
            name: name
            id: id
            uri: uri
        type: User
        status: Enabled
      properties:
        contact:
          $ref: '#/components/schemas/ContactInfoUpdateRequest'
        extensionNumber:
          description: Number of extension
          type: string
        password:
          description: Password for extension. If not specified, the password is auto-generated
          type: string
        references:
          description: List of non-RC internal identifiers assigned to an extension
          items:
            $ref: '#/components/schemas/ReferenceInfo'
          type: array
        regionalSettings:
          $ref: '#/components/schemas/RegionalSettings'
        setupWizardState:
          description: Specifies extension configuration wizard state (web service setup). The default value is 'NotStarted' = ['NotStarted', 'Incomplete', 'Completed']
          enum:
          - NotStarted
          - Incomplete
          - Completed
          type: string
        status:
          description: Extension current state = ['Enabled', 'Disabled', 'NotActivated', 'Unassigned']
          enum:
          - Enabled
          - Disabled
          - NotActivated
          - Unassigned
          type: string
        statusInfo:
          $ref: '#/components/schemas/ExtensionStatusInfo'
        type:
          description: Extension type = ['User', 'VirtualUser', 'DigitalUser', 'Department']
          enum:
          - User
          - VirtualUser
          - DigitalUser
          - Department
          type: string
      type: object
    RCVideoNotificationsEvent:
      properties:
        id:
          description: Identifier of a meeting
          type: string
        name:
          description: Meeting Name
          type: string
        start:
          description: Datetime of meeting start in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z
          type: string
        duration:
          description: Meeting duration
          type: integer
        participants:
          $ref: '#/components/schemas/RCVParticipantsInfo'
        recorded:
          description: Specifies whether a meeting is recorded or not
          type: boolean
        recording:
          $ref: '#/components/schemas/RCVRecordingInfo'
      type: object
    GlipAPNSInfo:
      properties:
        aps:
          $ref: '#/components/schemas/APSInfo'
        timestamp:
          description: Datetime of a call action in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z
          format: date-time
          type: string
        uuid:
          description: Universally unique identifier of a notification
          type: string
        event:
          description: Event filter URI
          type: string
        subscriptionId:
          description: Internal identifier of a subscription
          type: string
        body:
          $ref: '#/components/schemas/GlipUnreadMessageCountInfo'
      type: object
    MissedCallEvent:
      properties:
        uuid:
          description: Universally unique identifier of a notification
          type: string
        pn_apns:
          $ref: '#/components/schemas/APNSInfo'
        event:
          description: Event filter URI
          type: string
        subscriptionId:
          description: Internal identifier of a subscription
          type: string
        timestamp:
          description: The datetime of a call action in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z
          format: date-time
          type: string
        extensionId:
          default: ~
          description: Internal identifier of an extension
          type: string
        action:
          description: Calling action, for example 'StartRing'
          type: string
        sessionId:
          description: Identifier of a call session
          type: string
        serverId:
          description: Identifier of a server
          type: string
        from:
          description: Phone number of a caller
          type: string
        fromName:
          description: Caller name
          type: string
        to:
          description: Phone number of a callee
          type: string
        toName:
          description: Callee name
          type: string
        sid:
          description: Unique identifier of a session
          type: string
        toUrl:
          description: SIP proxy registration name
          type: string
        srvLvl:
          description: User data
          type: string
        srvLvlExt:
          description: User data
          type: string
        recUrl:
          description: File containing recorded caller name
          type: string
        pn_ttl:
          description: Notification lifetime value in seconds, the default value is 30 seconds
          type: integer
      type: object
    RoleResource:
      example:
        lastUpdated: 2000-01-23T04:56:07.000+00:00
        hidden: false
        displayName: displayName
        permissions:
        - id: id
          uri: http://example.com/aeiou
        - id: id
          uri: http://example.com/aeiou
        custom: false
        scope: scope
        description: description
        id: id
        uri: http://example.com/aeiou
      properties:
        uri:
          format: uri
          type: string
        id:
          type: string
        displayName:
          maxLength: 128
          minLength: 0
          pattern: ^((?!(<|>|\/|\")).)*$
          type: string
        description:
          maxLength: 2000
          minLength: 0
          pattern: ^((?!(<|>|\/|\")).)*$
          type: string
        custom:
          default: false
          type: boolean
        scope:
          type: string
        hidden:
          default: false
          type: boolean
        lastUpdated:
          format: date-time
          type: string
        permissions:
          items:
            $ref: '#/components/schemas/PermissionIdResource'
          type: array
      type: object
    FederationAccountInfo:
      example:
        companyName: companyName
        federatedName: federatedName
        linkCreationTime: linkCreationTime
        id: id
        mainNumber:
          formattedPhoneNumber: formattedPhoneNumber
          phoneNumber: phoneNumber
        conflictCount: 0
      properties:
        id:
          description: Internal identifier of an account
          type: string
        companyName:
          description: Company name of an account
          type: string
        federatedName:
          description: Federation name of an account
          type: string
        linkCreationTime:
          description: Datetime when this account was linked to a federation, in ISO 8601 format, for example 2016-03-10T18:07:52.534Z
          type: string
        mainNumber:
          $ref: '#/components/schemas/FederationMainNumberInfo'
        conflictCount:
          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'
          type: integer
      type: object
    UserCallLogRecord:
      example:
        duration: 0
        recording:
          contentUri: contentUri
          id: id
          type: Automatic
          uri: uri
        from:
          phoneNumber: phoneNumber
          extensionNumber: extensionNumber
          name: name
          location: location
          device:
            id: id
            uri: uri
        startTime: startTime
        id: id
        sessionId: sessionId
        to:
          phoneNumber: phoneNumber
          extensionNumber: extensionNumber
          name: name
          location: location
          device:
            id: id
            uri: uri
        type: Voice
        uri: uri
        direction: Inbound
      properties:
        id:
          description: Internal identifier of a cal log record
          type: string
        uri:
          description: Canonical URI of a call log record
          type: string
        sessionId:
          description: Internal identifier of a call session
          type: string
        from:
          $ref: '#/components/schemas/CallLogCallerInfo'
        to:
          $ref: '#/components/schemas/CallLogCallerInfo'
        type:
          description: Call type = ['Voice', 'Fax']
          enum:
          - Voice
          - Fax
          type: string
        direction:
          description: Call direction = ['Inbound', 'Outbound']
          enum:
          - Inbound
          - Outbound
          type: string
        startTime:
          description: The call start datetime in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z
          type: string
        duration:
          description: Call duration in seconds
          type: integer
        recording:
          $ref: '#/components/schemas/RecordingInfo'
      type: object
    AccountDeviceUpdate:
      example:
        emergencyServiceAddress:
          zip: zip
          country: country
          city: city
          street: street
          street2: street2
          state: state
          customerName: customerName
      properties:
        emergencyServiceAddress:
          $ref: '#/components/schemas/EmergencyAddressInfoRequest'
      type: object
    GlipPersonInfo:
      example:
        firstName: firstName
        lastName: lastName
        companyId: companyId
        lastModifiedTime: 2000-01-23T04:56:07.000+00:00
        creationTime: 2000-01-23T04:56:07.000+00:00
        jobTitle: jobTitle
        location: location
        id: id
        avatar: avatar
        email: email
      properties:
        id:
          description: Internal identifier of a user
          type: string
        firstName:
          description: First name of a user
          type: string
        lastName:
          description: Last name of a user
          type: string
        email:
          description: Email of a user
          type: string
        jobTitle:
          description: Job title of a user
          type: string
        location:
          description: Location of a user
          type: string
        avatar:
          description: Photo of a user
          type: string
        companyId:
          description: Internal identifier of a company
          type: string
        creationTime:
          description: Time of creation in ISO 8601 format
          format: date-time
          type: string
        lastModifiedTime:
          description: Time of last modification in ISO 8601 format
          format: date-time
          type: string
      required:
      - id
      type: object
    ExtensionListEvent:
      properties:
        extensionId:
          description: Internal identifier of an extension
          type: string
        eventType:
          description: Type of extension info change
          enum:
          - Create
          - Update
          - Delete
          type: string
      type: object
    ExtensionGreetingLanguageInfoRequest:
      example:
        id: id
      properties:
        id:
          description: internal Identifier of a greeting language
          type: string
      type: object
    PronouncedNameInfo:
      example:
        text: text
        type: Default
      properties:
        type:
          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
          type: string
        text:
          description: Custom text
          type: string
      type: object
    CompanyAnsweringRuleScheduleInfo:
      example:
        ref: BusinessHours
        ranges:
          from: 2000-01-23T04:56:07.000+00:00
          to: 2000-01-23T04:56:07.000+00:00
        weeklyRanges:
          sunday:
          - from: from
            to: to
          - from: from
            to: to
          saturday:
          - from: from
            to: to
          - from: from
            to: to
          tuesday:
          - from: from
            to: to
          - from: from
            to: to
          wednesday:
          - from: from
            to: to
          - from: from
            to: to
          thursday:
          - from: from
            to: to
          - from: from
            to: to
          friday:
          - from: from
            to: to
          - from: from
            to: to
          monday:
          - from: from
            to: to
          - from: from
            to: to
      properties:
        weeklyRanges:
          $ref: '#/components/schemas/CompanyAnsweringRuleWeeklyScheduleInfoRequest'
        ranges:
          $ref: '#/components/schemas/RangesInfo'
        ref:
          description: Reference to Business Hours or After Hours schedule = ['BusinessHours', 'AfterHours']
          enum:
          - BusinessHours
          - AfterHours
          type: string
      type: object
    SipInfoResource:
      properties:
        uri:
          format: uri
          type: string
        domain:
          type: string
        outboundProxy:
          type: string
        userName:
          type: string
        password:
          type: string
        authorizationId:
          type: string
      type: object
    ReportingSettings:
      example:
        views:
        - pages:
          - name: name
            attrX: attrX
          - name: name
            attrX: attrX
          schedules:
          - recurrence:
            - pattern: Daily
              value: "0"
            - pattern: Daily
              value: "0"
            attachments:
            - pdf: true
              csv: true
            - pdf: true
              csv: true
            pages:
            - pages
            - pages
            recipients:
            - recipients
            - recipients
            viewType: Detailed
            scheduleId: scheduleId
          - recurrence:
            - pattern: Daily
              value: "0"
            - pattern: Daily
              value: "0"
            attachments:
            - pdf: true
              csv: true
            - pdf: true
              csv: true
            pages:
            - pages
            - pages
            recipients:
            - recipients
            - recipients
            viewType: Detailed
            scheduleId: scheduleId
          name: name
        - pages:
          - name: name
            attrX: attrX
          - name: name
            attrX: attrX
          schedules:
          - recurrence:
            - pattern: Daily
              value: "0"
            - pattern: Daily
              value: "0"
            attachments:
            - pdf: true
              csv: true
            - pdf: true
              csv: true
            pages:
            - pages
            - pages
            recipients:
            - recipients
            - recipients
            viewType: Detailed
            scheduleId: scheduleId
          - recurrence:
            - pattern: Daily
              value: "0"
            - pattern: Daily
              value: "0"
            attachments:
            - pdf: true
              csv: true
            - pdf: true
              csv: true
            pages:
            - pages
            - pages
            recipients:
            - recipients
            - recipients
            viewType: Detailed
            scheduleId: scheduleId
          name: name
      properties:
        views:
          description: List of 'View' structures with a tuple of filter values, pages and schedules
          items:
            $ref: '#/components/schemas/ReportingViewInfo'
          type: array
      required:
      - views
      type: object
    ContactList:
      example:
        navigation:
          previousPage:
            uri: uri
          firstPage:
            uri: uri
          lastPage:
            uri: uri
          nextPage:
            uri: uri
        records:
        - birthday: 2000-01-23T04:56:07.000+00:00
          lastName: lastName
          notes: notes
          jobTitle: jobTitle
          callbackPhone: callbackPhone
          availability: Alive
          carPhone: carPhone
          email3: email3
          email2: email2
          businessPhone2: businessPhone2
          companyPhone: companyPhone
          otherAddress:
            zip: zip
            country: country
            city: city
            street: street
            state: state
          company: company
          id: id
          otherFax: otherFax
          businessAddress:
            zip: zip
            country: country
            city: city
            street: street
            state: state
          email: email
          homeAddress:
            zip: zip
            country: country
            city: city
            street: street
            state: state
          nickName: nickName
          homePhone: homePhone
          webPage: webPage
          homePhone2: homePhone2
          uri: http://example.com/aeiou
          firstName: firstName
          mobilePhone: mobilePhone
          otherPhone: otherPhone
          assistantPhone: assistantPhone
          middleName: middleName
          businessFax: businessFax
          businessPhone: businessPhone
        - birthday: 2000-01-23T04:56:07.000+00:00
          lastName: lastName
          notes: notes
          jobTitle: jobTitle
          callbackPhone: callbackPhone
          availability: Alive
          carPhone: carPhone
          email3: email3
          email2: email2
          businessPhone2: businessPhone2
          companyPhone: companyPhone
          otherAddress:
            zip: zip
            country: country
            city: city
            street: street
            state: state
          company: company
          id: id
          otherFax: otherFax
          businessAddress:
            zip: zip
            country: country
            city: city
            street: street
            state: state
          email: email
          homeAddress:
            zip: zip
            country: country
            city: city
            street: street
            state: state
          nickName: nickName
          homePhone: homePhone
          webPage: webPage
          homePhone2: homePhone2
          uri: http://example.com/aeiou
          firstName: firstName
          mobilePhone: mobilePhone
          otherPhone: otherPhone
          assistantPhone: assistantPhone
          middleName: middleName
          businessFax: businessFax
          businessPhone: businessPhone
        paging:
          perPage: 5
          pageStart: 5
          pageEnd: 2
          totalPages: 7
          page: 1
          totalElements: 9
      properties:
        records:
          description: List of personal contacts from the extension address book
          items:
            $ref: '#/components/schemas/PersonalContactResource'
          type: array
        navigation:
          $ref: '#/components/schemas/NavigationInfo'
        paging:
          $ref: '#/components/schemas/PagingInfo'
      type: object
    PaymentInfoResource:
      properties:
        uri:
          format: uri
          type: string
        paymentType:
          enum:
          - Card
          - Invoice
          type: string
        card:
          $ref: '#/components/schemas/PaymentInfoCardResource'
        invoiceSettings:
          $ref: '#/components/schemas/InvoiceSettingsResource'
      type: object
    UserPresencePermissionsUpdateRequest:
      example:
        extensions:
        - id: id
        - id: id
      properties:
        extensions:
          items:
            $ref: '#/components/schemas/PresencePermissionsExtensionInfoRequest'
          type: array
      type: object
    LicenseList:
      example:
        navigation:
          previousPage:
            uri: uri
          firstPage:
            uri: uri
          lastPage:
            uri: uri
          nextPage:
            uri: uri
        records:
        - extension:
            extensionNumber: extensionNumber
            name: name
            id: id
            uri: uri
          creationTime: creationTime
          id: id
          type:
            name: name
            limit: 0
            id: id
          uri: uri
        - extension:
            extensionNumber: extensionNumber
            name: name
            id: id
            uri: uri
          creationTime: creationTime
          id: id
          type:
            name: name
            limit: 0
            id: id
          uri: uri
        paging:
          perPage: 5
          pageStart: 5
          pageEnd: 2
          totalPages: 7
          page: 1
          totalElements: 9
      properties:
        records:
          description: 'List of licenses '
          items:
            $ref: '#/components/schemas/LicenseInfo'
          type: array
        paging:
          $ref: '#/components/schemas/PagingInfo'
        navigation:
          $ref: '#/components/schemas/NavigationInfo'
      type: object
    DepartmentResource:
      example:
        extensionNumber: extensionNumber
        id: id
        uri: http://example.com/aeiou
      properties:
        uri:
          format: uri
          type: string
        id:
          type: string
        extensionNumber:
          type: string
      type: object
    UrnInfoRequest:
      properties:
        department:
          description: Name of department (call queue) member
          type: string
      type: object
    PagingOnlyGroupDevices:
      example:
        navigation:
          previousPage:
            uri: uri
          firstPage:
            uri: uri
          lastPage:
            uri: uri
          nextPage:
            uri: uri
        records:
        - name: name
          id: id
          uri: uri
        - name: name
          id: id
          uri: uri
        paging:
          perPage: 5
          pageStart: 5
          pageEnd: 2
          totalPages: 7
          page: 1
          totalElements: 9
      properties:
        records:
          description: List of paging devices assigned to this group
          items:
            $ref: '#/components/schemas/PagingDeviceInfo'
          type: array
        navigation:
          $ref: '#/components/schemas/NavigationInfo'
        paging:
          $ref: '#/components/schemas/PagingInfo'
      type: object
    MessageStoreCallerInfoRequest:
      example:
        phoneNumber: phoneNumber
        extensionNumber: extensionNumber
        name: name
        location: location
      properties:
        extensionNumber:
          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
          type: string
        location:
          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)
          type: string
        name:
          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
          type: string
        phoneNumber:
          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
          type: string
      type: object
    NotificationRecipientInfo:
      properties:
        phoneNumber:
          description: Phone number in E.164 (with '+' sign) format
          type: string
        extensionNumber:
          description: Extension number
          type: string
        target:
          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'
          type: boolean
        location:
          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)
          type: string
        name:
          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
          type: string
      type: object
    ServiceInfoRequest:
      example:
        limits:
          freeSoftPhoneLinesPerExtension: 0
          meetingSize: 6
          maxMonitoredExtensionsPerUser: 1
          maxExtensionNumberLength: 5
      properties:
        limits:
          $ref: '#/components/schemas/AccountLimits'
      type: object
    GetUserListResponse:
      example:
        startIndex: 0
        totalResults: 6
        itemsPerPage: 1
        schemas:
        - schemas
        - schemas
        Resources:
        - emails:
          - type: work
            value: value
          - type: work
            value: value
          addresses:
          - country: country
            streetAddress: streetAddress
            postalCode: postalCode
            locality: locality
            region: region
            type: work
          - country: country
            streetAddress: streetAddress
            postalCode: postalCode
            locality: locality
            region: region
            type: work
          meta:
            created: 2000-01-23T04:56:07.000+00:00
            location: location
            lastModified: 2000-01-23T04:56:07.000+00:00
            resourceType: User
          schemas:
          - schemas
          - schemas
          name:
            givenName: givenName
            familyName: familyName
          active: false
          externalId: externalId
          id: id
          userName: userName
          photos:
          - type: photo
            value: value
          - type: photo
            value: value
          phoneNumbers:
          - type: work
            value: value
          - type: work
            value: value
          urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:
            department: department
        - emails:
          - type: work
            value: value
          - type: work
            value: value
          addresses:
          - country: country
            streetAddress: streetAddress
            postalCode: postalCode
            locality: locality
            region: region
            type: work
          - country: country
            streetAddress: streetAddress
            postalCode: postalCode
            locality: locality
            region: region
            type: work
          meta:
            created: 2000-01-23T04:56:07.000+00:00
            location: location
            lastModified: 2000-01-23T04:56:07.000+00:00
            resourceType: User
          schemas:
          - schemas
          - schemas
          name:
            givenName: givenName
            familyName: familyName
          active: false
          externalId: externalId
          id: id
          userName: userName
          photos:
          - type: photo
            value: value
          - type: photo
            value: value
          phoneNumbers:
          - type: work
            value: value
          - type: work
            value: value
          urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:
            department: department
      properties:
        schemas:
          description: Specification links
          items:
            type: string
          type: array
        startIndex:
          description: 1-based index of query result
          type: integer
        totalResults:
          description: Results count
          type: integer
        Resources:
          description: List of users with detailed info
          items:
            $ref: '#/components/schemas/UserInfo'
          type: array
        itemsPerPage:
          description: Number of users displayed per page
          type: integer
      type: object
    GrantInfo:
      example:
        extension:
          extensionNumber: extensionNumber
          id: id
          type: User
          uri: uri
        callPickup: true
        callMonitoring: true
        uri: uri
      properties:
        uri:
          description: Canonical URI of a grant
          type: string
        extension:
          $ref: '#/components/schemas/ExtensionInfoGrants'
        callPickup:
          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
          type: boolean
        callMonitoring:
          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
          type: boolean
      type: object
    ReferenceInfo:
      example:
        ref: ref
        type: PartnerId
      properties:
        ref:
          description: Non-RC identifier of an extension
          type: string
        type:
          description: Type of external identifier
          enum:
          - PartnerId
          - CustomerDirectoryId
          type: string
      type: object
    Locale:
      properties:
        language:
          type: string
        country:
          type: string
        displayCountry:
          type: string
        displayLanguage:
          type: string
        displayName:
          type: string
        displayScript:
          type: string
        displayVariant:
          type: string
        extensionKeys:
          items:
            type: string
          type: array
        iso3Country:
          type: string
        iso3Language:
          type: string
        script:
          type: string
        unicodeLocaleAttributes:
          items:
            type: string
          type: array
        unicodeLocaleKeys:
          items:
            type: string
          type: array
        variant:
          type: string
      type: object
    ActiveCallInfoWithoutSIP:
      properties:
        id:
          description: Internal identifier of a call
          type: string
        direction:
          description: Call direction
          enum:
          - Inbound
          - Outbound
          type: string
        from:
          description: Phone number or extension number of a caller
          type: string
        to:
          description: Phone number or extension number of a callee
          type: string
        telephonyStatus:
          description: Telephony call status
          enum:
          - NoCall
          - CallConnected
          - Ringing
          - OnHold
          - ParkedCall
          type: string
        sessionId:
          description: Internal identifier of a call session
          type: string
        terminationType:
          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
          type: string
      type: object
    ProfileImageResource:
      example:
        scales:
        - uri: http://example.com/aeiou
        - uri: http://example.com/aeiou
        etag: etag
        lastModified: 2000-01-23T04:56:07.000+00:00
        uri: http://example.com/aeiou
        contentType: contentType
      properties:
        uri:
          format: uri
          type: string
        etag:
          type: string
        contentType:
          type: string
        lastModified:
          format: date-time
          type: string
        scales:
          items:
            $ref: '#/components/schemas/ScaledProfileImageResource'
          type: array
      type: object
    LicenseTypes:
      example:
        navigation:
          previousPage:
            uri: uri
          firstPage:
            uri: uri
          lastPage:
            uri: uri
          nextPage:
            uri: uri
        records:
        - extension:
            extensionNumber: extensionNumber
            name: name
            id: id
            uri: uri
          creationTime: creationTime
          id: id
          type:
            name: name
            limit: 0
            id: id
          uri: uri
        - extension:
            extensionNumber: extensionNumber
            name: name
            id: id
            uri: uri
          creationTime: creationTime
          id: id
          type:
            name: name
            limit: 0
            id: id
          uri: uri
        paging:
          perPage: 5
          pageStart: 5
          pageEnd: 2
          totalPages: 7
          page: 1
          totalElements: 9
        uri: uri
      properties:
        uri:
          description: Canonical URI of a license types resource
          type: string
        records:
          description: 'List of supported licenses '
          items:
            $ref: '#/components/schemas/LicenseInfo'
          type: array
        paging:
          $ref: '#/components/schemas/PagingInfo'
        navigation:
          $ref: '#/components/schemas/NavigationInfo'
      type: object
    AudioPromptInfo:
      example:
        id: id
        uri: uri
      properties:
        uri:
          description: Link to an prompt audio file
          type: string
        id:
          description: Internal identifier of an prompt
          type: string
      type: object
    AnsweringForwardingResource:
      properties:
        notifyMySoftPhones:
          default: false
          type: boolean
        notifyAdminSoftPhones:
          default: false
          type: boolean
        softPhonesRingCount:
          format: int32
          type: integer
        ringingMode:
          enum:
          - Sequentially
          - Simultaneously
          type: string
        rules:
          items:
            $ref: '#/components/schemas/AnsweringForwardingRuleResource'
          type: array
      type: object
    CallLogRecords:
      properties:
        uri:
          format: uri
          type: string
        records:
          items:
            $ref: '#/components/schemas/CallLogRecordResource'
          type: array
        paging:
          $ref: '#/components/schemas/Paging'
        navigation:
          $ref: '#/components/schemas/Navigation'
      type: object
    UserBusinessHoursUpdateRequest:
      example:
        schedule:
          sunday:
          - from: 2000-01-23T04:56:07.000+00:00
            to: 2000-01-23T04:56:07.000+00:00
          - from: 2000-01-23T04:56:07.000+00:00
            to: 2000-01-23T04:56:07.000+00:00
          saturday:
          - from: 2000-01-23T04:56:07.000+00:00
            to: 2000-01-23T04:56:07.000+00:00
          - from: 2000-01-23T04:56:07.000+00:00
            to: 2000-01-23T04:56:07.000+00:00
          tuesday:
          - from: 2000-01-23T04:56:07.000+00:00
            to: 2000-01-23T04:56:07.000+00:00
          - from: 2000-01-23T04:56:07.000+00:00
            to: 2000-01-23T04:56:07.000+00:00
          wednesday:
          - from: 2000-01-23T04:56:07.000+00:00
            to: 2000-01-23T04:56:07.000+00:00
          - from: 2000-01-23T04:56:07.000+00:00
            to: 2000-01-23T04:56:07.000+00:00
          thursday:
          - from: 2000-01-23T04:56:07.000+00:00
            to: 2000-01-23T04:56:07.000+00:00
          - from: 2000-01-23T04:56:07.000+00:00
            to: 2000-01-23T04:56:07.000+00:00
          friday:
          - from: 2000-01-23T04:56:07.000+00:00
            to: 2000-01-23T04:56:07.000+00:00
          - from: 2000-01-23T04:56:07.000+00:00
            to: 2000-01-23T04:56:07.000+00:00
          monday:
          - from: 2000-01-23T04:56:07.000+00:00
            to: 2000-01-23T04:56:07.000+00:00
          - from: 2000-01-23T04:56:07.000+00:00
            to: 2000-01-23T04:56:07.000+00:00
      properties:
        schedule:
          $ref: '#/components/schemas/WeeklyScheduleInfo'
      type: object
    ExtensionLanguageInfoRequest:
      example:
        id: id
      properties:
        id:
          description: internal Identifier of a language
          type: string
      type: object
    FederationConflictsAccountInfo:
      example:
        federatedName: federatedName
        id: id
      properties:
        id:
          description: Internal identifier of an account
          type: string
        federatedName:
          description: Federated name of an account
          type: string
      type: object
    ForwardingNumberInfoRules:
      example:
        phoneNumber: phoneNumber
        id: id
        label: label
        uri: uri
      properties:
        uri:
          description: Link to a forwarding number resource
          type: string
        id:
          description: Internal identifier of a forwarding number
          type: string
        phoneNumber:
          description: Phone number to which the call is forwarded
          type: string
        label:
          description: Title of a forwarding number
          type: string
      type: object
    DeviceResource:
      example:
        extension:
          setupWizardState: NotStarted
          statusInfo:
            reason: reason
            till: 2000-01-23T04:56:07.000+00:00
            comment: comment
          references:
          - ref: ref
            type: PartnerId
          - ref: ref
            type: PartnerId
          profileImage:
            scales:
            - uri: http://example.com/aeiou
            - uri: http://example.com/aeiou
            etag: etag
            lastModified: 2000-01-23T04:56:07.000+00:00
            uri: http://example.com/aeiou
            contentType: contentType
          type: Unknown
          uri: http://example.com/aeiou
          ivrPin: ivrPin
          password: password
          serviceFeatures:
          - reason: Available
            featureName: featureName
            enabled: false
          - reason: Available
            featureName: featureName
            enabled: false
          extensionNumber: extensionNumber
          permissions:
            admin:
              enabled: false
            uri: http://example.com/aeiou
            internationalCalling:
              enabled: false
            freeSoftPhoneDigitalLine:
              enabled: false
          loginName: loginName
          contact:
            firstName: firstName
            lastName: lastName
            company: company
            businessPhone: businessPhone
            businessAddress:
              zip: zip
              country: country
              city: city
              street: street
              state: state
            email: email
          name: name
          regionalSettings:
            timezone:
              name: name
              description: description
              id: id
              uri: http://example.com/aeiou
            greetingLanguage:
              localeCode: localeCode
              name: name
              id: id
            formattingLocale:
              localeCode: localeCode
              name: name
              id: id
            language:
              localeCode: localeCode
              name: name
              id: id
            homeCountry:
              callingCode: callingCode
              numberSelling: false
              isoCode: isoCode
              emergencyCalling: false
              name: name
              id: id
              uri: http://example.com/aeiou
              loginAllowed: false
          id: 6
          partnerId: partnerId
          departments:
          - extensionNumber: extensionNumber
            id: id
            uri: http://example.com/aeiou
          - extensionNumber: extensionNumber
            id: id
            uri: http://example.com/aeiou
          status: Enabled
        phoneLines:
        - lineType: Unknown
          phoneInfo:
            country:
              callingCode: callingCode
              numberSelling: false
              isoCode: isoCode
              emergencyCalling: false
              name: name
              id: id
              uri: http://example.com/aeiou
              loginAllowed: false
            extension:
              setupWizardState: NotStarted
              statusInfo:
                reason: reason
                till: 2000-01-23T04:56:07.000+00:00
                comment: comment
              references:
              - ref: ref
                type: PartnerId
              - ref: ref
                type: PartnerId
              profileImage:
                scales:
                - uri: http://example.com/aeiou
                - uri: http://example.com/aeiou
                etag: etag
                lastModified: 2000-01-23T04:56:07.000+00:00
                uri: http://example.com/aeiou
                contentType: contentType
              type: Unknown
              uri: http://example.com/aeiou
              ivrPin: ivrPin
              password: password
              serviceFeatures:
              - reason: Available
                featureName: featureName
                enabled: false
              - reason: Available
                featureName: featureName
                enabled: false
              extensionNumber: extensionNumber
              permissions:
                admin:
                  enabled: false
                uri: http://example.com/aeiou
                internationalCalling:
                  enabled: false
                freeSoftPhoneDigitalLine:
                  enabled: false
              loginName: loginName
              contact:
                firstName: firstName
                lastName: lastName
                company: company
                businessPhone: businessPhone
                businessAddress:
                  zip: zip
                  country: country
                  city: city
                  street: street
                  state: state
                email: email
              name: name
              regionalSettings:
                timezone:
                  name: name
                  description: description
                  id: id
                  uri: http://example.com/aeiou
                greetingLanguage:
                  localeCode: localeCode
                  name: name
                  id: id
                formattingLocale:
                  localeCode: localeCode
                  name: name
                  id: id
                language:
                  localeCode: localeCode
                  name: name
                  id: id
                homeCountry:
                  callingCode: callingCode
                  numberSelling: false
                  isoCode: isoCode
                  emergencyCalling: false
                  name: name
                  id: id
                  uri: http://example.com/aeiou
                  loginAllowed: false
              id: id
              partnerId: partnerId
              departments:
              - extensionNumber: extensionNumber
                id: id
                uri: http://example.com/aeiou
              - extensionNumber: extensionNumber
                id: id
                uri: http://example.com/aeiou
              status: Enabled
            phoneNumber: phoneNumber
            location: location
            id: 1
            label: label
            type: VoiceFax
            paymentType: External
            status: status
            usageType: CompanyNumber
          emergencyAddress:
            localOnly: true
            required: true
        - lineType: Unknown
          phoneInfo:
            country:
              callingCode: callingCode
              numberSelling: false
              isoCode: isoCode
              emergencyCalling: false
              name: name
              id: id
              uri: http://example.com/aeiou
              loginAllowed: false
            extension:
              setupWizardState: NotStarted
              statusInfo:
                reason: reason
                till: 2000-01-23T04:56:07.000+00:00
                comment: comment
              references:
              - ref: ref
                type: PartnerId
              - ref: ref
                type: PartnerId
              profileImage:
                scales:
                - uri: http://example.com/aeiou
                - uri: http://example.com/aeiou
                etag: etag
                lastModified: 2000-01-23T04:56:07.000+00:00
                uri: http://example.com/aeiou
                contentType: contentType
              type: Unknown
              uri: http://example.com/aeiou
              ivrPin: ivrPin
              password: password
              serviceFeatures:
              - reason: Available
                featureName: featureName
                enabled: false
              - reason: Available
                featureName: featureName
                enabled: false
              extensionNumber: extensionNumber
              permissions:
                admin:
                  enabled: false
                uri: http://example.com/aeiou
                internationalCalling:
                  enabled: false
                freeSoftPhoneDigitalLine:
                  enabled: false
              loginName: loginName
              contact:
                firstName: firstName
                lastName: lastName
                company: company
                businessPhone: businessPhone
                businessAddress:
                  zip: zip
                  country: country
                  city: city
                  street: street
                  state: state
                email: email
              name: name
              regionalSettings:
                timezone:
                  name: name
                  description: description
                  id: id
                  uri: http://example.com/aeiou
                greetingLanguage:
                  localeCode: localeCode
                  name: name
                  id: id
                formattingLocale:
                  localeCode: localeCode
                  name: name
                  id: id
                language:
                  localeCode: localeCode
                  name: name
                  id: id
                homeCountry:
                  callingCode: callingCode
                  numberSelling: false
                  isoCode: isoCode
                  emergencyCalling: false
                  name: name
                  id: id
                  uri: http://example.com/aeiou
                  loginAllowed: false
              id: id
              partnerId: partnerId
              departments:
              - extensionNumber: extensionNumber
                id: id
                uri: http://example.com/aeiou
              - extensionNumber: extensionNumber
                id: id
                uri: http://example.com/aeiou
              status: Enabled
            phoneNumber: phoneNumber
            location: location
            id: 1
            label: label
            type: VoiceFax
            paymentType: External
            status: status
            usageType: CompanyNumber
          emergencyAddress:
            localOnly: true
            required: true
        type: HardPhone
        uri: http://example.com/aeiou
        emergencyServiceAddress:
          zip: zip
          country: country
          city: city
          street: street
          street2: street2
          state: state
          customerName: customerName
        shipping:
          carrier: carrier
          address:
            zip: zip
            country: country
            city: city
            street: street
            street2: street2
            state: state
            customerName: customerName
          method:
            name: name
            id: id
          trackingNumber: trackingNumber
          status: status
        boxBillingId: 5
        serial: serial
        computerName: computerName
        linePooling: Host
        name: name
        model:
          addons:
          - name: name
            count: 0
            id: id
          - name: name
            count: 0
            id: id
          name: name
          id: id
        id: id
        sku: sku
        status: Online
      properties:
        id:
          description: Internal identifier of a device
          type: string
        uri:
          description: Canonical URI of a device
          format: uri
          type: string
        sku:
          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: string
        type:
          description: Device type. The default value is 'HardPhone'
          enum:
          - HardPhone
          - SoftPhone
          - OtherPhone
          type: string
        status:
          description: Status of a device = ['Online', 'Offline']
          enum:
          - Online
          - Offline
          type: string
        name:
          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
          type: string
        serial:
          description: Serial number for HardPhone (is returned only when the phone is shipped and provisioned); endpoint_id for softphone and mobile applications
          type: string
        computerName:
          description: PC name for softphone
          type: string
        model:
          $ref: '#/components/schemas/DeviceModelResource'
        extension:
          $ref: '#/components/schemas/ExtensionResourceIntId'
        phoneLines:
          description: Phone lines information
          items:
            $ref: '#/components/schemas/PhoneLineResource'
          type: array
        emergencyServiceAddress:
          $ref: '#/components/schemas/EmergencyServiceAddressResource'
        shipping:
          $ref: '#/components/schemas/ShippingResource'
        boxBillingId:
          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
          type: integer
        linePooling:
          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
          type: string
      type: object
    ReservePhoneNumberResource:
      example:
        formattedNumber: formattedNumber
        phoneNumber: phoneNumber
        reservationId: reservationId
        reservedTill: reservedTill
        error: NumberIsAlreadyProvisioned
        status: Enabled
      properties:
        phoneNumber:
          description: Phone number in E.164
          type: string
        formattedNumber:
          description: Domestic format of a phone number
          type: string
        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:
          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
          type: string
        status:
          description: Phone number status = ['Enabled', 'Pending', 'Disabled'],
          enum:
          - Enabled
          - Pending
          - Disabled
          type: string
        error:
          description: The error code in case of reservation/un-reservation failure = ['NumberIsAlreadyProvisioned', 'NumberReserved', 'NumberNotAvailable']
          enum:
          - NumberIsAlreadyProvisioned
          - NumberReserved
          - NumberNotAvailable
          type: string
      type: object
    NotificationInfo:
      properties:
        alerts:
          $ref: '#/components/schemas/AlertInfo'
        badge:
          description: Number of incoming messages
          type: string
        sound:
          description: Message sound
          type: string
        content-available:
          description: Content availability
          type: string
        category:
          description: Category of a message
          type: string
      type: object
    GetSecretQuestionListResponse:
      example:
        navigation:
          previousPage:
            uri: uri
          firstPage:
            uri: uri
          lastPage:
            uri: uri
          nextPage:
            uri: uri
        records:
        - showInSignUp: true
          languageId: languageId
          id: id
          questionType: 0
          questionText: questionText
        - showInSignUp: true
          languageId: languageId
          id: id
          questionType: 0
          questionText: questionText
        paging:
          perPage: 5
          pageStart: 5
          pageEnd: 2
          totalPages: 7
          page: 1
          totalElements: 9
        uri: uri
      properties:
        uri:
          description: Canonical URI of a question list resource
          type: string
        records:
          description: List of secret questions with their descriptions
          items:
            $ref: '#/components/schemas/SecretQuestionInfo'
          type: array
        navigation:
          $ref: '#/components/schemas/NavigationInfo'
        paging:
          $ref: '#/components/schemas/PagingInfo'
      type: object
    AcceptableToken:
      properties:
        token:
          type: string
        quality:
          format: int32
          type: integer
      type: object
    CallersInfo:
      example:
        name: name
        callerId: callerId
      properties:
        callerId:
          description: Phone number of a caller
          type: string
        name:
          description: Contact name of a caller
          type: string
      type: object
    PagingDeviceInfo:
      example:
        name: name
        id: id
        uri: uri
      properties:
        id:
          description: Internal identifier of a paging device
          type: string
        uri:
          description: Link to a paging device resource
          type: string
        name:
          description: Name of a paging device
          type: string
      type: object
    GreetingLanguageInfo:
      example:
        localeCode: localeCode
        name: name
        id: id
      properties:
        id:
          description: Internal identifier of a greeting language
          type: string
        localeCode:
          description: Localization code of a greeting language
          type: string
        name:
          description: Official name of a greeting language
          type: string
      type: object
    ClientResource:
      properties:
        detected:
          default: false
          type: boolean
        userAgent:
          type: string
        appId:
          type: string
        appName:
          type: string
        appKey:
          type: string
        appVersion:
          type: string
        locale:
          type: string
      type: object
    ShippingInfo:
      example:
        carrier: carrier
        address:
          zip: zip
          country: country
          city: city
          street: street
          street2: street2
          state: state
          customerName: customerName
        method:
          name: Ground
          id: "1"
        trackingNumber: trackingNumber
        status: Initial
      properties:
        status:
          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
          type: string
        carrier:
          description: 'Shipping carrier name. Appears only if the device status is  Shipped '
          type: string
        trackingNumber:
          description: Carrier-specific tracking number. Appears only if the device status is  Shipped
          type: string
        method:
          $ref: '#/components/schemas/MethodInfo'
        address:
          $ref: '#/components/schemas/ShippingAddressInfo'
      required:
      - address
      - method
      type: object
    ProvisionPhoneNumberRequest:
      example:
        phoneNumber: phoneNumber
        reservationId: reservationId
        label: label
        type: VoiceFax
        extensionId:
          id: id
          partnerId: partnerId
        usageType: CompanyNumber
        vanityPattern: vanityPattern
      properties:
        extensionId:
          $ref: '#/components/schemas/ExtensionInfoProvisionPhoneNumbers'
        phoneNumber:
          description: Phone number to purchase returned in E.164 (11-digits) format
          type: string
        reservationId:
          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
          type: string
        label:
          description: Custom user name of a phone number, if any. Supported for numbers assigned to Auto-Receptionist, with usage type 'CompanyNumber
          type: string
        usageType:
          description: Usage type of a phone number. The default value is 'DirectNumber'
          enum:
          - CompanyNumber
          - MainCompanyNumber
          - AdditionalCompanyNumber
          - DirectNumber
          - CompanyFaxNumber
          - ForwardedNumber
          - ForwardedCompanyNumber
          type: string
        type:
          description: Type of a phone number
          enum:
          - VoiceFax
          - VoiceOnly
          - FaxOnly
          type: string
        vanityPattern:
          description: ' Vanity pattern that was used to find this number. It should
            be passed as if it was returned from the Number Lookup call'
          type: string
      type: object
    EmergencyAddressInfoRequest:
      example:
        zip: zip
        country: country
        city: city
        street: street
        street2: street2
        state: state
        customerName: customerName
      properties:
        customerName:
          description: Name of a customer
          type: string
        street:
          description: Street address, line 1 - street address, P.O. box, company name, c/o
          type: string
        street2:
          description: Street address, line 2 - apartment, suite, unit, building, floor, etc
          type: string
        city:
          description: City name
          type: string
        state:
          description: State/province name
          type: string
        zip:
          description: Zip code
          type: string
        country:
          description: Country name
          type: string
      type: object
    PoolResponseResource:
      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:
          items:
            $ref: '#/components/schemas/File'
          type: array
        messageServers:
          items:
            type: string
          type: array
        touchInterval:
          format: int64
          type: integer
      type: object
    NameInfoRequest:
      properties:
        givenName:
          description: User first name
          type: string
        familyName:
          description: User last name
          type: string
      type: object
    PoolRequestResource:
      properties:
        rendererId:
          type: string
      type: object
    MeetingServiceInfoResource:
      example:
        intlDialInNumbersUri: intlDialInNumbersUri
        supportUri: supportUri
        externalUserInfo:
          accountId: accountId
          userToken: userToken
          userType: 0
          uri: http://example.com/aeiou
          userId: userId
        dialInNumbers:
        - country:
            callingCode: callingCode
            numberSelling: false
            isoCode: isoCode
            emergencyCalling: false
            name: name
            id: id
            uri: http://example.com/aeiou
            loginAllowed: false
          formattedNumber: formattedNumber
          phoneNumber: phoneNumber
          location: location
        - country:
            callingCode: callingCode
            numberSelling: false
            isoCode: isoCode
            emergencyCalling: false
            name: name
            id: id
            uri: http://example.com/aeiou
            loginAllowed: false
          formattedNumber: formattedNumber
          phoneNumber: phoneNumber
          location: location
        uri: http://example.com/aeiou
      properties:
        uri:
          format: uri
          type: string
        supportUri:
          type: string
        intlDialInNumbersUri:
          type: string
        externalUserInfo:
          $ref: '#/components/schemas/MeetingExternalUserInfoResource'
        dialInNumbers:
          items:
            $ref: '#/components/schemas/DialInNumberResource'
          type: array
      type: object
    ShippingOptionResource:
      properties:
        uri:
          format: uri
          type: string
        method:
          $ref: '#/components/schemas/ShippingMethod'
        quantity:
          format: int32
          type: integer
        price:
          format: double
          type: number
      type: object
    CountryResource:
      example:
        callingCode: callingCode
        numberSelling: false
        isoCode: isoCode
        emergencyCalling: false
        name: name
        id: id
        uri: http://example.com/aeiou
        loginAllowed: false
      properties:
        uri:
          format: uri
          type: string
        id:
          type: string
        name:
          type: string
        isoCode:
          type: string
        callingCode:
          type: string
        emergencyCalling:
          default: false
          type: boolean
        numberSelling:
          default: false
          type: boolean
        loginAllowed:
          default: false
          type: boolean
      type: object
    Paging:
      example:
        perPage: 1
        pageStart: 5
        pageEnd: 2
        totalPages: 6
        page: 0
        totalElements: 5
      properties:
        page:
          format: int32
          type: integer
        totalPages:
          format: int32
          type: integer
        perPage:
          format: int32
          type: integer
        totalElements:
          format: int32
          type: integer
        pageStart:
          format: int32
          type: integer
        pageEnd:
          format: int32
          type: integer
      type: object
    AnsweringForwardingRuleResource:
      properties:
        index:
          format: int32
          type: integer
        ringCount:
          format: int32
          type: integer
        forwardingNumbers:
          items:
            $ref: '#/components/schemas/ForwardingNumberResource'
          type: array
      type: object
    RingOutFromInfo:
      example:
        phoneNumber: phoneNumber
        forwardingNumberId: forwardingNumberId
      properties:
        phoneNumber:
          type: string
        forwardingNumberId:
          type: string
      type: object
    AnsweringRuleInfo:
      example:
        voicemail:
          recipient:
            id: id
            uri: uri
          enabled: true
        forwarding:
          softPhonesRingCount: 0
          rules:
          - forwardingNumbers:
            - phoneNumber: phoneNumber
              id: id
              label: label
              uri: uri
            - phoneNumber: phoneNumber
              id: id
              label: label
              uri: uri
            ringCount: 1
            index: 6
          - forwardingNumbers:
            - phoneNumber: phoneNumber
              id: id
              label: label
              uri: uri
            - phoneNumber: phoneNumber
              id: id
              label: label
              uri: uri
            ringCount: 1
            index: 6
          notifyMySoftPhones: true
          notifyAdminSoftPhones: true
          ringingMode: Sequentially
        greetings:
        - preset:
            name: name
            id: id
            uri: uri
          type: Introductory
          usageType: UserExtensionAnsweringRule
        - preset:
            name: name
            id: id
            uri: uri
          type: Introductory
          usageType: UserExtensionAnsweringRule
        type: BusinessHours
        uri: uri
        enabled: true
        callHandlingAction: ForwardCalls
        calledNumbers:
        - phoneNumber: phoneNumber
        - phoneNumber: phoneNumber
        schedule:
          ref: BusinessHours
          ranges:
            from: 2000-01-23T04:56:07.000+00:00
            to: 2000-01-23T04:56:07.000+00:00
          weeklyRanges:
            sunday:
            - from: 2000-01-23T04:56:07.000+00:00
              to: 2000-01-23T04:56:07.000+00:00
            - from: 2000-01-23T04:56:07.000+00:00
              to: 2000-01-23T04:56:07.000+00:00
            saturday:
            - from: 2000-01-23T04:56:07.000+00:00
              to: 2000-01-23T04:56:07.000+00:00
            - from: 2000-01-23T04:56:07.000+00:00
              to: 2000-01-23T04:56:07.000+00:00
            tuesday:
            - from: 2000-01-23T04:56:07.000+00:00
              to: 2000-01-23T04:56:07.000+00:00
            - from: 2000-01-23T04:56:07.000+00:00
              to: 2000-01-23T04:56:07.000+00:00
            wednesday:
            - from: 2000-01-23T04:56:07.000+00:00
              to: 2000-01-23T04:56:07.000+00:00
            - from: 2000-01-23T04:56:07.000+00:00
              to: 2000-01-23T04:56:07.000+00:00
            thursday:
            - from: 2000-01-23T04:56:07.000+00:00
              to: 2000-01-23T04:56:07.000+00:00
            - from: 2000-01-23T04:56:07.000+00:00
              to: 2000-01-23T04:56:07.000+00:00
            friday:
            - from: 2000-01-23T04:56:07.000+00:00
              to: 2000-01-23T04:56:07.000+00:00
            - from: 2000-01-23T04:56:07.000+00:00
              to: 2000-01-23T04:56:07.000+00:00
            monday:
            - from: 2000-01-23T04:56:07.000+00:00
              to: 2000-01-23T04:56:07.000+00:00
            - from: 2000-01-23T04:56:07.000+00:00
              to: 2000-01-23T04:56:07.000+00:00
        transfer:
          extension:
            extensionNumber: extensionNumber
            id: id
            partnerId: partnerId
            uri: uri
        name: name
        id: id
        callers:
        - name: name
          callerId: callerId
        - name: name
          callerId: callerId
        unconditionalForwarding:
          phoneNumber: phoneNumber
        queue:
          wrapUpTime: 7
          transferMode: Rotating
          fixedOrderAgents:
          - extension:
              extensionNumber: extensionNumber
              id: id
              partnerId: partnerId
              uri: uri
            index: 5
          - extension:
              extensionNumber: extensionNumber
              id: id
              partnerId: partnerId
              uri: uri
            index: 5
          holdAudioInterruptionPeriod: 5
          maxCallersAction: Voicemail
          maxCallers: 3
          holdAudioInterruptionMode: Never
          agentTimeout: 2
          holdTime: 9
      properties:
        uri:
          description: Canonical URI to the answering rule resource
          type: string
        id:
          description: Internal identifier of an answering rule
          type: string
        type:
          description: Type of an answering rule
          enum:
          - BusinessHours
          - AfterHours
          - Custom
          type: string
        name:
          description: Name of an answering rule specified by user
          type: string
        enabled:
          description: Specifies if an answering rule is active or inactive
          type: boolean
        schedule:
          $ref: '#/components/schemas/ScheduleInfo'
        calledNumbers:
          description: Answering rules are applied when calling to selected number(s)
          items:
            $ref: '#/components/schemas/CalledNumberInfo'
          type: array
        callers:
          description: Answering rules are applied when calls are received from specified caller(s)
          items:
            $ref: '#/components/schemas/CallersInfo'
          type: array
        callHandlingAction:
          description: Specifies how incoming calls are forwarded
          enum:
          - ForwardCalls
          - UnconditionalForwarding
          - AgentQueue
          - TransferToExtension
          - TakeMessagesOnly
          - PlayAnnouncementOnly
          type: string
        forwarding:
          $ref: '#/components/schemas/ForwardingInfo'
        unconditionalForwarding:
          $ref: '#/components/schemas/UnconditionalForwardingInfo'
        queue:
          $ref: '#/components/schemas/QueueInfo'
        transfer:
          $ref: '#/components/schemas/TransferredExtensionInfo'
        voicemail:
          $ref: '#/components/schemas/VoicemailInfo'
        greetings:
          description: Greetings applied for an answering rule; only predefined greetings can be applied, see Dictionary Greeting List
          items:
            $ref: '#/components/schemas/GreetingInfo'
          type: array
      type: object
    UpdatePresenceLinesRequest:
      example:
        records:
        - extension:
            id: id
          id: id
        - extension:
            id: id
          id: id
      properties:
        records:
          items:
            $ref: '#/components/schemas/PresenceLineInfo'
          type: array
      type: object
    GCMInfo:
      properties:
        priority:
          description: Notification priority, if the value is 'high' then notification is turned on even if the application is in background
          enum:
          - high
          - normal
          type: string
        time_to_live:
          description: Notification lifetime value in seconds, the default value is 30 seconds
          type: integer
        data:
          $ref: '#/components/schemas/GCMData'
      type: object
    RingOutCountry:
      example:
        id: id
      properties:
        id:
          type: string
      type: object
    InProductMessages:
      example:
        navigation:
          previousPage:
            uri: uri
          firstPage:
            uri: uri
          lastPage:
            uri: uri
          nextPage:
            uri: uri
        records:
        - bannerType: bannerType
          description: description
          content: content
          expirationDate: expirationDate
        - bannerType: bannerType
          description: description
          content: content
          expirationDate: expirationDate
        paging:
          perPage: 5
          pageStart: 5
          pageEnd: 2
          totalPages: 7
          page: 1
          totalElements: 9
        uri: uri
      properties:
        uri:
          description: Link to the in-product messages resource
          type: string
        records:
          description: The list of in-product messages
          items:
            $ref: '#/components/schemas/BannerInfo'
          type: array
        navigation:
          $ref: '#/components/schemas/NavigationInfo'
        paging:
          $ref: '#/components/schemas/PagingInfo'
      type: object
    GetAccountDevicesResponse:
      example:
        navigation:
          previousPage:
            uri: uri
          firstPage:
            uri: uri
          lastPage:
            uri: uri
          nextPage:
            uri: uri
        records:
        - extension:
            extensionNumber: extensionNumber
            id: 0
            partnerId: partnerId
            uri: uri
          phoneLines:
          - lineType: Standalone
            phoneInfo:
              country:
                name: name
                id: id
                uri: uri
              extension:
                extensionNumber: extensionNumber
                id: id
                partnerId: partnerId
                uri: uri
              phoneNumber: phoneNumber
              location: location
              id: 6
              label: label
              type: VoiceFax
              paymentType: External
              status: status
              usageType: MainCompanyNumber
          - lineType: Standalone
            phoneInfo:
              country:
                name: name
                id: id
                uri: uri
              extension:
                extensionNumber: extensionNumber
                id: id
                partnerId: partnerId
                uri: uri
              phoneNumber: phoneNumber
              location: location
              id: 6
              label: label
              type: VoiceFax
              paymentType: External
              status: status
              usageType: MainCompanyNumber
          type: SoftPhone
          uri: uri
          emergencyServiceAddress:
            zip: zip
            country: country
            city: city
            street: street
            street2: street2
            state: state
            customerName: customerName
          shipping:
            carrier: carrier
            address:
              zip: zip
              country: country
              city: city
              street: street
              street2: street2
              state: state
              customerName: customerName
            method:
              name: Ground
              id: "1"
            trackingNumber: trackingNumber
            status: Initial
          boxBillingId: 1
          serial: serial
          computerName: computerName
          name: name
          model:
            addons:
            - count: count
              id: id
            - count: count
              id: id
            name: name
            id: id
          id: id
          sku: sku
        - extension:
            extensionNumber: extensionNumber
            id: 0
            partnerId: partnerId
            uri: uri
          phoneLines:
          - lineType: Standalone
            phoneInfo:
              country:
                name: name
                id: id
                uri: uri
              extension:
                extensionNumber: extensionNumber
                id: id
                partnerId: partnerId
                uri: uri
              phoneNumber: phoneNumber
              location: location
              id: 6
              label: label
              type: VoiceFax
              paymentType: External
              status: status
              usageType: MainCompanyNumber
          - lineType: Standalone
            phoneInfo:
              country:
                name: name
                id: id
                uri: uri
              extension:
                extensionNumber: extensionNumber
                id: id
                partnerId: partnerId
                uri: uri
              phoneNumber: phoneNumber
              location: location
              id: 6
              label: label
              type: VoiceFax
              paymentType: External
              status: status
              usageType: MainCompanyNumber
          type: SoftPhone
          uri: uri
          emergencyServiceAddress:
            zip: zip
            country: country
            city: city
            street: street
            street2: street2
            state: state
            customerName: customerName
          shipping:
            carrier: carrier
            address:
              zip: zip
              country: country
              city: city
              street: street
              street2: street2
              state: state
              customerName: customerName
            method:
              name: Ground
              id: "1"
            trackingNumber: trackingNumber
            status: Initial
          boxBillingId: 1
          serial: serial
          computerName: computerName
          name: name
          model:
            addons:
            - count: count
              id: id
            - count: count
              id: id
            name: name
            id: id
          id: id
          sku: sku
        paging:
          perPage: 5
          pageStart: 5
          pageEnd: 2
          totalPages: 7
          page: 1
          totalElements: 9
      properties:
        records:
          description: List of extension records
          items:
            $ref: '#/components/schemas/GetDeviceInfoResponse'
          type: array
        navigation:
          $ref: '#/components/schemas/NavigationInfo'
        paging:
          $ref: '#/components/schemas/PagingInfo'
      required:
      - navigation
      - paging
      - records
      type: object
    ApiVersionResource:
      properties:
        uri:
          format: uri
          type: string
        versionString:
          type: string
        releaseDate:
          format: date-time
          type: string
        uriString:
          type: string
      type: object
    PermissionInfo:
      example:
        enabled: true
      properties:
        enabled:
          description: Specifies if a permission is enabled or not
          type: boolean
      type: object
    SCIMSearchRequestInfo:
      properties:
        count:
          description: page size
          format: int32
          type: integer
        filter:
          description: only support 'userName' or 'email' filter expressions for now
          type: string
        schemas:
          items:
            enum:
            - urn:ietf:params:scim:api:messages:2.0:SearchRequest
            type: string
          type: array
        startIndex:
          description: start index (1-based)
          format: int32
          type: integer
      type: object
    CfaSchedule:
      properties:
        scheduleId:
          type: string
        recurrence:
          $ref: '#/components/schemas/CfaRecurrence'
        viewType:
          enum:
          - Detailed
          - Simple
          type: string
        attachments:
          $ref: '#/components/schemas/CfaAttachments'
        recipients:
          items:
            type: string
          type: array
        pages:
          items:
            type: string
          type: array
      type: object
    ForwardingNumberInfo:
      example:
        features:
        - CallFlip
        - CallFlip
        phoneNumber: phoneNumber
        flipNumber: flipNumber
        id: id
        label: label
        uri: uri
      properties:
        id:
          description: Internal identifier of a forwarding/call flip phone number
          type: string
        uri:
          description: Canonical URI of a forwarding/call flip phone number
          type: string
        phoneNumber:
          description: Forwarding/Call flip phone number
          type: string
        label:
          description: Forwarding/Call flip number title
          type: string
        features:
          description: Type of option this phone number is used for. Multiple values are accepted
          items:
            enum:
            - CallFlip
            - CallForwarding
            type: string
          type: array
        flipNumber:
          description: Number assigned to the call flip phone number, corresponds to the shortcut dial number
          type: string
      type: object
    RecipientInfo:
      example:
        id: id
        uri: uri
      properties:
        uri:
          description: Link to a recipient extension resource
          type: string
        id:
          description: Internal identifier of a recipient extension
          type: string
      type: object
    ScheduleInfoUserBusinessHours:
      example:
        weeklyRanges:
          sunday:
          - from: 2000-01-23T04:56:07.000+00:00
            to: 2000-01-23T04:56:07.000+00:00
          - from: 2000-01-23T04:56:07.000+00:00
            to: 2000-01-23T04:56:07.000+00:00
          saturday:
          - from: 2000-01-23T04:56:07.000+00:00
            to: 2000-01-23T04:56:07.000+00:00
          - from: 2000-01-23T04:56:07.000+00:00
            to: 2000-01-23T04:56:07.000+00:00
          tuesday:
          - from: 2000-01-23T04:56:07.000+00:00
            to: 2000-01-23T04:56:07.000+00:00
          - from: 2000-01-23T04:56:07.000+00:00
            to: 2000-01-23T04:56:07.000+00:00
          wednesday:
          - from: 2000-01-23T04:56:07.000+00:00
            to: 2000-01-23T04:56:07.000+00:00
          - from: 2000-01-23T04:56:07.000+00:00
            to: 2000-01-23T04:56:07.000+00:00
          thursday:
          - from: 2000-01-23T04:56:07.000+00:00
            to: 2000-01-23T04:56:07.000+00:00
          - from: 2000-01-23T04:56:07.000+00:00
            to: 2000-01-23T04:56:07.000+00:00
          friday:
          - from: 2000-01-23T04:56:07.000+00:00
            to: 2000-01-23T04:56:07.000+00:00
          - from: 2000-01-23T04:56:07.000+00:00
            to: 2000-01-23T04:56:07.000+00:00
          monday:
          - from: 2000-01-23T04:56:07.000+00:00
            to: 2000-01-23T04:56:07.000+00:00
          - from: 2000-01-23T04:56:07.000+00:00
            to: 2000-01-23T04:56:07.000+00:00
      properties:
        weeklyRanges:
          $ref: '#/components/schemas/WeeklyScheduleInfo'
      type: object
    VersionedResource:
      properties:
        uri:
          format: uri
          type: string
      type: object
    File:
      properties:
        sourceFile:
          type: string
        originalFileName:
          type: string
      type: object
    GlipPostInfo:
      example:
        lastModifiedTime: 2000-01-23T04:56:07.000+00:00
        attachments:
        - imageUri: imageUri
          color: color
          author:
            name: name
            uri: uri
            iconUri: iconUri
          intro: intro
          id: id
          text: text
          footnote:
            text: text
            time: 2000-01-23T04:56:07.000+00:00
            iconUri: iconUri
          type: Card
          title: title
          thumbnailUri: thumbnailUri
          fields:
          - style: Short
            title: title
            value: value
          - style: Short
            title: title
            value: value
          fallback: fallback
        - imageUri: imageUri
          color: color
          author:
            name: name
            uri: uri
            iconUri: iconUri
          intro: intro
          id: id
          text: text
          footnote:
            text: text
            time: 2000-01-23T04:56:07.000+00:00
            iconUri: iconUri
          type: Card
          title: title
          thumbnailUri: thumbnailUri
          fields:
          - style: Short
            title: title
            value: value
          - style: Short
            title: title
            value: value
          fallback: fallback
        iconEmoji: iconEmoji
        creationTime: 2000-01-23T04:56:07.000+00:00
        activity: activity
        groupId: groupId
        creatorId: creatorId
        type: TextMessage
        title: title
        addedPersonIds:
        - addedPersonIds
        - addedPersonIds
        mentions:
        - name: name
          id: id
          type: Person
        - name: name
          id: id
          type: Person
        id: id
        text: text
        iconUri: iconUri
      properties:
        id:
          description: Internal identifier of a post
          type: string
        groupId:
          description: Internal identifier of a group a post belongs to
          type: string
        type:
          description: Type of a post
          enum:
          - TextMessage
          - PersonJoined
          - PersonsAdded
          type: string
        text:
          description: For 'TextMessage' post type only. Message text
          type: string
        creatorId:
          description: Internal identifier of a user - author of a post
          type: string
        addedPersonIds:
          description: For PersonsAdded post type only. Identifiers of persons added to a group
          items:
            type: string
          type: array
        creationTime:
          description: Post creation datetime in ISO 8601 format
          format: date-time
          type: string
        lastModifiedTime:
          description: Post last modification datetime in ISO 8601 format
          format: date-time
          type: string
        attachments:
          description: List of posted attachments
          items:
            $ref: '#/components/schemas/GlipMessageAttachmentInfo'
          type: array
        mentions:
          description: List of posted attachments
          items:
            $ref: '#/components/schemas/GlipMentionsInfo'
          type: array
        activity:
          description: activity type
          type: string
        title:
          description: Title of the message. Can be set for bot messages only
          type: string
        iconUri:
          description: URI to an image to use as the icon for this message.
          type: string
        iconEmoji:
          description: Emoji to use as the icon for a message
          type: string
      type: object
    PermissionIdResource:
      example:
        id: id
        uri: http://example.com/aeiou
      properties:
        uri:
          format: uri
          type: string
        id:
          type: string
      type: object
    LicenseFeatureInfo:
      example:
        name: name
        limit: 0
        id: id
      properties:
        id:
          description: Internal identifier of an feature
          type: string
        name:
          description: Full name of a feature
          type: string
        limit:
          description: Maximum count of licenses of specific type per account
          type: integer
      type: object
    LanguageResource:
      example:
        localeCode: localeCode
        name: name
        id: id
      properties:
        id:
          type: string
        name:
          type: string
        localeCode:
          type: string
      type: object
    NotificationBlacklistedData:
      description: Returned if WebHook subscription is blacklisted
      example:
        blacklistedAt: 2000-01-23T04:56:07.000+00:00
        reason: reason
      properties:
        blacklistedAt:
          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*
          format: date-time
          type: string
        reason:
          description: Reason of adding subscrition to a black list
          type: string
      type: object
    AdbPresenceInfoResource:
      properties:
        accountId:
          type: string
        extensionId:
          type: string
        extensionType:
          enum:
          - Unknown
          - User
          - Department
          - Announcement
          - Voicemail
          - DigitalUser
          - VirtualUser
          - FaxUser
          - PagingOnly
          - SharedLinesGroup
          - ParkLocation
          - IvrMenu
          - ApplicationExtension
          type: string
        extensionStatus:
          enum:
          - Enabled
          - Disabled
          - Frozen
          - NotActivated
          type: string
        dndStatus:
          enum:
          - TakeAllCalls
          - DoNotAcceptDepartmentCalls
          - TakeDepartmentCallsOnly
          - DoNotAcceptAnyCalls
          type: string
        userStatus:
          enum:
          - Available
          - Busy
          - Offline
          type: string
        message:
          type: string
        agentStatus:
          enum:
          - Offline
          - Online
          - Unknown
          type: string
        extensionNumber:
          type: string
        allowSeeMyPresence:
          default: false
          type: boolean
        ringOnMonitoredCall:
          default: false
          type: boolean
        pickUpCallsOnHold:
          default: false
          type: boolean
        presenceFeatureAvailable:
          default: false
          type: boolean
        dndFeatureAvailable:
          default: false
          type: boolean
      type: object
    EditPagingGroupRequest:
      example:
        removedDeviceIds:
        - removedDeviceIds
        - removedDeviceIds
        addedUserIds:
        - addedUserIds
        - addedUserIds
        removedUserIds:
        - removedUserIds
        - removedUserIds
        addedDeviceIds:
        - addedDeviceIds
        - addedDeviceIds
      properties:
        addedUserIds:
          description: List of users that will be allowed to page a group specified
          items:
            type: string
          type: array
        removedUserIds:
          description: List of users that will be unallowed to page a group specified
          items:
            type: string
          type: array
        addedDeviceIds:
          description: List of account devices that will be assigned to a paging group specified
          items:
            type: string
          type: array
        removedDeviceIds:
          description: List of account devices that will be unassigned from a paging group specified
          items:
            type: string
          type: array
      type: object
    ExtensionWithRolesCollectionResource:
      properties:
        uri:
          format: uri
          type: string
        records:
          items:
            $ref: '#/components/schemas/ExtensionWithRolesResource'
          type: array
      type: object
    ContactAddressInfo:
      example:
        zip: zip
        country: country
        city: city
        street: street
        state: state
      properties:
        country:
          description: Country name of extension user company. Not returned for Address Book
          type: string
        state:
          description: State/province name of extension user company
          type: string
        city:
          description: City name of extension user company
          type: string
        street:
          description: Street address of extension user company
          type: string
        zip:
          description: Zip code of extension user company
          type: string
      type: object
    InboundMessageEvent:
      properties:
        aps:
          $ref: '#/components/schemas/NotificationInfo'
        messageId:
          description: Internal identifier of an message
          type: string
        conversationId:
          description: Internal identifier of an conversation
          type: string
        from:
          description: Sender phone number
          type: string
        to:
          description: Receiver phone number
          type: string
      type: object
    PromotionCodeResource:
      properties:
        accountId:
          type: string
        promotionCode:
          type: string
      type: object
    ReassignPhoneNumberResource:
      example:
        extension:
          id: id
          partnerId: partnerId
        id: id
        uri: http://example.com/aeiou
        usageType: CompanyNumber
      properties:
        uri:
          format: uri
          type: string
        id:
          type: string
        usageType:
          enum:
          - CompanyNumber
          - MainCompanyNumber
          - AdditionalCompanyNumber
          - DirectNumber
          - CompanyFaxNumber
          - ForwardedNumber
          type: string
        extension:
          $ref: '#/components/schemas/ExtensionReferenceResource'
      type: object
    ExtensionTimezoneInfoRequest:
      example:
        id: id
      properties:
        id:
          description: internal Identifier for timezone
          type: string
      type: object
    SubscriptionRequest:
      properties:
        eventFilters:
          items:
            type: string
          type: array
        deliveryMode:
          $ref: '#/components/schemas/DeliveryModeResource'
        expiresIn:
          format: int64
          type: integer
      type: object
    IVRPrompts:
      example:
        navigation:
          previousPage:
            uri: uri
          firstPage:
            uri: uri
          lastPage:
            uri: uri
          nextPage:
            uri: uri
        records:
        - filename: filename
          contentUri: contentUri
          id: id
          uri: uri
          contentType: contentType
        - filename: filename
          contentUri: contentUri
          id: id
          uri: uri
          contentType: contentType
        paging:
          perPage: 5
          pageStart: 5
          pageEnd: 2
          totalPages: 7
          page: 1
          totalElements: 9
        uri: uri
      properties:
        uri:
          description: Link to prompts library resource
          type: string
        records:
          description: List of Prompts
          items:
            $ref: '#/components/schemas/PromptInfo'
          type: array
        navigation:
          $ref: '#/components/schemas/NavigationInfo'
        paging:
          $ref: '#/components/schemas/PagingInfo'
      type: object
    PhoneNumberInfoRequest:
      example:
        type: work
        value: value
      properties:
        value:
          description: Phone number
          type: string
        type:
          description: Phone number type
          enum:
          - work
          - mobile
          - other
          type: string
      type: object
    ExtensionUserCredentials:
      example:
        secretQuestion:
          showInSignUp: true
          languageId: languageId
          id: id
          questionType: 0
          questionText: questionText
      properties:
        secretQuestion:
          $ref: '#/components/schemas/SecretQuestionInfo'
      type: object
    ExtensionGrantResource:
      properties:
        uri:
          format: uri
          type: string
        extension:
          $ref: '#/components/schemas/InlinedExtensionResource'
        callPickup:
          default: false
          type: boolean
        callMonitoring:
          default: false
          type: boolean
      type: object
    SessionsResource:
      properties:
        uri:
          format: uri
          type: string
        records:
          items:
            $ref: '#/components/schemas/VersionedResource'
          type: array
      type: object
    GlipCreateGroup:
      example:
        members:
        - members
        - members
        name: name
        isPublic: true
        description: description
        type: PrivateChat
      properties:
        type:
          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
          enum:
          - PrivateChat
          - Team
          type: string
        isPublic:
          description: For 'Team' group type only. Team access level
          type: boolean
        name:
          description: For 'Team' group type only. Team name
          type: string
        description:
          description: For 'Team' group type only. Team description
          type: string
        members:
          description: Identifier(s) of group members. For 'PrivateChat' group type 2 members only are supported
          items:
            type: string
          type: array
      required:
      - type
      type: object
    RegistrationResponse:
      properties:
        uri:
          format: uri
          type: string
        device:
          $ref: '#/components/schemas/DeviceResource'
        sipInfo:
          items:
            $ref: '#/components/schemas/SipInfo'
          type: array
        sipFlags:
          $ref: '#/components/schemas/SipFlags'
      type: object
    BusinessHoursResource:
      properties:
        uri:
          format: uri
          type: string
        schedule:
          $ref: '#/components/schemas/ScheduleResource'
      type: object
    ServiceFeatureInfo:
      example:
        featureName: featureName
        enabled: true
      properties:
        featureName:
          description: Feature name, see all available values in Service Feature List
          type: string
        enabled:
          description: Feature status, shows feature availability for the extension
          type: boolean
      type: object
    ExtensionInfoGrants:
      example:
        extensionNumber: extensionNumber
        id: id
        type: User
        uri: uri
      properties:
        id:
          description: Internal identifier of an extension
          type: string
        uri:
          description: Canonical URI of an extension
          type: string
        extensionNumber:
          description: Extension short number (usually 3 or 4 digits)
          type: string
        type:
          description: Extension type
          enum:
          - User
          - Fax User
          - VirtualUser
          - DigitalUser
          - Department
          - Announcement
          - Voicemail
          - SharedLinesGroup
          - PagingOnly
          - IvrMenu
          - ApplicationExtension
          - Park Location
          type: string
      type: object
    Addon:
      example:
        name: name
        count: 0
        id: id
      properties:
        id:
          type: string
        name:
          type: string
        count:
          format: int32
          type: integer
      type: object
    RecordsCollectionResourceSubscriptionResponse:
      example:
        records:
        - expiresIn: 0
          eventFilters:
          - eventFilters
          - eventFilters
          creationTime: 2000-01-23T04:56:07.000+00:00
          deliveryMode:
            authKey: authKey
            address: address
            encryption: false
            subscriberKey: subscriberKey
            registrationId: registrationId
            certificateName: certificateName
            transportType: PUBNUB
            encryptionKey: encryptionKey
            cipherKey: cipherKey
            publisherKey: publisherKey
            encryptionAlgorithm: encryptionAlgorithm
          expirationTime: 2000-01-23T04:56:07.000+00:00
          blacklistedData:
            blacklistedAt: 2000-01-23T04:56:07.000+00:00
            reason: reason
          id: id
          uri: http://example.com/aeiou
          status: status
        - expiresIn: 0
          eventFilters:
          - eventFilters
          - eventFilters
          creationTime: 2000-01-23T04:56:07.000+00:00
          deliveryMode:
            authKey: authKey
            address: address
            encryption: false
            subscriberKey: subscriberKey
            registrationId: registrationId
            certificateName: certificateName
            transportType: PUBNUB
            encryptionKey: encryptionKey
            cipherKey: cipherKey
            publisherKey: publisherKey
            encryptionAlgorithm: encryptionAlgorithm
          expirationTime: 2000-01-23T04:56:07.000+00:00
          blacklistedData:
            blacklistedAt: 2000-01-23T04:56:07.000+00:00
            reason: reason
          id: id
          uri: http://example.com/aeiou
          status: status
        uri: http://example.com/aeiou
      properties:
        uri:
          format: uri
          type: string
        records:
          items:
            $ref: '#/components/schemas/SubscriptionResponse'
          type: array
      type: object
    GlipCreatePost:
      example:
        attachments:
        - imageUri: imageUri
          color: color
          author:
            name: name
            uri: uri
            iconUri: iconUri
          intro: intro
          text: text
          footnote:
            text: text
            time: 2000-01-23T04:56:07.000+00:00
            iconUri: iconUri
          type: Card
          title: title
          thumbnailUri: thumbnailUri
          fields:
          - style: Short
            title: title
            value: value
          - style: Short
            title: title
            value: value
          fallback: fallback
        - imageUri: imageUri
          color: color
          author:
            name: name
            uri: uri
            iconUri: iconUri
          intro: intro
          text: text
          footnote:
            text: text
            time: 2000-01-23T04:56:07.000+00:00
            iconUri: iconUri
          type: Card
          title: title
          thumbnailUri: thumbnailUri
          fields:
          - style: Short
            title: title
            value: value
          - style: Short
            title: title
            value: value
          fallback: fallback
        text: text
      properties:
        text:
          description: Text of a post, the maximum is 10000 unicode characters
          type: string
        attachments:
          description: List of attachments to be posted
          items:
            $ref: '#/components/schemas/GlipMessageAttachmentInfoRequest'
          type: array
      type: object
    GetExtensionDevicesResponse:
      example:
        navigation:
          previousPage:
            uri: uri
          firstPage:
            uri: uri
          lastPage:
            uri: uri
          nextPage:
            uri: uri
        records:
        - extension:
            extensionNumber: extensionNumber
            id: 0
            partnerId: partnerId
            uri: uri
          phoneLines:
          - lineType: Standalone
            phoneInfo:
              country:
                name: name
                id: id
                uri: uri
              extension:
                extensionNumber: extensionNumber
                id: id
                partnerId: partnerId
                uri: uri
              phoneNumber: phoneNumber
              location: location
              id: 6
              label: label
              type: VoiceFax
              paymentType: External
              status: status
              usageType: MainCompanyNumber
          - lineType: Standalone
            phoneInfo:
              country:
                name: name
                id: id
                uri: uri
              extension:
                extensionNumber: extensionNumber
                id: id
                partnerId: partnerId
                uri: uri
              phoneNumber: phoneNumber
              location: location
              id: 6
              label: label
              type: VoiceFax
              paymentType: External
              status: status
              usageType: MainCompanyNumber
          type: SoftPhone
          uri: uri
          emergencyServiceAddress:
            zip: zip
            country: country
            city: city
            street: street
            street2: street2
            state: state
            customerName: customerName
          shipping:
            carrier: carrier
            address:
              zip: zip
              country: country
              city: city
              street: street
              street2: street2
              state: state
              customerName: customerName
            method:
              name: Ground
              id: "1"
            trackingNumber: trackingNumber
            status: Initial
          boxBillingId: 1
          serial: serial
          computerName: computerName
          name: name
          model:
            addons:
            - count: count
              id: id
            - count: count
              id: id
            name: name
            id: id
          id: id
          sku: sku
        - extension:
            extensionNumber: extensionNumber
            id: 0
            partnerId: partnerId
            uri: uri
          phoneLines:
          - lineType: Standalone
            phoneInfo:
              country:
                name: name
                id: id
                uri: uri
              extension:
                extensionNumber: extensionNumber
                id: id
                partnerId: partnerId
                uri: uri
              phoneNumber: phoneNumber
              location: location
              id: 6
              label: label
              type: VoiceFax
              paymentType: External
              status: status
              usageType: MainCompanyNumber
          - lineType: Standalone
            phoneInfo:
              country:
                name: name
                id: id
                uri: uri
              extension:
                extensionNumber: extensionNumber
                id: id
                partnerId: partnerId
                uri: uri
              phoneNumber: phoneNumber
              location: location
              id: 6
              label: label
              type: VoiceFax
              paymentType: External
              status: status
              usageType: MainCompanyNumber
          type: SoftPhone
          uri: uri
          emergencyServiceAddress:
            zip: zip
            country: country
            city: city
            street: street
            street2: street2
            state: state
            customerName: customerName
          shipping:
            carrier: carrier
            address:
              zip: zip
              country: country
              city: city
              street: street
              street2: street2
              state: state
              customerName: customerName
            method:
              name: Ground
              id: "1"
            trackingNumber: trackingNumber
            status: Initial
          boxBillingId: 1
          serial: serial
          computerName: computerName
          name: name
          model:
            addons:
            - count: count
              id: id
            - count: count
              id: id
            name: name
            id: id
          id: id
          sku: sku
        paging:
          perPage: 5
          pageStart: 5
          pageEnd: 2
          totalPages: 7
          page: 1
          totalElements: 9
      properties:
        records:
          description: List of extension devices
          items:
            $ref: '#/components/schemas/GetDeviceInfoResponse'
          type: array
        navigation:
          $ref: '#/components/schemas/NavigationInfo'
        paging:
          $ref: '#/components/schemas/PagingInfo'
      required:
      - navigation
      - paging
      - records
      type: object
    CompanyAnsweringRuleCallersInfoRequest:
      example:
        name: name
        callerId: callerId
      properties:
        callerId:
          description: Phone number of a caller
          type: string
        name:
          description: Displayed name for a caller ID
          type: string
      type: object
    ExtensionInfoEvent:
      properties:
        extensionId:
          description: Internal identifier of an extension
          type: string
        eventType:
          description: Type of extension info change
          enum:
          - Update
          - Delete
          type: string
        hints:
          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
          type: array
      type: object
    FavoriteContactResource:
      example:
        contactId: contactId
        id: id
        uri: http://example.com/aeiou
        extensionId: extensionId
      properties:
        uri:
          format: uri
          type: string
        id:
          type: string
        extensionId:
          type: string
        contactId:
          type: string
      type: object
    AuthenticationScheme:
      example:
        documentationUrl: documentationUrl
        name: name
        description: description
        specUrl: specUrl
      properties:
        description:
          type: string
        documentationUrl:
          type: string
        name:
          type: string
        specUrl:
          type: string
      type: object
    VersionInfo:
      example:
        versionString: versionString
        releaseDate: releaseDate
        uriString: uriString
        uri: uri
      properties:
        uri:
          description: Canonical URI of API versions
          type: string
        versionString:
          description: Version of the RingCentral REST API
          type: string
        releaseDate:
          description: Release date of this version
          type: string
        uriString:
          description: URI part determining the current version
          type: string
      type: object
    PostGlipFile:
      example:
        contentUri: contentUri
        name: name
        id: id
      properties:
        id:
          description: Internal identifier of a file
          type: string
        contentUri:
          description: Link to binary content
          type: string
        name:
          description: Name of a file
          type: string
      required:
      - contentUri
      - id
      type: object
    ClientProvisioningHintInfo:
      example:
        expiresIn: 0
        actionRequired: true
      properties:
        expiresIn:
          description: Seconds until expiration date. Returned only if applicable
          type: integer
        actionRequired:
          description: '''False'', if the value of expiresIn is greater than 0 (zero),
            otherwise - ''True'''
          type: boolean
      type: object
    SecretQuestionInfoResource:
      properties:
        uri:
          format: uri
          type: string
        id:
          type: string
        questionType:
          format: int32
          type: integer
        languageId:
          format: int32
          type: integer
        questionText:
          type: string
        showInSignUp:
          default: false
          type: boolean
      type: object
    ExtensionUpdateRequest:
      example:
        reason: reason
        setupWizardState: NotStarted
        statusInfo:
          reason: Voluntarily
          comment: comment
        transition: transition
        ivrPin: ivrPin
        callQueueInfo:
          slaThresholdSeconds: 6
          abandonedThresholdSeconds: 1
          slaGoal: 0
          includeAbandonedCalls: true
        password: password
        extensionNumber: extensionNumber
        contact:
          firstName: firstName
          lastName: lastName
          emailAsLoginName: true
          pronouncedName:
            text: text
            type: Default
          company: company
          businessPhone: businessPhone
          businessAddress:
            zip: zip
            country: country
            city: city
            street: street
            state: state
          department: department
          email: email
        regionalSettings:
          timezone:
            id: id
          timeFormat: timeFormat
          greetingLanguage:
            id: id
          formattingLocale:
            id: id
          language:
            id: id
          homeCountry:
            id: id
        comment: comment
        partnerId: partnerId
        status: Disabled
      properties:
        status:
          enum:
          - Disabled
          - Enabled
          - NotActivated
          type: string
        statusInfo:
          $ref: '#/components/schemas/ExtensionStatusInfo'
        reason:
          description: Type of suspension
          type: string
        comment:
          description: Free Form user comment
          type: string
        extensionNumber:
          description: Extension number available
          type: string
        contact:
          $ref: '#/components/schemas/ContactInfoUpdateRequest'
        regionalSettings:
          $ref: '#/components/schemas/ExtensionRegionalSettingRequest'
        setupWizardState:
          enum:
          - NotStarted
          - Incomplete
          - Completed
          type: string
        partnerId:
          description: ' Extension partner identifier'
          type: string
        ivrPin:
          description: IVR PIN
          type: string
        password:
          description: Password for extension
          type: string
        callQueueInfo:
          $ref: '#/components/schemas/CallQueueInfoRequest'
        transition:
          description: For NotActivated extensions only. Welcome email setting
          type: string
      type: object
    CompanyAnsweringRuleRequest:
      example:
        schedule:
          ref: BusinessHours
          ranges:
            from: 2000-01-23T04:56:07.000+00:00
            to: 2000-01-23T04:56:07.000+00:00
          weeklyRanges:
            sunday:
            - from: from
              to: to
            - from: from
              to: to
            saturday:
            - from: from
              to: to
            - from: from
              to: to
            tuesday:
            - from: from
              to: to
            - from: from
              to: to
            wednesday:
            - from: from
              to: to
            - from: from
              to: to
            thursday:
            - from: from
              to: to
            - from: from
              to: to
            friday:
            - from: from
              to: to
            - from: from
              to: to
            monday:
            - from: from
              to: to
            - from: from
              to: to
        extension:
          name: name
          callerId: callerId
        name: name
        callers:
        - name: name
          callerId: callerId
        - name: name
          callerId: callerId
        greetings:
        - preset:
            name: name
            id: id
            uri: uri
          type: Introductory
          usageType: UserExtensionAnsweringRule
        - preset:
            name: name
            id: id
            uri: uri
          type: Introductory
          usageType: UserExtensionAnsweringRule
        type: BusinessHours
        enabled: true
        callHandlingAction: Operator
        calledNumbers:
        - id: id
        - id: id
      properties:
        name:
          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
          type: string
        enabled:
          default: true
          description: Specifies if the rule is active or inactive. The default value is 'True'
          type: boolean
        type:
          description: Type of an answering rule, the default value is 'Custom' = ['BusinessHours', 'AfterHours', 'Custom']
          enum:
          - BusinessHours
          - AfterHours
          - Custom
          type: string
        callers:
          description: Answering rule will be applied when calls are received from the specified caller(s)
          items:
            $ref: '#/components/schemas/CompanyAnsweringRuleCallersInfoRequest'
          type: array
        calledNumbers:
          description: Answering rule will be applied when calling the specified number(s)
          items:
            $ref: '#/components/schemas/CompanyAnsweringRuleCalledNumberInfo'
          type: array
        schedule:
          $ref: '#/components/schemas/CompanyAnsweringRuleScheduleInfoRequest'
        callHandlingAction:
          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
          type: string
        extension:
          $ref: '#/components/schemas/CompanyAnsweringRuleCallersInfoRequest'
        greetings:
          description: Greetings applied for an answering rule; only predefined greetings can be applied, see Dictionary Greeting List
          items:
            $ref: '#/components/schemas/GreetingInfo'
          type: array
      type: object
    AddressBookSync:
      example:
        nextPageId: 0
        nextPageUri: http://example.com/aeiou
        records:
        - birthday: 2000-01-23T04:56:07.000+00:00
          lastName: lastName
          notes: notes
          jobTitle: jobTitle
          callbackPhone: callbackPhone
          availability: Alive
          carPhone: carPhone
          email3: email3
          email2: email2
          businessPhone2: businessPhone2
          companyPhone: companyPhone
          otherAddress:
            zip: zip
            country: country
            city: city
            street: street
            state: state
          company: company
          id: id
          otherFax: otherFax
          businessAddress:
            zip: zip
            country: country
            city: city
            street: street
            state: state
          email: email
          homeAddress:
            zip: zip
            country: country
            city: city
            street: street
            state: state
          nickName: nickName
          homePhone: homePhone
          webPage: webPage
          homePhone2: homePhone2
          uri: http://example.com/aeiou
          firstName: firstName
          mobilePhone: mobilePhone
          otherPhone: otherPhone
          assistantPhone: assistantPhone
          middleName: middleName
          businessFax: businessFax
          businessPhone: businessPhone
        - birthday: 2000-01-23T04:56:07.000+00:00
          lastName: lastName
          notes: notes
          jobTitle: jobTitle
          callbackPhone: callbackPhone
          availability: Alive
          carPhone: carPhone
          email3: email3
          email2: email2
          businessPhone2: businessPhone2
          companyPhone: companyPhone
          otherAddress:
            zip: zip
            country: country
            city: city
            street: street
            state: state
          company: company
          id: id
          otherFax: otherFax
          businessAddress:
            zip: zip
            country: country
            city: city
            street: street
            state: state
          email: email
          homeAddress:
            zip: zip
            country: country
            city: city
            street: street
            state: state
          nickName: nickName
          homePhone: homePhone
          webPage: webPage
          homePhone2: homePhone2
          uri: http://example.com/aeiou
          firstName: firstName
          mobilePhone: mobilePhone
          otherPhone: otherPhone
          assistantPhone: assistantPhone
          middleName: middleName
          businessFax: businessFax
          businessPhone: businessPhone
        uri: http://example.com/aeiou
        syncInfo:
          syncTime: 2000-01-23T04:56:07.000+00:00
          olderRecordsExist: false
          syncToken: syncToken
          syncType: FSync
      properties:
        uri:
          format: uri
          type: string
        records:
          items:
            $ref: '#/components/schemas/PersonalContactResource'
          type: array
        syncInfo:
          $ref: '#/components/schemas/SyncInfo'
        nextPageId:
          format: int64
          type: integer
        nextPageUri:
          format: uri
          type: string
      type: object
    SecurityContext:
      properties:
        userPrincipal:
          $ref: '#/components/schemas/Principal'
        secure:
          default: false
          type: boolean
        authenticationScheme:
          type: string
      type: object
    EditGroupRequest:
      example:
        addedPersonIds:
        - addedPersonIds
        - addedPersonIds
        addedPersonEmails:
        - addedPersonEmails
        - addedPersonEmails
        removedPersonIds:
        - removedPersonIds
        - removedPersonIds
      properties:
        addedPersonIds:
          description: List of users to be added to the team
          items:
            type: string
          type: array
        addedPersonEmails:
          description: List of user email addresses to be added to the team (i.e. as guests)
          items:
            type: string
          type: array
        removedPersonIds:
          description: List of users to be removed from the team
          items:
            type: string
          type: array
      type: object
    SyncCallLogRecords:
      properties:
        uri:
          format: uri
          type: string
        records:
          items:
            $ref: '#/components/schemas/CallLogRecordResource'
          type: array
        syncInfo:
          $ref: '#/components/schemas/SyncInfo'
      type: object
    GetTimezoneInfoResponse:
      example:
        name: name
        description: description
        id: id
        uri: uri
      properties:
        id:
          description: Internal identifier of a timezone
          type: string
        uri:
          description: Canonical URI of the timezone
          type: string
        name:
          description: Short name of the timezone
          type: string
        description:
          description: Description of the timezone
          type: string
      type: object
    DefaultUserRoleRequest:
      example:
        id: id
      properties:
        id:
          description: Internal identifier of a user role to be set as default, see User Role List
          type: string
      type: object
    MissedCallsInfo:
      example:
        notifyBySms: true
        notifyByEmail: true
        advancedEmailAddresses:
        - advancedEmailAddresses
        - advancedEmailAddresses
        advancedSmsEmailAddresses:
        - advancedSmsEmailAddresses
        - advancedSmsEmailAddresses
      properties:
        notifyByEmail:
          description: Email notification flag
          type: boolean
        notifyBySms:
          description: SMS notification flag
          type: boolean
        advancedEmailAddresses:
          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
          type: array
        advancedSmsEmailAddresses:
          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
          type: array
      type: object
    SchedulesInfoReporting:
      example:
        recurrence:
        - pattern: Daily
          value: "0"
        - pattern: Daily
          value: "0"
        attachments:
        - pdf: true
          csv: true
        - pdf: true
          csv: true
        pages:
        - pages
        - pages
        recipients:
        - recipients
        - recipients
        viewType: Detailed
        scheduleId: scheduleId
      properties:
        scheduleId:
          description: Unique schedule identifier
          type: string
        recurrence:
          description: Recurrence pattern of a schedule
          items:
            $ref: '#/components/schemas/RecurrenceInfoReporting'
          type: array
        viewType:
          description: Type of report. Detailed reports include tables with data. Simple reports only include charts
          enum:
          - Detailed
          - Simple
          type: string
        attachments:
          description: Set of optional attachments. Basically, every report email is in HTML format. Optionally, it can contain PDF or CSV files
          items:
            $ref: '#/components/schemas/AttachmentInfoReporting'
          type: array
        pages:
          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
          type: array
        recipients:
          description: List of emails to which to send rendered reports
          items:
            type: string
          type: array
      type: object
    IVRMenuExtensionInfo:
      example:
        id: id
        uri: uri
      properties:
        uri:
          description: Link to an extension resource
          type: string
        id:
          description: Internal identifier of an extension
          type: string
      type: object
    RingOutPhoneNumberInfo:
      example:
        phoneNumber: phoneNumber
      properties:
        phoneNumber:
          type: string
      type: object
    BlockedNumbersList:
      example:
        navigation:
          previousPage:
            uri: uri
          firstPage:
            uri: uri
          lastPage:
            uri: uri
          nextPage:
            uri: uri
        records:
        - phoneNumber: phoneNumber
          name: name
          id: id
          uri: uri
        - phoneNumber: phoneNumber
          name: name
          id: id
          uri: uri
        paging:
          perPage: 5
          pageStart: 5
          pageEnd: 2
          totalPages: 7
          page: 1
          totalElements: 9
      properties:
        records:
          description: List of blocked phone numbers
          items:
            $ref: '#/components/schemas/BlockedNumberInfo'
          type: array
        navigation:
          $ref: '#/components/schemas/NavigationInfo'
        paging:
          $ref: '#/components/schemas/PagingInfo'
      type: object
    UnconditionalForwardingResource:
      properties:
        phoneNumber:
          type: string
      type: object
    Feature:
      properties:
        enabled:
          default: false
          type: boolean
        reason:
          $ref: '#/components/schemas/Reason'
      type: object
    HintResource:
      properties:
        expiresIn:
          format: int64
          type: integer
        actionRequired:
          default: false
          type: boolean
        messageUri:
          type: string
      type: object
    DeviceInfoRequest:
      example:
        computerName: computerName
        appExternalId: appExternalId
        id: id
      properties:
        id:
          description: Device unique identifier, retrieved on previous session (if any)
          type: string
        appExternalId:
          description: For iOS devices only Certificate name (used by iOS applications for APNS subscription)
          type: string
        computerName:
          description: For SoftPhone only Computer name
          type: string
      type: object
    UpdatePresenceLinesResponse:
      example:
        navigation:
          previousPage:
            uri: uri
          firstPage:
            uri: uri
          lastPage:
            uri: uri
          nextPage:
            uri: uri
        records:
        - extension:
            extensionNumber: extensionNumber
            id: id
            type: User
            uri: uri
          id: id
          uri: uri
        - extension:
            extensionNumber: extensionNumber
            id: id
            type: User
            uri: uri
          id: id
          uri: uri
        paging:
          perPage: 5
          pageStart: 5
          pageEnd: 2
          totalPages: 7
          page: 1
          totalElements: 9
        uri: uri
      properties:
        uri:
          description: Canonical URI of the monitored lines (extensions) resource
          type: string
        records:
          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: '#/components/schemas/LineInfo'
          type: array
        navigation:
          $ref: '#/components/schemas/NavigationInfo'
        paging:
          $ref: '#/components/schemas/PagingInfo'
      type: object
    UserBusinessHoursScheduleInfo:
      example:
        weeklyRanges:
          sunday:
          - from: 2000-01-23T04:56:07.000+00:00
            to: 2000-01-23T04:56:07.000+00:00
          - from: 2000-01-23T04:56:07.000+00:00
            to: 2000-01-23T04:56:07.000+00:00
          saturday:
          - from: 2000-01-23T04:56:07.000+00:00
            to: 2000-01-23T04:56:07.000+00:00
          - from: 2000-01-23T04:56:07.000+00:00
            to: 2000-01-23T04:56:07.000+00:00
          tuesday:
          - from: 2000-01-23T04:56:07.000+00:00
            to: 2000-01-23T04:56:07.000+00:00
          - from: 2000-01-23T04:56:07.000+00:00
            to: 2000-01-23T04:56:07.000+00:00
          wednesday:
          - from: 2000-01-23T04:56:07.000+00:00
            to: 2000-01-23T04:56:07.000+00:00
          - from: 2000-01-23T04:56:07.000+00:00
            to: 2000-01-23T04:56:07.000+00:00
          thursday:
          - from: 2000-01-23T04:56:07.000+00:00
            to: 2000-01-23T04:56:07.000+00:00
          - from: 2000-01-23T04:56:07.000+00:00
            to: 2000-01-23T04:56:07.000+00:00
          friday:
          - from: 2000-01-23T04:56:07.000+00:00
            to: 2000-01-23T04:56:07.000+00:00
          - from: 2000-01-23T04:56:07.000+00:00
            to: 2000-01-23T04:56:07.000+00:00
          monday:
          - from: 2000-01-23T04:56:07.000+00:00
            to: 2000-01-23T04:56:07.000+00:00
          - from: 2000-01-23T04:56:07.000+00:00
            to: 2000-01-23T04:56:07.000+00:00
      properties:
        weeklyRanges:
          $ref: '#/components/schemas/WeeklyScheduleInfo'
      type: object
    ConferencingInfoResource:
      properties:
        uri:
          format: uri
          type: string
        phoneNumber:
          type: string
        hostCode:
          type: string
        participantCode:
          type: string
        allowJoinBeforeHost:
          default: false
          type: boolean
        tapToJoinUri:
          type: string
        supportUri:
          type: string
        mode:
          enum:
          - FCC
          - RCC
          type: string
        phoneNumbers:
          items:
            $ref: '#/components/schemas/ConferencingNumberResource'
          type: array
      type: object
    PagingInfo:
      example:
        perPage: 5
        pageStart: 5
        pageEnd: 2
        totalPages: 7
        page: 1
        totalElements: 9
      properties:
        page:
          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)
          type: integer
        perPage:
          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
          type: integer
        pageStart:
          description: The zero-based number of the first element on the current page. Omitted if the page is omitted or result is empty
          type: integer
        pageEnd:
          description: The zero-based index of the last element on the current page. Omitted if the page is omitted or result is empty
          type: integer
        totalPages:
          description: The total number of pages in a dataset. May be omitted for some resources due to performance reasons
          type: integer
        totalElements:
          description: The total number of elements in a dataset. May be omitted for some resource due to performance reasons
          type: integer
      type: object
    ErrorEntity:
      example:
        errorCode: errorCode
        message: message
      properties:
        errorCode:
          type: string
        message:
          type: string
      type: object
    CustomCompanyGreetingAnsweringRuleInfo:
      example:
        id: id
      properties:
        id:
          description: Internal identifier of an answering rule
          type: string
      type: object
    SyncInfo:
      example:
        syncTime: 2000-01-23T04:56:07.000+00:00
        olderRecordsExist: false
        syncToken: syncToken
        syncType: FSync
      properties:
        syncType:
          enum:
          - FSync
          - ISync
          type: string
        syncToken:
          type: string
        syncTime:
          format: date-time
          type: string
        olderRecordsExist:
          default: false
          type: boolean
      type: object
    Currency:
      example:
        symbol: symbol
        code: code
        minorSymbol: minorSymbol
        name: name
        id: id
      properties:
        id:
          type: string
        code:
          type: string
        name:
          type: string
        symbol:
          type: string
        minorSymbol:
          type: string
      type: object
    Permission:
      example:
        enabled: false
      properties:
        enabled:
          default: false
          type: boolean
      type: object
    ForwardingInfoCreateRuleRequest:
      properties:
        notifyMySoftPhones:
          description: Specifies if the first ring on desktop/mobile apps is enabled. The default value is 'True'
          type: boolean
        notifyAdminSoftPhones:
          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'
          type: boolean
        softPhonesRingCount:
          description: Specifies delay between ring on apps and starting of a call forwarding. The default value is 1
          type: integer
        ringingMode:
          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
          type: string
        rules:
          description: Information on a call forwarding rule
          items:
            $ref: '#/components/schemas/RuleInfoCreateRuleRequest'
          type: array
      type: object
    MediaType:
      properties:
        type:
          type: string
        subtype:
          type: string
        wildcardType:
          default: false
          type: boolean
        wildcardSubtype:
          default: false
          type: boolean
      type: object
    GetServiceInfoResponse:
      example:
        servicePlanName: servicePlanName
        serviceFeatures:
        - featureName: featureName
          enabled: true
        - featureName: featureName
          enabled: true
        uri: uri
        limits:
          freeSoftPhoneLinesPerExtension: 0
          meetingSize: 6
          maxMonitoredExtensionsPerUser: 1
          maxExtensionNumberLength: 5
      properties:
        uri:
          description: Canonical URI of the account Service Info resource
          type: string
        servicePlanName:
          description: Account Service Plan name
          type: string
        serviceFeatures:
          description: Service features information, see Service Feature List
          items:
            $ref: '#/components/schemas/ServiceFeatureInfo'
          type: array
        limits:
          $ref: '#/components/schemas/AccountLimits'
      type: object
    FixedOrderAgents:
      example:
        extension:
          extensionNumber: extensionNumber
          id: id
          partnerId: partnerId
          uri: uri
        index: 5
      properties:
        extension:
          $ref: '#/components/schemas/ExtensionInfo'
        index:
          description: Ordinal of an agent (call queue member)
          type: integer
      type: object
    CallerIdPhoneInfo:
      example:
        phoneNumber: phoneNumber
        id: id
        uri: uri
      properties:
        id:
          description: Internal identifier of a phone number
          type: string
        uri:
          description: Link to a phone number resource
          type: string
        phoneNumber:
          description: Phone number in E.164 (with '+' sign) format
          type: string
      type: object
    Cookie:
      properties:
        name:
          type: string
        value:
          type: string
        version:
          format: int32
          type: integer
        path:
          type: string
        domain:
          type: string
      type: object
    DetailedExtensionPresenceWithSIPEvent:
      properties:
        extensionId:
          default: ~
          description: Internal identifier of an extension. Optional parameter
          type: string
        telephonyStatus:
          description: Telephony presence status. Returned if telephony status is changed.
          enum:
          - NoCall
          - CallConnected
          - Ringing
          - OnHold
          - ParkedCall
          type: string
        activeCalls:
          description: Collection of Active Call Info
          items:
            $ref: '#/components/schemas/ActiveCallInfo'
          type: array
        sequence:
          description: Order number of a notification to state the chronology
          type: integer
        presenceStatus:
          description: Aggregated presence status, calculated from a number of sources
          enum:
          - Offline
          - Busy
          - Available
          type: string
        userStatus:
          description: User-defined presence status (as previously published by the user)
          enum:
          - Offline
          - Busy
          - Available
          type: string
        dndStatus:
          description: Extended DnD (Do not Disturb) status
          enum:
          - TakeAllCalls
          - DoNotAcceptAnyCalls
          - DoNotAcceptDepartmentCalls
          - TakeDepartmentCallsOnly
          type: string
        allowSeeMyPresence:
          description: If 'True' enables other extensions to see the extension presence status
          type: boolean
        ringOnMonitoredCall:
          description: If 'True' enables to ring extension phone, if any user monitored by this extension is ringing
          type: boolean
        pickUpCallsOnHold:
          description: If 'True' enables the extension user to pick up a monitored line on hold
          type: boolean
      type: object
    TargetServicePlanInfo:
      example:
        name: name
        id: id
      properties:
        id:
          description: Internal identifier of a target service plan
          type: string
        name:
          description: Name of a target service plan
          type: string
      type: object
    GetMessageList:
      example:
        navigation:
          previousPage:
            uri: uri
          firstPage:
            uri: uri
          lastPage:
            uri: uri
          nextPage:
            uri: uri
        records:
        - readStatus: Read
          faxResolution: High
          attachments:
          - filename: filename
            size: 5
            vmDuration: 1
            id: 6
            type: AudioRecording
            uri: uri
            contentType: contentType
          - filename: filename
            size: 5
            vmDuration: 1
            id: 6
            type: AudioRecording
            uri: uri
            contentType: contentType
          lastModifiedTime: 2000-01-23T04:56:07.000+00:00
          creationTime: 2000-01-23T04:56:07.000+00:00
          conversationId: 5
          deliveryErrorCode: deliveryErrorCode
          subject: subject
          vmTranscriptionStatus: NotAvailable
          availability: Alive
          priority: Normal
          type: Fax
          uri: uri
          messageStatus: Queued
          faxPageCount: 2
          smsSendingAttemptsCount: 7
          smsDeliveryTime: 2000-01-23T04:56:07.000+00:00
          pgToDepartment: true
          from:
            messageStatus: Queued
            faxErrorCode: Undefined
            phoneNumber: phoneNumber
            extensionNumber: extensionNumber
            name: name
            location: location
          id: 0
          to:
          - messageStatus: Queued
            faxErrorCode: Undefined
            phoneNumber: phoneNumber
            extensionNumber: extensionNumber
            name: name
            location: location
          - messageStatus: Queued
            faxErrorCode: Undefined
            phoneNumber: phoneNumber
            extensionNumber: extensionNumber
            name: name
            location: location
          direction: Inbound
        - readStatus: Read
          faxResolution: High
          attachments:
          - filename: filename
            size: 5
            vmDuration: 1
            id: 6
            type: AudioRecording
            uri: uri
            contentType: contentType
          - filename: filename
            size: 5
            vmDuration: 1
            id: 6
            type: AudioRecording
            uri: uri
            contentType: contentType
          lastModifiedTime: 2000-01-23T04:56:07.000+00:00
          creationTime: 2000-01-23T04:56:07.000+00:00
          conversationId: 5
          deliveryErrorCode: deliveryErrorCode
          subject: subject
          vmTranscriptionStatus: NotAvailable
          availability: Alive
          priority: Normal
          type: Fax
          uri: uri
          messageStatus: Queued
          faxPageCount: 2
          smsSendingAttemptsCount: 7
          smsDeliveryTime: 2000-01-23T04:56:07.000+00:00
          pgToDepartment: true
          from:
            messageStatus: Queued
            faxErrorCode: Undefined
            phoneNumber: phoneNumber
            extensionNumber: extensionNumber
            name: name
            location: location
          id: 0
          to:
          - messageStatus: Queued
            faxErrorCode: Undefined
            phoneNumber: phoneNumber
            extensionNumber: extensionNumber
            name: name
            location: location
          - messageStatus: Queued
            faxErrorCode: Undefined
            phoneNumber: phoneNumber
            extensionNumber: extensionNumber
            name: name
            location: location
          direction: Inbound
        paging:
          perPage: 5
          pageStart: 5
          pageEnd: 2
          totalPages: 7
          page: 1
          totalElements: 9
      properties:
        records:
          description: List of records with message information
          items:
            $ref: '#/components/schemas/GetMessageInfoResponseIntId'
          type: array
        navigation:
          $ref: '#/components/schemas/NavigationInfo'
        paging:
          $ref: '#/components/schemas/PagingInfo'
      required:
      - navigation
      - paging
      - records
      type: object
    ExtensionRegionalSettingRequest:
      example:
        timezone:
          id: id
        timeFormat: timeFormat
        greetingLanguage:
          id: id
        formattingLocale:
          id: id
        language:
          id: id
        homeCountry:
          id: id
      properties:
        homeCountry:
          $ref: '#/components/schemas/ExtensionCountryInfoRequest'
        timezone:
          $ref: '#/components/schemas/ExtensionTimezoneInfoRequest'
        language:
          $ref: '#/components/schemas/ExtensionLanguageInfoRequest'
        greetingLanguage:
          $ref: '#/components/schemas/ExtensionGreetingLanguageInfoRequest'
        formattingLocale:
          $ref: '#/components/schemas/ExtensionFormattingLocaleInfoRequest'
        timeFormat:
          description: Time format setting. The default value is '12h' = ['12h', '24h']
          type: string
      type: object
    GetCountryInfoConferencing:
      example:
        callingCode: callingCode
        emergencyCalling: true
        isoCode: isoCode
        name: name
        id: id
        uri: uri
      properties:
        id:
          description: Internal identifier of a country
          type: string
        uri:
          description: Canonical URI of a country
          type: string
        callingCode:
          description: Country calling code defined by ITU-T recommendations E.123 and E.164, see Calling Codes
          type: string
        emergencyCalling:
          description: Emergency calling feature availability/emergency address requirement indicator
          type: boolean
        isoCode:
          description: Country code according to the ISO standard, see ISO 3166
          type: string
        name:
          description: Official name of a country
          type: string
      type: object
    CountryInfo:
      example:
        name: name
        id: id
        uri: uri
      properties:
        id:
          description: Internal identifier of a home country
          type: string
        uri:
          description: Canonical URI of a home country
          type: string
        name:
          description: Official name of a home country
          type: string
      type: object
    NotificationSettings:
      example:
        advancedMode: true
        emailAddresses:
        - emailAddresses
        - emailAddresses
        outboundFaxes:
          notifyBySms: true
          notifyByEmail: true
          advancedEmailAddresses:
          - advancedEmailAddresses
          - advancedEmailAddresses
          advancedSmsEmailAddresses:
          - advancedSmsEmailAddresses
          - advancedSmsEmailAddresses
        missedCalls:
          notifyBySms: true
          notifyByEmail: true
          advancedEmailAddresses:
          - advancedEmailAddresses
          - advancedEmailAddresses
          advancedSmsEmailAddresses:
          - advancedSmsEmailAddresses
          - advancedSmsEmailAddresses
        smsEmailAddresses:
        - smsEmailAddresses
        - smsEmailAddresses
        voicemails:
          notifyBySms: true
          includeAttachment: true
          notifyByEmail: true
          advancedEmailAddresses:
          - advancedEmailAddresses
          - advancedEmailAddresses
          advancedSmsEmailAddresses:
          - advancedSmsEmailAddresses
          - advancedSmsEmailAddresses
          markAsRead: true
        inboundTexts:
          notifyBySms: true
          notifyByEmail: true
          advancedEmailAddresses:
          - advancedEmailAddresses
          - advancedEmailAddresses
          advancedSmsEmailAddresses:
          - advancedSmsEmailAddresses
          - advancedSmsEmailAddresses
        inboundFaxes:
          notifyBySms: true
          includeAttachment: true
          notifyByEmail: true
          advancedEmailAddresses:
          - advancedEmailAddresses
          - advancedEmailAddresses
          advancedSmsEmailAddresses:
          - advancedSmsEmailAddresses
          - advancedSmsEmailAddresses
          markAsRead: true
        uri: uri
      properties:
        uri:
          description: Canonical URI of notifications settings resource
          type: string
        emailAddresses:
          description: List of notification recipient email addresses
          items:
            type: string
          type: array
        smsEmailAddresses:
          description: List of notification recipient email addresses
          items:
            type: string
          type: array
        advancedMode:
          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
          type: boolean
        voicemails:
          $ref: '#/components/schemas/VoicemailsInfo'
        inboundFaxes:
          $ref: '#/components/schemas/InboundFaxesInfo'
        outboundFaxes:
          $ref: '#/components/schemas/OutboundFaxesInfo'
        inboundTexts:
          $ref: '#/components/schemas/InboundTextsInfo'
        missedCalls:
          $ref: '#/components/schemas/MissedCallsInfo'
      type: object
    BillingPlanInfo:
      example:
        duration: duration
        name: name
        id: id
        durationUnit: Month
        type: Initial
      properties:
        id:
          description: Internal identifier of a billing plan
          type: string
        name:
          description: Billing plan name
          type: string
        durationUnit:
          description: Duration period
          enum:
          - Month
          - Day
          type: string
        duration:
          description: Number of duration units
          type: string
        type:
          description: Billing plan type
          enum:
          - Initial
          - Regular
          - Suspended
          - Trial
          - TrialNoCC
          - Free
          type: string
      type: object
    GroupResource:
      properties:
        uri:
          format: uri
          type: string
        contacts:
          $ref: '#/components/schemas/ResourceLink'
        id:
          type: string
        notes:
          type: string
        groupName:
          type: string
        contactsCount:
          format: int32
          type: integer
      type: object
    ForwardingNumberInfoRulesCreateRuleRequest:
      properties:
        id:
          description: Internal identifier of a forwarding number
          type: string
      type: object
    UpdateAccountRequest:
      example:
        statusInfo:
          reason: Voluntarily
          till: till
          comment: comment
        regionalSettings:
          timezone:
            name: name
            description: description
            id: id
            uri: uri
          timeFormat: 12h
          greetingLanguage:
            localeCode: localeCode
            name: name
            id: id
          formattingLocale:
            localeCode: localeCode
            name: name
            id: id
          language:
            localeCode: localeCode
            ui: true
            greeting: true
            name: name
            formattingLocale: true
            id: id
            uri: uri
          homeCountry:
            name: name
            id: id
            uri: uri
        serviceInfo:
          servicePlanName: servicePlanName
          servicePlan:
            name: name
            edition: edition
            id: id
          serviceFeatures:
          - featureName: featureName
            enabled: true
          - featureName: featureName
            enabled: true
          billingPlan:
            duration: duration
            name: name
            id: id
            durationUnit: Month
            type: Initial
          uri: uri
          brand:
            name: name
            id: id
            homeCountry:
              name: name
              id: id
              uri: uri
          limits:
            freeSoftPhoneLinesPerExtension: 0
            meetingSize: 6
            maxMonitoredExtensionsPerUser: 1
            maxExtensionNumberLength: 5
        partnerId: partnerId
        operatorId: operatorId
        transitionInfo:
          sendConfirmationEmail: true
          activationEmailHash: activationEmailHash
          sendWelcomeEmail: true
          shipDevices: true
        status: Unconfirmed
        signupInfo:
          tosAccepted: false
          signupState:
          - AccountCreated
          - AccountCreated
          verificationReason: CC_Failed
      properties:
        status:
          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
          type: string
        statusInfo:
          $ref: '#/components/schemas/AccountStatusInfo'
        transitionInfo:
          $ref: '#/components/schemas/TransitionInfo'
        partnerId:
          description: Additional account identifier, developed and applied on the client side
          type: string
        serviceInfo:
          $ref: '#/components/schemas/AccountServiceInfo'
        regionalSettings:
          $ref: '#/components/schemas/RegionalSettings'
        operatorId:
          description: Identifier of extension to be set as operator for account
          type: string
        signupInfo:
          $ref: '#/components/schemas/SignupInfoResource'
      type: object
    ParameterizedHeader:
      properties:
        value:
          type: string
      type: object
    SessionResource:
      properties:
        uri:
          format: uri
          type: string
        id:
          type: string
        accountId:
          type: string
        extensionId:
          type: string
        creationTime:
          format: date-time
          type: string
        clientId:
          type: string
        application:
          $ref: '#/components/schemas/ApplicationResource'
      type: object
    MonitoringExtensionResource:
      example:
        extensionNumber: extensionNumber
        id: id
        uri: http://example.com/aeiou
      properties:
        uri:
          format: uri
          type: string
        id:
          type: string
        extensionNumber:
          type: string
      type: object
    GetMessageInfoResponse:
      example:
        readStatus: Read
        faxResolution: High
        attachments:
        - filename: filename
          size: 6
          vmDuration: 0
          id: id
          type: AudioRecording
          uri: uri
          contentType: contentType
        - filename: filename
          size: 6
          vmDuration: 0
          id: id
          type: AudioRecording
          uri: uri
          contentType: contentType
        lastModifiedTime: 2000-01-23T04:56:07.000+00:00
        creationTime: 2000-01-23T04:56:07.000+00:00
        conversationId: 1
        deliveryErrorCode: deliveryErrorCode
        subject: subject
        vmTranscriptionStatus: NotAvailable
        availability: Alive
        priority: Normal
        type: Fax
        uri: uri
        messageStatus: Queued
        faxPageCount: 5
        smsSendingAttemptsCount: 5
        smsDeliveryTime: 2000-01-23T04:56:07.000+00:00
        pgToDepartment: true
        from:
          messageStatus: Queued
          faxErrorCode: Undefined
          phoneNumber: phoneNumber
          extensionNumber: extensionNumber
          name: name
          location: location
        id: id
        to:
        - messageStatus: Queued
          faxErrorCode: Undefined
          phoneNumber: phoneNumber
          extensionNumber: extensionNumber
          name: name
          location: location
        - messageStatus: Queued
          faxErrorCode: Undefined
          phoneNumber: phoneNumber
          extensionNumber: extensionNumber
          name: name
          location: location
        direction: Inbound
      properties:
        id:
          description: Internal identifier of a message
          type: string
        uri:
          description: Canonical URI of a message
          type: string
        attachments:
          description: The list of message attachments
          items:
            $ref: '#/components/schemas/MessageAttachmentInfo'
          type: array
        availability:
          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
          type: string
        conversationId:
          description: SMS and Pager only. Identifier of the conversation the message belongs to
          type: integer
        creationTime:
          description: Message creation datetime in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z
          format: date-time
          type: string
        deliveryErrorCode:
          description: SMS only. Delivery error code returned by gateway
          type: string
        direction:
          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
          type: string
        faxPageCount:
          description: Fax only. Page count in fax message
          type: integer
        faxResolution:
          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
          type: string
        from:
          $ref: '#/components/schemas/MessageStoreCallerInfoResponse'
        lastModifiedTime:
          description: The datetime when the message was modified on server in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z
          format: date-time
          type: string
        messageStatus:
          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
          type: string
        pgToDepartment:
          description: Pager only True if at least one of the message recipients is Department extension
          type: boolean
        priority:
          description: Message priority
          enum:
          - Normal
          - High
          type: string
        readStatus:
          description: Message read status
          enum:
          - Read
          - Unread
          type: string
        smsDeliveryTime:
          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
          format: date-time
          type: string
        smsSendingAttemptsCount:
          description: SMS only. Number of attempts made to send an outbound SMS to the gateway (if gateway is temporary unavailable)
          type: integer
        subject:
          description: Message subject. For SMS and Pager messages it replicates message text which is also returned as an attachment
          type: string
        to:
          description: Recipient information
          items:
            $ref: '#/components/schemas/MessageStoreCallerInfoResponse'
          type: array
        type:
          description: Message type
          enum:
          - Fax
          - SMS
          - VoiceMail
          - Pager
          - Text
          type: string
        vmTranscriptionStatus:
          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
          type: string
      type: object
    PresenceExtensionInfo:
      example:
        id: id
      properties:
        id:
          type: string
      type: object
    OptionInfo:
      properties:
        enabled:
          description: Specifies if the feature is allowed ('True') or disallowed ('False') for the special number
          type: boolean
        reason:
          $ref: '#/components/schemas/OptionInfoReason'
      required:
      - reason
      type: object
    ReportingRecurrenceInfo:
      example:
        pattern: Daily
        value: "0"
      properties:
        pattern:
          description: Pattern (frequency) of recurrence
          enum:
          - Daily
          - Weekly
          - Monthly
          type: string
        value:
          description: Time and dates should be specified in UTC time zone
          enum:
          - "0"
          - 1-7
          - 1-31
          - last
          type: string
      type: object
    PersonalContactResource:
      example:
        birthday: 2000-01-23T04:56:07.000+00:00
        lastName: lastName
        notes: notes
        jobTitle: jobTitle
        callbackPhone: callbackPhone
        availability: Alive
        carPhone: carPhone
        email3: email3
        email2: email2
        businessPhone2: businessPhone2
        companyPhone: companyPhone
        otherAddress:
          zip: zip
          country: country
          city: city
          street: street
          state: state
        company: company
        id: id
        otherFax: otherFax
        businessAddress:
          zip: zip
          country: country
          city: city
          street: street
          state: state
        email: email
        homeAddress:
          zip: zip
          country: country
          city: city
          street: street
          state: state
        nickName: nickName
        homePhone: homePhone
        webPage: webPage
        homePhone2: homePhone2
        uri: http://example.com/aeiou
        firstName: firstName
        mobilePhone: mobilePhone
        otherPhone: otherPhone
        assistantPhone: assistantPhone
        middleName: middleName
        businessFax: businessFax
        businessPhone: businessPhone
      properties:
        uri:
          format: uri
          type: string
        availability:
          enum:
          - Alive
          - Deleted
          - Purged
          type: string
        id:
          type: string
        firstName:
          type: string
        lastName:
          type: string
        middleName:
          type: string
        birthday:
          format: date-time
          type: string
        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: '#/components/schemas/ContactAddressInfo'
        otherAddress:
          $ref: '#/components/schemas/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: '#/components/schemas/ContactAddressInfo'
        assistantPhone:
          type: string
        businessPhone2:
          type: string
      type: object
    IncomingCallInformationResource:
      properties:
        uri:
          format: uri
          type: string
        announcementWhenDirectCalls:
          enum:
          - Never
          - Always
          - NonRingCentral
          type: string
        announcementWhenDepartmentCalls:
          enum:
          - Always
          - NonRingCentral
          type: string
      type: object
    CustomGreetingRequest:
      example:
        answeringRule:
          id: id
        type: Introductory
      properties:
        type:
          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
          type: string
        answeringRule:
          $ref: '#/components/schemas/CustomGreetingAnsweringRuleInfoRequest'
      type: object
    ParkLocationResponse:
      example:
        navigation:
          previousPage:
            uri: uri
          firstPage:
            uri: uri
          lastPage:
            uri: uri
          nextPage:
            uri: uri
        records:
        - extensionNumber: extensionNumber
          id: id
          partnerId: partnerId
          uri: uri
        - extensionNumber: extensionNumber
          id: id
          partnerId: partnerId
          uri: uri
        paging:
          perPage: 5
          pageStart: 5
          pageEnd: 2
          totalPages: 7
          page: 1
          totalElements: 9
      properties:
        records:
          description: List of user extensions allowed to park and unpark calls to/from the extension specified
          items:
            $ref: '#/components/schemas/ExtensionInfo'
          type: array
        navigation:
          $ref: '#/components/schemas/NavigationInfo'
        paging:
          $ref: '#/components/schemas/PagingInfo'
      type: object
    AddressFormResource:
      properties:
        uri:
          format: uri
          type: string
        records:
          items:
            $ref: '#/components/schemas/AddressFormCountryResource'
          type: array
      type: object
    PathPattern:
      properties:
        regex:
          type: string
        groupIndexes:
          items:
            format: int32
            type: integer
          type: array
        template:
          $ref: '#/components/schemas/UriTemplate'
      type: object
    CustomDataAttachmentInfo:
      example:
        uri: uri
        contentType: contentType
      properties:
        uri:
          description: Link to custom data attachment
          type: string
        contentType:
          description: Type of custom data attachment, see also MIME Types
          type: string
      required:
      - contentType
      - uri
      type: object
    SyncInfoMessages:
      example:
        syncTime: 2000-01-23T04:56:07.000+00:00
        syncToken: syncToken
        syncType: FSync
      properties:
        syncType:
          description: Type of synchronization
          enum:
          - FSync
          - ISync
          type: string
        syncToken:
          description: Synchronization token
          type: string
        syncTime:
          description: Last synchronization datetime in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z
          format: date-time
          type: string
      type: object
    FormFieldResource:
      properties:
        name:
          type: string
        fieldType:
          type: string
        description:
          type: string
        maxLength:
          format: int32
          type: integer
      type: object
    GetTimezoneListResponse:
      example:
        navigation:
          previousPage:
            uri: uri
          firstPage:
            uri: uri
          lastPage:
            uri: uri
          nextPage:
            uri: uri
        records:
        - name: name
          description: description
          id: id
          uri: uri
        - name: name
          description: description
          id: id
          uri: uri
        paging:
          perPage: 5
          pageStart: 5
          pageEnd: 2
          totalPages: 7
          page: 1
          totalElements: 9
      properties:
        records:
          description: List of timezones
          items:
            $ref: '#/components/schemas/GetTimezoneInfoResponse'
          type: array
        navigation:
          $ref: '#/components/schemas/NavigationInfo'
        paging:
          $ref: '#/components/schemas/PagingInfo'
      required:
      - navigation
      - paging
      - records
      type: object
    UserUpdateRequest:
      example:
        emails:
        - type: work
          value: value
        - type: work
          value: value
        addresses:
        - country: country
          streetAddress: streetAddress
          postalCode: postalCode
          locality: locality
          region: region
          type: work
        - country: country
          streetAddress: streetAddress
          postalCode: postalCode
          locality: locality
          region: region
          type: work
        schemas:
        - schemas
        - schemas
        name:
          givenName: givenName
          familyName: familyName
        active: false
        externalId: externalId
        id: id
        userName: userName
        photos:
        - type: photo
          value: value
        - type: photo
          value: value
        phoneNumbers:
        - type: work
          value: value
        - type: work
          value: value
        urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:
          department: department
      properties:
        active:
          default: false
          description: Status of a user
          type: boolean
        addresses:
          description: User addresses
          items:
            $ref: '#/components/schemas/AddressInfo'
          type: array
        emails:
          description: User email addresses
          items:
            $ref: '#/components/schemas/EmailInfo'
          type: array
        externalId:
          description: External identifier of a user
          type: string
        id:
          description: Internal identifier of a user
          type: string
        name:
          $ref: '#/components/schemas/NameInfo'
        phoneNumbers:
          description: User phone numbers
          items:
            $ref: '#/components/schemas/PhoneNumberInfoRequest'
          type: array
        photos:
          items:
            $ref: '#/components/schemas/PhotoInfo'
          type: array
        schemas:
          description: Specification links
          items:
            type: string
          type: array
        urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:
          $ref: '#/components/schemas/EnterpriseUser'
        userName:
          description: User mailbox. Must be same as work type email address
          type: string
      required:
      - emails
      - name
      - schemas
      - userName
      type: object
    ExtensionStatusInfo:
      example:
        reason: Voluntarily
        comment: comment
      properties:
        comment:
          description: A free-form user comment, describing the status change reason
          type: string
        reason:
          description: Type of suspension
          enum:
          - Voluntarily
          - Involuntarily
          type: string
      type: object
    GlipPosts:
      example:
        navigation:
          prevPageToken: prevPageToken
          nextPageToken: nextPageToken
        records:
        - lastModifiedTime: 2000-01-23T04:56:07.000+00:00
          attachments:
          - imageUri: imageUri
            color: color
            author:
              name: name
              uri: uri
              iconUri: iconUri
            intro: intro
            id: id
            text: text
            footnote:
              text: text
              time: 2000-01-23T04:56:07.000+00:00
              iconUri: iconUri
            type: Card
            title: title
            thumbnailUri: thumbnailUri
            fields:
            - style: Short
              title: title
              value: value
            - style: Short
              title: title
              value: value
            fallback: fallback
          - imageUri: imageUri
            color: color
            author:
              name: name
              uri: uri
              iconUri: iconUri
            intro: intro
            id: id
            text: text
            footnote:
              text: text
              time: 2000-01-23T04:56:07.000+00:00
              iconUri: iconUri
            type: Card
            title: title
            thumbnailUri: thumbnailUri
            fields:
            - style: Short
              title: title
              value: value
            - style: Short
              title: title
              value: value
            fallback: fallback
          iconEmoji: iconEmoji
          creationTime: 2000-01-23T04:56:07.000+00:00
          activity: activity
          groupId: groupId
          creatorId: creatorId
          type: TextMessage
          title: title
          addedPersonIds:
          - addedPersonIds
          - addedPersonIds
          mentions:
          - name: name
            id: id
            type: Person
          - name: name
            id: id
            type: Person
          id: id
          text: text
          iconUri: iconUri
        - lastModifiedTime: 2000-01-23T04:56:07.000+00:00
          attachments:
          - imageUri: imageUri
            color: color
            author:
              name: name
              uri: uri
              iconUri: iconUri
            intro: intro
            id: id
            text: text
            footnote:
              text: text
              time: 2000-01-23T04:56:07.000+00:00
              iconUri: iconUri
            type: Card
            title: title
            thumbnailUri: thumbnailUri
            fields:
            - style: Short
              title: title
              value: value
            - style: Short
              title: title
              value: value
            fallback: fallback
          - imageUri: imageUri
            color: color
            author:
              name: name
              uri: uri
              iconUri: iconUri
            intro: intro
            id: id
            text: text
            footnote:
              text: text
              time: 2000-01-23T04:56:07.000+00:00
              iconUri: iconUri
            type: Card
            title: title
            thumbnailUri: thumbnailUri
            fields:
            - style: Short
              title: title
              value: value
            - style: Short
              title: title
              value: value
            fallback: fallback
          iconEmoji: iconEmoji
          creationTime: 2000-01-23T04:56:07.000+00:00
          activity: activity
          groupId: groupId
          creatorId: creatorId
          type: TextMessage
          title: title
          addedPersonIds:
          - addedPersonIds
          - addedPersonIds
          mentions:
          - name: name
            id: id
            type: Person
          - name: name
            id: id
            type: Person
          id: id
          text: text
          iconUri: iconUri
      properties:
        records:
          description: List of posts
          items:
            $ref: '#/components/schemas/GlipPostInfo'
          type: array
        navigation:
          $ref: '#/components/schemas/GlipNavigationInfo'
      required:
      - records
      type: object
    AddressFormCountryResource:
      properties:
        uri:
          format: uri
          type: string
        country:
          $ref: '#/components/schemas/CountryResource'
        attributes:
          items:
            $ref: '#/components/schemas/FormFieldResource'
          type: array
        emergencyNumber:
          type: string
        default:
          default: false
          type: boolean
      type: object
    UpdateConferencingInfoRequest:
      example:
        phoneNumbers:
        - default: true
          phoneNumber: phoneNumber
        - default: true
          phoneNumber: phoneNumber
        allowJoinBeforeHost: true
      properties:
        phoneNumbers:
          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
          items:
            $ref: '#/components/schemas/ConferencePhoneNumberInfo'
          type: array
        allowJoinBeforeHost:
          description: Determines if host user allows conference participants to join before the host
          type: boolean
      type: object
    PresenceInfoResource:
      example:
        dndStatus: TakeAllCalls
        allowSeeMyPresence: false
        userStatus: Offline
        pickUpCallsOnHold: false
        ringOnMonitoredCall: false
        message: message
        activeCalls:
        - sipData:
            callId: callId
            fromTag: fromTag
            remoteUri: remoteUri
            toTag: toTag
            localUri: localUri
            rcSessionId: rcSessionId
          telephonyStatus: NoCall
          terminationType: final
          from: from
          id: id
          to: to
          sessionId: sessionId
          direction: Inbound
        - sipData:
            callId: callId
            fromTag: fromTag
            remoteUri: remoteUri
            toTag: toTag
            localUri: localUri
            rcSessionId: rcSessionId
          telephonyStatus: NoCall
          terminationType: final
          from: from
          id: id
          to: to
          sessionId: sessionId
          direction: Inbound
      properties:
        userStatus:
          enum:
          - Offline
          - Busy
          - Available
          type: string
        dndStatus:
          enum:
          - TakeAllCalls
          - DoNotAcceptDepartmentCalls
          - TakeDepartmentCallsOnly
          - DoNotAcceptAnyCalls
          - Unknown
          type: string
        message:
          maxLength: 75
          minLength: 0
          type: string
        allowSeeMyPresence:
          default: false
          type: boolean
        ringOnMonitoredCall:
          default: false
          type: boolean
        pickUpCallsOnHold:
          default: false
          type: boolean
        activeCalls:
          items:
            $ref: '#/components/schemas/ActiveCallInfo'
          type: array
      type: object
    AccountLimitsResource:
      example:
        freeSoftPhoneLinesPerExtension: 0
        meetingSize: 6
        maxMonitoredExtensionsPerUser: 1
        maxFreeDigitalLines: 5
      properties:
        freeSoftPhoneLinesPerExtension:
          format: int32
          type: integer
        meetingSize:
          format: int32
          type: integer
        maxMonitoredExtensionsPerUser:
          format: int32
          type: integer
        maxFreeDigitalLines:
          format: int32
          type: integer
      type: object
    GlipGroupList:
      example:
        navigation:
          prevPageToken: prevPageToken
          nextPageToken: nextPageToken
        records:
        - lastModifiedTime: 2000-01-23T04:56:07.000+00:00
          creationTime: 2000-01-23T04:56:07.000+00:00
          members:
          - members
          - members
          name: name
          isPublic: true
          description: description
          id: id
          type: PrivateChat
        - lastModifiedTime: 2000-01-23T04:56:07.000+00:00
          creationTime: 2000-01-23T04:56:07.000+00:00
          members:
          - members
          - members
          name: name
          isPublic: true
          description: description
          id: id
          type: PrivateChat
      properties:
        records:
          description: List of groups/teams/private chats
          items:
            $ref: '#/components/schemas/GlipGroupInfo'
          type: array
        navigation:
          $ref: '#/components/schemas/GlipNavigationInfo'
      required:
      - records
      type: object
    CompanyAnsweringRuleCalledNumberInfo:
      example:
        id: id
      properties:
        id:
          description: Internal identifier of an account phone number
          type: string
      type: object
    StatusInfo:
      example:
        reason: reason
        till: 2000-01-23T04:56:07.000+00:00
        comment: comment
      properties:
        reason:
          type: string
        till:
          format: date-time
          type: string
        comment:
          type: string
      type: object
    SipFlags:
      properties:
        voipFeatureEnabled:
          default: false
          type: boolean
        voipCountryBlocked:
          default: false
          type: boolean
        outboundCallsEnabled:
          default: false
          type: boolean
      type: object
    HostInfoRequest:
      example:
        id: id
      properties:
        id:
          description: Internal identifier of an extension which is assigned to be a meeting host. The default value is currently logged-in extension identifier
          type: string
      type: object
    ExtensionPermissionsResource:
      example:
        admin:
          enabled: false
        uri: http://example.com/aeiou
        internationalCalling:
          enabled: false
        freeSoftPhoneDigitalLine:
          enabled: false
      properties:
        uri:
          format: uri
          type: string
        admin:
          $ref: '#/components/schemas/Permission'
        internationalCalling:
          $ref: '#/components/schemas/Permission'
        freeSoftPhoneDigitalLine:
          $ref: '#/components/schemas/Permission'
      type: object
    ExtensionPresenceEvent:
      properties:
        extensionId:
          default: ~
          description: Internal identifier of an extension. Optional parameter
          type: string
        telephonyStatus:
          description: Telephony presence status. Returned if telephony status is changed.
          enum:
          - NoCall
          - CallConnected
          - Ringing
          - OnHold
          - ParkedCall
          type: string
        sequence:
          description: Order number of a notification to state the chronology
          type: integer
        presenceStatus:
          description: Aggregated presence status, calculated from a number of sources
          enum:
          - Offline
          - Busy
          - Available
          type: string
        userStatus:
          description: User-defined presence status (as previously published by the user)
          enum:
          - Offline
          - Busy
          - Available
          type: string
        dndStatus:
          description: Extended DnD (Do not Disturb) status
          enum:
          - TakeAllCalls
          - DoNotAcceptAnyCalls
          - DoNotAcceptDepartmentCalls
          - TakeDepartmentCallsOnly
          type: string
        allowSeeMyPresence:
          description: If 'True' enables other extensions to see the extension presence status
          type: boolean
        ringOnMonitoredCall:
          description: If 'True' enables to ring extension phone, if any user monitored by this extension is ringing
          type: boolean
        pickUpCallsOnHold:
          description: If 'True' enables the extension user to pick up a monitored line on hold
          type: boolean
      type: object
    GlipGroupInfo:
      example:
        lastModifiedTime: 2000-01-23T04:56:07.000+00:00
        creationTime: 2000-01-23T04:56:07.000+00:00
        members:
        - members
        - members
        name: name
        isPublic: true
        description: description
        id: id
        type: PrivateChat
      properties:
        id:
          description: Internal identifier of a group
          type: string
        type:
          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
          enum:
          - PrivateChat
          - Group
          - Team
          type: string
        isPublic:
          description: For 'Team' group type only. Team access level
          type: boolean
        name:
          description: For 'Team' group type only. Team name
          type: string
        description:
          description: For 'Team' group type only. Team description
          type: string
        members:
          description: Identifier(s) of group members
          items:
            type: string
          type: array
        creationTime:
          description: Group creation datetime in ISO 8601 format
          format: date-time
          type: string
        lastModifiedTime:
          description: Group last change datetime in ISO 8601 format
          format: date-time
          type: string
      type: object
    ClientInfoSpecialNumberResource:
      properties:
        uri:
          format: uri
          type: string
        phoneNumber:
          type: string
        description:
          type: string
        features:
          $ref: '#/components/schemas/Features'
      type: object
    ForwardingInfo:
      example:
        softPhonesRingCount: 0
        rules:
        - forwardingNumbers:
          - phoneNumber: phoneNumber
            id: id
            label: label
            uri: uri
          - phoneNumber: phoneNumber
            id: id
            label: label
            uri: uri
          ringCount: 1
          index: 6
        - forwardingNumbers:
          - phoneNumber: phoneNumber
            id: id
            label: label
            uri: uri
          - phoneNumber: phoneNumber
            id: id
            label: label
            uri: uri
          ringCount: 1
          index: 6
        notifyMySoftPhones: true
        notifyAdminSoftPhones: true
        ringingMode: Sequentially
      properties:
        notifyMySoftPhones:
          description: Specifies if the user's softphone(s) are notified before forwarding the incoming call to desk phones and forwarding numbers
          type: boolean
        notifyAdminSoftPhones:
          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'
          type: boolean
        softPhonesRingCount:
          description: Number of rings before forwarding starts
          type: integer
        ringingMode:
          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
          type: string
        rules:
          description: Information on a call forwarding rule
          items:
            $ref: '#/components/schemas/RuleInfo'
          type: array
      type: object
    CfaAttachments:
      properties:
        csv:
          default: false
          type: boolean
        pdf:
          default: false
          type: boolean
      type: object
    QueueInfo:
      example:
        wrapUpTime: 7
        transferMode: Rotating
        fixedOrderAgents:
        - extension:
            extensionNumber: extensionNumber
            id: id
            partnerId: partnerId
            uri: uri
          index: 5
        - extension:
            extensionNumber: extensionNumber
            id: id
            partnerId: partnerId
            uri: uri
          index: 5
        holdAudioInterruptionPeriod: 5
        maxCallersAction: Voicemail
        maxCallers: 3
        holdAudioInterruptionMode: Never
        agentTimeout: 2
        holdTime: 9
      properties:
        transferMode:
          description: Specifies how calls are transferred to group members
          enum:
          - Rotating
          - Simultaneous
          - FixedOrder
          type: string
        fixedOrderAgents:
          description: Information on a call forwarding rule
          items:
            $ref: '#/components/schemas/FixedOrderAgents'
          type: array
        holdAudioInterruptionMode:
          description: Connecting audio interruption mode
          enum:
          - Never
          - WhenMusicEnds
          - Periodically
          type: string
        holdAudioInterruptionPeriod:
          description: Connecting audio interruption message period in seconds
          type: integer
        agentTimeout:
          description: Maximum time in seconds to wait for a call queue member before trying the next member
          type: integer
        wrapUpTime:
          description: Minimum post-call wrap up time in seconds before agent status is automatically set
          type: integer
        holdTime:
          description: Maximum hold time in seconds to wait for an available call queue member
          type: integer
        maxCallers:
          description: Maximum count of callers on hold
          type: integer
        maxCallersAction:
          description: Action which should be taken if count of callers on hold exceeds the maximum
          enum:
          - Voicemail
          - Announcement
          type: string
      type: object
    CfaRecurrence:
      properties:
        pattern:
          enum:
          - Daily
          - Weekly
          - Monthly
          type: string
        value:
          type: string
      type: object
    OrderResource:
      properties:
        id:
          type: string
        uri:
          format: uri
          type: string
        devices:
          items:
            $ref: '#/components/schemas/DeviceResource'
          type: array
      type: object
    ParsedPhoneNumbersResource:
      properties:
        uri:
          format: uri
          type: string
        homeCountry:
          $ref: '#/components/schemas/HomeCountryResource'
        phoneNumbers:
          items:
            $ref: '#/components/schemas/ParsedNumberResource'
          type: array
      type: object
    PhoneLineResource:
      example:
        lineType: Unknown
        phoneInfo:
          country:
            callingCode: callingCode
            numberSelling: false
            isoCode: isoCode
            emergencyCalling: false
            name: name
            id: id
            uri: http://example.com/aeiou
            loginAllowed: false
          extension:
            setupWizardState: NotStarted
            statusInfo:
              reason: reason
              till: 2000-01-23T04:56:07.000+00:00
              comment: comment
            references:
            - ref: ref
              type: PartnerId
            - ref: ref
              type: PartnerId
            profileImage:
              scales:
              - uri: http://example.com/aeiou
              - uri: http://example.com/aeiou
              etag: etag
              lastModified: 2000-01-23T04:56:07.000+00:00
              uri: http://example.com/aeiou
              contentType: contentType
            type: Unknown
            uri: http://example.com/aeiou
            ivrPin: ivrPin
            password: password
            serviceFeatures:
            - reason: Available
              featureName: featureName
              enabled: false
            - reason: Available
              featureName: featureName
              enabled: false
            extensionNumber: extensionNumber
            permissions:
              admin:
                enabled: false
              uri: http://example.com/aeiou
              internationalCalling:
                enabled: false
              freeSoftPhoneDigitalLine:
                enabled: false
            loginName: loginName
            contact:
              firstName: firstName
              lastName: lastName
              company: company
              businessPhone: businessPhone
              businessAddress:
                zip: zip
                country: country
                city: city
                street: street
                state: state
              email: email
            name: name
            regionalSettings:
              timezone:
                name: name
                description: description
                id: id
                uri: http://example.com/aeiou
              greetingLanguage:
                localeCode: localeCode
                name: name
                id: id
              formattingLocale:
                localeCode: localeCode
                name: name
                id: id
              language:
                localeCode: localeCode
                name: name
                id: id
              homeCountry:
                callingCode: callingCode
                numberSelling: false
                isoCode: isoCode
                emergencyCalling: false
                name: name
                id: id
                uri: http://example.com/aeiou
                loginAllowed: false
            id: id
            partnerId: partnerId
            departments:
            - extensionNumber: extensionNumber
              id: id
              uri: http://example.com/aeiou
            - extensionNumber: extensionNumber
              id: id
              uri: http://example.com/aeiou
            status: Enabled
          phoneNumber: phoneNumber
          location: location
          id: 1
          label: label
          type: VoiceFax
          paymentType: External
          status: status
          usageType: CompanyNumber
        emergencyAddress:
          localOnly: true
          required: true
      properties:
        lineType:
          enum:
          - Unknown
          - Standalone
          - BlaPrimary
          - BlaSecondary
          - BLF
          - StandaloneFree
          type: string
        phoneInfo:
          $ref: '#/components/schemas/PhoneNumberResourceIntId'
        emergencyAddress:
          $ref: '#/components/schemas/EmergencyAddress'
      type: object
    SecretQuestionInfoValidationRequest:
      example:
        answer: answer
        id: id
      properties:
        id:
          description: Internal identifier of a secret question
          type: string
        answer:
          description: Answer to a secret question
          type: string
      type: object
    EmailResource:
      properties:
        accountId:
          type: string
        extensionId:
          type: string
        templateId:
          type: string
        recipients:
          items:
            type: string
          type: array
        files:
          items:
            type: string
          type: array
      type: object
    AuthProfileResource:
      example:
        permissions:
        - permission:
            id: id
            uri: http://example.com/aeiou
          scopes:
          - scopes
          - scopes
          effectiveRole:
            id: id
            uri: http://example.com/aeiou
        - permission:
            id: id
            uri: http://example.com/aeiou
          scopes:
          - scopes
          - scopes
          effectiveRole:
            id: id
            uri: http://example.com/aeiou
        uri: http://example.com/aeiou
      properties:
        uri:
          format: uri
          type: string
        permissions:
          items:
            $ref: '#/components/schemas/ActivePermissionResource'
          type: array
      type: object
    FederationExtensionNumbersExtensionInfo:
      example:
        extensionNumber: extensionNumber
        id: id
      properties:
        id:
          description: Internal identifier of an extension
          type: string
        extensionNumber:
          description: Number of an extension
          type: string
      type: object
    GetVersionsResponse:
      example:
        serverVersion: serverVersion
        serverRevision: serverRevision
        apiVersions:
        - versionString: versionString
          releaseDate: releaseDate
          uriString: uriString
          uri: uri
        - versionString: versionString
          releaseDate: releaseDate
          uriString: uriString
          uri: uri
        uri: uri
      properties:
        uri:
          description: Canonical URI of the API version
          type: string
        apiVersions:
          description: 'Full API version information: uri, number, release date'
          items:
            $ref: '#/components/schemas/VersionInfo'
          type: array
        serverVersion:
          description: Server version
          type: string
        serverRevision:
          description: Server revision
          type: string
      type: object
    PhoneNumberInfoNumberParser:
      example:
        special: true
        country:
        - callingCode: callingCode
          emergencyCalling: true
          isoCode: isoCode
          name: name
          id: id
          uri: uri
        - callingCode: callingCode
          emergencyCalling: true
          isoCode: isoCode
          name: name
          id: id
          uri: uri
        areaCode: areaCode
        dialable: dialable
        e164: e164
        formattedInternational: formattedInternational
        normalized: normalized
        originalString: originalString
        formattedNational: formattedNational
      properties:
        areaCode:
          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
          type: string
        country:
          description: Information on a country the phone number belongs to
          items:
            $ref: '#/components/schemas/GetCountryInfoNumberParser'
          type: array
        dialable:
          description: Dialing format of a phone number
          type: string
        e164:
          description: E.164 (11-digits) format of a phone number
          type: string
        formattedInternational:
          description: International format of a phone number
          type: string
        formattedNational:
          description: Domestic format of a phone number
          type: string
        originalString:
          description: One of the numbers to be parsed, passed as a string in response
          type: string
        special:
          description: ' True  if the number is in a special format (for example N11
            code)'
          type: boolean
        normalized:
          description: E.164 (11-digits) format of a phone number without the plus sign ('+')
          type: string
      type: object
    BulkRoleAssignResource:
      properties:
        uri:
          format: uri
          type: string
        addedExtensionIds:
          items:
            type: string
          type: array
        removedExtensionIds:
          items:
            type: string
          type: array
      type: object
    MakeRingOutCallerInfoRequestTo:
      example:
        phoneNumber: phoneNumber
      properties:
        phoneNumber:
          description: Phone number in E.164 format
          type: string
      type: object
    CallerIdByDevice:
      example:
        callerId:
          phoneInfo:
            phoneNumber: phoneNumber
            id: id
            uri: uri
          type: type
        device:
          phoneNumber: phoneNumber
          id: id
          uri: uri
      properties:
        device:
          $ref: '#/components/schemas/CallerIdDeviceInfo'
        callerId:
          $ref: '#/components/schemas/CallerIdByDeviceInfo'
      type: object
    VerifyExtensionUserCredentials:
      example:
        ivrPin: ivrPin
        secretQuestion:
          answer: answer
          id: id
        password: password
      properties:
        password:
          description: User password of an extension
          type: string
        ivrPin:
          description: User pin of an extension
          type: string
        secretQuestion:
          $ref: '#/components/schemas/SecretQuestionInfoVerificationRequest'
      type: object
    RCVRecordingInfo:
      properties:
        size:
          description: Meeting record size in bytes
          type: integer
        duration:
          description: Meeting duration in seconds
          type: integer
        url:
          description: Link to a meeting record
          type: string
      type: object
    CompanyDirectoryAccountInfo:
      example:
        id: id
      properties:
        id:
          description: Internal identifier of an account
          type: string
      type: object
    RingOutStatusInfo:
      example:
        calleeStatus: Invalid
        callStatus: Invalid
        callerStatus: Invalid
      properties:
        callStatus:
          description: Status of a call
          enum:
          - Invalid
          - Success
          - InProgress
          - Busy
          - NoAnswer
          - Rejected
          - GenericError
          - Finished
          - InternationalDisabled
          - DestinationBlocked
          - NotEnoughFunds
          - NoSuchUser
          type: string
        callerStatus:
          description: Status of a calling party
          enum:
          - Invalid
          - Success
          - InProgress
          - Busy
          - NoAnswer
          - Rejected
          - GenericError
          - Finished
          - InternationalDisabled
          - DestinationBlocked
          - NotEnoughFunds
          - NoSuchUser
          type: string
        calleeStatus:
          description: Status of a called party
          enum:
          - Invalid
          - Success
          - InProgress
          - Busy
          - NoAnswer
          - Rejected
          - GenericError
          - Finished
          - InternationalDisabled
          - DestinationBlocked
          - NotEnoughFunds
          - NoSuchUser
          type: string
      type: object
    GreetingInfo:
      example:
        preset:
          name: name
          id: id
          uri: uri
        type: Introductory
        usageType: UserExtensionAnsweringRule
      properties:
        type:
          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
          type: string
        usageType:
          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
          type: string
        preset:
          $ref: '#/components/schemas/PresetInfo'
      type: object
    SipDetailsToRegister:
      properties:
        transport:
          enum:
          - UDP
          - TCP
          - TLS
          - WS
          - WSS
          type: string
      type: object
    RolesCollectionResource:
      example:
        navigation:
          previousPage:
            uri: http://example.com/aeiou
          firstPage:
            uri: http://example.com/aeiou
          lastPage:
            uri: http://example.com/aeiou
          nextPage:
            uri: http://example.com/aeiou
        records:
        - lastUpdated: 2000-01-23T04:56:07.000+00:00
          hidden: false
          displayName: displayName
          permissions:
          - id: id
            uri: http://example.com/aeiou
          - id: id
            uri: http://example.com/aeiou
          custom: false
          scope: scope
          description: description
          id: id
          uri: http://example.com/aeiou
        - lastUpdated: 2000-01-23T04:56:07.000+00:00
          hidden: false
          displayName: displayName
          permissions:
          - id: id
            uri: http://example.com/aeiou
          - id: id
            uri: http://example.com/aeiou
          custom: false
          scope: scope
          description: description
          id: id
          uri: http://example.com/aeiou
        paging:
          perPage: 1
          pageStart: 5
          pageEnd: 2
          totalPages: 6
          page: 0
          totalElements: 5
        uri: http://example.com/aeiou
      properties:
        uri:
          format: uri
          type: string
        records:
          items:
            $ref: '#/components/schemas/RoleResource'
          type: array
        paging:
          $ref: '#/components/schemas/Paging'
        navigation:
          $ref: '#/components/schemas/Navigation'
      type: object
    GlipUnreadMessageCountInfo:
      properties:
        unread:
          description: Count of glip unread messages
          type: integer
      type: object
    TouchRequestResource:
      properties:
        rendererId:
          type: string
        messageId:
          type: string
      type: object
    GetCountryListResponse:
      example:
        navigation:
          previousPage:
            uri: uri
          firstPage:
            uri: uri
          lastPage:
            uri: uri
          nextPage:
            uri: uri
        records:
        - callingCode: callingCode
          numberSelling: true
          emergencyCalling: true
          isoCode: isoCode
          name: name
          id: id
          signupAllowed: true
          uri: uri
          loginAllowed: true
          freeSoftphoneLine: true
        - callingCode: callingCode
          numberSelling: true
          emergencyCalling: true
          isoCode: isoCode
          name: name
          id: id
          signupAllowed: true
          uri: uri
          loginAllowed: true
          freeSoftphoneLine: true
        paging:
          perPage: 5
          pageStart: 5
          pageEnd: 2
          totalPages: 7
          page: 1
          totalElements: 9
      properties:
        records:
          description: List of countries with the country data
          items:
            $ref: '#/components/schemas/GetCountryInfoDictionaryResponse'
          type: array
        navigation:
          $ref: '#/components/schemas/NavigationInfo'
        paging:
          $ref: '#/components/schemas/PagingInfo'
      required:
      - navigation
      - paging
      - records
      type: object
    CompanyAnsweringRuleCalledNumberInfoRequest:
      example:
        id: id
      properties:
        id:
          description: Internal identifier of an account phone number
          type: string
      type: object
    ScheduleResource:
      properties:
        ranges:
          items:
            $ref: '#/components/schemas/DateTimeIntervalResource'
          type: array
        ref:
          enum:
          - BusinessHours
          - AfterHours
          type: string
      type: object
    AccountPresenceEvent:
      properties:
        extensionId:
          default: ~
          description: Internal identifier of an extension. Optional parameter
          type: string
        telephonyStatus:
          description: Telephony presence status. Returned if telephony status is changed.
          enum:
          - NoCall
          - CallConnected
          - Ringing
          - OnHold
          - ParkedCall
          type: string
        sequence:
          description: Order number of a notification to state the chronology
          type: integer
        presenceStatus:
          description: Aggregated presence status, calculated from a number of sources
          enum:
          - Offline
          - Busy
          - Available
          type: string
        userStatus:
          description: User-defined presence status (as previously published by the user)
          enum:
          - Offline
          - Busy
          - Available
          type: string
        dndStatus:
          description: Extended DnD (Do not Disturb) status
          enum:
          - TakeAllCalls
          - DoNotAcceptAnyCalls
          - DoNotAcceptDepartmentCalls
          - TakeDepartmentCallsOnly
          type: string
        allowSeeMyPresence:
          description: If 'True' enables other extensions to see the extension presence status
          type: boolean
        ringOnMonitoredCall:
          description: If 'True' enables to ring extension phone, if any user monitored by this extension is ringing
          type: boolean
        pickUpCallsOnHold:
          description: If 'True' enables the extension user to pick up a monitored line on hold
          type: boolean
      type: object
    GlipMessageAttachmentAuthorInfo:
      example:
        name: name
        uri: uri
        iconUri: iconUri
      properties:
        name:
          description: The author name
          type: string
        uri:
          description: Used to link the authors name
          type: string
        iconUri:
          description: A url to an image up to 82x82px that will display to the left of the author’s name
          type: string
      type: object
    Binary:
      example:
        data: ""
      properties:
        data:
          description: Required Binary Data
          format: binary
          type: string
      type: object
    RingOutResource:
      example:
        country:
          id: id
        from:
          phoneNumber: phoneNumber
          forwardingNumberId: forwardingNumberId
        playPrompt: false
        to:
          phoneNumber: phoneNumber
        callerId:
          phoneNumber: phoneNumber
      properties:
        from:
          $ref: '#/components/schemas/RingOutFromInfo'
        to:
          $ref: '#/components/schemas/RingOutPhoneNumberInfo'
        callerId:
          $ref: '#/components/schemas/RingOutPhoneNumberInfo'
        playPrompt:
          default: false
          type: boolean
        country:
          $ref: '#/components/schemas/RingOutCountry'
      type: object
    CompanyBusinessHoursUpdateRequest:
      example:
        schedule:
          weeklyRanges:
            sunday:
            - from: 2000-01-23T04:56:07.000+00:00
              to: 2000-01-23T04:56:07.000+00:00
            - from: 2000-01-23T04:56:07.000+00:00
              to: 2000-01-23T04:56:07.000+00:00
            saturday:
            - from: 2000-01-23T04:56:07.000+00:00
              to: 2000-01-23T04:56:07.000+00:00
            - from: 2000-01-23T04:56:07.000+00:00
              to: 2000-01-23T04:56:07.000+00:00
            tuesday:
            - from: 2000-01-23T04:56:07.000+00:00
              to: 2000-01-23T04:56:07.000+00:00
            - from: 2000-01-23T04:56:07.000+00:00
              to: 2000-01-23T04:56:07.000+00:00
            wednesday:
            - from: 2000-01-23T04:56:07.000+00:00
              to: 2000-01-23T04:56:07.000+00:00
            - from: 2000-01-23T04:56:07.000+00:00
              to: 2000-01-23T04:56:07.000+00:00
            thursday:
            - from: 2000-01-23T04:56:07.000+00:00
              to: 2000-01-23T04:56:07.000+00:00
            - from: 2000-01-23T04:56:07.000+00:00
              to: 2000-01-23T04:56:07.000+00:00
            friday:
            - from: 2000-01-23T04:56:07.000+00:00
              to: 2000-01-23T04:56:07.000+00:00
            - from: 2000-01-23T04:56:07.000+00:00
              to: 2000-01-23T04:56:07.000+00:00
            monday:
            - from: 2000-01-23T04:56:07.000+00:00
              to: 2000-01-23T04:56:07.000+00:00
            - from: 2000-01-23T04:56:07.000+00:00
              to: 2000-01-23T04:56:07.000+00:00
      properties:
        schedule:
          $ref: '#/components/schemas/CompanyBusinessHoursScheduleInfo'
      type: object
    ExtensionAssignmentResult:
      example:
        extension:
          setupWizardState: NotStarted
          statusInfo:
            reason: reason
            till: 2000-01-23T04:56:07.000+00:00
            comment: comment
          references:
          - ref: ref
            type: PartnerId
          - ref: ref
            type: PartnerId
          profileImage:
            scales:
            - uri: http://example.com/aeiou
            - uri: http://example.com/aeiou
            etag: etag
            lastModified: 2000-01-23T04:56:07.000+00:00
            uri: http://example.com/aeiou
            contentType: contentType
          type: Unknown
          uri: http://example.com/aeiou
          ivrPin: ivrPin
          password: password
          serviceFeatures:
          - reason: Available
            featureName: featureName
            enabled: false
          - reason: Available
            featureName: featureName
            enabled: false
          extensionNumber: extensionNumber
          permissions:
            admin:
              enabled: false
            uri: http://example.com/aeiou
            internationalCalling:
              enabled: false
            freeSoftPhoneDigitalLine:
              enabled: false
          loginName: loginName
          contact:
            firstName: firstName
            lastName: lastName
            company: company
            businessPhone: businessPhone
            businessAddress:
              zip: zip
              country: country
              city: city
              street: street
              state: state
            email: email
          name: name
          regionalSettings:
            timezone:
              name: name
              description: description
              id: id
              uri: http://example.com/aeiou
            greetingLanguage:
              localeCode: localeCode
              name: name
              id: id
            formattingLocale:
              localeCode: localeCode
              name: name
              id: id
            language:
              localeCode: localeCode
              name: name
              id: id
            homeCountry:
              callingCode: callingCode
              numberSelling: false
              isoCode: isoCode
              emergencyCalling: false
              name: name
              id: id
              uri: http://example.com/aeiou
              loginAllowed: false
          id: id
          partnerId: partnerId
          departments:
          - extensionNumber: extensionNumber
            id: id
            uri: http://example.com/aeiou
          - extensionNumber: extensionNumber
            id: id
            uri: http://example.com/aeiou
          status: Enabled
        error:
          errorCode: errorCode
          message: message
        successful: false
      properties:
        successful:
          default: false
          type: boolean
        extension:
          $ref: '#/components/schemas/ExtensionResource'
        error:
          $ref: '#/components/schemas/ErrorEntity'
      type: object
    ApplicationInfoResource:
      properties:
        clientId:
          type: string
        application:
          $ref: '#/components/schemas/ApplicationResource'
      type: object
    LanguageInfoResource:
      properties:
        uri:
          format: uri
          type: string
        id:
          type: string
        name:
          type: string
        isoCode:
          type: string
        localeCode:
          type: string
        ui:
          default: false
          type: boolean
        greeting:
          default: false
          type: boolean
        formattingLocale:
          default: false
          type: boolean
      type: object
    Extensions:
      properties:
        uri:
          format: uri
          type: string
        records:
          items:
            $ref: '#/components/schemas/ExtensionResource'
          type: array
        paging:
          $ref: '#/components/schemas/Paging'
        navigation:
          $ref: '#/components/schemas/Navigation'
      type: object
    Supported:
      example:
        supported: false
      properties:
        supported:
          default: false
          type: boolean
      type: object
    GlipPostEvent:
      properties:
        id:
          description: Internal identifier of a post
          type: string
        eventType:
          description: Type of a post event
          enum:
          - PostAdded
          - PostChanged
          - PostRemoved
          type: string
        groupId:
          description: Internal identifier of a group a post belongs to
          type: string
        type:
          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
          type: string
        text:
          description: For 'TextMessage' post type only. Message text
          type: string
        creatorId:
          description: Internal identifier of a user - author of a post
          type: string
        addedPersonIds:
          description: For PersonsAdded post type only. Identifiers of persons added to a group
          items:
            type: string
          type: array
        removedPersonIds:
          description: For PersonsRemoved post type only. Identifiers of persons removed from a group
          items:
            type: string
          type: array
        mentions:
          description: List of at mentions in post text with names.
          items:
            $ref: '#/components/schemas/GlipMentionsInfo'
          type: array
        creationTime:
          description: Post creation datetime in ISO 8601 format
          format: date-time
          type: string
        lastModifiedTime:
          description: Post last change datetime in ISO 8601 format
          format: date-time
          type: string
      type: object
    IVRMenuActionsInfo:
      example:
        input: input
        extension:
          id: id
          uri: uri
        phoneNumber: phoneNumber
        action: Connect
      properties:
        input:
          description: 'Key. The following values are supported: numeric: ''1'' to
            ''9'' Star Hash NoInput'
          type: string
        action:
          description: Internal identifier of an answering rule
          enum:
          - Connect
          - Voicemail
          - DialByName
          - Transfer
          - Repeat
          - ReturnToRoot
          - ReturnToPrevious
          - Disconnect
          type: string
        extension:
          $ref: '#/components/schemas/IVRMenuExtensionInfo'
        phoneNumber:
          description: For 'Transfer' action only. PSTN number in E.164 format
          type: string
      type: object
    FaxCountryInfo:
      properties:
        id:
          description: Internal identifier of a home country
          type: string
        isoCode:
          description: Country code in ISO 3166-1 alpha-2. If specified then country ID cannot be specified
          type: string
      type: object
    ReportingSchedulesInfo:
      example:
        recurrence:
        - pattern: Daily
          value: "0"
        - pattern: Daily
          value: "0"
        attachments:
        - pdf: true
          csv: true
        - pdf: true
          csv: true
        pages:
        - pages
        - pages
        recipients:
        - recipients
        - recipients
        viewType: Detailed
        scheduleId: scheduleId
      properties:
        scheduleId:
          description: Unique schedule identifier
          type: string
        recurrence:
          description: Recurrence pattern of a schedule
          items:
            $ref: '#/components/schemas/ReportingRecurrenceInfo'
          type: array
        viewType:
          description: Type of report. Detailed reports include tables with data. Simple reports only include charts
          enum:
          - Detailed
          - Simple
          type: string
        attachments:
          description: Set of optional attachments. Basically, every report email is in HTML format. Optionally, it can contain PDF or CSV files
          items:
            $ref: '#/components/schemas/ReportingAttachmentInfo'
          type: array
        pages:
          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
          type: array
        recipients:
          description: List of emails to which to send rendered reports
          items:
            type: string
          type: array
      type: object
    SimpleResource:
      properties:
        uri:
          format: uri
          type: string
        resourceDescription:
          type: string
        id:
          type: string
        ver:
          $ref: '#/components/schemas/ApiVersionResource'
      type: object
    Features:
      properties:
        voip:
          $ref: '#/components/schemas/Feature'
        ringOut:
          $ref: '#/components/schemas/Feature'
        sms:
          $ref: '#/components/schemas/Feature'
        faxOut:
          $ref: '#/components/schemas/Feature'
      type: object
    DateTimeIntervalResource:
      properties:
        from:
          type: string
        to:
          type: string
      type: object
    MatchingEntityTag:
      properties:
        value:
          type: string
        weak:
          default: false
          type: boolean
      type: object
    ExtensionFavoritesEvent:
      properties:
        extensionId:
          description: Internal identifier of an extension
          type: string
      type: object
    DialInNumberResource:
      example:
        country:
          callingCode: callingCode
          numberSelling: false
          isoCode: isoCode
          emergencyCalling: false
          name: name
          id: id
          uri: http://example.com/aeiou
          loginAllowed: false
        formattedNumber: formattedNumber
        phoneNumber: phoneNumber
        location: location
      properties:
        phoneNumber:
          type: string
        formattedNumber:
          type: string
        location:
          type: string
        country:
          $ref: '#/components/schemas/CountryResource'
      type: object
    SenderInfo:
      properties:
        phoneNumber:
          description: Phone number in E.164 (with '+' sign) format
          type: string
        extensionNumber:
          description: Extension number
          type: string
        location:
          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)
          type: string
        name:
          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
          type: string
      type: object
    TimeInterval:
      example:
        from: 2000-01-23T04:56:07.000+00:00
        to: 2000-01-23T04:56:07.000+00:00
      properties:
        from:
          description: Time in format hh:mm
          format: date-time
          type: string
        to:
          description: Time in format hh:mm
          format: date-time
          type: string
      type: object
    Request:
      properties:
        method:
          type: string
      type: object
    PutPresenceResource:
      properties:
        userStatus:
          enum:
          - Offline
          - Busy
          - Available
          type: string
        message:
          maxLength: 75
          minLength: 0
          type: string
        dndStatus:
          enum:
          - TakeAllCalls
          - DoNotAcceptDepartmentCalls
          - TakeDepartmentCallsOnly
          - DoNotAcceptAnyCalls
          - Unknown
          type: string
        allowSeeMyPresence:
          default: false
          type: boolean
        ringOnMonitoredCall:
          default: false
          type: boolean
        pickUpCallsOnHold:
          default: false
          type: boolean
      type: object
    BillingPlanResource:
      properties:
        uri:
          format: uri
          type: string
        id:
          type: string
        name:
          type: string
        durationUnit:
          type: string
        duration:
          format: int32
          type: integer
        type:
          type: string
      type: object
    PermissionCollectionResource:
      example:
        navigation:
          previousPage:
            uri: http://example.com/aeiou
          firstPage:
            uri: http://example.com/aeiou
          lastPage:
            uri: http://example.com/aeiou
          nextPage:
            uri: http://example.com/aeiou
        records:
        - includedPermissions:
          - id: id
            uri: http://example.com/aeiou
          - id: id
            uri: http://example.com/aeiou
          displayName: displayName
          description: description
          readOnly: false
          id: id
          category:
            id: id
            uri: http://example.com/aeiou
          uri: http://example.com/aeiou
          assignable: false
        - includedPermissions:
          - id: id
            uri: http://example.com/aeiou
          - id: id
            uri: http://example.com/aeiou
          displayName: displayName
          description: description
          readOnly: false
          id: id
          category:
            id: id
            uri: http://example.com/aeiou
          uri: http://example.com/aeiou
          assignable: false
        paging:
          perPage: 1
          pageStart: 5
          pageEnd: 2
          totalPages: 6
          page: 0
          totalElements: 5
        uri: http://example.com/aeiou
      properties:
        uri:
          format: uri
          type: string
        records:
          items:
            $ref: '#/components/schemas/PermissionResource'
          type: array
        paging:
          $ref: '#/components/schemas/Paging'
        navigation:
          $ref: '#/components/schemas/Navigation'
      type: object
    LicenseTypeInfo:
      properties:
        id:
          description: Internal identifier of a type
          type: string
        uri:
          description: Canonical URI of a license type resource
          type: string
        sku:
          description: Short name of a license type
          type: string
        name:
          description: Full name of a license type
          type: string
        assignable:
          description: State of a license. Webinars and Large Meetings are assignable
          type: string
        feature:
          $ref: '#/components/schemas/LicenseFeatureInfo'
      type: object
    MeetingExternalUserInfoResource:
      example:
        accountId: accountId
        userToken: userToken
        userType: 0
        uri: http://example.com/aeiou
        userId: userId
      properties:
        uri:
          format: uri
          type: string
        userId:
          type: string
        accountId:
          type: string
        userType:
          format: int64
          type: integer
        userToken:
          type: string
      type: object
    CallerInfo:
      properties:
        phoneNumber:
          type: string
        extensionNumber:
          type: string
        name:
          type: string
        location:
          type: string
        contact:
          $ref: '#/components/schemas/PersonalContactResource'
        messageStatus:
          enum:
          - Sent
          - SendingFailed
          - Queued
          type: string
        faxErrorCode:
          enum:
          - Undefined
          - NoFaxSendPermission
          - NoInternationalPermission
          - NoFaxMachine
          - OutgoingCallError
          - RenderingFailed
          - TooManyPages
          - ReturnToDBQueue
          - NoCallTime
          - WrongNumber
          - ProhibitedNumber
          - InternalError
          - FaxSendingProhibited
          - ThePhoneIsBlacklisted
          - UserNotFound
          - ConvertError
          - DBGeneralError
          - SkypeBillingFailed
          - AccountSuspended
          - ProhibitedDestination
          - InternationalDisabled
          type: string
      type: object
    CreateAccountRequest:
      example:
        reservationId: reservationId
        promotionCode: promotionCode
        serviceInfo:
          servicePlanName: servicePlanName
          serviceFeatures:
          - featureName: featureName
            enabled: true
          - featureName: featureName
            enabled: true
          uri: uri
          limits:
            freeSoftPhoneLinesPerExtension: 0
            meetingSize: 6
            maxMonitoredExtensionsPerUser: 1
            maxExtensionNumberLength: 5
        mainNumber: mainNumber
        partnerId: partnerId
        operator:
          setupWizardState: NotStarted
          statusInfo:
            reason: Voluntarily
            comment: comment
          references:
          - ref: ref
            type: PartnerId
          - ref: ref
            type: PartnerId
          profileImage:
            scales:
            - uri: uri
            - uri: uri
            etag: etag
            lastModified: 2000-01-23T04:56:07.000+00:00
            uri: uri
            contentType: contentType
          type: User
          uri: uri
          callQueueInfo:
            slaThresholdSeconds: 1
            abandonedThresholdSeconds: 5
            slaGoal: 6
            includeAbandonedCalls: true
          serviceFeatures:
          - reason: reason
            featureName: featureName
            enabled: true
          - reason: reason
            featureName: featureName
            enabled: true
          extensionNumber: extensionNumber
          permissions:
            admin:
              enabled: true
            internationalCalling:
              enabled: true
          contact:
            firstName: firstName
            lastName: lastName
            company: company
            businessPhone: businessPhone
            businessAddress:
              zip: zip
              country: country
              city: city
              street: street
              state: state
            email: email
          name: name
          regionalSettings:
            timezone:
              name: name
              description: description
              id: id
              uri: uri
            timeFormat: 12h
            greetingLanguage:
              localeCode: localeCode
              name: name
              id: id
            formattingLocale:
              localeCode: localeCode
              name: name
              id: id
            language:
              localeCode: localeCode
              ui: true
              greeting: true
              name: name
              formattingLocale: true
              id: id
              uri: uri
            homeCountry:
              name: name
              id: id
              uri: uri
          id: 0
          departments:
          - extensionNumber: extensionNumber
            id: id
            uri: uri
          - extensionNumber: extensionNumber
            id: id
            uri: uri
          partnerId: partnerId
          status: Enabled
        status: Initial
        signupInfo:
          marketingAccepted: true
      properties:
        mainNumber:
          description: Main account VoIP phone number, either Local or Toll-Free. Cannot be Fax Only. Obtained via lookup/reserve API
          type: string
        operator:
          $ref: '#/components/schemas/GetExtensionInfoResponse'
        partnerId:
          description: Partner identifier for this account
          type: string
        promotionCode:
          description: Promotion code to calculate a discount
          type: string
        reservationId:
          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
          type: string
        serviceInfo:
          $ref: '#/components/schemas/GetServiceInfoResponse'
        status:
          description: The status with which an account is created. The default value is 'Initial'
          enum:
          - Initial
          - Unconfirmed
          - Confirmed
          type: string
        signupInfo:
          $ref: '#/components/schemas/AccountSignupInfoRequest'
      type: object
    PhoneNumberInfo:
      example:
        country:
          name: name
          id: id
          uri: uri
        extension:
          extensionNumber: extensionNumber
          id: id
          partnerId: partnerId
          uri: uri
        phoneNumber: phoneNumber
        location: location
        id: id
        label: label
        type: VoiceFax
        paymentType: External
        status: status
        usageType: MainCompanyNumber
      properties:
        id:
          description: Internal identifier of a phone number
          type: string
        country:
          $ref: '#/components/schemas/CountryInfo'
        extension:
          $ref: '#/components/schemas/ExtensionInfo'
        label:
          description: Custom user name of a phone number, if any. Supported for numbers assigned to Auto-Receptionist, with usage type 'CompanyNumber'
          type: string
        location:
          description: Location (City, State). Filled for local US numbers
          type: string
        paymentType:
          description: Payment type. 'External' is returned for forwarded numbers which are not terminated in the RingCentral phone system
          enum:
          - External
          - TollFree
          - Local
          type: string
        phoneNumber:
          description: Phone number
          type: string
        status:
          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: string
        type:
          description: Phone number type
          enum:
          - VoiceFax
          - FaxOnly
          - VoiceOnly
          type: string
        usageType:
          description: Usage type of the phone number
          enum:
          - MainCompanyNumber
          - AdditionalCompanyNumber
          - CompanyNumber
          - DirectNumber
          - CompanyFaxNumber
          - ForwardedNumber
          - ForwardedCompanyNumber
          - ContactCenterNumber
          type: string
      type: object
    ContentDisposition:
      properties:
        type:
          type: string
        fileName:
          type: string
        creationDate:
          format: date-time
          type: string
        modificationDate:
          format: date-time
          type: string
        readDate:
          format: date-time
          type: string
        size:
          format: int64
          type: integer
      type: object
    ForwardingNumbersResource:
      properties:
        uri:
          format: uri
          type: string
        records:
          items:
            $ref: '#/components/schemas/ForwardingNumberResource'
          type: array
        paging:
          $ref: '#/components/schemas/Paging'
        navigation:
          $ref: '#/components/schemas/Navigation'
      type: object
    ForwardingNumberResource:
      example:
        features:
        - CallFlip
        - CallFlip
        phoneNumber: phoneNumber
        flipNumber: flipNumber
        id: id
        label: label
        uri: http://example.com/aeiou
      properties:
        uri:
          format: uri
          type: string
        id:
          type: string
        phoneNumber:
          type: string
        label:
          type: string
        features:
          items:
            enum:
            - CallFlip
            - CallForwarding
            type: string
          type: array
        flipNumber:
          pattern: '[1-8]'
          type: string
      type: object
    SCIMErrorResponse:
      properties:
        detail:
          description: detail error message
          type: string
        schemas:
          items:
            enum:
            - urn:ietf:params:scim:api:messages:2.0:Error
            type: string
          type: array
        scimType:
          description: bad request type when status code is 400
          enum:
          - uniqueness
          - tooMany
          - mutability
          - sensitive
          - invalidSyntax
          - invalidFilter
          - invalidPath
          - invalidValue
          - invalidVers
          - noTarget
          type: string
        status:
          description: same as HTTP status code, e.g. 400, 401, etc.
          type: string
      type: object
    MethodInfo:
      example:
        name: Ground
        id: "1"
      properties:
        id:
          description: Method identifier. The default value is  1  (Ground)
          enum:
          - "1"
          - "2"
          - "3"
          type: string
        name:
          description: Method name, corresponding to the identifier
          enum:
          - Ground
          - 2 Day
          - Overnight
          type: string
      type: object
    PaymentInfoAddressResource:
      properties:
        country:
          type: string
        state:
          type: string
        city:
          type: string
        street:
          type: string
        zip:
          type: string
      type: object
    FederationExtensionInfo:
      example:
        firstName: firstName
        lastName: lastName
        extensionNumber: extensionNumber
        conflicts:
        - firstName: firstName
          lastName: lastName
          id: id
          account:
            federatedName: federatedName
            id: id
        - firstName: firstName
          lastName: lastName
          id: id
          account:
            federatedName: federatedName
            id: id
        id: id
      properties:
        id:
          description: Internal identifier of an extension of current account
          type: string
        extensionNumber:
          description: Number of an extension
          type: string
        firstName:
          description: Extension user first name
          type: string
        lastName:
          description: Extension user last name
          type: string
        conflicts:
          description: Conflicting extensions information
          items:
            $ref: '#/components/schemas/ConflictsInfo'
          type: array
      type: object
    BotExtensionCreationRequest:
      example:
        name: name
        applicationKey: applicationKey
        creatorId: creatorId
      properties:
        name:
          description: Bot name (equals to extension first name)
          type: string
        applicationKey:
          description: Key of a bot application
          type: string
        creatorId:
          description: User extension identifier
          type: string
      type: object
    PropertiesDelegate:
      properties:
        propertyNames:
          items:
            type: string
          type: array
      type: object
    SecretQuestionsInfoResource:
      properties:
        uri:
          format: uri
          type: string
        records:
          items:
            $ref: '#/components/schemas/SecretQuestionInfoResource'
          type: array
        paging:
          $ref: '#/components/schemas/Paging'
        navigation:
          $ref: '#/components/schemas/Navigation'
      type: object
    ExtensionWithRolesResource:
      properties:
        uri:
          format: uri
          type: string
        extensionId:
          type: string
        roles:
          items:
            $ref: '#/components/schemas/AssignedRoleResource'
          type: array
      type: object
    RecurrenceInfoReporting:
      example:
        pattern: Daily
        value: "0"
      properties:
        pattern:
          description: Pattern (frequency) of recurrence
          enum:
          - Daily
          - Weekly
          - Monthly
          type: string
        value:
          description: Time and dates should be specified in UTC time zone
          enum:
          - "0"
          - 1-7
          - 1-31
          - last
          type: string
      type: object
    GetAccountInfoResponse:
      example:
        setupWizardState: NotStarted
        statusInfo:
          reason: Voluntarily
          till: till
          comment: comment
        federated: true
        regionalSettings:
          timezone:
            name: name
            description: description
            id: id
            uri: uri
          timeFormat: 12h
          greetingLanguage:
            localeCode: localeCode
            name: name
            id: id
          formattingLocale:
            localeCode: localeCode
            name: name
            id: id
          language:
            localeCode: localeCode
            ui: true
            greeting: true
            name: name
            formattingLocale: true
            id: id
            uri: uri
          homeCountry:
            name: name
            id: id
            uri: uri
        serviceInfo:
          servicePlan:
            name: name
            edition: edition
            id: id
          billingPlan:
            duration: duration
            name: name
            id: id
            durationUnit: Month
            type: Initial
          targetServicePlan:
            name: name
            id: id
          uri: uri
          brand:
            name: name
            id: id
            homeCountry:
              name: name
              id: id
              uri: uri
        id: id
        mainNumber: mainNumber
        partnerId: partnerId
        uri: uri
        operator:
          setupWizardState: NotStarted
          statusInfo:
            reason: Voluntarily
            comment: comment
          references:
          - ref: ref
            type: PartnerId
          - ref: ref
            type: PartnerId
          profileImage:
            scales:
            - uri: uri
            - uri: uri
            etag: etag
            lastModified: 2000-01-23T04:56:07.000+00:00
            uri: uri
            contentType: contentType
          type: User
          uri: uri
          callQueueInfo:
            slaThresholdSeconds: 1
            abandonedThresholdSeconds: 5
            slaGoal: 6
            includeAbandonedCalls: true
          serviceFeatures:
          - reason: reason
            featureName: featureName
            enabled: true
          - reason: reason
            featureName: featureName
            enabled: true
          extensionNumber: extensionNumber
          permissions:
            admin:
              enabled: true
            internationalCalling:
              enabled: true
          contact:
            firstName: firstName
            lastName: lastName
            company: company
            businessPhone: businessPhone
            businessAddress:
              zip: zip
              country: country
              city: city
              street: street
              state: state
            email: email
          name: name
          regionalSettings:
            timezone:
              name: name
              description: description
              id: id
              uri: uri
            timeFormat: 12h
            greetingLanguage:
              localeCode: localeCode
              name: name
              id: id
            formattingLocale:
              localeCode: localeCode
              name: name
              id: id
            language:
              localeCode: localeCode
              ui: true
              greeting: true
              name: name
              formattingLocale: true
              id: id
              uri: uri
            homeCountry:
              name: name
              id: id
              uri: uri
          id: 0
          departments:
          - extensionNumber: extensionNumber
            id: id
            uri: uri
          - extensionNumber: extensionNumber
            id: id
            uri: uri
          partnerId: partnerId
          status: Enabled
        status: Confirmed
      properties:
        id:
          description: Internal identifier of an account
          type: string
        uri:
          description: Canonical URI of an account
          type: string
        mainNumber:
          description: Main phone number of the current account
          type: string
        operator:
          $ref: '#/components/schemas/GetExtensionInfoResponse'
        partnerId:
          description: Additional account identifier, developed and applied by the client
          type: string
        serviceInfo:
          $ref: '#/components/schemas/ServiceInfo'
        setupWizardState:
          description: Specifies account configuration wizard state (web service setup). The default value is 'NotStarted'
          enum:
          - NotStarted
          - Incomplete
          - Completed
          type: string
        status:
          description: Status of the current account
          enum:
          - Confirmed
          - Disabled
          type: string
        statusInfo:
          $ref: '#/components/schemas/AccountStatusInfo'
        regionalSettings:
          $ref: '#/components/schemas/RegionalSettings'
        federated:
          description: Specifies whether an account is included into any federation of accounts or not
          type: boolean
      type: object
    CompanyDirectoryPhoneNumberInfo:
      example:
        phoneNumber: phoneNumber
        hidden: true
        type: VoiceFax
        usageType: MobileNumber
      properties:
        phoneNumber:
          description: Extension phone number in E.164 format
          type: string
        type:
          description: Type of a phone number
          enum:
          - VoiceFax
          - FaxOnly
          - VoiceOnly
          type: string
        hidden:
          description: Specifies if a phone number should be hidden or not. Returned only if the value is 'True'
          type: boolean
        usageType:
          description: Usage type of a phone number
          enum:
          - MobileNumber
          - ContactNumber
          - DirectNumber
          - ForwardedNumber
          type: string
      type: object
    UpdateAnsweringRuleRequest:
      example:
        schedule:
          ref: BusinessHours
          ranges:
            from: 2000-01-23T04:56:07.000+00:00
            to: 2000-01-23T04:56:07.000+00:00
          weeklyRanges:
            sunday:
            - from: 2000-01-23T04:56:07.000+00:00
              to: 2000-01-23T04:56:07.000+00:00
            - from: 2000-01-23T04:56:07.000+00:00
              to: 2000-01-23T04:56:07.000+00:00
            saturday:
            - from: 2000-01-23T04:56:07.000+00:00
              to: 2000-01-23T04:56:07.000+00:00
            - from: 2000-01-23T04:56:07.000+00:00
              to: 2000-01-23T04:56:07.000+00:00
            tuesday:
            - from: 2000-01-23T04:56:07.000+00:00
              to: 2000-01-23T04:56:07.000+00:00
            - from: 2000-01-23T04:56:07.000+00:00
              to: 2000-01-23T04:56:07.000+00:00
            wednesday:
            - from: 2000-01-23T04:56:07.000+00:00
              to: 2000-01-23T04:56:07.000+00:00
            - from: 2000-01-23T04:56:07.000+00:00
              to: 2000-01-23T04:56:07.000+00:00
            thursday:
            - from: 2000-01-23T04:56:07.000+00:00
              to: 2000-01-23T04:56:07.000+00:00
            - from: 2000-01-23T04:56:07.000+00:00
              to: 2000-01-23T04:56:07.000+00:00
            friday:
            - from: 2000-01-23T04:56:07.000+00:00
              to: 2000-01-23T04:56:07.000+00:00
            - from: 2000-01-23T04:56:07.000+00:00
              to: 2000-01-23T04:56:07.000+00:00
            monday:
            - from: 2000-01-23T04:56:07.000+00:00
              to: 2000-01-23T04:56:07.000+00:00
            - from: 2000-01-23T04:56:07.000+00:00
              to: 2000-01-23T04:56:07.000+00:00
        voicemail:
          recipient:
            id: id
            uri: uri
          enabled: true
        name: name
        callers:
        - name: name
          callerId: callerId
        - name: name
          callerId: callerId
        forwarding:
          softPhonesRingCount: 0
          rules:
          - forwardingNumbers:
            - phoneNumber: phoneNumber
              id: id
              label: label
              uri: uri
            - phoneNumber: phoneNumber
              id: id
              label: label
              uri: uri
            ringCount: 1
            index: 6
          - forwardingNumbers:
            - phoneNumber: phoneNumber
              id: id
              label: label
              uri: uri
            - phoneNumber: phoneNumber
              id: id
              label: label
              uri: uri
            ringCount: 1
            index: 6
          notifyMySoftPhones: true
          notifyAdminSoftPhones: true
          ringingMode: Sequentially
        greetings:
        - preset:
            name: name
            id: id
            uri: uri
          type: Introductory
          usageType: UserExtensionAnsweringRule
        - preset:
            name: name
            id: id
            uri: uri
          type: Introductory
          usageType: UserExtensionAnsweringRule
        enabled: true
        callHandlingAction: ForwardCalls
        unconditionalForwarding:
          phoneNumber: phoneNumber
        queue:
          wrapUpTime: 7
          transferMode: Rotating
          fixedOrderAgents:
          - extension:
              extensionNumber: extensionNumber
              id: id
              partnerId: partnerId
              uri: uri
            index: 5
          - extension:
              extensionNumber: extensionNumber
              id: id
              partnerId: partnerId
              uri: uri
            index: 5
          holdAudioInterruptionPeriod: 5
          maxCallersAction: Voicemail
          maxCallers: 3
          holdAudioInterruptionMode: Never
          agentTimeout: 2
          holdTime: 9
        calledNumbers:
        - phoneNumber: phoneNumber
        - phoneNumber: phoneNumber
      properties:
        name:
          description: Name of an answering rule specified by user
          type: string
        enabled:
          description: Specifies if an answering rule is active or inactive
          type: boolean
        callers:
          description: Answering rules are applied when calls are received from specified caller(s)
          items:
            $ref: '#/components/schemas/CallersInfo'
          type: array
        calledNumbers:
          description: Answering rules are applied when calling to selected number(s)
          items:
            $ref: '#/components/schemas/CalledNumberInfo'
          type: array
        schedule:
          $ref: '#/components/schemas/ScheduleInfo'
        callHandlingAction:
          description: Specifies how incoming calls are forwarded
          enum:
          - ForwardCalls
          - UnconditionalForwarding
          - AgentQueue
          - TransferToExtension
          - TakeMessagesOnly
          - PlayAnnouncementOnly
          type: string
        forwarding:
          $ref: '#/components/schemas/ForwardingInfo'
        unconditionalForwarding:
          $ref: '#/components/schemas/UnconditionalForwardingInfo'
        queue:
          $ref: '#/components/schemas/QueueInfo'
        voicemail:
          $ref: '#/components/schemas/VoicemailInfo'
        greetings:
          description: Greetings applied for an answering rule; only predefined greetings can be applied, see Dictionary Greeting List
          items:
            $ref: '#/components/schemas/GreetingInfo'
          type: array
      type: object
    ExtensionInfoIntId:
      example:
        extensionNumber: extensionNumber
        id: 0
        partnerId: partnerId
        uri: uri
      properties:
        id:
          description: Internal identifier of an extension
          format: int64
          type: integer
        uri:
          description: Canonical URI of an extension
          type: string
        extensionNumber:
          description: Number of department extension
          type: string
        partnerId:
          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
          type: string
      type: object
    GetDeviceInfoResponse:
      example:
        extension:
          extensionNumber: extensionNumber
          id: 0
          partnerId: partnerId
          uri: uri
        phoneLines:
        - lineType: Standalone
          phoneInfo:
            country:
              name: name
              id: id
              uri: uri
            extension:
              extensionNumber: extensionNumber
              id: id
              partnerId: partnerId
              uri: uri
            phoneNumber: phoneNumber
            location: location
            id: 6
            label: label
            type: VoiceFax
            paymentType: External
            status: status
            usageType: MainCompanyNumber
        - lineType: Standalone
          phoneInfo:
            country:
              name: name
              id: id
              uri: uri
            extension:
              extensionNumber: extensionNumber
              id: id
              partnerId: partnerId
              uri: uri
            phoneNumber: phoneNumber
            location: location
            id: 6
            label: label
            type: VoiceFax
            paymentType: External
            status: status
            usageType: MainCompanyNumber
        type: SoftPhone
        uri: uri
        emergencyServiceAddress:
          zip: zip
          country: country
          city: city
          street: street
          street2: street2
          state: state
          customerName: customerName
        shipping:
          carrier: carrier
          address:
            zip: zip
            country: country
            city: city
            street: street
            street2: street2
            state: state
            customerName: customerName
          method:
            name: Ground
            id: "1"
          trackingNumber: trackingNumber
          status: Initial
        boxBillingId: 1
        serial: serial
        computerName: computerName
        name: name
        model:
          addons:
          - count: count
            id: id
          - count: count
            id: id
          name: name
          id: id
        id: id
        sku: sku
      properties:
        id:
          description: Internal identifier of a device
          type: string
        uri:
          description: Canonical URI of a device
          type: string
        sku:
          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: string
        type:
          description: Device type. The default value is 'HardPhone'
          enum:
          - SoftPhone
          - OtherPhone
          - HardPhone
          type: string
        name:
          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
          type: string
        serial:
          description: Serial number for HardPhone (is returned only when the phone is shipped and provisioned); endpoint_id for softphone and mobile applications
          type: string
        computerName:
          description: PC name for softphone
          type: string
        model:
          $ref: '#/components/schemas/ModelInfo'
        extension:
          $ref: '#/components/schemas/ExtensionInfoIntId'
        emergencyServiceAddress:
          $ref: '#/components/schemas/EmergencyAddressInfo'
        phoneLines:
          description: Phone lines information
          items:
            $ref: '#/components/schemas/PhoneLinesInfo'
          type: array
        shipping:
          $ref: '#/components/schemas/ShippingInfo'
        boxBillingId:
          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
          type: integer
      type: object
    MessageAttachmentInfoIntId:
      example:
        filename: filename
        size: 5
        vmDuration: 1
        id: 6
        type: AudioRecording
        uri: uri
        contentType: contentType
      properties:
        id:
          description: Internal identifier of a message attachment
          format: int64
          type: integer
        uri:
          description: Canonical URI of a message attachment
          type: string
        type:
          description: Type of message attachment
          enum:
          - AudioRecording
          - AudioTranscription
          - Text
          - SourceDocument
          - RenderedDocument
          - MmsAttachment
          type: string
        contentType:
          description: MIME type for a given attachment, for instance 'audio/wav'
          type: string
        vmDuration:
          description: Voicemail only Duration of the voicemail in seconds
          type: integer
        filename:
          description: Name of a file attached
          type: string
        size:
          description: Size of attachment in bytes
          type: integer
      type: object
    GlipGroupsEvent:
      properties:
        id:
          description: Internal identifier of a group
          type: string
        type:
          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
          type: string
        isPublic:
          description: For 'Team' group type only. Team access level
          type: boolean
        name:
          description: For 'Team' group type only. Team name
          type: string
        description:
          description: For 'Team' group type only. Team description
          type: string
        members:
          description: Identifier(s) of group members
          items:
            type: string
          type: array
        creationTime:
          description: Group creation datetime in ISO 8601 format
          format: date-time
          type: string
        lastModifiedTime:
          description: Group last change datetime in ISO 8601 format
          format: date-time
          type: string
        eventType:
          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
          type: string
      type: object
    ReservePhoneNumbersRecordsResource:
      example:
        records:
        - formattedNumber: formattedNumber
          phoneNumber: phoneNumber
          reservationId: reservationId
          reservedTill: reservedTill
          error: NumberIsAlreadyProvisioned
          status: Enabled
        - formattedNumber: formattedNumber
          phoneNumber: phoneNumber
          reservationId: reservationId
          reservedTill: reservedTill
          error: NumberIsAlreadyProvisioned
          status: Enabled
      properties:
        records:
          items:
            $ref: '#/components/schemas/ReservePhoneNumberResource'
          type: array
      type: object
    ScheduleInfo:
      example:
        ref: BusinessHours
        ranges:
          from: 2000-01-23T04:56:07.000+00:00
          to: 2000-01-23T04:56:07.000+00:00
        weeklyRanges:
          sunday:
          - from: 2000-01-23T04:56:07.000+00:00
            to: 2000-01-23T04:56:07.000+00:00
          - from: 2000-01-23T04:56:07.000+00:00
            to: 2000-01-23T04:56:07.000+00:00
          saturday:
          - from: 2000-01-23T04:56:07.000+00:00
            to: 2000-01-23T04:56:07.000+00:00
          - from: 2000-01-23T04:56:07.000+00:00
            to: 2000-01-23T04:56:07.000+00:00
          tuesday:
          - from: 2000-01-23T04:56:07.000+00:00
            to: 2000-01-23T04:56:07.000+00:00
          - from: 2000-01-23T04:56:07.000+00:00
            to: 2000-01-23T04:56:07.000+00:00
          wednesday:
          - from: 2000-01-23T04:56:07.000+00:00
            to: 2000-01-23T04:56:07.000+00:00
          - from: 2000-01-23T04:56:07.000+00:00
            to: 2000-01-23T04:56:07.000+00:00
          thursday:
          - from: 2000-01-23T04:56:07.000+00:00
            to: 2000-01-23T04:56:07.000+00:00
          - from: 2000-01-23T04:56:07.000+00:00
            to: 2000-01-23T04:56:07.000+00:00
          friday:
          - from: 2000-01-23T04:56:07.000+00:00
            to: 2000-01-23T04:56:07.000+00:00
          - from: 2000-01-23T04:56:07.000+00:00
            to: 2000-01-23T04:56:07.000+00:00
          monday:
          - from: 2000-01-23T04:56:07.000+00:00
            to: 2000-01-23T04:56:07.000+00:00
          - from: 2000-01-23T04:56:07.000+00:00
            to: 2000-01-23T04:56:07.000+00:00
      properties:
        weeklyRanges:
          $ref: '#/components/schemas/WeeklyScheduleInfo'
        ranges:
          $ref: '#/components/schemas/RangesInfo'
        ref:
          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
          type: string
      type: object
    CalledNumberInfo:
      example:
        phoneNumber: phoneNumber
      properties:
        phoneNumber:
          description: Called phone number
          type: string
      type: object
    CompanyAnsweringRuleExtensionInfoRequest:
      properties:
        id:
          description: Time in format hh:mm
          type: string
      type: object
    ParsePhoneNumberRequest:
      example:
        originalStrings: originalStrings
      properties:
        originalStrings:
          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
          type: string
      type: object
    ExtensionPermissions:
      example:
        admin:
          enabled: true
        internationalCalling:
          enabled: true
      properties:
        admin:
          $ref: '#/components/schemas/PermissionInfo'
        internationalCalling:
          $ref: '#/components/schemas/PermissionInfo'
      type: object
    TransitionInfo:
      example:
        sendConfirmationEmail: true
        activationEmailHash: activationEmailHash
        sendWelcomeEmail: true
        shipDevices: true
      properties:
        sendWelcomeEmail:
          default: true
          description: Supported for account confirmation. Specifies whether welcome email is sent. The default value is 'True'
          type: boolean
        sendConfirmationEmail:
          default: true
          description: Supported for account activation. Specifies whether confirmation email is sent. The default value is 'True'
          type: boolean
        shipDevices:
          default: true
          description: Specifies whether devices are shipped after successful account confirmation. The default value is 'True'
          type: boolean
        activationEmailHash:
          description: Supported for account confirmation. Activation email hash code
          type: string
      type: object
    FederationExtensionNumbers:
      example:
        records:
        - extensionNumber: extensionNumber
          id: id
        - extensionNumber: extensionNumber
          id: id
      properties:
        records:
          description: List of extension numbers of the current federation
          items:
            $ref: '#/components/schemas/FederationExtensionNumbersExtensionInfo'
          type: array
      required:
      - records
      type: object
    DetailedExtensionPresenceEvent:
      properties:
        extensionId:
          default: ~
          description: Internal identifier of an extension. Optional parameter
          type: string
        telephonyStatus:
          description: Telephony presence status. Returned if telephony status is changed.
          enum:
          - NoCall
          - CallConnected
          - Ringing
          - OnHold
          - ParkedCall
          type: string
        activeCalls:
          description: Collection of Active Call Info
          items:
            $ref: '#/components/schemas/ActiveCallInfoWithoutSIP'
          type: array
        sequence:
          description: Order number of a notification to state the chronology
          type: integer
        presenceStatus:
          description: Aggregated presence status, calculated from a number of sources
          enum:
          - Offline
          - Busy
          - Available
          type: string
        userStatus:
          description: User-defined presence status (as previously published by the user)
          enum:
          - Offline
          - Busy
          - Available
          type: string
        dndStatus:
          description: Extended DnD (Do not Disturb) status
          enum:
          - TakeAllCalls
          - DoNotAcceptAnyCalls
          - DoNotAcceptDepartmentCalls
          - TakeDepartmentCallsOnly
          type: string
        allowSeeMyPresence:
          description: If 'True' enables other extensions to see the extension presence status
          type: boolean
        ringOnMonitoredCall:
          description: If 'True' enables to ring extension phone, if any user monitored by this extension is ringing
          type: boolean
        pickUpCallsOnHold:
          description: If 'True' enables the extension user to pick up a monitored line on hold
          type: boolean
      type: object
    OptionInfoReason:
      properties:
        id:
          description: Internal code of the option disallowance reason
          type: string
        message:
          description: Text description of the option disallowance reason
          type: string
      type: object
    CustomGreetingAnsweringRuleInfo:
      example:
        id: id
        uri: uri
      properties:
        uri:
          description: Canonical URI of an answering rule
          type: string
        id:
          description: Internal identifier of an answering rule
          type: string
      type: object
    CompanyBusinessHours:
      example:
        schedule:
          weeklyRanges:
            sunday:
            - from: 2000-01-23T04:56:07.000+00:00
              to: 2000-01-23T04:56:07.000+00:00
            - from: 2000-01-23T04:56:07.000+00:00
              to: 2000-01-23T04:56:07.000+00:00
            saturday:
            - from: 2000-01-23T04:56:07.000+00:00
              to: 2000-01-23T04:56:07.000+00:00
            - from: 2000-01-23T04:56:07.000+00:00
              to: 2000-01-23T04:56:07.000+00:00
            tuesday:
            - from: 2000-01-23T04:56:07.000+00:00
              to: 2000-01-23T04:56:07.000+00:00
            - from: 2000-01-23T04:56:07.000+00:00
              to: 2000-01-23T04:56:07.000+00:00
            wednesday:
            - from: 2000-01-23T04:56:07.000+00:00
              to: 2000-01-23T04:56:07.000+00:00
            - from: 2000-01-23T04:56:07.000+00:00
              to: 2000-01-23T04:56:07.000+00:00
            thursday:
            - from: 2000-01-23T04:56:07.000+00:00
              to: 2000-01-23T04:56:07.000+00:00
            - from: 2000-01-23T04:56:07.000+00:00
              to: 2000-01-23T04:56:07.000+00:00
            friday:
            - from: 2000-01-23T04:56:07.000+00:00
              to: 2000-01-23T04:56:07.000+00:00
            - from: 2000-01-23T04:56:07.000+00:00
              to: 2000-01-23T04:56:07.000+00:00
            monday:
            - from: 2000-01-23T04:56:07.000+00:00
              to: 2000-01-23T04:56:07.000+00:00
            - from: 2000-01-23T04:56:07.000+00:00
              to: 2000-01-23T04:56:07.000+00:00
        uri: uri
      properties:
        uri:
          description: 'Canonical URI of a business-hours resource '
          type: string
        schedule:
          $ref: '#/components/schemas/CompanyBusinessHoursScheduleInfo'
      type: object
    AccountActiveCallsResponse:
      properties:
        records:
          description: List of call log records
          items:
            $ref: '#/components/schemas/CallLogRecord'
          type: array
        navigation:
          $ref: '#/components/schemas/NavigationInfo'
        paging:
          $ref: '#/components/schemas/PagingInfo'
      required:
      - navigation
      - paging
      - records
      type: object
    SubResource:
      properties:
        uri:
          format: uri
          type: string
        resourceDescription:
          type: string
        parentId:
          format: int64
          type: integer
        subId:
          format: int64
          type: integer
        subVer:
          $ref: '#/components/schemas/ApiVersionResource'
      type: object
    PhoneNumbersRecordsResource:
      properties:
        uri:
          format: uri
          type: string
        records:
          items:
            $ref: '#/components/schemas/PhoneNumberResource'
          type: array
      type: object
    UserGroupManagerResource:
      properties:
        uri:
          format: uri
          type: string
        id:
          type: string
        extensionNumber:
          type: string
        firstName:
          type: string
        lastName:
          type: string
      type: object
    CompanyAnsweringRuleTimeIntervalRequest:
      example:
        from: from
        to: to
      properties:
        from:
          description: Time in format hh:mm
          type: string
        to:
          description: Time in format hh:mm
          type: string
      type: object
    UpdateMessageRequest:
      example:
        readStatus: Read
      properties:
        readStatus:
          description: Read status of a message to be changed. Multiple values are accepted
          enum:
          - Read
          - Unread
          type: string
      type: object
    StatesResource:
      properties:
        uri:
          format: uri
          type: string
        records:
          items:
            $ref: '#/components/schemas/StateResource'
          type: array
        paging:
          $ref: '#/components/schemas/Paging'
        navigation:
          $ref: '#/components/schemas/Navigation'
      type: object
    CustomDataRequest:
      example:
        id: id
        value: value
      properties:
        id:
          description: Custom data access key. Optional. If specified, must match the custom key in the URL
          type: string
        value:
          description: Description of custom data. Mandatory for create, if there is no attachment specified. Maximum length is limited to 256 symbols
          type: string
      type: object
    ServicePlan:
      properties:
        id:
          type: string
        name:
          type: string
        edition:
          enum:
          - Unknown
          - Standard
          - Premium
          - Enterprise
          - Unlimited
          - HighUsage
          type: string
      type: object
    ActivePermissionResource:
      example:
        permission:
          id: id
          uri: http://example.com/aeiou
        scopes:
        - scopes
        - scopes
        effectiveRole:
          id: id
          uri: http://example.com/aeiou
      properties:
        permission:
          $ref: '#/components/schemas/PermissionIdResource'
        effectiveRole:
          $ref: '#/components/schemas/RoleIdResource'
        scopes:
          items:
            type: string
          type: array
      type: object
    AnsweringRuleResource:
      properties:
        uri:
          format: uri
          type: string
        id:
          type: string
        type:
          enum:
          - BusinessHours
          - AfterHours
          - Custom
          type: string
        name:
          maxLength: 30
          minLength: 0
          type: string
        enabled:
          default: false
          type: boolean
        schedule:
          $ref: '#/components/schemas/ScheduleResource'
        callers:
          items:
            $ref: '#/components/schemas/CallerResource'
          type: array
        calledNumbers:
          items:
            $ref: '#/components/schemas/PhoneNumberResource'
          type: array
        callHandlingAction:
          enum:
          - ForwardCalls
          - TakeMessagesOnly
          - PlayAnnouncementOnly
          - UnconditionalForwarding
          - AgentQueue
          - Unknown
          type: string
        forwarding:
          $ref: '#/components/schemas/AnsweringForwardingResource'
        unconditionalForwarding:
          $ref: '#/components/schemas/UnconditionalForwardingResource'
        voicemail:
          $ref: '#/components/schemas/VoicemailSettingsResource'
      type: object
    ClientInfoResource:
      properties:
        uri:
          format: uri
          type: string
        client:
          $ref: '#/components/schemas/ClientResource'
        provisioning:
          $ref: '#/components/schemas/ProvisioningResource'
      type: object
    ExtensionIdResource:
      properties:
        uri:
          format: uri
          type: string
        id:
          type: string
        extensionNumber:
          type: string
      type: object
    AttachmentInfoReporting:
      example:
        pdf: true
        csv: true
      properties:
        csv:
          description: Specifies whether to include CSV version of the report
          type: boolean
        pdf:
          description: Specifies whether to include PDF version of the report
          type: boolean
      type: object
    ApplicationResource:
      properties:
        id:
          type: string
        name:
          type: string
        description:
          type: string
        organization:
          $ref: '#/components/schemas/OrganizationResource'
        scope:
          type: string
        platformType:
          type: string
        permissions:
          items:
            $ref: '#/components/schemas/PermissionResource'
          type: array
      type: object
    PresencePermissions:
      properties:
        targetExtensionId:
          type: string
        subscriberExtensionId:
          type: string
        canReadPresenceStatus:
          default: false
          type: boolean
        canReadPresenceSettings:
          default: false
          type: boolean
        canPickup:
          default: false
          type: boolean
      type: object
    GetRingOutStatusResponseIntId:
      example:
        id: 0
        uri: uri
        status:
          calleeStatus: Invalid
          callStatus: Invalid
          callerStatus: Invalid
      properties:
        id:
          description: Internal identifier of a RingOut call
          format: int64
          type: integer
        uri:
          type: string
        status:
          $ref: '#/components/schemas/RingOutStatusInfo'
      type: object
    ExtensionActiveCallsResponse:
      example:
        navigation:
          previousPage:
            uri: uri
          firstPage:
            uri: uri
          lastPage:
            uri: uri
          nextPage:
            uri: uri
        records:
        - lastModifiedTime: 2000-01-23T04:56:07.000+00:00
          recording:
            contentUri: contentUri
            id: id
            type: Automatic
            uri: uri
          sessionId: sessionId
          transport: PSTN
          type: Voice
          uri: uri
          result: Unknown
          duration: 0
          legs:
          - duration: 6
            result: Unknown
            extension:
              id: id
              uri: uri
            legType: legType
            action: Unknown
            recording:
              contentUri: contentUri
              id: id
              type: Automatic
              uri: uri
            startTime: 2000-01-23T04:56:07.000+00:00
            from:
              phoneNumber: phoneNumber
              extensionNumber: extensionNumber
              name: name
              location: location
              device:
                id: id
                uri: uri
            to:
              phoneNumber: phoneNumber
              extensionNumber: extensionNumber
              name: name
              location: location
              device:
                id: id
                uri: uri
            transport: PSTN
            type: Voice
            direction: Inbound
          - duration: 6
            result: Unknown
            extension:
              id: id
              uri: uri
            legType: legType
            action: Unknown
            recording:
              contentUri: contentUri
              id: id
              type: Automatic
              uri: uri
            startTime: 2000-01-23T04:56:07.000+00:00
            from:
              phoneNumber: phoneNumber
              extensionNumber: extensionNumber
              name: name
              location: location
              device:
                id: id
                uri: uri
            to:
              phoneNumber: phoneNumber
              extensionNumber: extensionNumber
              name: name
              location: location
              device:
                id: id
                uri: uri
            transport: PSTN
            type: Voice
            direction: Inbound
          action: Unknown
          from:
            phoneNumber: phoneNumber
            extensionNumber: extensionNumber
            name: name
            location: location
            device:
              id: id
              uri: uri
          startTime: 2000-01-23T04:56:07.000+00:00
          id: id
          to:
            phoneNumber: phoneNumber
            extensionNumber: extensionNumber
            name: name
            location: location
            device:
              id: id
              uri: uri
          direction: Inbound
        - lastModifiedTime: 2000-01-23T04:56:07.000+00:00
          recording:
            contentUri: contentUri
            id: id
            type: Automatic
            uri: uri
          sessionId: sessionId
          transport: PSTN
          type: Voice
          uri: uri
          result: Unknown
          duration: 0
          legs:
          - duration: 6
            result: Unknown
            extension:
              id: id
              uri: uri
            legType: legType
            action: Unknown
            recording:
              contentUri: contentUri
              id: id
              type: Automatic
              uri: uri
            startTime: 2000-01-23T04:56:07.000+00:00
            from:
              phoneNumber: phoneNumber
              extensionNumber: extensionNumber
              name: name
              location: location
              device:
                id: id
                uri: uri
            to:
              phoneNumber: phoneNumber
              extensionNumber: extensionNumber
              name: name
              location: location
              device:
                id: id
                uri: uri
            transport: PSTN
            type: Voice
            direction: Inbound
          - duration: 6
            result: Unknown
            extension:
              id: id
              uri: uri
            legType: legType
            action: Unknown
            recording:
              contentUri: contentUri
              id: id
              type: Automatic
              uri: uri
            startTime: 2000-01-23T04:56:07.000+00:00
            from:
              phoneNumber: phoneNumber
              extensionNumber: extensionNumber
              name: name
              location: location
              device:
                id: id
                uri: uri
            to:
              phoneNumber: phoneNumber
              extensionNumber: extensionNumber
              name: name
              location: location
              device:
                id: id
                uri: uri
            transport: PSTN
            type: Voice
            direction: Inbound
          action: Unknown
          from:
            phoneNumber: phoneNumber
            extensionNumber: extensionNumber
            name: name
            location: location
            device:
              id: id
              uri: uri
          startTime: 2000-01-23T04:56:07.000+00:00
          id: id
          to:
            phoneNumber: phoneNumber
            extensionNumber: extensionNumber
            name: name
            location: location
            device:
              id: id
              uri: uri
          direction: Inbound
        paging:
          perPage: 5
          pageStart: 5
          pageEnd: 2
          totalPages: 7
          page: 1
          totalElements: 9
      properties:
        records:
          description: List of call log records
          items:
            $ref: '#/components/schemas/CallLogRecord'
          type: array
        navigation:
          $ref: '#/components/schemas/NavigationInfo'
        paging:
          $ref: '#/components/schemas/PagingInfo'
      required:
      - navigation
      - paging
      - records
      type: object
    GetExtensionForwardingNumberListResponse:
      example:
        navigation:
          previousPage:
            uri: uri
          firstPage:
            uri: uri
          lastPage:
            uri: uri
          nextPage:
            uri: uri
        records:
        - features:
          - CallFlip
          - CallFlip
          phoneNumber: phoneNumber
          flipNumber: flipNumber
          id: id
          label: label
          uri: uri
        - features:
          - CallFlip
          - CallFlip
          phoneNumber: phoneNumber
          flipNumber: flipNumber
          id: id
          label: label
          uri: uri
        paging:
          perPage: 5
          pageStart: 5
          pageEnd: 2
          totalPages: 7
          page: 1
          totalElements: 9
      properties:
        records:
          description: List of forwarding phone numbers
          items:
            $ref: '#/components/schemas/ForwardingNumberInfo'
          type: array
        navigation:
          $ref: '#/components/schemas/NavigationInfo'
        paging:
          $ref: '#/components/schemas/PagingInfo'
      type: object
    BlacklistEntryResource:
      properties:
        uri:
          format: uri
          type: string
        id:
          type: string
        phoneNumber:
          type: string
        name:
          type: string
      type: object
    InvoiceSettingsResource:
      properties:
        maxAmountPerFirstMonth:
          format: int64
          type: integer
        maxAmountPerMonth:
          format: int64
          type: integer
        paymentTerm:
          format: int64
          type: integer
        period:
          format: int64
          type: integer
        address:
          $ref: '#/components/schemas/Address'
      type: object
    TransferredExtensionInfo:
      example:
        extension:
          extensionNumber: extensionNumber
          id: id
          partnerId: partnerId
          uri: uri
      properties:
        extension:
          $ref: '#/components/schemas/ExtensionInfo'
      type: object
    PagesInfoReporting:
      example:
        name: name
        attrX: attrX
      properties:
        name:
          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
          type: string
        attrX:
          description: CFA-defined filter values/page parameters
          type: string
      required:
      - name
      type: object
    LicenseTypeInfoRequest:
      example:
        sku: RMS
      properties:
        sku:
          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
          type: string
      type: object
    NumberPortingRequest:
      properties:
        rcAccountId:
          format: int64
          type: integer
        rcOrderId:
          format: int64
          type: integer
        orderStatus:
          type: string
        timestamp:
          type: string
        jcode:
          type: string
        completionDate:
          type: string
        transferDate:
          type: string
      type: object
    AnsweringRulesResource:
      properties:
        uri:
          format: uri
          type: string
        records:
          items:
            $ref: '#/components/schemas/AnsweringRuleResource'
          type: array
        paging:
          $ref: '#/components/schemas/Paging'
        navigation:
          $ref: '#/components/schemas/Navigation'
      type: object
    AcceptableLanguageTag:
      properties:
        tag:
          type: string
        primaryTag:
          type: string
        subTags:
          type: string
        quality:
          format: int32
          type: integer
        asLocale:
          $ref: '#/components/schemas/Locale'
      type: object
    AccountCallLogResponse:
      example:
        navigation:
          previousPage:
            uri: uri
          firstPage:
            uri: uri
          lastPage:
            uri: uri
          nextPage:
            uri: uri
        records:
        - lastModifiedTime: 2000-01-23T04:56:07.000+00:00
          recording:
            contentUri: contentUri
            id: id
            type: Automatic
            uri: uri
          sessionId: sessionId
          transport: PSTN
          type: Voice
          uri: uri
          result: Unknown
          duration: 0
          legs:
          - duration: 6
            result: Unknown
            extension:
              id: id
              uri: uri
            legType: legType
            action: Unknown
            recording:
              contentUri: contentUri
              id: id
              type: Automatic
              uri: uri
            startTime: 2000-01-23T04:56:07.000+00:00
            from:
              phoneNumber: phoneNumber
              extensionNumber: extensionNumber
              name: name
              location: location
              device:
                id: id
                uri: uri
            to:
              phoneNumber: phoneNumber
              extensionNumber: extensionNumber
              name: name
              location: location
              device:
                id: id
                uri: uri
            transport: PSTN
            type: Voice
            direction: Inbound
          - duration: 6
            result: Unknown
            extension:
              id: id
              uri: uri
            legType: legType
            action: Unknown
            recording:
              contentUri: contentUri
              id: id
              type: Automatic
              uri: uri
            startTime: 2000-01-23T04:56:07.000+00:00
            from:
              phoneNumber: phoneNumber
              extensionNumber: extensionNumber
              name: name
              location: location
              device:
                id: id
                uri: uri
            to:
              phoneNumber: phoneNumber
              extensionNumber: extensionNumber
              name: name
              location: location
              device:
                id: id
                uri: uri
            transport: PSTN
            type: Voice
            direction: Inbound
          action: Unknown
          from:
            phoneNumber: phoneNumber
            extensionNumber: extensionNumber
            name: name
            location: location
            device:
              id: id
              uri: uri
          startTime: 2000-01-23T04:56:07.000+00:00
          id: id
          to:
            phoneNumber: phoneNumber
            extensionNumber: extensionNumber
            name: name
            location: location
            device:
              id: id
              uri: uri
          direction: Inbound
        - lastModifiedTime: 2000-01-23T04:56:07.000+00:00
          recording:
            contentUri: contentUri
            id: id
            type: Automatic
            uri: uri
          sessionId: sessionId
          transport: PSTN
          type: Voice
          uri: uri
          result: Unknown
          duration: 0
          legs:
          - duration: 6
            result: Unknown
            extension:
              id: id
              uri: uri
            legType: legType
            action: Unknown
            recording:
              contentUri: contentUri
              id: id
              type: Automatic
              uri: uri
            startTime: 2000-01-23T04:56:07.000+00:00
            from:
              phoneNumber: phoneNumber
              extensionNumber: extensionNumber
              name: name
              location: location
              device:
                id: id
                uri: uri
            to:
              phoneNumber: phoneNumber
              extensionNumber: extensionNumber
              name: name
              location: location
              device:
                id: id
                uri: uri
            transport: PSTN
            type: Voice
            direction: Inbound
          - duration: 6
            result: Unknown
            extension:
              id: id
              uri: uri
            legType: legType
            action: Unknown
            recording:
              contentUri: contentUri
              id: id
              type: Automatic
              uri: uri
            startTime: 2000-01-23T04:56:07.000+00:00
            from:
              phoneNumber: phoneNumber
              extensionNumber: extensionNumber
              name: name
              location: location
              device:
                id: id
                uri: uri
            to:
              phoneNumber: phoneNumber
              extensionNumber: extensionNumber
              name: name
              location: location
              device:
                id: id
                uri: uri
            transport: PSTN
            type: Voice
            direction: Inbound
          action: Unknown
          from:
            phoneNumber: phoneNumber
            extensionNumber: extensionNumber
            name: name
            location: location
            device:
              id: id
              uri: uri
          startTime: 2000-01-23T04:56:07.000+00:00
          id: id
          to:
            phoneNumber: phoneNumber
            extensionNumber: extensionNumber
            name: name
            location: location
            device:
              id: id
              uri: uri
          direction: Inbound
        paging:
          perPage: 5
          pageStart: 5
          pageEnd: 2
          totalPages: 7
          page: 1
          totalElements: 9
      properties:
        records:
          description: List of call log records
          items:
            $ref: '#/components/schemas/CallLogRecord'
          type: array
        navigation:
          $ref: '#/components/schemas/NavigationInfo'
        paging:
          $ref: '#/components/schemas/PagingInfo'
      required:
      - navigation
      - paging
      - records
      type: object
    ServiceParameterResource:
      properties:
        id:
          type: string
        value:
          type: string
        accountId:
          type: string
      type: object
    LanguageInfoResources:
      properties:
        uri:
          format: uri
          type: string
        records:
          items:
            $ref: '#/components/schemas/LanguageInfoResource'
          type: array
        paging:
          $ref: '#/components/schemas/Paging'
        navigation:
          $ref: '#/components/schemas/Navigation'
      type: object
    RoleIdResource:
      example:
        id: id
        uri: http://example.com/aeiou
      properties:
        uri:
          format: uri
          type: string
        id:
          type: string
      type: object
    ExtensionResourceIntId:
      example:
        setupWizardState: NotStarted
        statusInfo:
          reason: reason
          till: 2000-01-23T04:56:07.000+00:00
          comment: comment
        references:
        - ref: ref
          type: PartnerId
        - ref: ref
          type: PartnerId
        profileImage:
          scales:
          - uri: http://example.com/aeiou
          - uri: http://example.com/aeiou
          etag: etag
          lastModified: 2000-01-23T04:56:07.000+00:00
          uri: http://example.com/aeiou
          contentType: contentType
        type: Unknown
        uri: http://example.com/aeiou
        ivrPin: ivrPin
        password: password
        serviceFeatures:
        - reason: Available
          featureName: featureName
          enabled: false
        - reason: Available
          featureName: featureName
          enabled: false
        extensionNumber: extensionNumber
        permissions:
          admin:
            enabled: false
          uri: http://example.com/aeiou
          internationalCalling:
            enabled: false
          freeSoftPhoneDigitalLine:
            enabled: false
        loginName: loginName
        contact:
          firstName: firstName
          lastName: lastName
          company: company
          businessPhone: businessPhone
          businessAddress:
            zip: zip
            country: country
            city: city
            street: street
            state: state
          email: email
        name: name
        regionalSettings:
          timezone:
            name: name
            description: description
            id: id
            uri: http://example.com/aeiou
          greetingLanguage:
            localeCode: localeCode
            name: name
            id: id
          formattingLocale:
            localeCode: localeCode
            name: name
            id: id
          language:
            localeCode: localeCode
            name: name
            id: id
          homeCountry:
            callingCode: callingCode
            numberSelling: false
            isoCode: isoCode
            emergencyCalling: false
            name: name
            id: id
            uri: http://example.com/aeiou
            loginAllowed: false
        id: 6
        partnerId: partnerId
        departments:
        - extensionNumber: extensionNumber
          id: id
          uri: http://example.com/aeiou
        - extensionNumber: extensionNumber
          id: id
          uri: http://example.com/aeiou
        status: Enabled
      properties:
        uri:
          format: uri
          type: string
        id:
          format: int64
          type: integer
        partnerId:
          maxLength: 128
          minLength: 0
          pattern: ^[\p{Alnum}\.\-_]*$
          type: string
        extensionNumber:
          type: string
        loginName:
          type: string
        contact:
          $ref: '#/components/schemas/ContactInfo'
        references:
          items:
            $ref: '#/components/schemas/Reference'
          type: array
        name:
          type: string
        type:
          enum:
          - Unknown
          - User
          - Department
          - Announcement
          - Voicemail
          - DigitalUser
          - VirtualUser
          - FaxUser
          - PagingOnly
          - SharedLinesGroup
          - IvrMenu
          - ApplicationExtension
          - ParkLocation
          type: string
        status:
          enum:
          - Enabled
          - Disabled
          - Frozen
          - NotActivated
          - Unassigned
          type: string
        statusInfo:
          $ref: '#/components/schemas/StatusInfo'
        departments:
          items:
            $ref: '#/components/schemas/DepartmentResource'
          type: array
        serviceFeatures:
          items:
            $ref: '#/components/schemas/ServiceFeatureValue'
          type: array
        regionalSettings:
          $ref: '#/components/schemas/RegionalSettingsResource'
        setupWizardState:
          enum:
          - NotStarted
          - Incomplete
          - Completed
          - Unknown
          type: string
        permissions:
          $ref: '#/components/schemas/ExtensionPermissionsResource'
        password:
          type: string
        ivrPin:
          type: string
        profileImage:
          $ref: '#/components/schemas/ProfileImageResource'
      type: object
    AccountServiceInfoResource:
      properties:
        uri:
          format: uri
          type: string
        servicePlanName:
          type: string
        brand:
          $ref: '#/components/schemas/Brand'
        servicePlan:
          $ref: '#/components/schemas/ServicePlan'
        targetServicePlan:
          $ref: '#/components/schemas/ServicePlan'
        billingPlan:
          $ref: '#/components/schemas/BillingPlanResource'
        serviceFeatures:
          items:
            $ref: '#/components/schemas/ServiceFeatureValue'
          type: array
        limits:
          $ref: '#/components/schemas/AccountLimitsResource'
      type: object
    GetMessageSyncResponse:
      example:
        records:
        - readStatus: Read
          faxResolution: High
          attachments:
          - filename: filename
            size: 6
            vmDuration: 0
            id: id
            type: AudioRecording
            uri: uri
            contentType: contentType
          - filename: filename
            size: 6
            vmDuration: 0
            id: id
            type: AudioRecording
            uri: uri
            contentType: contentType
          lastModifiedTime: 2000-01-23T04:56:07.000+00:00
          creationTime: 2000-01-23T04:56:07.000+00:00
          conversationId: 1
          deliveryErrorCode: deliveryErrorCode
          subject: subject
          vmTranscriptionStatus: NotAvailable
          availability: Alive
          priority: Normal
          type: Fax
          uri: uri
          messageStatus: Queued
          faxPageCount: 5
          smsSendingAttemptsCount: 5
          smsDeliveryTime: 2000-01-23T04:56:07.000+00:00
          pgToDepartment: true
          from:
            messageStatus: Queued
            faxErrorCode: Undefined
            phoneNumber: phoneNumber
            extensionNumber: extensionNumber
            name: name
            location: location
          id: id
          to:
          - messageStatus: Queued
            faxErrorCode: Undefined
            phoneNumber: phoneNumber
            extensionNumber: extensionNumber
            name: name
            location: location
          - messageStatus: Queued
            faxErrorCode: Undefined
            phoneNumber: phoneNumber
            extensionNumber: extensionNumber
            name: name
            location: location
          direction: Inbound
        - readStatus: Read
          faxResolution: High
          attachments:
          - filename: filename
            size: 6
            vmDuration: 0
            id: id
            type: AudioRecording
            uri: uri
            contentType: contentType
          - filename: filename
            size: 6
            vmDuration: 0
            id: id
            type: AudioRecording
            uri: uri
            contentType: contentType
          lastModifiedTime: 2000-01-23T04:56:07.000+00:00
          creationTime: 2000-01-23T04:56:07.000+00:00
          conversationId: 1
          deliveryErrorCode: deliveryErrorCode
          subject: subject
          vmTranscriptionStatus: NotAvailable
          availability: Alive
          priority: Normal
          type: Fax
          uri: uri
          messageStatus: Queued
          faxPageCount: 5
          smsSendingAttemptsCount: 5
          smsDeliveryTime: 2000-01-23T04:56:07.000+00:00
          pgToDepartment: true
          from:
            messageStatus: Queued
            faxErrorCode: Undefined
            phoneNumber: phoneNumber
            extensionNumber: extensionNumber
            name: name
            location: location
          id: id
          to:
          - messageStatus: Queued
            faxErrorCode: Undefined
            phoneNumber: phoneNumber
            extensionNumber: extensionNumber
            name: name
            location: location
          - messageStatus: Queued
            faxErrorCode: Undefined
            phoneNumber: phoneNumber
            extensionNumber: extensionNumber
            name: name
            location: location
          direction: Inbound
        syncInfo:
          syncTime: 2000-01-23T04:56:07.000+00:00
          syncToken: syncToken
          syncType: FSync
      properties:
        records:
          description: List of message records with synchronization information
          items:
            $ref: '#/components/schemas/GetMessageInfoResponse'
          type: array
        syncInfo:
          $ref: '#/components/schemas/SyncInfoMessages'
      required:
      - records
      - syncInfo
      type: object
    MeetingLinks:
      example:
        startUri: startUri
        joinUri: joinUri
      properties:
        startUri:
          type: string
        joinUri:
          type: string
      type: object
    ParsedNumberResource:
      properties:
        uri:
          format: uri
          type: string
        originalString:
          type: string
        country:
          $ref: '#/components/schemas/CountryResource'
        areaCode:
          type: string
        subscriberNumber:
          type: string
        formattedNational:
          type: string
        formattedInternational:
          type: string
        dialable:
          type: string
        e164:
          type: string
        special:
          default: false
          type: boolean
        normalized:
          type: string
        tollFree:
          default: false
          type: boolean
        subAddress:
          type: string
        dtmfPostfix:
          type: string
      type: object
    NotificationDeliveryModeRequest:
      example:
        address: address
        encryption: true
        registrationId: registrationId
        certificateName: certificateName
        transportType: PubNub
      properties:
        transportType:
          description: Notifications transportation provider name. 'APNS' (Apple Push Notifications Service)
          enum:
          - PubNub
          - Webhook
          - APNS
          - PubNub/APNS
          - PubNub/GCM
          type: string
        address:
          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)
          type: string
        encryption:
          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'
          type: boolean
        certificateName:
          description: For 'PubNub/APNS' and 'PubNub/GCM' transport types. Name of a certificate
          type: string
        registrationId:
          description: For 'PubNub/APNS' and 'PubNub/GCM' transport types. Identifier of a registration
          type: string
      type: object
    BannerInfo:
      example:
        bannerType: bannerType
        description: description
        content: content
        expirationDate: expirationDate
      properties:
        bannerType:
          description: Type of a banner
          type: string
        description:
          description: Custom text description of a banner
          type: string
        content:
          description: HTML formatted message content
          type: string
        expirationDate:
          description: Datetime of message expiration in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z
          type: string
      type: object
    AccountServiceInfo:
      example:
        servicePlanName: servicePlanName
        servicePlan:
          name: name
          edition: edition
          id: id
        serviceFeatures:
        - featureName: featureName
          enabled: true
        - featureName: featureName
          enabled: true
        billingPlan:
          duration: duration
          name: name
          id: id
          durationUnit: Month
          type: Initial
        uri: uri
        brand:
          name: name
          id: id
          homeCountry:
            name: name
            id: id
            uri: uri
        limits:
          freeSoftPhoneLinesPerExtension: 0
          meetingSize: 6
          maxMonitoredExtensionsPerUser: 1
          maxExtensionNumberLength: 5
      properties:
        uri:
          description: Canonical URI of the account Service Info resource
          type: string
        servicePlanName:
          description: Account Service Plan name
          type: string
        brand:
          $ref: '#/components/schemas/BrandInfo'
        servicePlan:
          $ref: '#/components/schemas/ServicePlanInfo'
        billingPlan:
          $ref: '#/components/schemas/BillingPlanInfo'
        serviceFeatures:
          description: Service features information, see Service Feature List
          items:
            $ref: '#/components/schemas/ServiceFeatureInfo'
          type: array
        limits:
          $ref: '#/components/schemas/AccountLimits'
      type: object
    AccountStatusInfo:
      example:
        reason: Voluntarily
        till: till
        comment: comment
      properties:
        comment:
          description: A free-form user comment, describing the status change reason
          type: string
        reason:
          description: Type of suspension
          enum:
          - Voluntarily
          - Involuntarily
          type: string
        till:
          description: Date until which the account will get deleted. The default value is 30 days since current date
          type: string
      type: object
    DeviceModelExtResource:
      example:
        model:
          addons:
          - name: name
            count: 0
            id: id
          - name: name
            count: 0
            id: id
          name: name
          id: id
        sku: sku
        type: SoftPhone
      properties:
        sku:
          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: string
        type:
          description: Device type. The default value is 'HardPhone'
          enum:
          - SoftPhone
          - HardPhone
          - OtherPhone
          type: string
        model:
          $ref: '#/components/schemas/DeviceModelResource'
      type: object
    AcceptableMediaType:
      properties:
        type:
          type: string
        subtype:
          type: string
        quality:
          format: int32
          type: integer
        wildcardType:
          default: false
          type: boolean
        wildcardSubtype:
          default: false
          type: boolean
      type: object
    PatternWithGroups:
      properties:
        regex:
          type: string
        groupIndexes:
          items:
            format: int32
            type: integer
          type: array
      type: object
    CreateSipRegistrationRequest:
      example:
        device:
        - computerName: computerName
          appExternalId: appExternalId
          id: id
        - computerName: computerName
          appExternalId: appExternalId
          id: id
        sipInfo:
        - transport: UDP
        - transport: UDP
      properties:
        device:
          description: Device unique description
          items:
            $ref: '#/components/schemas/DeviceInfoRequest'
          type: array
        sipInfo:
          description: SIP settings for device
          items:
            $ref: '#/components/schemas/SIPInfoRequest'
          type: array
      required:
      - device
      - sipInfo
      type: object
    OrderLicensesRequest:
      example:
        addedLicenses:
        - quantity: 0
          type:
            sku: RMS
        - quantity: 0
          type:
            sku: RMS
      properties:
        addedLicenses:
          description: List of licenses to be purchased
          items:
            $ref: '#/components/schemas/LicenseInfoRequest'
          type: array
      type: object
    PhoneNumberStringsResource:
      properties:
        uri:
          format: uri
          type: string
        originalStrings:
          items:
            type: string
          type: array
      type: object
    PermissionCategoryIdResource:
      example:
        id: id
        uri: http://example.com/aeiou
      properties:
        uri:
          format: uri
          type: string
        id:
          type: string
      type: object
    GetExtensionGrantListResponse:
      example:
        navigation:
          previousPage:
            uri: uri
          firstPage:
            uri: uri
          lastPage:
            uri: uri
          nextPage:
            uri: uri
        records:
        - extension:
            extensionNumber: extensionNumber
            id: id
            type: User
            uri: uri
          callPickup: true
          callMonitoring: true
          uri: uri
        - extension:
            extensionNumber: extensionNumber
            id: id
            type: User
            uri: uri
          callPickup: true
          callMonitoring: true
          uri: uri
        paging:
          perPage: 5
          pageStart: 5
          pageEnd: 2
          totalPages: 7
          page: 1
          totalElements: 9
      properties:
        records:
          description: List of extension grants with the data
          items:
            $ref: '#/components/schemas/GrantInfo'
          type: array
        navigation:
          $ref: '#/components/schemas/NavigationInfo'
        paging:
          $ref: '#/components/schemas/PagingInfo'
      required:
      - navigation
      - paging
      - records
      type: object
    PresenceLinesNavigationResource:
      properties:
        uri:
          format: uri
          type: string
        records:
          items:
            $ref: '#/components/schemas/PresenceLineResource'
          type: array
        paging:
          $ref: '#/components/schemas/Paging'
        navigation:
          $ref: '#/components/schemas/Navigation'
      type: object
    CompanyBusinessHoursScheduleInfo:
      example:
        weeklyRanges:
          sunday:
          - from: 2000-01-23T04:56:07.000+00:00
            to: 2000-01-23T04:56:07.000+00:00
          - from: 2000-01-23T04:56:07.000+00:00
            to: 2000-01-23T04:56:07.000+00:00
          saturday:
          - from: 2000-01-23T04:56:07.000+00:00
            to: 2000-01-23T04:56:07.000+00:00
          - from: 2000-01-23T04:56:07.000+00:00
            to: 2000-01-23T04:56:07.000+00:00
          tuesday:
          - from: 2000-01-23T04:56:07.000+00:00
            to: 2000-01-23T04:56:07.000+00:00
          - from: 2000-01-23T04:56:07.000+00:00
            to: 2000-01-23T04:56:07.000+00:00
          wednesday:
          - from: 2000-01-23T04:56:07.000+00:00
            to: 2000-01-23T04:56:07.000+00:00
          - from: 2000-01-23T04:56:07.000+00:00
            to: 2000-01-23T04:56:07.000+00:00
          thursday:
          - from: 2000-01-23T04:56:07.000+00:00
            to: 2000-01-23T04:56:07.000+00:00
          - from: 2000-01-23T04:56:07.000+00:00
            to: 2000-01-23T04:56:07.000+00:00
          friday:
          - from: 2000-01-23T04:56:07.000+00:00
            to: 2000-01-23T04:56:07.000+00:00
          - from: 2000-01-23T04:56:07.000+00:00
            to: 2000-01-23T04:56:07.000+00:00
          monday:
          - from: 2000-01-23T04:56:07.000+00:00
            to: 2000-01-23T04:56:07.000+00:00
          - from: 2000-01-23T04:56:07.000+00:00
            to: 2000-01-23T04:56:07.000+00:00
      properties:
        weeklyRanges:
          $ref: '#/components/schemas/WeeklyScheduleInfo'
      type: object
    CallLogRecordingInfoResource:
      properties:
        uri:
          format: uri
          type: string
        id:
          type: string
        contentUri:
          format: uri
          type: string
        contentType:
          type: string
        duration:
          format: int64
          type: integer
      type: object
    Reference:
      example:
        ref: ref
        type: PartnerId
      properties:
        type:
          enum:
          - PartnerId
          - CustomerDirectoryId
          type: string
        ref:
          type: string
      type: object
    SecretQuestionInfoVerificationRequest:
      example:
        answer: answer
        id: id
      properties:
        id:
          description: Internal identifier of a secret question
          type: string
        answer:
          description: Answer to a secret question
          type: string
      type: object
    UserGroupResource:
      properties:
        uri:
          format: uri
          type: string
        id:
          pattern: ^\d+$
          type: string
        displayName:
          maxLength: 128
          minLength: 0
          pattern: ^((?!(<|>|\/|\")).)*$
          type: string
        description:
          maxLength: 2000
          minLength: 0
          pattern: ^((?!(<|>|\/|\")).)*$
          type: string
        managers:
          items:
            $ref: '#/components/schemas/UserGroupManagerResource'
          type: array
        members:
          items:
            $ref: '#/components/schemas/ExtensionIdResource'
          type: array
      type: object
    RCVParticipantsInfo:
      properties:
        account:
          description: Participant account
          type: string
        extension:
          description: Participant extension
          type: string
        name:
          description: Participant name
          type: string
        img:
          description: Participant profile image
          type: string
      type: object
    AttachmentInfo:
      example:
        uri: http://example.com/aeiou
        contentType: contentType
      properties:
        uri:
          format: uri
          type: string
        contentType:
          type: string
      type: object
    NavigableCollectionResourceUserGroupResource:
      properties:
        uri:
          format: uri
          type: string
        records:
          items:
            $ref: '#/components/schemas/UserGroupResource'
          type: array
        paging:
          $ref: '#/components/schemas/Paging'
        navigation:
          $ref: '#/components/schemas/Navigation'
      type: object
    RangesInfo:
      example:
        from: 2000-01-23T04:56:07.000+00:00
        to: 2000-01-23T04:56:07.000+00:00
      properties:
        from:
          description: Date and time in format YYYY-MM-DD hh:mm
          format: date-time
          type: string
        to:
          description: Date and time in format YYYY-MM-DD hh:mm
          format: date-time
          type: string
      type: object
    GetExtensionPhoneNumbersResponse:
      example:
        navigation:
          previousPage:
            uri: uri
          firstPage:
            uri: uri
          lastPage:
            uri: uri
          nextPage:
            uri: uri
        records:
        - country:
            name: name
            id: id
            uri: uri
          extension:
            extensionNumber: extensionNumber
            id: id
            partnerId: partnerId
            uri: uri
          phoneNumber: phoneNumber
          location: location
          id: id
          label: label
          type: VoiceFax
          paymentType: External
          status: status
          usageType: MainCompanyNumber
        - country:
            name: name
            id: id
            uri: uri
          extension:
            extensionNumber: extensionNumber
            id: id
            partnerId: partnerId
            uri: uri
          phoneNumber: phoneNumber
          location: location
          id: id
          label: label
          type: VoiceFax
          paymentType: External
          status: status
          usageType: MainCompanyNumber
        paging:
          perPage: 5
          pageStart: 5
          pageEnd: 2
          totalPages: 7
          page: 1
          totalElements: 9
      properties:
        records:
          description: List of phone numbers
          items:
            $ref: '#/components/schemas/PhoneNumberInfo'
          type: array
        navigation:
          $ref: '#/components/schemas/NavigationInfo'
        paging:
          $ref: '#/components/schemas/PagingInfo'
      required:
      - navigation
      - paging
      - records
      type: object
    ServicePlanResource:
      example:
        serviceFeatures:
        - reason: Available
          featureName: featureName
          enabled: false
        - reason: Available
          featureName: featureName
          enabled: false
        name: name
        edition: Unknown
        id: id
        type: Regular
        uri: http://example.com/aeiou
        brand:
          name: name
          currency:
            symbol: symbol
            code: code
            minorSymbol: minorSymbol
            name: name
            id: id
          id: id
          uri: http://example.com/aeiou
          homeCountry:
            callingCode: callingCode
            numberSelling: false
            isoCode: isoCode
            emergencyCalling: false
            name: name
            id: id
            uri: http://example.com/aeiou
            loginAllowed: false
        limits:
          freeSoftPhoneLinesPerExtension: 0
          meetingSize: 6
          maxMonitoredExtensionsPerUser: 1
          maxFreeDigitalLines: 5
      properties:
        uri:
          format: uri
          type: string
        id:
          type: string
        name:
          type: string
        edition:
          enum:
          - Unknown
          - Standard
          - Premium
          - Enterprise
          - Unlimited
          - HighUsage
          type: string
        brand:
          $ref: '#/components/schemas/BrandResource'
        type:
          enum:
          - Regular
          - UserBased
          - Unknown
          type: string
        serviceFeatures:
          items:
            $ref: '#/components/schemas/ServiceFeatureValue'
          type: array
        limits:
          $ref: '#/components/schemas/AccountLimitsResource'
      type: object
    CustomCompanyGreetingRequest:
      example:
        answeringRule:
          id: id
        type: Introductory
      properties:
        type:
          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
          type: string
        answeringRule:
          $ref: '#/components/schemas/CustomCompanyGreetingAnsweringRuleInfo'
      type: object
    Type:
      properties:
        typeName:
          type: string
      type: object
    MessageStoreCallerInfoResponse:
      example:
        messageStatus: Queued
        faxErrorCode: Undefined
        phoneNumber: phoneNumber
        extensionNumber: extensionNumber
        name: name
        location: location
      properties:
        extensionNumber:
          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
          type: string
        location:
          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)
          type: string
        messageStatus:
          description: Status of a message. Returned for outbound fax messages only
          enum:
          - Queued
          - Sent
          - Delivered
          - DeliveryFailed
          - SendingFailed
          - Received
          type: string
        faxErrorCode:
          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
          type: string
        name:
          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
          type: string
        phoneNumber:
          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
          type: string
      required:
      - extensionNumber
      type: object
    OrganizationResource:
      properties:
        id:
          type: string
        name:
          type: string
      type: object
    MessageInfoResource:
      properties:
        uri:
          format: uri
          type: string
        id:
          type: string
        to:
          items:
            $ref: '#/components/schemas/CallerInfo'
          type: array
        from:
          $ref: '#/components/schemas/CallerInfo'
        type:
          enum:
          - EMail
          - VoiceMail
          - Fax
          - Text
          - SMS
          - Pager
          - Unknown
          type: string
        creationTime:
          format: date-time
          type: string
        readStatus:
          enum:
          - Read
          - Unread
          type: string
        priority:
          enum:
          - Normal
          - High
          type: string
        attachments:
          items:
            $ref: '#/components/schemas/MessageAttachmentInfo'
          type: array
        direction:
          enum:
          - Inbound
          - Outbound
          type: string
        availability:
          enum:
          - Alive
          - Deleted
          - Purged
          type: string
        subject:
          type: string
        messageStatus:
          enum:
          - Queued
          - Sent
          - Delivered
          - DeliveryFailed
          - SendingFailed
          - Received
          type: string
        faxResolution:
          enum:
          - Undefined
          - High
          - Low
          type: string
        faxPageCount:
          format: int32
          type: integer
        deliveryErrorCode:
          type: string
        smsDeliveryTime:
          format: date-time
          type: string
        smsSendingAttemptsCount:
          format: int64
          type: integer
        conversationId:
          format: int64
          type: integer
        conversation:
          $ref: '#/components/schemas/ConversationResource'
        lastModifiedTime:
          format: date-time
          type: string
        pgToDepartment:
          default: false
          type: boolean
        vmTranscriptionStatus:
          enum:
          - InProgress
          - CompletedPartially
          - Completed
          - TimedOut
          - Failed
          - NotAvailable
          - Unknown
          type: string
        sourceFilePath:
          type: string
        coverIndex:
          format: int32
          type: integer
        coverPageText:
          type: string
      type: object
    BulkProvisionUnassignedExtensionsResponseResource:
      example:
        items:
        - extension:
            setupWizardState: NotStarted
            statusInfo:
              reason: reason
              till: 2000-01-23T04:56:07.000+00:00
              comment: comment
            references:
            - ref: ref
              type: PartnerId
            - ref: ref
              type: PartnerId
            profileImage:
              scales:
              - uri: http://example.com/aeiou
              - uri: http://example.com/aeiou
              etag: etag
              lastModified: 2000-01-23T04:56:07.000+00:00
              uri: http://example.com/aeiou
              contentType: contentType
            type: Unknown
            uri: http://example.com/aeiou
            ivrPin: ivrPin
            password: password
            serviceFeatures:
            - reason: Available
              featureName: featureName
              enabled: false
            - reason: Available
              featureName: featureName
              enabled: false
            extensionNumber: extensionNumber
            permissions:
              admin:
                enabled: false
              uri: http://example.com/aeiou
              internationalCalling:
                enabled: false
              freeSoftPhoneDigitalLine:
                enabled: false
            loginName: loginName
            contact:
              firstName: firstName
              lastName: lastName
              company: company
              businessPhone: businessPhone
              businessAddress:
                zip: zip
                country: country
                city: city
                street: street
                state: state
              email: email
            name: name
            regionalSettings:
              timezone:
                name: name
                description: description
                id: id
                uri: http://example.com/aeiou
              greetingLanguage:
                localeCode: localeCode
                name: name
                id: id
              formattingLocale:
                localeCode: localeCode
                name: name
                id: id
              language:
                localeCode: localeCode
                name: name
                id: id
              homeCountry:
                callingCode: callingCode
                numberSelling: false
                isoCode: isoCode
                emergencyCalling: false
                name: name
                id: id
                uri: http://example.com/aeiou
                loginAllowed: false
            id: id
            partnerId: partnerId
            departments:
            - extensionNumber: extensionNumber
              id: id
              uri: http://example.com/aeiou
            - extensionNumber: extensionNumber
              id: id
              uri: http://example.com/aeiou
            status: Enabled
          error:
            errorCode: errorCode
            message: message
          successful: false
        - extension:
            setupWizardState: NotStarted
            statusInfo:
              reason: reason
              till: 2000-01-23T04:56:07.000+00:00
              comment: comment
            references:
            - ref: ref
              type: PartnerId
            - ref: ref
              type: PartnerId
            profileImage:
              scales:
              - uri: http://example.com/aeiou
              - uri: http://example.com/aeiou
              etag: etag
              lastModified: 2000-01-23T04:56:07.000+00:00
              uri: http://example.com/aeiou
              contentType: contentType
            type: Unknown
            uri: http://example.com/aeiou
            ivrPin: ivrPin
            password: password
            serviceFeatures:
            - reason: Available
              featureName: featureName
              enabled: false
            - reason: Available
              featureName: featureName
              enabled: false
            extensionNumber: extensionNumber
            permissions:
              admin:
                enabled: false
              uri: http://example.com/aeiou
              internationalCalling:
                enabled: false
              freeSoftPhoneDigitalLine:
                enabled: false
            loginName: loginName
            contact:
              firstName: firstName
              lastName: lastName
              company: company
              businessPhone: businessPhone
              businessAddress:
                zip: zip
                country: country
                city: city
                street: street
                state: state
              email: email
            name: name
            regionalSettings:
              timezone:
                name: name
                description: description
                id: id
                uri: http://example.com/aeiou
              greetingLanguage:
                localeCode: localeCode
                name: name
                id: id
              formattingLocale:
                localeCode: localeCode
                name: name
                id: id
              language:
                localeCode: localeCode
                name: name
                id: id
              homeCountry:
                callingCode: callingCode
                numberSelling: false
                isoCode: isoCode
                emergencyCalling: false
                name: name
                id: id
                uri: http://example.com/aeiou
                loginAllowed: false
            id: id
            partnerId: partnerId
            departments:
            - extensionNumber: extensionNumber
              id: id
              uri: http://example.com/aeiou
            - extensionNumber: extensionNumber
              id: id
              uri: http://example.com/aeiou
            status: Enabled
          error:
            errorCode: errorCode
            message: message
          successful: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/ExtensionAssignmentResult'
          type: array
      type: object
    NavigationInfo:
      example:
        previousPage:
          uri: uri
        firstPage:
          uri: uri
        lastPage:
          uri: uri
        nextPage:
          uri: uri
      properties:
        firstPage:
          $ref: '#/components/schemas/NavigationInfoURI'
        nextPage:
          $ref: '#/components/schemas/NavigationInfoURI'
        previousPage:
          $ref: '#/components/schemas/NavigationInfoURI'
        lastPage:
          $ref: '#/components/schemas/NavigationInfoURI'
      type: object
    GetDialingPlanInfo:
      example:
        navigation:
          previousPage:
            uri: uri
          firstPage:
            uri: uri
          lastPage:
            uri: uri
          nextPage:
            uri: uri
        records:
        - callingCode: callingCode
          isoCode: isoCode
          name: name
          id: id
          uri: uri
        - callingCode: callingCode
          isoCode: isoCode
          name: name
          id: id
          uri: uri
        paging:
          perPage: 5
          pageStart: 5
          pageEnd: 2
          totalPages: 7
          page: 1
          totalElements: 9
      properties:
        records:
          description: List of countries which can be selected for a dialing plan
          items:
            $ref: '#/components/schemas/GetDialingPlanCountryInfo'
          type: array
        paging:
          $ref: '#/components/schemas/PagingInfo'
        navigation:
          $ref: '#/components/schemas/NavigationInfo'
      required:
      - navigation
      - paging
      - records
      type: object
    WebUrisResource:
      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:
          format: int64
          type: integer
        eula:
          type: string
        emergencyDisclaimer:
          type: string
      type: object
    CompanyAnsweringRuleRangesInfoRequest:
      properties:
        from:
          description: Date and time in format YYYY-MM-DD hh:mm
          type: string
        to:
          description: Date and time in format YYYY-MM-DD hh:mm
          type: string
      type: object
    CreateFaxMessageRequest:
      properties:
        to:
          description: Recipient information. Phone number property is mandatory. Optional for resend fax request
          items:
            $ref: '#/components/schemas/MessageStoreCallerInfoRequest'
          type: array
        resolution:
          description: Fax resolution
          enum:
          - High
          - Low
          type: string
        sendTime:
          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
          format: date-time
          type: string
        coverPageText:
          description: Optional. Cover page text, entered by the fax sender and printed on the cover page. Maximum length is limited to 1024 symbols
          type: string
        originalMessageId:
          description: Internal identifier of the original fax message which needs to be resent. Mandatory for resend fax request
          type: string
      required:
      - to
      type: object
    GetReportingSettingsResponse:
      properties:
        views:
          description: List of 'View' structures with a tuple of filter values, pages and schedules
          items:
            $ref: '#/components/schemas/ViewInfoReporting'
          type: array
      required:
      - views
      type: object
    GlipMessageAttachmentInfoRequest:
      example:
        imageUri: imageUri
        color: color
        author:
          name: name
          uri: uri
          iconUri: iconUri
        intro: intro
        text: text
        footnote:
          text: text
          time: 2000-01-23T04:56:07.000+00:00
          iconUri: iconUri
        type: Card
        title: title
        thumbnailUri: thumbnailUri
        fields:
        - style: Short
          title: title
          value: value
        - style: Short
          title: title
          value: value
        fallback: fallback
      properties:
        type:
          default: Card
          description: Type of an attachment
          type: string
        fallback:
          description: A string of default text that will be rendered in the case that the client does not support Interactive Messages
          type: string
        color:
          description: A Hex color code that determines the color of the side border of the Interactive Message
          type: string
        intro:
          description: A pretext to the message
          type: string
        author:
          $ref: '#/components/schemas/GlipMessageAttachmentAuthorInfo'
        title:
          description: Message title
          type: string
        text:
          description: A large string field (up to 1000 chars) to be displayed as the body of a message (Supports GlipDown)
          type: string
        imageUri:
          description: url used to display a single image at the bottom of a message
          type: string
        thumbnailUri:
          description: url used to display a thumbnail to the right of a message (82x82)
          type: string
        fields:
          description: Information on navigation
          items:
            $ref: '#/components/schemas/GlipMessageAttachmentFieldsInfo'
          type: array
        footnote:
          $ref: '#/components/schemas/GlipMessageAttachmentFootnoteInfo'
      type: object
    Principal:
      properties:
        name:
          type: string
      type: object
    APSInfo:
      properties:
        content-available:
          description: If the value is '1' then notification is turned on even if the application is in background
          type: integer
      type: object
    GetExtensionInfoResponse:
      example:
        setupWizardState: NotStarted
        statusInfo:
          reason: Voluntarily
          comment: comment
        references:
        - ref: ref
          type: PartnerId
        - ref: ref
          type: PartnerId
        profileImage:
          scales:
          - uri: uri
          - uri: uri
          etag: etag
          lastModified: 2000-01-23T04:56:07.000+00:00
          uri: uri
          contentType: contentType
        type: User
        uri: uri
        callQueueInfo:
          slaThresholdSeconds: 1
          abandonedThresholdSeconds: 5
          slaGoal: 6
          includeAbandonedCalls: true
        serviceFeatures:
        - reason: reason
          featureName: featureName
          enabled: true
        - reason: reason
          featureName: featureName
          enabled: true
        extensionNumber: extensionNumber
        permissions:
          admin:
            enabled: true
          internationalCalling:
            enabled: true
        contact:
          firstName: firstName
          lastName: lastName
          company: company
          businessPhone: businessPhone
          businessAddress:
            zip: zip
            country: country
            city: city
            street: street
            state: state
          email: email
        name: name
        regionalSettings:
          timezone:
            name: name
            description: description
            id: id
            uri: uri
          timeFormat: 12h
          greetingLanguage:
            localeCode: localeCode
            name: name
            id: id
          formattingLocale:
            localeCode: localeCode
            name: name
            id: id
          language:
            localeCode: localeCode
            ui: true
            greeting: true
            name: name
            formattingLocale: true
            id: id
            uri: uri
          homeCountry:
            name: name
            id: id
            uri: uri
        id: 0
        departments:
        - extensionNumber: extensionNumber
          id: id
          uri: uri
        - extensionNumber: extensionNumber
          id: id
          uri: uri
        partnerId: partnerId
        status: Enabled
      properties:
        id:
          description: Internal identifier of an extension
          format: int64
          type: integer
        uri:
          description: Canonical URI of an extension
          type: string
        contact:
          $ref: '#/components/schemas/ContactInfo'
        departments:
          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: '#/components/schemas/DepartmentInfo'
          type: array
        extensionNumber:
          description: Number of department extension
          type: string
        name:
          description: Extension user name
          type: string
        partnerId:
          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
          type: string
        permissions:
          $ref: '#/components/schemas/ExtensionPermissions'
        profileImage:
          $ref: '#/components/schemas/ProfileImageInfo'
        references:
          description: List of non-RC internal identifiers assigned to an extension
          items:
            $ref: '#/components/schemas/ReferenceInfo'
          type: array
        regionalSettings:
          $ref: '#/components/schemas/RegionalSettings'
        serviceFeatures:
          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: '#/components/schemas/ExtensionServiceFeatureInfo'
          type: array
        setupWizardState:
          description: Specifies extension configuration wizard state (web service setup). The default value is 'NotStarted'
          enum:
          - NotStarted
          - Incomplete
          - Completed
          type: string
        status:
          description: Extension current state. If the status is 'Unassigned'. Returned for all extensions
          enum:
          - Enabled
          - Disabled
          - NotActivated
          - Unassigned
          type: string
        statusInfo:
          $ref: '#/components/schemas/ExtensionStatusInfo'
        type:
          description: Extension type
          enum:
          - User
          - FaxUser
          - VirtualUser
          - DigitalUser
          - Department
          - Announcement
          - Voicemail
          - SharedLinesGroup
          - PagingOnlyGroup
          - IvrMenu
          - ApplicationExtension
          - ParkLocation
          type: string
        callQueueInfo:
          $ref: '#/components/schemas/CallQueueInfo'
      required:
      - id
      - profileImage
      - status
      - type
      - uri
      type: object
    PhoneNumbersResource:
      properties:
        uri:
          format: uri
          type: string
        records:
          items:
            $ref: '#/components/schemas/PhoneNumberResource'
          type: array
        paging:
          $ref: '#/components/schemas/Paging'
        navigation:
          $ref: '#/components/schemas/Navigation'
      type: object
    ExtensionServiceFeatureInfo:
      example:
        reason: reason
        featureName: featureName
        enabled: true
      properties:
        enabled:
          description: Feature status; shows feature availability for an extension
          type: boolean
        featureName:
          description: Feature name, see all available values in Service Feature List
          type: string
        reason:
          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
          type: string
      type: object
    GlipNavigationInfo:
      example:
        prevPageToken: prevPageToken
        nextPageToken: nextPageToken
      properties:
        prevPageToken:
          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
          type: string
        nextPageToken:
          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
          type: string
      type: object
    ProfileImageInfoURI:
      example:
        uri: uri
      properties:
        uri:
          type: string
      type: object
    UnconditionalForwardingInfo:
      example:
        phoneNumber: phoneNumber
      properties:
        phoneNumber:
          description: Phone number to which the call is forwarded
          type: string
      type: object
    GetStateInfoResponse:
      example:
        country:
          id: id
          uri: uri
        isoCode: isoCode
        name: name
        id: id
        uri: uri
      properties:
        id:
          description: Internal identifier of a state
          type: string
        uri:
          description: Canonical URI of a state
          type: string
        country:
          $ref: '#/components/schemas/GetCountryInfoState'
        isoCode:
          description: Short code for a state (2-letter usually)
          type: string
        name:
          description: Official name of a state
          type: string
      type: object
    DeviceInstance:
      properties:
        id:
          type: string
        serial:
          type: string
        trackingNumber:
          type: string
        shippingCarrier:
          type: string
        rmaNumber:
          type: string
      type: object
    ResourceModelComponent:
      properties:
        components:
          items:
            $ref: '#/components/schemas/ResourceModelComponent'
          type: array
      type: object
    CompanyAnsweringRuleWeeklyScheduleInfoRequest:
      example:
        sunday:
        - from: from
          to: to
        - from: from
          to: to
        saturday:
        - from: from
          to: to
        - from: from
          to: to
        tuesday:
        - from: from
          to: to
        - from: from
          to: to
        wednesday:
        - from: from
          to: to
        - from: from
          to: to
        thursday:
        - from: from
          to: to
        - from: from
          to: to
        friday:
        - from: from
          to: to
        - from: from
          to: to
        monday:
        - from: from
          to: to
        - from: from
          to: to
      properties:
        monday:
          description: Time interval for a particular day
          items:
            $ref: '#/components/schemas/CompanyAnsweringRuleTimeIntervalRequest'
          type: array
        tuesday:
          description: Time interval for a particular day
          items:
            $ref: '#/components/schemas/CompanyAnsweringRuleTimeIntervalRequest'
          type: array
        wednesday:
          description: Time interval for a particular day
          items:
            $ref: '#/components/schemas/CompanyAnsweringRuleTimeIntervalRequest'
          type: array
        thursday:
          description: Time interval for a particular day
          items:
            $ref: '#/components/schemas/CompanyAnsweringRuleTimeIntervalRequest'
          type: array
        friday:
          description: Time interval for a particular day
          items:
            $ref: '#/components/schemas/CompanyAnsweringRuleTimeIntervalRequest'
          type: array
        saturday:
          description: Time interval for a particular day
          items:
            $ref: '#/components/schemas/CompanyAnsweringRuleTimeIntervalRequest'
          type: array
        sunday:
          description: Time interval for a particular day
          items:
            $ref: '#/components/schemas/CompanyAnsweringRuleTimeIntervalRequest'
          type: array
      type: object
    DeviceOrderCreation:
      example:
        task:
          lastModifiedTime: 2000-01-23T04:56:07.000+00:00
          creationTime: 2000-01-23T04:56:07.000+00:00
          id: id
          uri: uri
          status: Accepted
        devices:
        - extension:
            setupWizardState: NotStarted
            statusInfo:
              reason: reason
              till: 2000-01-23T04:56:07.000+00:00
              comment: comment
            references:
            - ref: ref
              type: PartnerId
            - ref: ref
              type: PartnerId
            profileImage:
              scales:
              - uri: http://example.com/aeiou
              - uri: http://example.com/aeiou
              etag: etag
              lastModified: 2000-01-23T04:56:07.000+00:00
              uri: http://example.com/aeiou
              contentType: contentType
            type: Unknown
            uri: http://example.com/aeiou
            ivrPin: ivrPin
            password: password
            serviceFeatures:
            - reason: Available
              featureName: featureName
              enabled: false
            - reason: Available
              featureName: featureName
              enabled: false
            extensionNumber: extensionNumber
            permissions:
              admin:
                enabled: false
              uri: http://example.com/aeiou
              internationalCalling:
                enabled: false
              freeSoftPhoneDigitalLine:
                enabled: false
            loginName: loginName
            contact:
              firstName: firstName
              lastName: lastName
              company: company
              businessPhone: businessPhone
              businessAddress:
                zip: zip
                country: country
                city: city
                street: street
                state: state
              email: email
            name: name
            regionalSettings:
              timezone:
                name: name
                description: description
                id: id
                uri: http://example.com/aeiou
              greetingLanguage:
                localeCode: localeCode
                name: name
                id: id
              formattingLocale:
                localeCode: localeCode
                name: name
                id: id
              language:
                localeCode: localeCode
                name: name
                id: id
              homeCountry:
                callingCode: callingCode
                numberSelling: false
                isoCode: isoCode
                emergencyCalling: false
                name: name
                id: id
                uri: http://example.com/aeiou
                loginAllowed: false
            id: 6
            partnerId: partnerId
            departments:
            - extensionNumber: extensionNumber
              id: id
              uri: http://example.com/aeiou
            - extensionNumber: extensionNumber
              id: id
              uri: http://example.com/aeiou
            status: Enabled
          phoneLines:
          - lineType: Unknown
            phoneInfo:
              country:
                callingCode: callingCode
                numberSelling: false
                isoCode: isoCode
                emergencyCalling: false
                name: name
                id: id
                uri: http://example.com/aeiou
                loginAllowed: false
              extension:
                setupWizardState: NotStarted
                statusInfo:
                  reason: reason
                  till: 2000-01-23T04:56:07.000+00:00
                  comment: comment
                references:
                - ref: ref
                  type: PartnerId
                - ref: ref
                  type: PartnerId
                profileImage:
                  scales:
                  - uri: http://example.com/aeiou
                  - uri: http://example.com/aeiou
                  etag: etag
                  lastModified: 2000-01-23T04:56:07.000+00:00
                  uri: http://example.com/aeiou
                  contentType: contentType
                type: Unknown
                uri: http://example.com/aeiou
                ivrPin: ivrPin
                password: password
                serviceFeatures:
                - reason: Available
                  featureName: featureName
                  enabled: false
                - reason: Available
                  featureName: featureName
                  enabled: false
                extensionNumber: extensionNumber
                permissions:
                  admin:
                    enabled: false
                  uri: http://example.com/aeiou
                  internationalCalling:
                    enabled: false
                  freeSoftPhoneDigitalLine:
                    enabled: false
                loginName: loginName
                contact:
                  firstName: firstName
                  lastName: lastName
                  company: company
                  businessPhone: businessPhone
                  businessAddress:
                    zip: zip
                    country: country
                    city: city
                    street: street
                    state: state
                  email: email
                name: name
                regionalSettings:
                  timezone:
                    name: name
                    description: description
                    id: id
                    uri: http://example.com/aeiou
                  greetingLanguage:
                    localeCode: localeCode
                    name: name
                    id: id
                  formattingLocale:
                    localeCode: localeCode
                    name: name
                    id: id
                  language:
                    localeCode: localeCode
                    name: name
                    id: id
                  homeCountry:
                    callingCode: callingCode
                    numberSelling: false
                    isoCode: isoCode
                    emergencyCalling: false
                    name: name
                    id: id
                    uri: http://example.com/aeiou
                    loginAllowed: false
                id: id
                partnerId: partnerId
                departments:
                - extensionNumber: extensionNumber
                  id: id
                  uri: http://example.com/aeiou
                - extensionNumber: extensionNumber
                  id: id
                  uri: http://example.com/aeiou
                status: Enabled
              phoneNumber: phoneNumber
              location: location
              id: 1
              label: label
              type: VoiceFax
              paymentType: External
              status: status
              usageType: CompanyNumber
            emergencyAddress:
              localOnly: true
              required: true
          - lineType: Unknown
            phoneInfo:
              country:
                callingCode: callingCode
                numberSelling: false
                isoCode: isoCode
                emergencyCalling: false
                name: name
                id: id
                uri: http://example.com/aeiou
                loginAllowed: false
              extension:
                setupWizardState: NotStarted
                statusInfo:
                  reason: reason
                  till: 2000-01-23T04:56:07.000+00:00
                  comment: comment
                references:
                - ref: ref
                  type: PartnerId
                - ref: ref
                  type: PartnerId
                profileImage:
                  scales:
                  - uri: http://example.com/aeiou
                  - uri: http://example.com/aeiou
                  etag: etag
                  lastModified: 2000-01-23T04:56:07.000+00:00
                  uri: http://example.com/aeiou
                  contentType: contentType
                type: Unknown
                uri: http://example.com/aeiou
                ivrPin: ivrPin
                password: password
                serviceFeatures:
                - reason: Available
                  featureName: featureName
                  enabled: false
                - reason: Available
                  featureName: featureName
                  enabled: false
                extensionNumber: extensionNumber
                permissions:
                  admin:
                    enabled: false
                  uri: http://example.com/aeiou
                  internationalCalling:
                    enabled: false
                  freeSoftPhoneDigitalLine:
                    enabled: false
                loginName: loginName
                contact:
                  firstName: firstName
                  lastName: lastName
                  company: company
                  businessPhone: businessPhone
                  businessAddress:
                    zip: zip
                    country: country
                    city: city
                    street: street
                    state: state
                  email: email
                name: name
                regionalSettings:
                  timezone:
                    name: name
                    description: description
                    id: id
                    uri: http://example.com/aeiou
                  greetingLanguage:
                    localeCode: localeCode
                    name: name
                    id: id
                  formattingLocale:
                    localeCode: localeCode
                    name: name
                    id: id
                  language:
                    localeCode: localeCode
                    name: name
                    id: id
                  homeCountry:
                    callingCode: callingCode
                    numberSelling: false
                    isoCode: isoCode
                    emergencyCalling: false
                    name: name
                    id: id
                    uri: http://example.com/aeiou
                    loginAllowed: false
                id: id
                partnerId: partnerId
                departments:
                - extensionNumber: extensionNumber
                  id: id
                  uri: http://example.com/aeiou
                - extensionNumber: extensionNumber
                  id: id
                  uri: http://example.com/aeiou
                status: Enabled
              phoneNumber: phoneNumber
              location: location
              id: 1
              label: label
              type: VoiceFax
              paymentType: External
              status: status
              usageType: CompanyNumber
            emergencyAddress:
              localOnly: true
              required: true
          type: HardPhone
          uri: http://example.com/aeiou
          emergencyServiceAddress:
            zip: zip
            country: country
            city: city
            street: street
            street2: street2
            state: state
            customerName: customerName
          shipping:
            carrier: carrier
            address:
              zip: zip
              country: country
              city: city
              street: street
              street2: street2
              state: state
              customerName: customerName
            method:
              name: name
              id: id
            trackingNumber: trackingNumber
            status: status
          boxBillingId: 5
          serial: serial
          computerName: computerName
          linePooling: Host
          name: name
          model:
            addons:
            - name: name
              count: 0
              id: id
            - name: name
              count: 0
              id: id
            name: name
            id: id
          id: id
          sku: sku
          status: Online
        - extension:
            setupWizardState: NotStarted
            statusInfo:
              reason: reason
              till: 2000-01-23T04:56:07.000+00:00
              comment: comment
            references:
            - ref: ref
              type: PartnerId
            - ref: ref
              type: PartnerId
            profileImage:
              scales:
              - uri: http://example.com/aeiou
              - uri: http://example.com/aeiou
              etag: etag
              lastModified: 2000-01-23T04:56:07.000+00:00
              uri: http://example.com/aeiou
              contentType: contentType
            type: Unknown
            uri: http://example.com/aeiou
            ivrPin: ivrPin
            password: password
            serviceFeatures:
            - reason: Available
              featureName: featureName
              enabled: false
            - reason: Available
              featureName: featureName
              enabled: false
            extensionNumber: extensionNumber
            permissions:
              admin:
                enabled: false
              uri: http://example.com/aeiou
              internationalCalling:
                enabled: false
              freeSoftPhoneDigitalLine:
                enabled: false
            loginName: loginName
            contact:
              firstName: firstName
              lastName: lastName
              company: company
              businessPhone: businessPhone
              businessAddress:
                zip: zip
                country: country
                city: city
                street: street
                state: state
              email: email
            name: name
            regionalSettings:
              timezone:
                name: name
                description: description
                id: id
                uri: http://example.com/aeiou
              greetingLanguage:
                localeCode: localeCode
                name: name
                id: id
              formattingLocale:
                localeCode: localeCode
                name: name
                id: id
              language:
                localeCode: localeCode
                name: name
                id: id
              homeCountry:
                callingCode: callingCode
                numberSelling: false
                isoCode: isoCode
                emergencyCalling: false
                name: name
                id: id
                uri: http://example.com/aeiou
                loginAllowed: false
            id: 6
            partnerId: partnerId
            departments:
            - extensionNumber: extensionNumber
              id: id
              uri: http://example.com/aeiou
            - extensionNumber: extensionNumber
              id: id
              uri: http://example.com/aeiou
            status: Enabled
          phoneLines:
          - lineType: Unknown
            phoneInfo:
              country:
                callingCode: callingCode
                numberSelling: false
                isoCode: isoCode
                emergencyCalling: false
                name: name
                id: id
                uri: http://example.com/aeiou
                loginAllowed: false
              extension:
                setupWizardState: NotStarted
                statusInfo:
                  reason: reason
                  till: 2000-01-23T04:56:07.000+00:00
                  comment: comment
                references:
                - ref: ref
                  type: PartnerId
                - ref: ref
                  type: PartnerId
                profileImage:
                  scales:
                  - uri: http://example.com/aeiou
                  - uri: http://example.com/aeiou
                  etag: etag
                  lastModified: 2000-01-23T04:56:07.000+00:00
                  uri: http://example.com/aeiou
                  contentType: contentType
                type: Unknown
                uri: http://example.com/aeiou
                ivrPin: ivrPin
                password: password
                serviceFeatures:
                - reason: Available
                  featureName: featureName
                  enabled: false
                - reason: Available
                  featureName: featureName
                  enabled: false
                extensionNumber: extensionNumber
                permissions:
                  admin:
                    enabled: false
                  uri: http://example.com/aeiou
                  internationalCalling:
                    enabled: false
                  freeSoftPhoneDigitalLine:
                    enabled: false
                loginName: loginName
                contact:
                  firstName: firstName
                  lastName: lastName
                  company: company
                  businessPhone: businessPhone
                  businessAddress:
                    zip: zip
                    country: country
                    city: city
                    street: street
                    state: state
                  email: email
                name: name
                regionalSettings:
                  timezone:
                    name: name
                    description: description
                    id: id
                    uri: http://example.com/aeiou
                  greetingLanguage:
                    localeCode: localeCode
                    name: name
                    id: id
                  formattingLocale:
                    localeCode: localeCode
                    name: name
                    id: id
                  language:
                    localeCode: localeCode
                    name: name
                    id: id
                  homeCountry:
                    callingCode: callingCode
                    numberSelling: false
                    isoCode: isoCode
                    emergencyCalling: false
                    name: name
                    id: id
                    uri: http://example.com/aeiou
                    loginAllowed: false
                id: id
                partnerId: partnerId
                departments:
                - extensionNumber: extensionNumber
                  id: id
                  uri: http://example.com/aeiou
                - extensionNumber: extensionNumber
                  id: id
                  uri: http://example.com/aeiou
                status: Enabled
              phoneNumber: phoneNumber
              location: location
              id: 1
              label: label
              type: VoiceFax
              paymentType: External
              status: status
              usageType: CompanyNumber
            emergencyAddress:
              localOnly: true
              required: true
          - lineType: Unknown
            phoneInfo:
              country:
                callingCode: callingCode
                numberSelling: false
                isoCode: isoCode
                emergencyCalling: false
                name: name
                id: id
                uri: http://example.com/aeiou
                loginAllowed: false
              extension:
                setupWizardState: NotStarted
                statusInfo:
                  reason: reason
                  till: 2000-01-23T04:56:07.000+00:00
                  comment: comment
                references:
                - ref: ref
                  type: PartnerId
                - ref: ref
                  type: PartnerId
                profileImage:
                  scales:
                  - uri: http://example.com/aeiou
                  - uri: http://example.com/aeiou
                  etag: etag
                  lastModified: 2000-01-23T04:56:07.000+00:00
                  uri: http://example.com/aeiou
                  contentType: contentType
                type: Unknown
                uri: http://example.com/aeiou
                ivrPin: ivrPin
                password: password
                serviceFeatures:
                - reason: Available
                  featureName: featureName
                  enabled: false
                - reason: Available
                  featureName: featureName
                  enabled: false
                extensionNumber: extensionNumber
                permissions:
                  admin:
                    enabled: false
                  uri: http://example.com/aeiou
                  internationalCalling:
                    enabled: false
                  freeSoftPhoneDigitalLine:
                    enabled: false
                loginName: loginName
                contact:
                  firstName: firstName
                  lastName: lastName
                  company: company
                  businessPhone: businessPhone
                  businessAddress:
                    zip: zip
                    country: country
                    city: city
                    street: street
                    state: state
                  email: email
                name: name
                regionalSettings:
                  timezone:
                    name: name
                    description: description
                    id: id
                    uri: http://example.com/aeiou
                  greetingLanguage:
                    localeCode: localeCode
                    name: name
                    id: id
                  formattingLocale:
                    localeCode: localeCode
                    name: name
                    id: id
                  language:
                    localeCode: localeCode
                    name: name
                    id: id
                  homeCountry:
                    callingCode: callingCode
                    numberSelling: false
                    isoCode: isoCode
                    emergencyCalling: false
                    name: name
                    id: id
                    uri: http://example.com/aeiou
                    loginAllowed: false
                id: id
                partnerId: partnerId
                departments:
                - extensionNumber: extensionNumber
                  id: id
                  uri: http://example.com/aeiou
                - extensionNumber: extensionNumber
                  id: id
                  uri: http://example.com/aeiou
                status: Enabled
              phoneNumber: phoneNumber
              location: location
              id: 1
              label: label
              type: VoiceFax
              paymentType: External
              status: status
              usageType: CompanyNumber
            emergencyAddress:
              localOnly: true
              required: true
          type: HardPhone
          uri: http://example.com/aeiou
          emergencyServiceAddress:
            zip: zip
            country: country
            city: city
            street: street
            street2: street2
            state: state
            customerName: customerName
          shipping:
            carrier: carrier
            address:
              zip: zip
              country: country
              city: city
              street: street
              street2: street2
              state: state
              customerName: customerName
            method:
              name: name
              id: id
            trackingNumber: trackingNumber
            status: status
          boxBillingId: 5
          serial: serial
          computerName: computerName
          linePooling: Host
          name: name
          model:
            addons:
            - name: name
              count: 0
              id: id
            - name: name
              count: 0
              id: id
            name: name
            id: id
          id: id
          sku: sku
          status: Online
      properties:
        devices:
          description: List of devices ordered
          items:
            $ref: '#/components/schemas/DeviceResource'
          type: array
        task:
          $ref: '#/components/schemas/TaskInfo'
      type: object
    ExtensionCountryInfoRequest:
      example:
        id: id
      properties:
        id:
          description: internal Identifier for country
          type: string
      type: object
    ClientApiResponse:
      example:
        client:
          appVersion: appVersion
          appPlatform: appPlatform
          appName: appName
          appId: appId
          detected: true
          userAgent: userAgent
          appPlatformVersion: appPlatformVersion
          locale: locale
        provisioning:
          hints:
            trialState:
              expiresIn: 0
              actionRequired: true
            appVersionUpgrade:
              expiresIn: 0
              actionRequired: true
            userCredentialState:
              expiresIn: 0
              actionRequired: true
          webUris:
            mobileWebTellAFriend: mobileWebTellAFriend
            mobileWebInternationalCalling: mobileWebInternationalCalling
            mobileWebResetPassword: mobileWebResetPassword
            appDownload: appDownload
            mobileWebPhoneSystem: mobileWebPhoneSystem
            serviceWebTellAFriend: serviceWebTellAFriend
            serviceWebPhoneSystem: serviceWebPhoneSystem
            mobileWebReporting: mobileWebReporting
            mobileWebBilling: mobileWebBilling
            serviceWebResetPassword: serviceWebResetPassword
            signUp: signUp
            meetingsAppDownload: meetingsAppDownload
            mobileWebCallHandling: mobileWebCallHandling
            mobileWebTrialUpgrade: mobileWebTrialUpgrade
            mobileWebUserSettings: mobileWebUserSettings
            serviceWebUserSettings: serviceWebUserSettings
            serviceWebBilling: serviceWebBilling
            appDownloadFile: appDownloadFile
            serviceWebHome: serviceWebHome
            expressSetupMobile: expressSetupMobile
            support: support
            mobileWebNotifications: mobileWebNotifications
      properties:
        client:
          $ref: '#/components/schemas/ClientApplicationInfo'
        provisioning:
          $ref: '#/components/schemas/ClientProvisioningInfo'
      required:
      - client
      - provisioning
      type: object
    ExtensionSecretQuestionInfo:
      example:
        answer: answer
        id: id
        uri: uri
      properties:
        id:
          description: Internal identifier of a secret question
          type: string
        uri:
          description: Link to a secret question resource
          type: string
        answer:
          description: Answer to a secret question
          type: string
      type: object
    SpecialNumberFeaturesInfo:
      properties:
        voip:
          $ref: '#/components/schemas/OptionInfo'
        ringOut:
          $ref: '#/components/schemas/OptionInfo'
        sms:
          $ref: '#/components/schemas/OptionInfo'
        faxOut:
          $ref: '#/components/schemas/OptionInfo'
      type: object
    ClientInfoSpecialNumbersResource:
      properties:
        uri:
          format: uri
          type: string
        records:
          items:
            $ref: '#/components/schemas/ClientInfoSpecialNumberResource'
          type: array
        paging:
          $ref: '#/components/schemas/Paging'
        navigation:
          $ref: '#/components/schemas/Navigation'
      type: object
    MeetingRequestResource:
      example:
        startParticipantsVideo: false
        audioOptions:
        - audioOptions
        - audioOptions
        schedule:
          durationInMinutes: 0
          timeZone:
            name: name
            description: description
            id: id
            uri: http://example.com/aeiou
          startTime: startTime
        password: password
        host:
          id: id
        topic: topic
        meetingType: meetingType
        startHostVideo: false
        allowJoinBeforeHost: false
      properties:
        topic:
          type: string
        meetingType:
          type: string
        schedule:
          $ref: '#/components/schemas/MeetingScheduleResource'
        password:
          type: string
        host:
          $ref: '#/components/schemas/HostInfoRequest'
        allowJoinBeforeHost:
          default: false
          type: boolean
        startHostVideo:
          default: false
          type: boolean
        startParticipantsVideo:
          default: false
          type: boolean
        audioOptions:
          items:
            type: string
          type: array
      type: object
    PagingOnlyGroupUsers:
      example:
        navigation:
          previousPage:
            uri: uri
          firstPage:
            uri: uri
          lastPage:
            uri: uri
          nextPage:
            uri: uri
        records:
        - extensionNumber: extensionNumber
          name: name
          id: id
          uri: uri
        - extensionNumber: extensionNumber
          name: name
          id: id
          uri: uri
        paging:
          perPage: 5
          pageStart: 5
          pageEnd: 2
          totalPages: 7
          page: 1
          totalElements: 9
      properties:
        records:
          description: List of users allowed to page this group
          items:
            $ref: '#/components/schemas/PagingGroupExtensionInfo'
          type: array
        navigation:
          $ref: '#/components/schemas/NavigationInfo'
        paging:
          $ref: '#/components/schemas/PagingInfo'
      type: object
    ResourceLink:
      example:
        uri: http://example.com/aeiou
      properties:
        uri:
          format: uri
          type: string
      type: object
    EmailInfo:
      example:
        type: work
        value: value
      properties:
        value:
          description: Email address
          type: string
        type:
          description: Email address type
          enum:
          - work
          type: string
      type: object
    GetLocationListResponse:
      example:
        navigation:
          previousPage:
            uri: uri
          firstPage:
            uri: uri
          lastPage:
            uri: uri
          nextPage:
            uri: uri
        records:
        - areaCode: areaCode
          city: city
          state: state
          uri: uri
          npa: npa
          nxx: nxx
        - areaCode: areaCode
          city: city
          state: state
          uri: uri
          npa: npa
          nxx: nxx
        paging:
          perPage: 5
          pageStart: 5
          pageEnd: 2
          totalPages: 7
          page: 1
          totalElements: 9
      properties:
        records:
          description: List of locations
          items:
            $ref: '#/components/schemas/LocationInfo'
          type: array
        navigation:
          $ref: '#/components/schemas/NavigationInfo'
        paging:
          $ref: '#/components/schemas/PagingInfo'
      required:
      - navigation
      - paging
      type: object
    ModifyAccountBusinessAddressRequest:
      example:
        company: company
        businessAddress:
          zip: zip
          country: country
          city: city
          street: street
          state: state
        email: email
      properties:
        company:
          description: Company business name
          type: string
        email:
          description: Company business email address
          type: string
        businessAddress:
          $ref: '#/components/schemas/BusinessAddressInfo'
      required:
      - businessAddress
      type: object
    PresencePermissionsExtensionInfoRequest:
      example:
        id: id
      properties:
        id:
          description: Internal identifier of an extension
          type: string
      type: object
    ExtensionInfoMonitoredLines:
      example:
        extensionNumber: extensionNumber
        id: id
        type: User
        uri: uri
      properties:
        id:
          description: Internal identifier of a monitored extension
          type: string
        uri:
          description: Canonical URI of a monitored extension
          type: string
        extensionNumber:
          description: Brief information on a monitored extension
          type: string
        type:
          description: Type of a monitored extension
          enum:
          - User
          - FaxUser
          - VirtualUser
          - DigitalUser
          - Department
          - ApplicationExtension
          - ParkLocation
          type: string
      type: object
    ServiceProviderConfig:
      example:
        filter:
          maxResults: 1
          supported: false
        patch:
          supported: false
        authenticationSchemes:
          authenticationSchemes:
          - documentationUrl: documentationUrl
            name: name
            description: description
            specUrl: specUrl
          - documentationUrl: documentationUrl
            name: name
            description: description
            specUrl: specUrl
        schemas:
        - urn:ietf:params:scim:schemas:core:2.0:ServiceProviderConfig
        - urn:ietf:params:scim:schemas:core:2.0:ServiceProviderConfig
        etag:
          supported: false
        sort:
          supported: false
        bulk:
          maxPayloadSize: 6
          maxOperations: 0
          supported: false
        changePassword:
          supported: false
      properties:
        authenticationSchemes:
          $ref: '#/components/schemas/AuthenticationSchemes'
        bulk:
          $ref: '#/components/schemas/BulkSupported'
        changePassword:
          $ref: '#/components/schemas/Supported'
        etag:
          $ref: '#/components/schemas/Supported'
        filter:
          $ref: '#/components/schemas/FilterSupported'
        patch:
          $ref: '#/components/schemas/Supported'
        schemas:
          items:
            enum:
            - urn:ietf:params:scim:schemas:core:2.0:ServiceProviderConfig
            type: string
          type: array
        sort:
          $ref: '#/components/schemas/Supported'
      type: object
    DictionaryShippingOptions:
      example:
        quantity: 0
        method:
          name: name
          id: id
        price: 6
      properties:
        quantity:
          description: Quantity of devices to ship
          type: integer
        price:
          description: Price for shipping with the specified method (depending on the quantity value)
          type: integer
        method:
          $ref: '#/components/schemas/ShippingMethod'
      type: object
    MonitoringExtensionsResource:
      example:
        navigation:
          previousPage:
            uri: http://example.com/aeiou
          firstPage:
            uri: http://example.com/aeiou
          lastPage:
            uri: http://example.com/aeiou
          nextPage:
            uri: http://example.com/aeiou
        records:
        - extensionNumber: extensionNumber
          id: id
          uri: http://example.com/aeiou
        - extensionNumber: extensionNumber
          id: id
          uri: http://example.com/aeiou
        paging:
          perPage: 1
          pageStart: 5
          pageEnd: 2
          totalPages: 6
          page: 0
          totalElements: 5
        uri: http://example.com/aeiou
      properties:
        uri:
          format: uri
          type: string
        records:
          items:
            $ref: '#/components/schemas/MonitoringExtensionResource'
          type: array
        paging:
          $ref: '#/components/schemas/Paging'
        navigation:
          $ref: '#/components/schemas/Navigation'
      type: object
    ExtensionUserGroupsResource:
      properties:
        uri:
          format: uri
          type: string
        groups:
          items:
            $ref: '#/components/schemas/UserGroupIdResource'
          type: array
      type: object
    MeetingsResource:
      example:
        navigation:
          previousPage:
            uri: http://example.com/aeiou
          firstPage:
            uri: http://example.com/aeiou
          lastPage:
            uri: http://example.com/aeiou
          nextPage:
            uri: http://example.com/aeiou
        records:
        - uri: http://example.com/aeiou
          uuid: uuid
          meetingType: meetingType
          startHostVideo: false
          startParticipantsVideo: false
          audioOptions:
          - audioOptions
          - audioOptions
          schedule:
            durationInMinutes: 0
            timeZone:
              name: name
              description: description
              id: id
              uri: http://example.com/aeiou
            startTime: startTime
          password: password
          topic: topic
          links:
            startUri: startUri
            joinUri: joinUri
          id: id
          allowJoinBeforeHost: false
          status: status
        - uri: http://example.com/aeiou
          uuid: uuid
          meetingType: meetingType
          startHostVideo: false
          startParticipantsVideo: false
          audioOptions:
          - audioOptions
          - audioOptions
          schedule:
            durationInMinutes: 0
            timeZone:
              name: name
              description: description
              id: id
              uri: http://example.com/aeiou
            startTime: startTime
          password: password
          topic: topic
          links:
            startUri: startUri
            joinUri: joinUri
          id: id
          allowJoinBeforeHost: false
          status: status
        paging:
          perPage: 1
          pageStart: 5
          pageEnd: 2
          totalPages: 6
          page: 0
          totalElements: 5
        uri: http://example.com/aeiou
      properties:
        uri:
          format: uri
          type: string
        records:
          items:
            $ref: '#/components/schemas/MeetingResponseResource'
          type: array
        paging:
          $ref: '#/components/schemas/Paging'
        navigation:
          $ref: '#/components/schemas/Navigation'
      type: object
    ExtensionInfo:
      example:
        extensionNumber: extensionNumber
        id: id
        partnerId: partnerId
        uri: uri
      properties:
        id:
          description: Internal identifier of an extension
          type: string
        uri:
          description: Canonical URI of an extension
          type: string
        extensionNumber:
          description: Number of department extension
          type: string
        partnerId:
          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
          type: string
      type: object
    PhoneLinesInfo:
      example:
        lineType: Standalone
        phoneInfo:
          country:
            name: name
            id: id
            uri: uri
          extension:
            extensionNumber: extensionNumber
            id: id
            partnerId: partnerId
            uri: uri
          phoneNumber: phoneNumber
          location: location
          id: 6
          label: label
          type: VoiceFax
          paymentType: External
          status: status
          usageType: MainCompanyNumber
      properties:
        lineType:
          description: Type of phone line
          enum:
          - Standalone
          - StandaloneFree
          - BlaPrimary
          - BlaSecondary
          type: string
        phoneInfo:
          $ref: '#/components/schemas/PhoneNumberInfoIntId'
      type: object
    AccountPhoneNumbers:
      example:
        navigation:
          previousPage:
            uri: uri
          firstPage:
            uri: uri
          lastPage:
            uri: uri
          nextPage:
            uri: uri
        records:
        - country:
            name: name
            id: id
            uri: uri
          extension:
            extensionNumber: extensionNumber
            id: id
            partnerId: partnerId
            uri: uri
          phoneNumber: phoneNumber
          location: location
          id: id
          label: label
          type: VoiceFax
          paymentType: External
          status: status
          usageType: MainCompanyNumber
        - country:
            name: name
            id: id
            uri: uri
          extension:
            extensionNumber: extensionNumber
            id: id
            partnerId: partnerId
            uri: uri
          phoneNumber: phoneNumber
          location: location
          id: id
          label: label
          type: VoiceFax
          paymentType: External
          status: status
          usageType: MainCompanyNumber
        paging:
          perPage: 5
          pageStart: 5
          pageEnd: 2
          totalPages: 7
          page: 1
          totalElements: 9
      properties:
        records:
          description: List of account phone numbers
          items:
            $ref: '#/components/schemas/PhoneNumberInfo'
          type: array
        navigation:
          $ref: '#/components/schemas/NavigationInfo'
        paging:
          $ref: '#/components/schemas/PagingInfo'
      type: object
    RecordingInfo:
      example:
        contentUri: contentUri
        id: id
        type: Automatic
        uri: uri
      properties:
        id:
          description: Internal identifier of the call recording
          type: string
        uri:
          description: Link to the call recording metadata resource
          type: string
        type:
          description: Indicates recording mode used
          enum:
          - Automatic
          - OnDemand
          type: string
        contentUri:
          description: Link to the call recording binary content
          type: string
      type: object
    ExtensionFormattingLocaleInfoRequest:
      example:
        id: id
      properties:
        id:
          description: Internal Identifier of a formatting language
          type: string
      type: object
    GetPresenceExtensionInfo:
      example:
        extensionNumber: extensionNumber
        id: id
        uri: uri
      properties:
        id:
          description: Internal identifier of an extension
          type: string
        uri:
          description: Canonical URI of an extension
          type: string
        extensionNumber:
          description: Extension number (usually 3 or 4 digits)
          type: string
      type: object
    CreateAnsweringRuleRequest:
      example:
        voicemail:
          recipient:
            id: id
            uri: uri
          enabled: true
        forwarding:
          softPhonesRingCount: 0
          rules:
          - forwardingNumbers:
            - phoneNumber: phoneNumber
              id: id
              label: label
              uri: uri
            - phoneNumber: phoneNumber
              id: id
              label: label
              uri: uri
            ringCount: 1
            index: 6
          - forwardingNumbers:
            - phoneNumber: phoneNumber
              id: id
              label: label
              uri: uri
            - phoneNumber: phoneNumber
              id: id
              label: label
              uri: uri
            ringCount: 1
            index: 6
          notifyMySoftPhones: true
          notifyAdminSoftPhones: true
          ringingMode: Sequentially
        greetings:
        - preset:
            name: name
            id: id
            uri: uri
          type: Introductory
          usageType: UserExtensionAnsweringRule
        - preset:
            name: name
            id: id
            uri: uri
          type: Introductory
          usageType: UserExtensionAnsweringRule
        type: type
        enabled: true
        callHandlingAction: ForwardCalls
        calledNumbers:
        - phoneNumber: phoneNumber
        - phoneNumber: phoneNumber
        schedule:
          ref: BusinessHours
          ranges:
            from: 2000-01-23T04:56:07.000+00:00
            to: 2000-01-23T04:56:07.000+00:00
          weeklyRanges:
            sunday:
            - from: 2000-01-23T04:56:07.000+00:00
              to: 2000-01-23T04:56:07.000+00:00
            - from: 2000-01-23T04:56:07.000+00:00
              to: 2000-01-23T04:56:07.000+00:00
            saturday:
            - from: 2000-01-23T04:56:07.000+00:00
              to: 2000-01-23T04:56:07.000+00:00
            - from: 2000-01-23T04:56:07.000+00:00
              to: 2000-01-23T04:56:07.000+00:00
            tuesday:
            - from: 2000-01-23T04:56:07.000+00:00
              to: 2000-01-23T04:56:07.000+00:00
            - from: 2000-01-23T04:56:07.000+00:00
              to: 2000-01-23T04:56:07.000+00:00
            wednesday:
            - from: 2000-01-23T04:56:07.000+00:00
              to: 2000-01-23T04:56:07.000+00:00
            - from: 2000-01-23T04:56:07.000+00:00
              to: 2000-01-23T04:56:07.000+00:00
            thursday:
            - from: 2000-01-23T04:56:07.000+00:00
              to: 2000-01-23T04:56:07.000+00:00
            - from: 2000-01-23T04:56:07.000+00:00
              to: 2000-01-23T04:56:07.000+00:00
            friday:
            - from: 2000-01-23T04:56:07.000+00:00
              to: 2000-01-23T04:56:07.000+00:00
            - from: 2000-01-23T04:56:07.000+00:00
              to: 2000-01-23T04:56:07.000+00:00
            monday:
            - from: 2000-01-23T04:56:07.000+00:00
              to: 2000-01-23T04:56:07.000+00:00
            - from: 2000-01-23T04:56:07.000+00:00
              to: 2000-01-23T04:56:07.000+00:00
        transfer:
          extension:
            extensionNumber: extensionNumber
            id: id
            partnerId: partnerId
            uri: uri
        name: name
        callers:
        - name: name
          callerId: callerId
        - name: name
          callerId: callerId
        unconditionalForwarding:
          phoneNumber: phoneNumber
        queue:
          wrapUpTime: 7
          transferMode: Rotating
          fixedOrderAgents:
          - extension:
              extensionNumber: extensionNumber
              id: id
              partnerId: partnerId
              uri: uri
            index: 5
          - extension:
              extensionNumber: extensionNumber
              id: id
              partnerId: partnerId
              uri: uri
            index: 5
          holdAudioInterruptionPeriod: 5
          maxCallersAction: Voicemail
          maxCallers: 3
          holdAudioInterruptionMode: Never
          agentTimeout: 2
          holdTime: 9
      properties:
        enabled:
          description: Specifies if the rule is active or inactive. The default value is 'True'
          type: boolean
        type:
          description: Type of an answering rule. The 'Custom' value should be specified
          type: string
        name:
          description: Name of an answering rule specified by user
          type: string
        callers:
          description: Answering rule will be applied when calls are received from the specified caller(s)
          items:
            $ref: '#/components/schemas/CallersInfoRequest'
          type: array
        calledNumbers:
          description: Answering rules are applied when calling to selected number(s)
          items:
            $ref: '#/components/schemas/CalledNumberInfo'
          type: array
        schedule:
          $ref: '#/components/schemas/ScheduleInfo'
        callHandlingAction:
          description: Specifies how incoming calls are forwarded
          enum:
          - ForwardCalls
          - UnconditionalForwarding
          - AgentQueue
          - TransferToExtension
          - TakeMessagesOnly
          - PlayAnnouncementOnly
          type: string
        forwarding:
          $ref: '#/components/schemas/ForwardingInfo'
        unconditionalForwarding:
          $ref: '#/components/schemas/UnconditionalForwardingInfo'
        queue:
          $ref: '#/components/schemas/QueueInfo'
        transfer:
          $ref: '#/components/schemas/TransferredExtensionInfo'
        voicemail:
          $ref: '#/components/schemas/VoicemailInfo'
        greetings:
          description: Greetings applied for an answering rule; only predefined greetings can be applied, see Dictionary Greeting List
          items:
            $ref: '#/components/schemas/GreetingInfo'
          type: array
      required:
      - name
      - type
      type: object
    AuthenticationSchemes:
      example:
        authenticationSchemes:
        - documentationUrl: documentationUrl
          name: name
          description: description
          specUrl: specUrl
        - documentationUrl: documentationUrl
          name: name
          description: description
          specUrl: specUrl
      properties:
        authenticationSchemes:
          items:
            $ref: '#/components/schemas/AuthenticationScheme'
          type: array
      type: object
    MessageChanges:
      properties:
        type:
          description: Message type
          enum:
          - Voicemail
          - SMS
          - Fax
          - Pager
          type: string
        newCount:
          description: The number of new messages. Can be omitted if the value is zero
          type: integer
        updatedCount:
          description: The number of updated messages. Can be omitted if the value is zero
          type: integer
      type: object
    GetCountryInfoDictionaryResponse:
      example:
        callingCode: callingCode
        numberSelling: true
        emergencyCalling: true
        isoCode: isoCode
        name: name
        id: id
        signupAllowed: true
        uri: uri
        loginAllowed: true
        freeSoftphoneLine: true
      properties:
        id:
          description: Internal identifier of a country
          type: string
        uri:
          description: Canonical URI of a country
          type: string
        callingCode:
          description: Country calling code defined by ITU-T recommendations E.123 and E.164, see Calling Codes
          type: string
        emergencyCalling:
          description: Emergency calling feature availability/emergency address requirement indicator
          type: boolean
        isoCode:
          description: Country code according to the ISO standard, see ISO 3166
          type: string
        name:
          description: Official name of a country
          type: string
        numberSelling:
          description: Determines whether phone numbers are available for a country
          type: boolean
        loginAllowed:
          description: Specifies whether login with the phone numbers of this country is enabled or not
          type: boolean
        signupAllowed:
          description: Indicates whether signup/billing is allowed for a country
          type: boolean
        freeSoftphoneLine:
          description: Specifies if free phone line for softphone is available for a country or not
          type: boolean
      type: object
    GlipMessageAttachmentFootnoteInfo:
      example:
        text: text
        time: 2000-01-23T04:56:07.000+00:00
        iconUri: iconUri
      properties:
        text:
          description: A string used to be displayed as the body of the footer.
          type: string
        iconUri:
          description: A URL used to display a 32x32px icon to the left of the footer
          type: string
        time:
          description: A Unix timestamp to be displayed to the right of the footer (prettified)
          format: date-time
          type: string
      type: object
    BusinessAddressInfo:
      example:
        zip: zip
        country: country
        city: city
        street: street
        state: state
      properties:
        country:
          description: Name of a country
          type: string
        state:
          description: Name of a state/province
          type: string
        city:
          description: Name of a city
          type: string
        street:
          description: Street address
          type: string
        zip:
          description: Zip code
          type: string
      type: object
    BulkProvisionExtensionResource:
      properties:
        uri:
          format: uri
          type: string
        id:
          type: string
        partnerId:
          maxLength: 128
          minLength: 0
          pattern: ^[\p{Alnum}\.\-_]*$
          type: string
        extensionNumber:
          type: string
        loginName:
          type: string
        contact:
          $ref: '#/components/schemas/ContactInfo'
        references:
          items:
            $ref: '#/components/schemas/Reference'
          type: array
        name:
          type: string
        type:
          enum:
          - Unknown
          - User
          - Department
          - Announcement
          - Voicemail
          - DigitalUser
          - VirtualUser
          - FaxUser
          - PagingOnly
          - SharedLinesGroup
          - IvrMenu
          - ApplicationExtension
          - ParkLocation
          type: string
        status:
          enum:
          - Enabled
          - Disabled
          - Frozen
          - NotActivated
          - Unassigned
          type: string
        statusInfo:
          $ref: '#/components/schemas/StatusInfo'
        departments:
          items:
            $ref: '#/components/schemas/DepartmentResource'
          type: array
        serviceFeatures:
          items:
            $ref: '#/components/schemas/ServiceFeatureValue'
          type: array
        regionalSettings:
          $ref: '#/components/schemas/RegionalSettingsResource'
        setupWizardState:
          enum:
          - NotStarted
          - Incomplete
          - Completed
          - Unknown
          type: string
        permissions:
          $ref: '#/components/schemas/ExtensionPermissionsResource'
        password:
          type: string
        ivrPin:
          type: string
        profileImage:
          $ref: '#/components/schemas/ProfileImageResource'
      type: object
    MessageAttachmentInfo:
      example:
        filename: filename
        size: 6
        vmDuration: 0
        id: id
        type: AudioRecording
        uri: uri
        contentType: contentType
      properties:
        id:
          description: Internal identifier of a message attachment
          type: string
        uri:
          description: Canonical URI of a message attachment
          type: string
        type:
          description: Type of message attachment
          enum:
          - AudioRecording
          - AudioTranscription
          - Text
          - SourceDocument
          - RenderedDocument
          - MmsAttachment
          type: string
        contentType:
          description: MIME type for a given attachment, for instance 'audio/wav'
          type: string
        vmDuration:
          description: Voicemail only Duration of the voicemail in seconds
          type: integer
        filename:
          description: Name of a file attached
          type: string
        size:
          description: Size of attachment in bytes
          type: integer
      type: object
    AssignedRoleResource:
      properties:
        uri:
          format: uri
          type: string
        id:
          type: string
        autoAssigned:
          default: false
          type: boolean
        displayName:
          type: string
      type: object
    UserCreationRequest:
      example:
        emails:
        - type: work
          value: value
        - type: work
          value: value
        addresses:
        - country: country
          streetAddress: streetAddress
          postalCode: postalCode
          locality: locality
          region: region
          type: work
        - country: country
          streetAddress: streetAddress
          postalCode: postalCode
          locality: locality
          region: region
          type: work
        schemas:
        - schemas
        - schemas
        name:
          givenName: givenName
          familyName: familyName
        active: false
        externalId: externalId
        id: id
        userName: userName
        photos:
        - type: photo
          value: value
        - type: photo
          value: value
        phoneNumbers:
        - type: work
          value: value
        - type: work
          value: value
        urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:
          department: department
      properties:
        active:
          default: false
          description: Status of a user
          type: boolean
        addresses:
          description: User addresses
          items:
            $ref: '#/components/schemas/AddressInfo'
          type: array
        emails:
          description: User email addresses
          items:
            $ref: '#/components/schemas/EmailInfo'
          type: array
        externalId:
          description: External identifier of a user
          type: string
        id:
          description: Internal identifier of a user
          type: string
        name:
          $ref: '#/components/schemas/NameInfo'
        phoneNumbers:
          description: User phone numbers
          items:
            $ref: '#/components/schemas/PhoneNumberInfoRequest'
          type: array
        photos:
          items:
            $ref: '#/components/schemas/PhotoInfo'
          type: array
        schemas:
          description: Specification links
          items:
            type: string
          type: array
        urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:
          $ref: '#/components/schemas/EnterpriseUser'
        userName:
          description: User mailbox. Must be same as work type email address
          type: string
      required:
      - emails
      - name
      - schemas
      - userName
      type: object
    AuthProfileCheckResource:
      example:
        details:
          permission:
            id: id
            uri: http://example.com/aeiou
          scopes:
          - scopes
          - scopes
          effectiveRole:
            id: id
            uri: http://example.com/aeiou
        uri: http://example.com/aeiou
        successful: false
      properties:
        uri:
          format: uri
          type: string
        successful:
          default: false
          type: boolean
        details:
          $ref: '#/components/schemas/ActivePermissionResource'
      type: object
    DeliveryModeResource:
      example:
        authKey: authKey
        address: address
        encryption: false
        subscriberKey: subscriberKey
        registrationId: registrationId
        certificateName: certificateName
        transportType: PUBNUB
        encryptionKey: encryptionKey
        cipherKey: cipherKey
        publisherKey: publisherKey
        encryptionAlgorithm: encryptionAlgorithm
      properties:
        transportType:
          enum:
          - PUBNUB
          - APNS
          - PUBNUB_TO_APNS
          - PUBNUB_TO_APNS_VOIP
          - PUBNUB_TO_GCM
          - PUBNUB_TO_GCM_VOIP
          - WEB_HOOK
          type: string
        encryption:
          default: false
          type: boolean
        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
      type: object
    ContactsInput:
      properties:
        records:
          items:
            $ref: '#/components/schemas/PersonalContactResource'
          type: array
      type: object
    PresetInfo:
      example:
        name: name
        id: id
        uri: uri
      properties:
        uri:
          description: Link to a greeting resource
          type: string
        id:
          description: Internal identifier of greeting
          type: string
        name:
          description: Name of a greeting
          type: string
      type: object
    GetMessageInfoResponseIntId:
      example:
        readStatus: Read
        faxResolution: High
        attachments:
        - filename: filename
          size: 5
          vmDuration: 1
          id: 6
          type: AudioRecording
          uri: uri
          contentType: contentType
        - filename: filename
          size: 5
          vmDuration: 1
          id: 6
          type: AudioRecording
          uri: uri
          contentType: contentType
        lastModifiedTime: 2000-01-23T04:56:07.000+00:00
        creationTime: 2000-01-23T04:56:07.000+00:00
        conversationId: 5
        deliveryErrorCode: deliveryErrorCode
        subject: subject
        vmTranscriptionStatus: NotAvailable
        availability: Alive
        priority: Normal
        type: Fax
        uri: uri
        messageStatus: Queued
        faxPageCount: 2
        smsSendingAttemptsCount: 7
        smsDeliveryTime: 2000-01-23T04:56:07.000+00:00
        pgToDepartment: true
        from:
          messageStatus: Queued
          faxErrorCode: Undefined
          phoneNumber: phoneNumber
          extensionNumber: extensionNumber
          name: name
          location: location
        id: 0
        to:
        - messageStatus: Queued
          faxErrorCode: Undefined
          phoneNumber: phoneNumber
          extensionNumber: extensionNumber
          name: name
          location: location
        - messageStatus: Queued
          faxErrorCode: Undefined
          phoneNumber: phoneNumber
          extensionNumber: extensionNumber
          name: name
          location: location
        direction: Inbound
      properties:
        id:
          description: Internal identifier of a message
          format: int64
          type: integer
        uri:
          description: Canonical URI of a message
          type: string
        attachments:
          description: The list of message attachments
          items:
            $ref: '#/components/schemas/MessageAttachmentInfoIntId'
          type: array
        availability:
          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
          type: string
        conversationId:
          description: SMS and Pager only. Identifier of the conversation the message belongs to
          format: int64
          type: integer
        creationTime:
          description: Message creation datetime in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z
          format: date-time
          type: string
        deliveryErrorCode:
          description: SMS only. Delivery error code returned by gateway
          type: string
        direction:
          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
          type: string
        faxPageCount:
          description: Fax only. Page count in fax message
          type: integer
        faxResolution:
          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
          type: string
        from:
          $ref: '#/components/schemas/MessageStoreCallerInfoResponse'
        lastModifiedTime:
          description: The datetime when the message was modified on server in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z
          format: date-time
          type: string
        messageStatus:
          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
          type: string
        pgToDepartment:
          description: Pager only True if at least one of the message recipients is Department extension
          type: boolean
        priority:
          description: Message priority
          enum:
          - Normal
          - High
          type: string
        readStatus:
          description: Message read status
          enum:
          - Read
          - Unread
          type: string
        smsDeliveryTime:
          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
          format: date-time
          type: string
        smsSendingAttemptsCount:
          description: SMS only. Number of attempts made to send an outbound SMS to the gateway (if gateway is temporary unavailable)
          type: integer
        subject:
          description: Message subject. For SMS and Pager messages it replicates message text which is also returned as an attachment
          type: string
        to:
          description: Recipient information
          items:
            $ref: '#/components/schemas/MessageStoreCallerInfoResponse'
          type: array
        type:
          description: Message type
          enum:
          - Fax
          - SMS
          - VoiceMail
          - Pager
          - Text
          type: string
        vmTranscriptionStatus:
          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
          type: string
      type: object
    AccountLimits:
      example:
        freeSoftPhoneLinesPerExtension: 0
        meetingSize: 6
        maxMonitoredExtensionsPerUser: 1
        maxExtensionNumberLength: 5
      properties:
        freeSoftPhoneLinesPerExtension:
          description: The maximum number of free softphone phone lines per user extension
          type: integer
        meetingSize:
          description: The maximum number of participants in RingCentral Meeting hosted by this account's user
          type: integer
        maxMonitoredExtensionsPerUser:
          description: The maximum number of extensions which can be included in the list of users monitored for Presence
          type: integer
        maxExtensionNumberLength:
          description: Maximum length for extension numbers of an account; depends on account type. The default value is 5
          type: integer
      type: object
    SmsResource:
      properties:
        country:
          $ref: '#/components/schemas/CountryResource'
        to:
          items:
            $ref: '#/components/schemas/CallerInfo'
          type: array
        from:
          $ref: '#/components/schemas/CallerInfo'
        text:
          type: string
      type: object
    PaymentInfoCardHolderResource:
      properties:
        firstName:
          type: string
        lastName:
          type: string
        address:
          $ref: '#/components/schemas/PaymentInfoAddressResource'
      type: object
    CfaView:
      properties:
        name:
          type: string
        schedules:
          items:
            $ref: '#/components/schemas/CfaSchedule'
          type: array
      type: object
    EmergencyAddress:
      example:
        localOnly: true
        required: true
      properties:
        required:
          description: ' ''True'' if specifying of emergency address is required'
          type: boolean
        localOnly:
          description: ' ''True'' if only local emergency address can be specified'
          type: boolean
      type: object
    RegistrationRequest:
      properties:
        device:
          $ref: '#/components/schemas/DeviceToRegister'
        sipInfo:
          items:
            $ref: '#/components/schemas/SipDetailsToRegister'
          type: array
      type: object
    Reason:
      properties:
        id:
          type: string
        message:
          type: string
      type: object
    CallerResource:
      properties:
        callerId:
          maxLength: 127
          minLength: 0
          type: string
        name:
          type: string
      type: object
    BrandResource:
      example:
        name: name
        currency:
          symbol: symbol
          code: code
          minorSymbol: minorSymbol
          name: name
          id: id
        id: id
        uri: http://example.com/aeiou
        homeCountry:
          callingCode: callingCode
          numberSelling: false
          isoCode: isoCode
          emergencyCalling: false
          name: name
          id: id
          uri: http://example.com/aeiou
          loginAllowed: false
      properties:
        uri:
          format: uri
          type: string
        id:
          type: string
        name:
          type: string
        homeCountry:
          $ref: '#/components/schemas/CountryResource'
        currency:
          $ref: '#/components/schemas/Currency'
      type: object
    GetExtensionListResponse:
      example:
        navigation:
          previousPage:
            uri: uri
          firstPage:
            uri: uri
          lastPage:
            uri: uri
          nextPage:
            uri: uri
        records:
        - setupWizardState: NotStarted
          statusInfo:
            reason: Voluntarily
            comment: comment
          references:
          - ref: ref
            type: PartnerId
          - ref: ref
            type: PartnerId
          profileImage:
            scales:
            - uri: uri
            - uri: uri
            etag: etag
            lastModified: 2000-01-23T04:56:07.000+00:00
            uri: uri
            contentType: contentType
          type: User
          uri: uri
          callQueueInfo:
            slaThresholdSeconds: 1
            abandonedThresholdSeconds: 5
            slaGoal: 6
            includeAbandonedCalls: true
          serviceFeatures:
          - reason: reason
            featureName: featureName
            enabled: true
          - reason: reason
            featureName: featureName
            enabled: true
          extensionNumber: extensionNumber
          permissions:
            admin:
              enabled: true
            internationalCalling:
              enabled: true
          contact:
            firstName: firstName
            lastName: lastName
            company: company
            businessPhone: businessPhone
            businessAddress:
              zip: zip
              country: country
              city: city
              street: street
              state: state
            email: email
          name: name
          regionalSettings:
            timezone:
              name: name
              description: description
              id: id
              uri: uri
            timeFormat: 12h
            greetingLanguage:
              localeCode: localeCode
              name: name
              id: id
            formattingLocale:
              localeCode: localeCode
              name: name
              id: id
            language:
              localeCode: localeCode
              ui: true
              greeting: true
              name: name
              formattingLocale: true
              id: id
              uri: uri
            homeCountry:
              name: name
              id: id
              uri: uri
          id: 0
          departments:
          - extensionNumber: extensionNumber
            id: id
            uri: uri
          - extensionNumber: extensionNumber
            id: id
            uri: uri
          partnerId: partnerId
          status: Enabled
        - setupWizardState: NotStarted
          statusInfo:
            reason: Voluntarily
            comment: comment
          references:
          - ref: ref
            type: PartnerId
          - ref: ref
            type: PartnerId
          profileImage:
            scales:
            - uri: uri
            - uri: uri
            etag: etag
            lastModified: 2000-01-23T04:56:07.000+00:00
            uri: uri
            contentType: contentType
          type: User
          uri: uri
          callQueueInfo:
            slaThresholdSeconds: 1
            abandonedThresholdSeconds: 5
            slaGoal: 6
            includeAbandonedCalls: true
          serviceFeatures:
          - reason: reason
            featureName: featureName
            enabled: true
          - reason: reason
            featureName: featureName
            enabled: true
          extensionNumber: extensionNumber
          permissions:
            admin:
              enabled: true
            internationalCalling:
              enabled: true
          contact:
            firstName: firstName
            lastName: lastName
            company: company
            businessPhone: businessPhone
            businessAddress:
              zip: zip
              country: country
              city: city
              street: street
              state: state
            email: email
          name: name
          regionalSettings:
            timezone:
              name: name
              description: description
              id: id
              uri: uri
            timeFormat: 12h
            greetingLanguage:
              localeCode: localeCode
              name: name
              id: id
            formattingLocale:
              localeCode: localeCode
              name: name
              id: id
            language:
              localeCode: localeCode
              ui: true
              greeting: true
              name: name
              formattingLocale: true
              id: id
              uri: uri
            homeCountry:
              name: name
              id: id
              uri: uri
          id: 0
          departments:
          - extensionNumber: extensionNumber
            id: id
            uri: uri
          - extensionNumber: extensionNumber
            id: id
            uri: uri
          partnerId: partnerId
          status: Enabled
        paging:
          perPage: 5
          pageStart: 5
          pageEnd: 2
          totalPages: 7
          page: 1
          totalElements: 9
      properties:
        records:
          description: List of extensions with extension information
          items:
            $ref: '#/components/schemas/GetExtensionInfoResponse'
          type: array
        navigation:
          $ref: '#/components/schemas/NavigationInfo'
        paging:
          $ref: '#/components/schemas/PagingInfo'
      required:
      - navigation
      - paging
      - records
      type: object
    ProvisioningResource:
      properties:
        webUris:
          $ref: '#/components/schemas/WebUrisResource'
        hints:
          $ref: '#/components/schemas/HintsResource'
      type: object
    ExtensionPresenceLineEvent:
      properties:
        extension:
          $ref: '#/components/schemas/ExtensionNotificationInfo'
        sequence:
          description: Order number of a notification to state the chronology
          type: integer
      type: object
    ReportingViewInfo:
      example:
        pages:
        - name: name
          attrX: attrX
        - name: name
          attrX: attrX
        schedules:
        - recurrence:
          - pattern: Daily
            value: "0"
          - pattern: Daily
            value: "0"
          attachments:
          - pdf: true
            csv: true
          - pdf: true
            csv: true
          pages:
          - pages
          - pages
          recipients:
          - recipients
          - recipients
          viewType: Detailed
          scheduleId: scheduleId
        - recurrence:
          - pattern: Daily
            value: "0"
          - pattern: Daily
            value: "0"
          attachments:
          - pdf: true
            csv: true
          - pdf: true
            csv: true
          pages:
          - pages
          - pages
          recipients:
          - recipients
          - recipients
          viewType: Detailed
          scheduleId: scheduleId
        name: name
      properties:
        name:
          description: User-defined name of a 'View'. The maximum value is 255
          type: string
        pages:
          description: List of pages, the max amount is 10
          items:
            $ref: '#/components/schemas/ReportingPagesInfo'
          type: array
        schedules:
          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: '#/components/schemas/ReportingSchedulesInfo'
          type: array
      required:
      - name
      - pages
      type: object
    FederationConflicts:
      example:
        records:
        - firstName: firstName
          lastName: lastName
          extensionNumber: extensionNumber
          conflicts:
          - firstName: firstName
            lastName: lastName
            id: id
            account:
              federatedName: federatedName
              id: id
          - firstName: firstName
            lastName: lastName
            id: id
            account:
              federatedName: federatedName
              id: id
          id: id
        - firstName: firstName
          lastName: lastName
          extensionNumber: extensionNumber
          conflicts:
          - firstName: firstName
            lastName: lastName
            id: id
            account:
              federatedName: federatedName
              id: id
          - firstName: firstName
            lastName: lastName
            id: id
            account:
              federatedName: federatedName
              id: id
          id: id
      properties:
        records:
          description: List of conflicting federation extensions
          items:
            $ref: '#/components/schemas/FederationExtensionInfo'
          type: array
      required:
      - records
      type: object
    PermissionCategoryResource:
      example:
        displayName: displayName
        description: description
        id: id
        uri: http://example.com/aeiou
      properties:
        uri:
          format: uri
          type: string
        id:
          type: string
        displayName:
          type: string
        description:
          type: string
      type: object
    GetUserBusinessHoursResponse:
      example:
        schedule:
          weeklyRanges:
            sunday:
            - from: 2000-01-23T04:56:07.000+00:00
              to: 2000-01-23T04:56:07.000+00:00
            - from: 2000-01-23T04:56:07.000+00:00
              to: 2000-01-23T04:56:07.000+00:00
            saturday:
            - from: 2000-01-23T04:56:07.000+00:00
              to: 2000-01-23T04:56:07.000+00:00
            - from: 2000-01-23T04:56:07.000+00:00
              to: 2000-01-23T04:56:07.000+00:00
            tuesday:
            - from: 2000-01-23T04:56:07.000+00:00
              to: 2000-01-23T04:56:07.000+00:00
            - from: 2000-01-23T04:56:07.000+00:00
              to: 2000-01-23T04:56:07.000+00:00
            wednesday:
            - from: 2000-01-23T04:56:07.000+00:00
              to: 2000-01-23T04:56:07.000+00:00
            - from: 2000-01-23T04:56:07.000+00:00
              to: 2000-01-23T04:56:07.000+00:00
            thursday:
            - from: 2000-01-23T04:56:07.000+00:00
              to: 2000-01-23T04:56:07.000+00:00
            - from: 2000-01-23T04:56:07.000+00:00
              to: 2000-01-23T04:56:07.000+00:00
            friday:
            - from: 2000-01-23T04:56:07.000+00:00
              to: 2000-01-23T04:56:07.000+00:00
            - from: 2000-01-23T04:56:07.000+00:00
              to: 2000-01-23T04:56:07.000+00:00
            monday:
            - from: 2000-01-23T04:56:07.000+00:00
              to: 2000-01-23T04:56:07.000+00:00
            - from: 2000-01-23T04:56:07.000+00:00
              to: 2000-01-23T04:56:07.000+00:00
        uri: uri
      properties:
        uri:
          description: Canonical URI of a business-hours resource
          type: string
        schedule:
          $ref: '#/components/schemas/ScheduleInfoUserBusinessHours'
      type: object
    EntityTag:
      properties:
        value:
          type: string
        weak:
          default: false
          type: boolean
      type: object
    IntervalResource:
      properties:
        from:
          type: string
        to:
          type: string
      type: object
    SIPFlagsRespones:
      example:
        outboundCallsEnabled: True
        voipFeatureEnabled: True
        voipCountryBlocked: True
      properties:
        voipFeatureEnabled:
          description: If 'True' VoIP calling feature is enabled
          enum:
          - True
          - False
          type: string
        voipCountryBlocked:
          description: If 'True' the request is sent from IP address of a country blocked for VoIP calling
          enum:
          - True
          - False
          type: string
        outboundCallsEnabled:
          description: If 'True' outbound calls are enabled
          enum:
          - True
          - False
          type: string
      type: object
    ActiveCallInfo:
      example:
        sipData:
          callId: callId
          fromTag: fromTag
          remoteUri: remoteUri
          toTag: toTag
          localUri: localUri
          rcSessionId: rcSessionId
        telephonyStatus: NoCall
        terminationType: final
        from: from
        id: id
        to: to
        sessionId: sessionId
        direction: Inbound
      properties:
        id:
          description: Internal identifier of a call
          type: string
        direction:
          description: Call direction
          enum:
          - Inbound
          - Outbound
          type: string
        from:
          description: Phone number or extension number of a caller
          type: string
        to:
          description: Phone number or extension number of a callee
          type: string
        telephonyStatus:
          description: Telephony call status
          enum:
          - NoCall
          - CallConnected
          - Ringing
          - OnHold
          - ParkedCall
          type: string
        sipData:
          $ref: '#/components/schemas/DetailedCallInfo'
        sessionId:
          description: Internal identifier of a call session
          type: string
        terminationType:
          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
          type: string
      type: object
    UpdateForwardingNumberRequest:
      example:
        phoneNumber: phoneNumber
        flipNumber: flipNumber
        label: label
      properties:
        phoneNumber:
          description: Forwarding/Call flip phone number
          type: string
        label:
          description: Forwarding/Call flip number title
          type: string
        flipNumber:
          description: Number assigned to the call flip phone number, corresponds to the shortcut dial number
          type: string
      type: object
    DepartmentInfo:
      example:
        extensionNumber: extensionNumber
        id: id
        uri: uri
      properties:
        id:
          description: Internal identifier of a department extension
          type: string
        uri:
          description: Canonical URI of a department extension
          type: string
        extensionNumber:
          description: Number of a department extension
          type: string
      type: object
    Navigation:
      example:
        previousPage:
          uri: http://example.com/aeiou
        firstPage:
          uri: http://example.com/aeiou
        lastPage:
          uri: http://example.com/aeiou
        nextPage:
          uri: http://example.com/aeiou
      properties:
        nextPage:
          $ref: '#/components/schemas/ResourceLink'
        previousPage:
          $ref: '#/components/schemas/ResourceLink'
        firstPage:
          $ref: '#/components/schemas/ResourceLink'
        lastPage:
          $ref: '#/components/schemas/ResourceLink'
      type: object
    DeviceToRegister:
      properties:
        id:
          type: string
        computerName:
          type: string
        appExternalId:
          type: string
      type: object
    GlipUnreadMessageCount:
      example:
        unreadPostsCount: 0
        tooManyUnreadPosts: true
      properties:
        unreadPostsCount:
          description: Total count of unread posts
          type: integer
        tooManyUnreadPosts:
          description: '''True'' if message quantity exceeds the threshold (100 by
            default)'
          type: boolean
      type: object
    PromptInfo:
      example:
        filename: filename
        contentUri: contentUri
        id: id
        uri: uri
        contentType: contentType
      properties:
        uri:
          description: Internal identifier of a prompt
          type: string
        id:
          description: Link to a prompt metadata
          type: string
        contentType:
          description: Type of a prompt media content
          type: string
        contentUri:
          description: Link to a prompt media content
          type: string
        filename:
          description: Name of a prompt
          type: string
      type: object
    CreatePagerMessageRequest:
      example:
        replyOn: 0
        from:
          phoneNumber: phoneNumber
          extensionNumber: extensionNumber
          name: name
          location: location
        text: text
        to:
        - phoneNumber: phoneNumber
          extensionNumber: extensionNumber
          name: name
          location: location
        - phoneNumber: phoneNumber
          extensionNumber: extensionNumber
          name: name
          location: location
      properties:
        from:
          $ref: '#/components/schemas/MessageStoreCallerInfoRequest'
        replyOn:
          description: Internal identifier of a message this message replies to
          type: integer
        text:
          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
          type: string
        to:
          description: Optional if replyOn parameter is specified. Receiver of a pager message. The extensionNumber property must be filled
          items:
            $ref: '#/components/schemas/MessageStoreCallerInfoRequest'
          type: array
      required:
      - from
      - text
      type: object
    ShippingOptionsResource:
      properties:
        uri:
          format: uri
          type: string
        records:
          items:
            $ref: '#/components/schemas/ShippingOptionResource'
          type: array
        paging:
          $ref: '#/components/schemas/Paging'
        navigation:
          $ref: '#/components/schemas/Navigation'
      type: object
    SetReportingSettingsRequest:
      example:
        views:
        - pages:
          - name: name
            attrX: attrX
          - name: name
            attrX: attrX
          schedules:
          - recurrence:
            - pattern: Daily
              value: "0"
            - pattern: Daily
              value: "0"
            attachments:
            - pdf: true
              csv: true
            - pdf: true
              csv: true
            pages:
            - pages
            - pages
            recipients:
            - recipients
            - recipients
            viewType: Detailed
            scheduleId: scheduleId
          - recurrence:
            - pattern: Daily
              value: "0"
            - pattern: Daily
              value: "0"
            attachments:
            - pdf: true
              csv: true
            - pdf: true
              csv: true
            pages:
            - pages
            - pages
            recipients:
            - recipients
            - recipients
            viewType: Detailed
            scheduleId: scheduleId
          name: name
        - pages:
          - name: name
            attrX: attrX
          - name: name
            attrX: attrX
          schedules:
          - recurrence:
            - pattern: Daily
              value: "0"
            - pattern: Daily
              value: "0"
            attachments:
            - pdf: true
              csv: true
            - pdf: true
              csv: true
            pages:
            - pages
            - pages
            recipients:
            - recipients
            - recipients
            viewType: Detailed
            scheduleId: scheduleId
          - recurrence:
            - pattern: Daily
              value: "0"
            - pattern: Daily
              value: "0"
            attachments:
            - pdf: true
              csv: true
            - pdf: true
              csv: true
            pages:
            - pages
            - pages
            recipients:
            - recipients
            - recipients
            viewType: Detailed
            scheduleId: scheduleId
          name: name
      properties:
        views:
          description: List of 'View' structures with a tuple of filter values, pages and schedules
          items:
            $ref: '#/components/schemas/ViewInfoReporting'
          type: array
      required:
      - views
      type: object
    DeviceModelResource:
      example:
        addons:
        - name: name
          count: 0
          id: id
        - name: name
          count: 0
          id: id
        name: name
        id: id
      properties:
        id:
          type: string
        name:
          type: string
        addons:
          items:
            $ref: '#/components/schemas/Addon'
          type: array
      type: object
    LocationResource:
      properties:
        uri:
          format: uri
          type: string
        city:
          type: string
        areaCode:
          type: string
        npa:
          type: string
        nxx:
          type: string
        state:
          $ref: '#/components/schemas/VersionedResource'
      type: object
    AddressInfo:
      example:
        country: country
        streetAddress: streetAddress
        postalCode: postalCode
        locality: locality
        region: region
        type: work
      properties:
        streetAddress:
          description: User street address
          type: string
        locality:
          description: User city
          type: string
        region:
          description: User state/region
          type: string
        postalCode:
          description: User postal code
          type: string
        country:
          description: User country
          type: string
        type:
          description: Address type
          enum:
          - work
          type: string
      type: object
    LookupPhoneNumberInfo:
      example:
        formattedNumber: formattedNumber
        phoneNumber: phoneNumber
        rank: 0
        vanityPattern: vanityPattern
      properties:
        phoneNumber:
          description: Phone number in E.164 format
          type: string
        formattedNumber:
          description: Phone number formatted according to current brand's default country
          type: string
        vanityPattern:
          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
          type: string
        rank:
          description: The value is returned if the extendedSearch parameter is true. The values are 10, 9, 8, etc.; '10' is the closest match
          type: integer
      type: object
    AccountResource:
      properties:
        uri:
          format: uri
          type: string
        id:
          type: string
        serviceInfo:
          $ref: '#/components/schemas/AccountServiceInfoResource'
        partnerId:
          type: string
        operator:
          $ref: '#/components/schemas/ExtensionResource'
        mainNumber:
          type: string
        reservationId:
          type: string
        sessionId:
          type: string
        status:
          enum:
          - Initial
          - Unconfirmed
          - Confirmed
          - Disabled
          type: string
        statusInfo:
          $ref: '#/components/schemas/StatusInfo'
        signupInfo:
          $ref: '#/components/schemas/SignupInfoResource'
        setupWizardState:
          enum:
          - NotStarted
          - Incomplete
          - Completed
          - Unknown
          type: string
        testerFlags:
          items:
            type: string
          type: array
        promotionCode:
          type: string
      required:
      - operator
      type: object
    CallQueueInfoRequest:
      example:
        slaThresholdSeconds: 6
        abandonedThresholdSeconds: 1
        slaGoal: 0
        includeAbandonedCalls: true
      properties:
        slaGoal:
          description: Target percentage of calls that must be answered by agents within the service level time threshold
          type: integer
        slaThresholdSeconds:
          type: integer
        includeAbandonedCalls:
          type: boolean
        abandonedThresholdSeconds:
          type: integer
      type: object
    ExtensionCallerIdInfo:
      example:
        byFeature:
        - feature: RingOut
          callerId:
            phoneInfo:
              phoneNumber: phoneNumber
              id: id
              uri: uri
            type: type
        - feature: RingOut
          callerId:
            phoneInfo:
              phoneNumber: phoneNumber
              id: id
              uri: uri
            type: type
        byDevice:
        - callerId:
            phoneInfo:
              phoneNumber: phoneNumber
              id: id
              uri: uri
            type: type
          device:
            phoneNumber: phoneNumber
            id: id
            uri: uri
        - callerId:
            phoneInfo:
              phoneNumber: phoneNumber
              id: id
              uri: uri
            type: type
          device:
            phoneNumber: phoneNumber
            id: id
            uri: uri
        uri: uri
      properties:
        uri:
          description: Canonical URL of a caller ID resource
          type: string
        byDevice:
          items:
            $ref: '#/components/schemas/CallerIdByDevice'
          type: array
        byFeature:
          items:
            $ref: '#/components/schemas/CallerIdByFeature'
          type: array
      type: object
    StatusType:
      properties:
        family:
          enum:
          - INFORMATIONAL
          - SUCCESSFUL
          - REDIRECTION
          - CLIENT_ERROR
          - SERVER_ERROR
          - OTHER
          type: string
        statusCode:
          format: int32
          type: integer
        reasonPhrase:
          type: string
      type: object
    EnterpriseUser:
      example:
        department: department
      properties:
        department:
          type: string
      type: object
    EmergencyServiceAddressResource:
      example:
        zip: zip
        country: country
        city: city
        street: street
        street2: street2
        state: state
        customerName: customerName
      properties:
        street:
          type: string
        street2:
          type: string
        city:
          type: string
        state:
          type: string
        country:
          type: string
        zip:
          type: string
        customerName:
          type: string
      type: object
    CompanyAnsweringRuleScheduleInfoRequest:
      example:
        ref: BusinessHours
        ranges:
          from: 2000-01-23T04:56:07.000+00:00
          to: 2000-01-23T04:56:07.000+00:00
        weeklyRanges:
          sunday:
          - from: from
            to: to
          - from: from
            to: to
          saturday:
          - from: from
            to: to
          - from: from
            to: to
          tuesday:
          - from: from
            to: to
          - from: from
            to: to
          wednesday:
          - from: from
            to: to
          - from: from
            to: to
          thursday:
          - from: from
            to: to
          - from: from
            to: to
          friday:
          - from: from
            to: to
          - from: from
            to: to
          monday:
          - from: from
            to: to
          - from: from
            to: to
      properties:
        weeklyRanges:
          $ref: '#/components/schemas/CompanyAnsweringRuleWeeklyScheduleInfoRequest'
        ranges:
          $ref: '#/components/schemas/RangesInfo'
        ref:
          description: Reference to Business Hours or After Hours schedule = ['BusinessHours', 'AfterHours']
          enum:
          - BusinessHours
          - AfterHours
          type: string
      type: object
    ClientProvisioningInfo:
      example:
        hints:
          trialState:
            expiresIn: 0
            actionRequired: true
          appVersionUpgrade:
            expiresIn: 0
            actionRequired: true
          userCredentialState:
            expiresIn: 0
            actionRequired: true
        webUris:
          mobileWebTellAFriend: mobileWebTellAFriend
          mobileWebInternationalCalling: mobileWebInternationalCalling
          mobileWebResetPassword: mobileWebResetPassword
          appDownload: appDownload
          mobileWebPhoneSystem: mobileWebPhoneSystem
          serviceWebTellAFriend: serviceWebTellAFriend
          serviceWebPhoneSystem: serviceWebPhoneSystem
          mobileWebReporting: mobileWebReporting
          mobileWebBilling: mobileWebBilling
          serviceWebResetPassword: serviceWebResetPassword
          signUp: signUp
          meetingsAppDownload: meetingsAppDownload
          mobileWebCallHandling: mobileWebCallHandling
          mobileWebTrialUpgrade: mobileWebTrialUpgrade
          mobileWebUserSettings: mobileWebUserSettings
          serviceWebUserSettings: serviceWebUserSettings
          serviceWebBilling: serviceWebBilling
          appDownloadFile: appDownloadFile
          serviceWebHome: serviceWebHome
          expressSetupMobile: expressSetupMobile
          support: support
          mobileWebNotifications: mobileWebNotifications
      properties:
        webUris:
          $ref: '#/components/schemas/ClientProvisioningWebUriInfo'
        hints:
          $ref: '#/components/schemas/ClientProvisioningHintsInfo'
      required:
      - hints
      - webUris
      type: object
    AccountPresenceInfo:
      example:
        navigation:
          previousPage:
            uri: uri
          firstPage:
            uri: uri
          lastPage:
            uri: uri
          nextPage:
            uri: uri
        records:
        - allowSeeMyPresence: true
          dndStatus: TakeAllCalls
          extension:
            extensionNumber: extensionNumber
            id: id
            uri: uri
          pickUpCallsOnHold: true
          userStatus: Offline
          telephonyStatus: NoCall
          ringOnMonitoredCall: true
          message: message
          presenceStatus: Offline
          uri: uri
          activeCalls:
          - sipData:
              callId: callId
              fromTag: fromTag
              remoteUri: remoteUri
              toTag: toTag
              localUri: localUri
              rcSessionId: rcSessionId
            telephonyStatus: NoCall
            terminationType: final
            from: from
            id: id
            to: to
            sessionId: sessionId
            direction: Inbound
          - sipData:
              callId: callId
              fromTag: fromTag
              remoteUri: remoteUri
              toTag: toTag
              localUri: localUri
              rcSessionId: rcSessionId
            telephonyStatus: NoCall
            terminationType: final
            from: from
            id: id
            to: to
            sessionId: sessionId
            direction: Inbound
        - allowSeeMyPresence: true
          dndStatus: TakeAllCalls
          extension:
            extensionNumber: extensionNumber
            id: id
            uri: uri
          pickUpCallsOnHold: true
          userStatus: Offline
          telephonyStatus: NoCall
          ringOnMonitoredCall: true
          message: message
          presenceStatus: Offline
          uri: uri
          activeCalls:
          - sipData:
              callId: callId
              fromTag: fromTag
              remoteUri: remoteUri
              toTag: toTag
              localUri: localUri
              rcSessionId: rcSessionId
            telephonyStatus: NoCall
            terminationType: final
            from: from
            id: id
            to: to
            sessionId: sessionId
            direction: Inbound
          - sipData:
              callId: callId
              fromTag: fromTag
              remoteUri: remoteUri
              toTag: toTag
              localUri: localUri
              rcSessionId: rcSessionId
            telephonyStatus: NoCall
            terminationType: final
            from: from
            id: id
            to: to
            sessionId: sessionId
            direction: Inbound
        paging:
          perPage: 5
          pageStart: 5
          pageEnd: 2
          totalPages: 7
          page: 1
          totalElements: 9
        uri: uri
      properties:
        uri:
          description: Canonical URI of account presence resource
          type: string
        records:
          description: List of Prompts
          items:
            $ref: '#/components/schemas/GetPresenceInfo'
          type: array
        navigation:
          $ref: '#/components/schemas/NavigationInfo'
        paging:
          $ref: '#/components/schemas/PagingInfo'
      type: object
  securitySchemes:
    OAuth2:
      flows:
        authorizationCode:
          authorizationUrl: https://platform.devtest.ringcentral.com/restapi/oauth/authorize
          scopes: {}
          tokenUrl: https://platform.devtest.ringcentral.com/restapi/oauth/token
      type: oauth2