RingCentral Call Handling Rules API

openapi: 3.0.3
info:
  title: RingCentral Adaptive Cards Call Handling Rules 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: Call Handling Rules
paths:
  /restapi/v1.0/account/{accountId}/answering-rule:
    get:
      tags:
      - Call Handling Rules
      summary: List Company Call Handling Rules
      description: Returns a list of company call handling rules.
      operationId: listCompanyAnsweringRules
      parameters:
      - $ref: '#/components/parameters/AccountId'
      - $ref: '#/components/parameters/Page'
      - $ref: '#/components/parameters/PerPage'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompanyAnsweringRuleList'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalError'
        '503':
          $ref: '#/components/responses/ServiceNotAvailable'
      x-feature: ReadAccountAnsweringRules
      x-availability: High
      x-throttling-group: Medium
      x-app-permission: ReadAccounts
      x-user-permission: ReadCompanyAnsweringRules
    post:
      tags:
      - Call Handling Rules
      summary: Create Company Call Handling Rule
      description: Creates call handling rule on account level.
      operationId: createCompanyAnsweringRule
      parameters:
      - $ref: '#/components/parameters/AccountId'
      requestBody:
        description: JSON body
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CompanyAnsweringRuleRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompanyAnsweringRuleInfo'
        '400':
          $ref: '#/components/responses/InvalidRequest'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalError'
        '503':
          $ref: '#/components/responses/ServiceNotAvailable'
      x-feature: EditAccountAnsweringRules
      x-availability: Limited
      x-throttling-group: Medium
      x-app-permission: EditAccounts
      x-user-permission: EditCompanyAnsweringRules
  /restapi/v1.0/account/{accountId}/answering-rule/{ruleId}:
    get:
      tags:
      - Call Handling Rules
      summary: Get Company Call Handling Rule
      description: Returns a company call handling rule by ID.
      operationId: readCompanyAnsweringRule
      parameters:
      - $ref: '#/components/parameters/AccountId'
      - $ref: '#/components/parameters/CallHandlingRuleId'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompanyAnsweringRuleInfo'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalError'
        '503':
          $ref: '#/components/responses/ServiceNotAvailable'
      x-feature: ReadAccountAnsweringRules
      x-availability: High
      x-throttling-group: Light
      x-app-permission: ReadAccounts
      x-user-permission: ReadCompanyAnsweringRules
    put:
      tags:
      - Call Handling Rules
      summary: Update Company Call Handling Rule
      description: Updates a company call handling rule.
      operationId: updateCompanyAnsweringRule
      parameters:
      - $ref: '#/components/parameters/AccountId'
      - $ref: '#/components/parameters/CallHandlingRuleId'
      requestBody:
        description: JSON body
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CompanyAnsweringRuleUpdate'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompanyAnsweringRuleInfo'
        '400':
          $ref: '#/components/responses/InvalidRequest'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalError'
        '503':
          $ref: '#/components/responses/ServiceNotAvailable'
      x-feature: EditAccountAnsweringRules
      x-availability: Limited
      x-throttling-group: Medium
      x-app-permission: EditAccounts
      x-user-permission: EditCompanyAnsweringRules
    delete:
      tags:
      - Call Handling Rules
      summary: Delete Company Call Handling Rule
      description: Deletes a company custom call handling rule by a particular ID.
      operationId: deleteCompanyAnsweringRule
      parameters:
      - $ref: '#/components/parameters/AccountId'
      - $ref: '#/components/parameters/CallHandlingRuleId'
      responses:
        '204':
          description: No Content
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalError'
        '503':
          $ref: '#/components/responses/ServiceNotAvailable'
      x-feature: EditAccountAnsweringRules
      x-availability: Limited
      x-throttling-group: Medium
      x-app-permission: EditAccounts
      x-user-permission: EditCompanyAnsweringRules
  /restapi/v1.0/account/{accountId}/forward-all-calls:
    get:
      tags:
      - Call Handling Rules
      summary: Get Forward All Company Calls
      description: Returns information about *Forward All Company Calls* feature setting.
      operationId: getForwardAllCompanyCalls
      parameters:
      - $ref: '#/components/parameters/AccountId'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForwardAllCompanyCallsInfo'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalError'
        '503':
          $ref: '#/components/responses/ServiceNotAvailable'
      x-availability: High
      x-throttling-group: Light
      x-app-permission: ReadAccounts
      x-user-permission: ReadCompanyAnsweringRules
    patch:
      tags:
      - Call Handling Rules
      summary: Update Forward All Company Calls
      description: Updates *Forward All Company Calls* feature setting.
      operationId: updateForwardAllCompanyCalls
      parameters:
      - $ref: '#/components/parameters/AccountId'
      requestBody:
        description: JSON body
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ForwardAllCompanyCallsRequest'
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForwardAllCompanyCallsInfo'
        '400':
          $ref: '#/components/responses/InvalidRequest'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalError'
        '503':
          $ref: '#/components/responses/ServiceNotAvailable'
      x-availability: High
      x-throttling-group: Medium
      x-app-permission: EditAccounts
      x-user-permission: EditCompanyAnsweringRules
  /restapi/v1.0/account/{accountId}/extension/{extensionId}/answering-rule:
    get:
      tags:
      - Call Handling Rules
      summary: List Call Handling Rules
      description: Returns call handling rules of an extension.
      operationId: listAnsweringRules
      parameters:
      - $ref: '#/components/parameters/AccountId'
      - $ref: '#/components/parameters/ExtensionId'
      - name: type
        in: query
        description: Filters custom call handling rules of the extension
        schema:
          type: string
          enum:
          - Custom
      - name: view
        in: query
        schema:
          type: string
          default: Simple
          enum:
          - Detailed
          - Simple
      - name: enabledOnly
        in: query
        description: If true, then only active call handling rules are returned
        schema:
          type: boolean
          default: false
      - $ref: '#/components/parameters/Page'
      - $ref: '#/components/parameters/PerPage'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserAnsweringRuleList'
        '400':
          $ref: '#/components/responses/InvalidRequest'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalError'
        '503':
          $ref: '#/components/responses/ServiceNotAvailable'
      x-feature: ReadExtensionAnsweringRules
      x-availability: High
      x-throttling-group: Medium
      x-app-permission: ReadAccounts
      x-user-permission: ReadUserAnsweringRules
    post:
      tags:
      - Call Handling Rules
      summary: Create Call Handling Rule
      description: Creates a custom call handling rule for a particular caller ID.
      operationId: createAnsweringRule
      parameters:
      - $ref: '#/components/parameters/AccountId'
      - $ref: '#/components/parameters/ExtensionId'
      requestBody:
        description: JSON body
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateAnsweringRuleRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomAnsweringRuleInfo'
        '400':
          $ref: '#/components/responses/InvalidRequest'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalError'
        '503':
          $ref: '#/components/responses/ServiceNotAvailable'
      x-feature: EditExtensionAnsweringRules
      x-availability: Limited
      x-throttling-group: Medium
      x-app-permission: EditExtensions
      x-user-permission: EditUserAnsweringRules
  /restapi/v1.0/account/{accountId}/extension/{extensionId}/answering-rule/{ruleId}:
    get:
      tags:
      - Call Handling Rules
      summary: Get Call Handling Rule
      description: Returns a call handling rule by ID.
      operationId: readAnsweringRule
      parameters:
      - $ref: '#/components/parameters/AccountId'
      - $ref: '#/components/parameters/ExtensionId'
      - $ref: '#/components/parameters/CallHandlingRuleId'
      - name: showInactiveNumbers
        in: query
        description: Indicates whether inactive numbers should be returned or not
        schema:
          type: boolean
          default: false
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AnsweringRuleInfo'
        '400':
          $ref: '#/components/responses/InvalidRequest'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalError'
        '503':
          $ref: '#/components/responses/ServiceNotAvailable'
      x-feature: ReadExtensionAnsweringRules
      x-availability: High
      x-throttling-group: Light
      x-app-permission: ReadAccounts
      x-user-permission: ReadUserAnsweringRules
    put:
      tags:
      - Call Handling Rules
      summary: Update Call Handling Rule
      description: Updates a custom call handling rule for a particular caller ID.
      operationId: updateAnsweringRule
      parameters:
      - $ref: '#/components/parameters/AccountId'
      - $ref: '#/components/parameters/ExtensionId'
      - $ref: '#/components/parameters/CallHandlingRuleId'
      requestBody:
        description: JSON body
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateAnsweringRuleRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AnsweringRuleInfo'
        '400':
          $ref: '#/components/responses/InvalidRequest'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalError'
        '503':
          $ref: '#/components/responses/ServiceNotAvailable'
      x-feature: EditExtensionAnsweringRules
      x-availability: Limited
      x-throttling-group: Medium
      x-app-permission: EditExtensions
      x-user-permission: EditUserAnsweringRules
    delete:
      tags:
      - Call Handling Rules
      summary: Delete Call Handling Rule
      description: Deletes a custom call handling rule by a particular ID.
      operationId: deleteAnsweringRule
      parameters:
      - $ref: '#/components/parameters/AccountId'
      - $ref: '#/components/parameters/ExtensionId'
      - $ref: '#/components/parameters/CallHandlingRuleId'
      responses:
        '204':
          description: No Content
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalError'
        '503':
          $ref: '#/components/responses/ServiceNotAvailable'
      x-feature: EditExtensionAnsweringRules
      x-availability: Limited
      x-throttling-group: Medium
      x-app-permission: EditExtensions
      x-user-permission: EditUserAnsweringRules
components:
  schemas:
    CreateAnsweringRuleForwardingNumberInfo:
      type: object
      properties:
        id:
          type: string
          description: Internal identifier of a forwarding number
        uri:
          type: string
          format: uri
          description: Canonical URI of a forwarding/call flip phone number
        phoneNumber:
          type: string
          description: Forwarding/Call flip phone number
        label:
          type: string
          description: Forwarding/Call flip number title
        type:
          type: string
          description: Type of forwarding number
          enum:
          - Home
          - Mobile
          - Work
          - PhoneLine
          - Outage
          - Other
          - BusinessMobilePhone
          - ExternalCarrier
          - ExtensionApps
    IvrCallHandlingActionEnum:
      type: string
      description: 'Specifies how incoming calls are forwarded. The default value

        is ''Operator'' ''Operator'' - play company greeting and forward to operator

        extension ''Disconnect'' - play company greeting and disconnect ''Bypass''

        - bypass greeting to go to selected extension = [''Operator'', ''Disconnect'',

        ''Bypass'']

        '
      enum:
      - Operator
      - Disconnect
      - Bypass
    CompanyAnsweringRuleExtensionInfoRequest:
      type: object
      properties:
        id:
          type: string
          description: Internal identifier of an extension
      description: Extension to which the call is forwarded in 'Bypass' mode
    SharedLinesInfo:
      type: object
      properties:
        timeout:
          type: integer
          format: int32
          minimum: 10
          maximum: 80
          description: 'Number of seconds to wait before forwarding unanswered calls. The value range is 10 - 80

            '
      description: SharedLines call handling action settings
    CompanyAnsweringRuleCalledNumberInfoRequest:
      type: object
      properties:
        id:
          type: string
          description: Internal identifier of an account phone number
        phoneNumber:
          type: string
          description: Phone number of a callee
    ScheduleInfo:
      type: object
      description: Schedule when an answering rule should be applied
      properties:
        weeklyRanges:
          $ref: '#/components/schemas/WeeklyScheduleInfo'
        ranges:
          type: array
          description: Specific data ranges
          items:
            $ref: '#/components/schemas/RangesInfo'
        ref:
          type: string
          description: The user's schedule specified for business hours or after hours; it can also be set/retrieved calling the corresponding method
          enum:
          - BusinessHours
          - AfterHours
    VoicemailInfo:
      type: object
      properties:
        enabled:
          type: boolean
          description: If `true` then voicemails are allowed to be received
        recipient:
          $ref: '#/components/schemas/RecipientInfo'
      description: Specifies whether to take a voicemail and who should do it
    CompanyAnsweringRuleRequest:
      type: object
      properties:
        name:
          type: string
          description: Name of an answering rule specified by user. Max number of symbols is 30. The default value is 'My Rule N' where 'N' is the first free number
        enabled:
          type: boolean
          description: Specifies if the rule is active or inactive. The default value is `true`
          default: true
        type:
          type: string
          description: Type of an answering rule, the default value is 'Custom' = ['BusinessHours', 'AfterHours', 'Custom']
          enum:
          - BusinessHours
          - AfterHours
          - Custom
        callers:
          type: array
          description: Answering rule will be applied when calls are received from the specified caller(s)
          items:
            $ref: '#/components/schemas/CompanyAnsweringRuleCallersInfoRequest'
        calledNumbers:
          type: array
          description: Answering rule will be applied when calling the specified number(s)
          items:
            $ref: '#/components/schemas/CompanyAnsweringRuleCalledNumberInfo'
        schedule:
          $ref: '#/components/schemas/CompanyAnsweringRuleScheduleInfoRequest'
        callHandlingAction:
          type: string
          description: Specifies how incoming calls are forwarded. The default value is 'Operator' 'Operator' - play company greeting and forward to operator extension 'Disconnect' - play company greeting and disconnect 'Bypass' - bypass greeting to go to selected extension = ['Operator', 'Disconnect', 'Bypass']
          enum:
          - Operator
          - Disconnect
          - Bypass
        extension:
          $ref: '#/components/schemas/CompanyAnsweringRuleExtensionInfoRequest'
        greetings:
          type: array
          description: Greetings applied for an answering rule; only predefined greetings can be applied, see Dictionary Greeting List
          items:
            $ref: '#/components/schemas/GreetingInfo'
    CompanyAnsweringRuleCallersInfoRequest:
      type: object
      properties:
        callerId:
          type: string
          description: Phone number of a caller
        name:
          type: string
          description: Displayed name for a caller ID
    ApiErrorWithParameter:
      description: 'The error model with additional attributes which can be used for HTTP 400/409

        This is a deprecated model: "ApiError" model can be used instead with arbitrary additional parameters

        '
      allOf:
      - $ref: '#/components/schemas/ApiError'
      - type: object
        properties:
          parameterName:
            type: string
            description: The name of the API parameter/attribute which caused the error
          parameterValue:
            type: string
            description: The value of the API parameter/attribute which caused the error
    CompanyAnsweringRuleUpdate:
      type: object
      properties:
        enabled:
          type: boolean
          description: Specifies if a rule is active or inactive. The default value is `true`
          default: true
        name:
          type: string
          description: 'Name of an answering rule specified by user. Max number of

            symbols is 30. The default value is ''My Rule N'' where ''N'' is the first

            free number

            '
        callers:
          type: array
          description: 'Answering rule will be applied when calls are received from

            the specified caller(s)

            '
          items:
            $ref: '#/components/schemas/CompanyAnsweringRuleCallersInfoRequest'
        calledNumbers:
          type: array
          description: Answering rule will be applied when calling the specified number(s)
          items:
            $ref: '#/components/schemas/CompanyAnsweringRuleCalledNumberInfo'
        schedule:
          $ref: '#/components/schemas/CompanyAnsweringRuleScheduleInfoRequest'
        callHandlingAction:
          type: string
          description: Specifies how incoming calls are forwarded. The default value is 'Operator' 'Operator' - play company greeting and forward to operator extension 'Disconnect' - play company greeting and disconnect 'Bypass' - bypass greeting to go to selected extension = ['Operator', 'Disconnect','Bypass']
          enum:
          - Operator
          - Disconnect
          - Bypass
        type:
          type: string
          description: Type of an answering rule
          default: Custom
          enum:
          - BusinessHours
          - AfterHours
          - Custom
        extension:
          $ref: '#/components/schemas/CompanyAnsweringRuleCallersInfoRequest'
        greetings:
          type: array
          description: 'Greetings applied for an answering rule; only predefined greetings

            can be applied, see Dictionary Greeting List

            '
          items:
            $ref: '#/components/schemas/GreetingInfo'
    FixedOrderAgents:
      type: object
      properties:
        extension:
          $ref: '#/components/schemas/FixedOrderAgentsExtensionInfo'
        index:
          type: integer
          format: int32
          description: Ordinal of an agent (call queue member)
    UnconditionalForwardingInfo:
      type: object
      description: 'Unconditional forwarding parameters.

        Returned if ''UnconditionalForwarding'' value is specified for the `callHandlingAction` parameter

        '
      properties:
        phoneNumber:
          type: string
          description: 'Phone number to which the call is forwarded. In addition to

            common e.164 format, the following number patterns are supported: 11xxxxxxxxxxx,

            444xxxxxxxxxxx, 616xxxxxxxxxxx, 1700yyyy; where xxxxxxxxxxx is a phone number in

            e.164 format (without ''+'' sign) and yyyy is an external short extension number.

            Max number of digits is 15

            '
        action:
          type: string
          description: Event that initiates forwarding to the specified phone number
          enum:
          - HoldTimeExpiration
          - MaxCallers
          - NoAnswer
    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
    MissedCallExtensionInfo:
      type: object
      description: Specifies an extension (a calling group) which should be used for the missed call transfer. Returned only if the `actionType` is set to 'ConnectToExtension'
      properties:
        id:
          type: string
          description: Internal identifier of an extension which should be used for the missed call transfer
        externalNumber:
          $ref: '#/components/schemas/MissedCallExtensionInfoExternalNumber'
    CalledNumberInfo:
      type: object
      properties:
        phoneNumber:
          type: string
          description: Called phone number
    PageNavigationUri:
      type: object
      additionalProperties: false
      properties:
        uri:
          type: string
          description: Canonical URI to retrieve the particular page of the result set
          format: uri
    EnumeratedPagingModel:
      type: object
      required:
      - perPage
      additionalProperties: false
      properties:
        perPage:
          type: integer
          format: int32
          minimum: 1
          maximum: 1000
          description: 'Current page size, describes how many items are in each page.

            Matches "perPage" parameter from the request.

            '
          example: 50
        page:
          type: integer
          format: int32
          minimum: 1
          maximum: 1000
          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)

            '
          example: 5
        pageStart:
          type: integer
          format: int32
          minimum: 0
          description: 'The zero-based number of the first element on the current page.

            Omitted if the page is omitted or result is empty

            '
          example: 0
        pageEnd:
          type: integer
          format: int32
          minimum: 0
          description: 'The zero-based index of the last element on the current page.

            Omitted if the page is omitted or result is empty

            '
          example: 5
        totalPages:
          type: integer
          format: int32
          minimum: 0
          description: 'The total number of pages in a dataset. May be omitted for

            some resources due to performance reasons

            '
          example: 25
        totalElements:
          type: integer
          format: int32
          minimum: 0
          description: 'The total number of elements in a dataset. May be omitted for

            some resource due to performance reasons

            '
          example: 25
    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'
    WeeklyScheduleInfo:
      type: object
      properties:
        monday:
          type: array
          description: Time intervals for a particular day
          items:
            $ref: '#/components/schemas/TimeInterval'
        tuesday:
          type: array
          description: Time intervals for a particular day
          items:
            $ref: '#/components/schemas/TimeInterval'
        wednesday:
          type: array
          description: Time intervals for a particular day
          items:
            $ref: '#/components/schemas/TimeInterval'
        thursday:
          type: array
          description: Time intervals for a particular day
          items:
            $ref: '#/components/schemas/TimeInterval'
        friday:
          type: array
          description: Time intervals for a particular day
          items:
            $ref: '#/components/schemas/TimeInterval'
        saturday:
          type: array
          description: Time intervals for a particular day
          items:
            $ref: '#/components/schemas/TimeInterval'
        sunday:
          type: array
          description: Time intervals for a particular day
          items:
            $ref: '#/components/schemas/TimeInterval'
      description: Weekly schedule
    MissedCallInfo:
      type: object
      description: Specifies behavior for the missed call scenario. Returned only if `enabled` parameter of a voicemail is set to 'false'
      properties:
        actionType:
          type: string
          description: Specifies the action that should be executed on a missed call. It can either be playing greeting message and disconnection, or sending call to a calling group. If 'ConnectToExtension' is set, then calling group extension should be specified
          enum:
          - PlayGreetingAndDisconnect
          - ConnectToExtension
          - ConnectToExternalNumber
        extension:
          $ref: '#/components/schemas/MissedCallExtensionInfo'
    ForwardingRuleCreateRequest:
      type: object
      properties:
        index:
          type: integer
          format: int32
          description: Forwarding number (or group) ordinal. Not returned for inactive numbers
        ringCount:
          type: integer
          format: int32
          description: 'Number of rings for a forwarding number (or group). For inactive

            numbers the default value (''4'') is returned

            '
        enabled:
          type: boolean
          description: Phone number status
        forwardingNumbers:
          type: array
          description: Forwarding number (or group) data
          items:
            $ref: '#/components/schemas/ForwardingNumberInfoRulesCreateRuleRequest'
    CompanyAnsweringRuleExtensionInfo:
      type: object
      properties:
        id:
          type: string
          description: Internal identifier of an extension
    CallersInfoRequest:
      type: object
      properties:
        callerId:
          type: string
          description: Phone number of a caller
        name:
          type: string
          description: Contact name of a caller
    PageNavigationModel:
      type: object
      description: Links to other pages of the current result set
      additionalProperties: false
      properties:
        firstPage:
          $ref: '#/components/schemas/PageNavigationUri'
        nextPage:
          $ref: '#/components/schemas/PageNavigationUri'
        previousPage:
          $ref: '#/components/schemas/PageNavigationUri'
        lastPage:
          $ref: '#/components/schemas/PageNavigationUri'
    ForwardingInfo:
      type: object
      properties:
        notifyMySoftPhones:
          type: boolean
          description: Specifies if the user's softphone(s) are notified before forwarding the incoming call to desk phones and forwarding numbers
        notifyAdminSoftPhones:
          type: boolean
          description: Deprecated parameter. Specifies if the administrator's softphone is notified before forwarding the incoming call to desk phones and forwarding numbers. The default value is `false`
          deprecated: true
        softPhonesRingCount:
          type: integer
          format: int32
          description: Number of rings before forwarding starts
        softPhonesAlwaysRing:
          type: boolean
          description: Specifies that desktop and mobile applications of the user will ring till the end of their forwarding list. If set to `true` then `softPhonesRingCount` is ignored
          default: true
        ringingMode:
          type: string
          description: Specifies the order in which the forwarding numbers ring. 'Sequentially' means that forwarding numbers are ringing one at a time, in order of priority. 'Simultaneously' means that forwarding numbers are ring all at the same time
          enum:
          - Sequentially
          - Simultaneously
        rules:
          type: array
          description: Information on a call forwarding rule
          items:
            $ref: '#/components/schemas/ForwardingRuleInfo'
        softPhonesPositionTop:
          type: boolean
          description: Specifies if desktop and mobile applications of the user are notified before (true) or after (false) for

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