RingCentral Company API

openapi: 3.2.0
info:
  title: RingCentral Adaptive Cards Company API
  description: RingCentral API specification
  version: 1.0.58-20240529-47eda8bd
  contact:
    name: RingCentral Developers Support
    url: https://developers.ringcentral.com/support
  termsOfService: https://www.ringcentral.com/legal/apilitos.html
  license:
    name: RingCentral API License Agreement
    url: https://www.ringcentral.com/legal/apilitos.html
servers:
- url: https://platform.ringcentral.com
  description: Production API entry point
- url: https://media.ringcentral.com
  description: Production Media entry point
- url: https://platform.devtest.ringcentral.com
  description: Developer sandbox API entry point
- url: https://platform.devtest.ringcentral.com
  description: Developer sandbox Media entry point
security:
- OAuth2: []
tags:
- name: Company
paths:
  /restapi/v2/accounts/{accountId}:
    get:
      tags:
      - Company
      summary: Get Account Info
      description: Returns basic information about particular RingCentral account
      operationId: getAccountInfoV2
      parameters:
      - $ref: '#/components/parameters/AccountId'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountInfo'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalError'
        '503':
          $ref: '#/components/responses/ServiceNotAvailable'
      x-availability: Limited
      x-throttling-group: Light
      x-app-permission: ReadAccounts
      x-user-permission: ReadCompanyInfo
  /restapi/v2/accounts/{accountId}/send-welcome-email:
    post:
      tags:
      - Company
      summary: Send/Resend Welcome Email
      description: Sends/resends welcome email to the system user of confirmed account
      operationId: sendWelcomeEmailV2
      parameters:
      - $ref: '#/components/parameters/AccountId'
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                email:
                  type: string
                  format: email
                  example: user@email.com
      responses:
        '200':
          description: Successful response
        '400':
          $ref: '#/components/responses/InvalidRequest'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalError'
        '503':
          $ref: '#/components/responses/ServiceNotAvailable'
      x-availability: Limited
      x-throttling-group: Medium
      x-app-permission: EditExtensions
      x-user-permission: Users
  /restapi/v2/accounts/{accountId}/send-activation-email:
    post:
      tags:
      - Company
      summary: Send/Resend Activation Email
      description: Sends/resends activation email to the system user of unconfirmed account.
      operationId: sendActivationEmailV2
      parameters:
      - $ref: '#/components/parameters/AccountId'
      responses:
        '200':
          description: Successful response
        '400':
          $ref: '#/components/responses/InvalidRequest'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalError'
        '503':
          $ref: '#/components/responses/ServiceNotAvailable'
      x-availability: Limited
      x-throttling-group: Medium
      x-app-permission: EditAccounts
      x-user-permission: AccountAdministration
  /restapi/v1.0/account/{accountId}:
    get:
      tags:
      - Company
      summary: Get Account Info
      description: 'Returns basic information about a particular RingCentral customer account.

        '
      operationId: readAccountInfo
      parameters:
      - $ref: '#/components/parameters/AccountId'
      responses:
        '200':
          description: Account information
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAccountInfoResponse'
      x-feature: ReadCompanyInfo
      x-availability: High
      x-throttling-group: Light
      x-app-permission: ReadAccounts
      x-user-permission: ReadCompanyInfo
  /restapi/v1.0/account/{accountId}/service-info:
    get:
      tags:
      - Company
      summary: Get Account Service Info
      description: 'Returns the information about service plan, available features

        and limitations for a particular RingCentral customer account.

        '
      operationId: readAccountServiceInfo
      parameters:
      - $ref: '#/components/parameters/AccountId'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountServiceInfo'
      x-feature: ReadServicePlan
      x-availability: High
      x-throttling-group: Light
      x-app-permission: ReadAccounts
      x-user-permission: ReadServicePlanInfo
  /restapi/v1.0/account/{accountId}/business-address:
    get:
      tags:
      - Company
      summary: Get Account Business Address
      description: 'Returns business address of a company.

        '
      operationId: readAccountBusinessAddress
      parameters:
      - $ref: '#/components/parameters/AccountId'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountBusinessAddressResource'
      x-feature: ReadCompanyInfo
      x-availability: High
      x-throttling-group: Light
      x-app-permission: ReadAccounts
      x-user-permission: ReadCompanyInfo
    put:
      tags:
      - Company
      summary: Update Company Business Address
      description: 'Updates the business address of a company that account is linked

        to.

        '
      operationId: updateAccountBusinessAddress
      parameters:
      - $ref: '#/components/parameters/AccountId'
      requestBody:
        description: JSON body
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ModifyAccountBusinessAddressRequest'
        required: true
      responses:
        '200':
          description: Updated company business address
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountBusinessAddressResource'
      x-feature: EditCompanyInfo
      x-availability: Limited
      x-throttling-group: Medium
      x-app-permission: EditAccounts
      x-user-permission: EditCompanyInfo
  /restapi/v1.0/dictionary/brand/{brandId}/contracted-country:
    get:
      tags:
      - Company
      summary: List Contracted Countries
      description: Returns the list of contracted countries for the given brand.
      operationId: listContractedCountries
      parameters:
      - name: brandId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContractedCountryListResponse'
      x-availability: High
      x-throttling-group: Light
  /restapi/v1.0/dictionary/brand/{brandId}/contracted-country/{contractedCountryId}:
    get:
      tags:
      - Company
      summary: List Domestic Countries
      description: 'Returns the list of domestic countries for account contracted country and brand.

        '
      operationId: listDomesticCountries
      parameters:
      - name: brandId
        in: path
        description: Internal identifier of a brand
        required: true
        schema:
          type: string
      - name: contractedCountryId
        in: path
        description: Internal identifier of a country
        required: true
        schema:
          type: string
      - name: page
        in: query
        description: 'Indicates a page number to retrieve. Only positive number values

          are accepted

          '
        schema:
          type: integer
          format: int32
          default: 1
      - name: perPage
        in: query
        description: Indicates a page size (number of items)
        schema:
          type: integer
          format: int32
          default: 100
      responses:
        '200':
          description: Domestic countries list
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CountryListDictionaryModel'
      x-availability: High
      x-throttling-group: Light
components:
  schemas:
    CountryListDictionaryModel:
      required:
      - navigation
      - paging
      - records
      type: object
      properties:
        uri:
          type: string
          format: uri
          description: Link to the list of countries supported
        records:
          type: array
          description: List of countries with the country data
          items:
            $ref: '#/components/schemas/CountryInfoDictionaryModel'
        navigation:
          $ref: '#/components/schemas/PageNavigationModel'
        paging:
          $ref: '#/components/schemas/EnumeratedPagingModel'
    BasicContactInfo:
      description: Personal contact information
      type: object
      properties:
        firstName:
          description: Given name
          type: string
          maxLength: 64
          example: John
        lastName:
          description: Family name
          type: string
          maxLength: 64
          example: Smith
        email:
          description: Contact email
          type: string
          format: email
          maxLength: 64
          example: john.smith@acme.com
    AccountServiceInfoRequest:
      type: object
      properties:
        uri:
          type: string
          format: uri
          description: Canonical URI of the account Service Info resource
        servicePlanName:
          type: string
          description: Account Service Plan name
        brand:
          $ref: '#/components/schemas/BrandInfo'
        contractedCountry:
          $ref: '#/components/schemas/CountryInfoShortModel'
        servicePlan:
          $ref: '#/components/schemas/ServicePlanInfo'
        targetServicePlan:
          $ref: '#/components/schemas/TargetServicePlanInfo'
        billingPlan:
          $ref: '#/components/schemas/BillingPlanInfo'
        serviceFeatures:
          type: array
          description: Service features information, see Service Feature List
          items:
            $ref: '#/components/schemas/ServiceFeatureInfo'
        limits:
          $ref: '#/components/schemas/AccountLimits'
        package:
          $ref: '#/components/schemas/PackageInfo'
      description: 'Account service information, including brand, service plan and billing plan

        '
    ServiceInfo:
      type: object
      properties:
        uri:
          type: string
          format: uri
          description: Canonical URI of a service info resource
        billingPlan:
          $ref: '#/components/schemas/BillingPlanInfo'
        brand:
          $ref: '#/components/schemas/BrandInfo'
        servicePlan:
          $ref: '#/components/schemas/ServicePlanInfo'
        targetServicePlan:
          $ref: '#/components/schemas/TargetServicePlanInfo'
        contractedCountry:
          $ref: '#/components/schemas/CountryInfoShortModel'
        uBrand:
          $ref: '#/components/schemas/UBrandInfo'
      description: 'Account service information, including brand, sub-brand, service plan and

        billing plan

        '
    ModifyAccountBusinessAddressRequest:
      type: object
      properties:
        company:
          type: string
          description: Company business name
        email:
          type: string
          format: email
          description: Company business email address
        businessAddress:
          $ref: '#/components/schemas/BusinessAddressInfo'
        mainSiteName:
          type: string
          description: Custom site name
    ServiceInfoCountryShortModel:
      allOf:
      - $ref: '#/components/schemas/CountryInfoBasicModel'
      - type: object
        properties:
          isoCode:
            type: string
            description: 'A ISO country code value complying with the

              [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)

              format.

              '
          callingCode:
            type: string
            description: 'Country calling code defined by [ITU-T](http://en.wikipedia.org/wiki/ITU-T)

              recommendations [E.123](http://en.wikipedia.org/wiki/E.123) and

              [E.164](http://en.wikipedia.org/wiki/E.164),

              see [Calling Codes](http://en.wikipedia.org/wiki/List_of_country_calling_codes)

              '
    BusinessAddressInfo:
      type: object
      properties:
        country:
          type: string
          description: Name of a country
        state:
          type: string
          description: Name of a state/province
        city:
          type: string
          description: Name of a city
        street:
          type: string
          description: Street address
        zip:
          type: string
          description: Zip code
      description: Company business address
    FormattingLocaleInfo:
      type: object
      properties:
        id:
          type: string
          description: Internal identifier of a formatting language
        localeCode:
          type: string
          description: Localization code of a formatting language
        name:
          type: string
          description: Official name of a formatting language
      description: 'Formatting language preferences for numbers, dates and currencies

        '
    SetupWizardStateEnum:
      type: string
      description: Initial configuration wizard state
      enum:
      - NotStarted
      - Incomplete
      - Completed
      - Unknown
    ServiceInfoPlan:
      type: object
      properties:
        id:
          type: string
          description: Internal identifier of a service plan
        name:
          type: string
          description: Name of a service plan
        edition:
          type: string
          description: Edition of a service plan
        freemiumProductType:
          type: string
          enum:
          - Freyja
          - Phoenix
      description: Information on account service plan
    PhoneNumberE164:
      type: string
      pattern: ^\+[1-9]\d{1,14}$
      description: Phone number in e.164 format (with '+' prefix)
      maxLength: 18
      example: '+16501234567'
    CountryInfoBasicModel:
      allOf:
      - $ref: '#/components/schemas/CountryInfoMinimalModel'
      - type: object
        properties:
          name:
            type: string
            description: The official name of a country
    ServicePlanInfo:
      type: object
      properties:
        id:
          type: string
          description: Internal identifier of a service plan
        name:
          type: string
          description: Name of a service plan
        edition:
          type: string
          description: Edition of a service plan
        freemiumProductType:
          type: string
          enum:
          - Freyja
          - Phoenix
      description: Information on account service plan
    AccountRegionalSettings:
      type: object
      properties:
        homeCountry:
          $ref: '#/components/schemas/CountryInfoShortModel'
        timezone:
          $ref: '#/components/schemas/TimezoneInfo'
        language:
          $ref: '#/components/schemas/RegionalLanguageInfo'
        greetingLanguage:
          $ref: '#/components/schemas/GreetingLanguageInfo'
        formattingLocale:
          $ref: '#/components/schemas/FormattingLocaleInfo'
        timeFormat:
          type: string
          description: Time format setting. The default value is '12h' = ['12h', '24h']
          enum:
          - 12h
          - 24h
        currency:
          $ref: '#/components/schemas/CurrencyInfo'
      description: 'Account level region data (web service Auto-Receptionist settings)

        '
    AccountLimits:
      type: object
      properties:
        freeSoftPhoneLinesPerExtension:
          type: integer
          format: int32
          description: 'Max number of free softphone phone lines per user extension

            '
        meetingSize:
          type: integer
          format: int32
          description: 'Max number of participants in RingCentral meeting hosted by

            this account''s user

            '
        cloudRecordingStorage:
          type: integer
          format: int32
          description: 'Meetings recording cloud storage limitation in Gb

            '
        maxMonitoredExtensionsPerUser:
          type: integer
          format: int32
          description: 'Max number of extensions which can be included in the list

            of users monitored for Presence

            '
        maxExtensionNumberLength:
          type: integer
          format: int32
          description: 'Max length of extension numbers of an account; the supported

            value is up to 8 symbols, depends on account type

            '
        siteCodeLength:
          type: integer
          format: int32
          description: Length of a site code
        shortExtensionNumberLength:
          type: integer
          format: int32
          description: Length of a short extension number
      description: Limits which are effective for the account
    AccountOperatorInfo:
      type: object
      description: 'Operator extension information. This extension will receive

        all calls and messages addressed to an operator.

        '
      properties:
        uri:
          type: string
          format: uri
          description: Link to an operator extension resource
        id:
          type: integer
          format: int64
          description: Internal identifier of an operator extension
        extensionNumber:
          type: string
          description: Number of an operator extension
        partnerId:
          type: string
          description: 'Internal identifier of an extension created by partner. Supported for Partner Applications.

            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

            '
    ParameterizedErrorResponseModel:
      type: object
      description: Standard error response which may include parameterized errors
      required:
      - errors
      properties:
        errors:
          type: array
          description: The array of errors (there will be just one in the most of the cases)
          minItems: 1
          items:
            $ref: '#/components/schemas/ApiErrorWithParameter'
    CountryInfoMinimalModel:
      type: object
      properties:
        id:
          type: string
          description: Internal identifier of a country
        uri:
          type: string
          format: uri
          description: Canonical URI of a country resource
    RegionalLanguageInfo:
      type: object
      properties:
        id:
          type: string
          description: Internal identifier of a language set as regional
        localeCode:
          type: string
          description: Localization code of a language set as regional
        name:
          type: string
          description: Official name of a language set as regional
      description: Information on a language set as regional
    PageNavigationUri:
      type: object
      additionalProperties: false
      properties:
        uri:
          type: string
          description: Canonical URI to retrieve the particular page of the result set
          format: uri
    PostalAddress:
      type: object
      description: Postal address/location
      required:
      - street
      - city
      - zip
      - country
      properties:
        street:
          type: string
          description: Street address
          maxLength: 256
          example: 20 Davis Dr
        street2:
          type: string
          description: Street address (2nd line)
          maxLength: 256
        city:
          type: string
          description: City name
          maxLength: 64
          example: Belmont
        state:
          description: State or province information in the target country
          maxLength: 64
          type: string
          example: CA
        zip:
          description: Postal code in the target country
          type: string
          maxLength: 10
          example: '94002'
        country:
          description: ISO-3166-1 2-letter country code (alpha2)
          type: string
          maxLength: 2
          minLength: 2
          example: US
    PackageInfo:
      type: object
      properties:
        version:
          type: string
          description: Billing package version
        id:
          type: string
          description: Billing package identifier
    AccountStatusInfo:
      type: object
      description: Optional information to be used when account is moved to "Disabled" status
      properties:
        reason:
          type: string
          description: Type of suspension, voluntarily or not
          enum:
          - SuspendedVoluntarily
          - SuspendedInvoluntarily
          - CancelledVoluntarily
          - CancelledInvoluntarily
          example: CancelledVoluntarily
        comment:
          type: string
          description: A meaningful description of the reason to change the status
          minLength: 1
          maxLength: 256
          example: By customer request. Case ABC123
        till:
          type: string
          description: Date after which the account will get deleted. Parameter can be used to overwrite default retention period
          format: date-time
          example: '2023-03-26T11:30:45.940Z'
    ServiceFeatureInfo:
      type: object
      properties:
        featureName:
          type: string
          description: Feature name
          enum:
          - AccountFederation
          - Archiver
          - AutomaticCallRecordingMute
          - AutomaticInboundCallRecording
          - AutomaticOutboundCallRecording
          - BlockedMessageForwarding
          - Calendar
          - CallerIdControl
          - CallForwarding
          - CallPark
          - CallParkLocations
          - CallSupervision
          - CallSwitch
          - CallQualitySurvey
          - Conferencing
          - ConferencingNumber
          - ConfigureDelegates
          - DeveloperPortal
          - DND
          - DynamicConference
          - EmergencyAddressAutoUpdate
          - EmergencyCalling
          - EncryptionAtRest
          - ExternalDirectoryIntegration
          - Fax
          - FaxReceiving
          - FreeSoftPhoneLines
          - HDVoice
          - HipaaCompliance
          - Intercom
          - InternationalCalling
          - InternationalSMS
          - LinkedSoftphoneLines
          - MMS
          - MobileVoipEmergencyCalling
          - OnDemandCallRecording
          - Pager
          - PagerReceiving
          - Paging
          - PasswordAuth
          - PromoMessage
          - Reports
          - Presence
          - RCTeams
          - RingOut
          - SalesForce
          - SharedLines
          - SingleExtensionUI
          - SiteCodes
          - SMS
          - SMSReceiving
          - SoftPhoneUpdate
          - TelephonySessions
          - UserManagement
          - VideoConferencing
          - VoipCalling
          - VoipCallingOnMobile
          - Voicemail
          - VoicemailToText
          - WebPhone
        enabled:
          type: boolean
          description: 'Feature status, shows feature availability for the extension

            '
    ServiceInfoPackage:
      description: Billing package information
      type: object
      required:
      - id
      - version
      properties:
        id:
          type: string
          description: Billing package ID
          example: '555'
        version:
          type: string
          description: Billing package version
          enum:
          - '1'
    BillingPlanInfo:
      type: object
      properties:
        id:
          type: string
          description: Internal identifier of a billing plan
        name:
          type: string
          description: Billing plan name
        durationUnit:
          type: string
          description: Duration period
          enum:
          - Day
          - Month
          - Year
        duration:
          type: integer
          format: int32
          description: Number of duration units
        type:
          type: string
          description: Billing plan type
          enum:
          - Initial
          - Regular
          - Suspended
          - Trial
          - TrialNoCC
          - Free
        includedPhoneLines:
          type: integer
          format: int32
          description: Included digital lines count
      description: Information on account billing plan
    ApiError:
      type: object
      description: Generalized API error structure suitable for any error type
      required:
      - errorCode
      - message
      properties:
        errorCode:
          type: string
          description: Logical error code (typically, 3 letters followed with number, dash separated)
          example: XXX-123
        message:
          type: string
          description: User-friendly error message
          example: Something went wrong
      additionalProperties: true
    UBrandInfo:
      type: object
      properties:
        id:
          type: string
          description: Sub-brand unique ID
          example: '111.222'
        name:
          type: string
          description: Sub-brand name
          example: Sub-brand name
      description: Account sub-brand information
    BasicContactInfoWithPhone:
      allOf:
      - $ref: '#/components/schemas/BasicContactInfo'
      - type: object
        properties:
          contactPhone:
            $ref: '#/components/schemas/PhoneNumberE164'
    AccountServiceInfo:
      allOf:
      - $ref: '#/components/schemas/AccountServiceInfoRequest'
      - type: object
        properties:
          uBrand:
            $ref: '#/components/schemas/UBrandInfo'
        description: 'Account service information, including brand, service plan and billing plan

          '
    CurrencyInfo:
      type: object
      properties:
        id:
          type: integer
          format: int64
          description: Internal identifier of a currency
        code:
          type: string
          description: Official code of a currency
        name:
          type: string
          description: Official name of a currency
        symbol:
          type: string
          description: Graphic symbol of a currency
        minorSymbol:
          type: string
          description: Minor graphic symbol of a currency
      description: Currency information
    CountryInfoShortModel:
      allOf:
      - $ref: '#/components/schemas/CountryInfoBasicModel'
      - type: object
        properties:
          isoCode:
            type: string
            description: 'A ISO country code value complying with the

              [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)

              format.

              '
          callingCode:
            type: string
            description: 'Country calling code defined by [ITU-T](http://en.wikipedia.org/wiki/ITU-T)

              recommendations [E.123](http://en.wikipedia.org/wiki/E.123) and

              [E.164](http://en.wikipedia.org/wiki/E.164),

              see [Calling Codes](http://en.wikipedia.org/wiki/List_of_country_calling_codes)

              '
    BrandInfo:
      type: object
      properties:
        id:
          type: string
          description: Internal identifier of a brand
        name:
          type: string
          description: 'Brand name, for example  RingCentral UK ,  ClearFax '
        homeCountry:
          $ref: '#/components/schemas/CountryInfoShortModel'
      description: Information on account brand
    ContractedCountryListResponse:
      type: object
      required:
      - records
      properties:
        records:
          type: array
          description: List of countries with the country data
          items:
            type: object
            properties:
              id:
                type: string
                description: Internal identifier of a country
              name:
                type: string
                description: Official name of a country
    GreetingLanguageInfo:
      type: object
      properties:
        id:
          type: string
          description: Internal identifier of a greeting language
        localeCode:
          type: string
          description: Localization code of a greeting language
        name:
          type: string
          description: Official name of a greeting language
      description: 'Information on language used for telephony greetings

        '
    SignupInfoResource:
      type: object
      properties:
        tosAccepted:
          type: boolean
          default: false
        signupState:
          type: array
          items:
            type: string
            enum:
            - AccountCreated
            - BillingEntered
            - CreditCardApproved
            - AccountConfirmed
            - PhoneVerificationRequired
            - PhoneVerificationPassed
        verificationReason:
          type: string
          enum:
          - CC_Failed
          - Phone_Suspicious
          - CC_Phone_Not_Match
          - AVS_Not_Available
          - MaxMind
          - CC_Blacklisted
          - Email_Blacklisted
          - Phone_Blacklisted
          - Cookie_Blacklisted
          - Device_Blacklisted
          - IP_Blacklisted
          - Agent_Instance_Blacklisted
          - Charge_Limit
          - Other_Country
          - Unknown
        marketingAccepted:
          type: boolean
          description: 'Updates ''Send Marketing Information'' flag on web interface

            '
        creationTime:
          type: string
          format: date-time
          description: The timestamp of account creation
          example: '2023-03-10T18:07:52.534Z'
      description: Account sign up data
    ExtensionNumber:
      description: 'Short number of an extension.

        Actual max length depends on system length limit for extension.

        '
      type: string
      pattern: ^\d{3,8}$
      minLength: 1
      maxLength: 8
      example: '205'
    ApiErrorResponseModel:
      type: object
      description: Standard error response model which is returned in case of any unsuccessful operation
      required:
      - errors
      properties:
        errors:
          type: array
          description: The array of errors (there will be just one in the most of the cases)
          minItems: 1
          items:
            $ref: '#/components/schemas/ApiError'
    GetAccountInfoResponse:
      type: object
      properties:
        id:
          type: integer
          format: int64
          description: Internal identifier of an account
        uri:
          type: string
          format: uri
          description: Canonical URI of an account
        bsid:
          type: string
          description: 'Internal identifier of an account in the billing system

            '
        mainNumber:
          type: string
          description: 'Main phone number of the current account

            '
        operator:
          $ref: '#/components/schemas/AccountOperatorInfo'
        partnerId:
          type: string
          description: 'Additional account identifier, created by partner application

            and applied on client sid

# --- truncated at 32 KB (49 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/ringcentral/refs/heads/main/openapi/ringcentral-company-api-openapi.yml