RingCentral Call Handling Rules API

openapi: 3.2.0
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:
    CustomGreetingInfoRequest:
      type: object
      properties:
        id:
          type: string
          description: Internal identifier of a custom user greeting
    TimeInterval:
      type: object
      properties:
        from:
          type: string
          description: Time in format hh:mm
        to:
          type: string
          description: Time in format hh:mm
    CompanyAnsweringRuleExtensionInfo:
      type: object
      properties:
        id:
          type: string
          description: Internal identifier of an extension
    ForwardingRuleInfo:
      type: object
      properties:
        index:
          type: integer
          format: int32
          description: Forwarding number (or group) ordinal
        ringCount:
          type: integer
          format: int32
          description: Number of rings for a forwarding number (or group)
        enabled:
          type: boolean
          description: Forwarding number status. Returned only if `showInactiveNumbers` is set to `true`
        forwardingNumbers:
          type: array
          description: Forwarding number (or group) data
          items:
            $ref: '#/components/schemas/CreateAnsweringRuleForwardingNumberInfo'
    TransferredExtension:
      type: object
      properties:
        id:
          type: string
          description: Internal identifier of an extension
        uri:
          type: string
          readOnly: true
          description: Canonical URI of an extension resource
      description: Transfer extension settings, set/returned if `callHandlingAction` is specified as `TransferToExtension`
    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'
    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
    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
    GreetingInfo:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/GreetingTypeEnum'
        preset:
          $ref: '#/components/schemas/PresetInfo'
        custom:
          $ref: '#/components/schemas/CustomGreetingInfoRequest'
    RangesInfo:
      type: object
      properties:
        from:
          type: string
          format: date-time
          description: 'Beginning timestamp of the range in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601),

            for example *2018-10-29T14:00:00*, *2018-10-29T14:00:00Z*, *2018-10-29T14:00:00+0100*

            '
        to:
          type: string
          format: date-time
          description: 'Ending timestamp of the range in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601),

            for example *2018-10-29T14:00:00*, *2018-10-29T14:00:00Z*, *2018-10-29T14:00:00+0100*

            '
    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'
    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'
    UserAnsweringRuleList:
      type: object
      properties:
        uri:
          type: string
          format: uri
          description: Canonical URI of an answering rule list resource
          example: https://platform.ringcentral.com/restapi/v1.0/account/240913004/extension/240972004/answering-rule?page=1&perPage=100
        records:
          type: array
          description: List of answering rules
          items:
            $ref: '#/components/schemas/AnsweringRuleInfo'
        paging:
          $ref: '#/components/schemas/EnumeratedPagingModel'
        navigation:
          $ref: '#/components/schemas/PageNavigationModel'
    GreetingTypeEnum:
      type: string
      description: Type of greeting, specifying the case when the greeting is played.
      enum:
      - Introductory
      - Announcement
      - AutomaticRecording
      - BlockedCallersAll
      - BlockedCallersSpecific
      - BlockedNoCallerId
      - BlockedPayPhones
      - ConnectingMessage
      - ConnectingAudio
      - StartRecording
      - StopRecording
      - Voicemail
      - Unavailable
      - InterruptPrompt
      - HoldMusic
      - Company
    CompanyAnsweringRuleInfo:
      type: object
      properties:
        id:
          type: string
          description: Internal identifier of an answering rule
        uri:
          type: string
          format: uri
          description: Canonical URI of an answering rule
        enabled:
          type: boolean
          description: Specifies if the rule is active or inactive
          default: true
        type:
          type: string
          description: Type of an answering rule
          default: Custom
          enum:
          - BusinessHours
          - AfterHours
          - Custom
        name:
          type: string
          description: Name of an answering rule specified by user. Max number of symbols is 30. The default value is 'My Rule N' where 'N' is the first free number
        callers:
          type: array
          description: Answering rule will be applied when calls are received from the specified caller(s)
          items:
            $ref: '#/components/schemas/CompanyAnsweringRuleCallersInfoRequest'
        calledNumbers:
          type: array
          description: Answering rule will be applied when calling the specified number(s)
          items:
            $ref: '#/components/schemas/CompanyAnsweringRuleCalledNumberInfoRequest'
        schedule:
          $ref: '#/components/schemas/CompanyAnsweringRuleScheduleInfo'
        callHandlingAction:
          type: string
          description: Specifies how incoming calls are forwarded. The default value is 'Operator' 'Operator' - play company greeting and forward to operator extension 'Disconnect' - play company greeting and disconnect 'Bypass' - bypass greeting to go to selected extension = ['Operator', 'Disconnect', 'Bypass']
          enum:
          - Operator
          - Disconnect
          - Bypass
        extension:
          $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
    CallersInfo:
      type: object
      properties:
        callerId:
          type: string
          description: Phone number of a caller
        name:
          type: string
          description: Contact name of a caller
    ListCompanyAnsweringRuleInfo:
      type: object
      properties:
        id:
          type: string
          description: Internal identifier of an answering rule
        uri:
          type: string
          format: uri
          description: Canonical URI of an answering rule
        enabled:
          type: boolean
          description: Specifies if the rule is active or inactive. The default value is `true`
          default: true
        type:
          type: string
          description: Type of an answering rule, the default value is 'Custom' = ['BusinessHours', 'AfterHours', 'Custom']
          enum:
          - BusinessHours
          - AfterHours
          - Custom
        name:
          type: string
          description: Name of an answering rule specified by user. Max number of symbols is 30. The default value is 'My Rule N' where 'N' is the first free number
        calledNumbers:
          type: array
          description: Answering rules are applied when calling to selected number(s)
          items:
            $ref: '#/components/schemas/CalledNumberInfo'
        extension:
          $ref: '#/components/schemas/CompanyAnsweringRuleExtensionInfo'
    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
    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'
    CalledNumberInfo:
      type: object
      properties:
        phoneNumber:
          type: string
          description: Called phone number
    UpdateAnsweringRuleRequest:
      type: object
      properties:
        id:
          type: string
          description: Identifier of an answering rule
        forwarding:
          $ref: '#/components/schemas/ForwardingInfoCreateRuleRequest'
        enabled:
          type: boolean
          description: Specifies if the rule is active or inactive. The default value is `true`
        name:
          type: string
          description: Name of an answering rule specified by user
        callers:
          type: array
          description: Answering rule will be applied when calls are received from the specified caller(s)
          items:
            $ref: '#/components/schemas/CallersInfoRequest'
        calledNumbers:
          type: array
          description: Answering rules are applied when calling to selected number(s)
          items:
            $ref: '#/components/schemas/CalledNumberInfo'
        schedule:
          $ref: '#/components/schemas/ScheduleInfo'
        callHandlingAction:
          type: string
          description: Specifies how incoming calls are forwarded
          enum:
          - ForwardCalls
          - UnconditionalForwarding
          - AgentQueue
          - TransferToExtension
          - TakeMessagesOnly
          - PlayAnnouncementOnly
          - SharedLines
        type:
          type: string
          description: Type of an answering rule
          enum:
          - BusinessHours
          - AfterHours
          - Custom
        unconditionalForwarding:
          $ref: '#/components/schemas/UnconditionalForwardingInfo'
        queue:
          $ref: '#/components/schemas/QueueInfo'
        voicemail:
          $ref: '#/components/schemas/VoicemailInfo'
        missedCall:
          $ref: '#/components/schemas/MissedCallInfo'
        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'
        screening:
          type: string
          description: 'Call screening status. ''Off'' - no call screening; ''NoCallerId''

            - if caller ID is missing, then callers are asked to say their name before

            connecting; ''UnknownCallerId'' - if caller ID is not in contact list, then

            callers are asked to say their name before connecting; ''Always'' - the

            callers are always asked to say their name before connecting. The default

            value is ''Off''

            '
          enum:
          - 'Off'
          - NoCallerId
          - UnknownCallerId
          - Always
          default: 'Off'
        showInactiveNumbers:
          type: boolean
          description: Indicates whether inactive numbers should be returned or not
        transfer:
          $ref: '#/components/schemas/TransferredExtensionInfo'
    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


# --- 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