---
title: "List Call Handling Rules"
method: GET
path: "/restapi/v1.0/account/{accountId}/extension/{extensionId}/answering-rule"
tags: ["Call Handling Rules"]
---

# List Call Handling Rules

`GET /restapi/v1.0/account/{accountId}/extension/{extensionId}/answering-rule`

Returns call handling rules of an extension.

## Path parameters

- `accountId` string, required
- `extensionId` string, required

## Query parameters

- `type` 'Custom'
- `view` 'Detailed' | 'Simple'
- `enabledOnly` boolean
- `page` integer
- `perPage` integer

## Response `200`

OK

- UserAnsweringRuleList
  - `uri` string, uri — Canonical URI of an answering rule list resource
  - `records` AnsweringRuleInfo[] — List of answering rules
    - `uri` string, uri — Canonical URI to an answering rule resource
    - `id` string — Internal identifier of an answering rule
    - `type` 'BusinessHours' | 'AfterHours' | 'Custom' — Type of an answering rule
    - `name` string — Name of an answering rule specified by user
    - `enabled` boolean — Specifies if an answering rule is active or inactive
    - `schedule` ScheduleInfo — Schedule when an answering rule should be applied
      - `weeklyRanges` WeeklyScheduleInfo — Weekly schedule
        - `monday` TimeInterval[] — Time intervals for a particular day
          - `from` string — Time in format hh:mm
          - `to` string — Time in format hh:mm
        - `tuesday` TimeInterval[] — Time intervals for a particular day
          - `from` string — Time in format hh:mm
          - `to` string — Time in format hh:mm
        - `wednesday` TimeInterval[] — Time intervals for a particular day
          - `from` string — Time in format hh:mm
          - `to` string — Time in format hh:mm
        - `thursday` TimeInterval[] — Time intervals for a particular day
          - `from` string — Time in format hh:mm
          - `to` string — Time in format hh:mm
        - `friday` TimeInterval[] — Time intervals for a particular day
          - `from` string — Time in format hh:mm
          - `to` string — Time in format hh:mm
        - `saturday` TimeInterval[] — Time intervals for a particular day
          - `from` string — Time in format hh:mm
          - `to` string — Time in format hh:mm
        - `sunday` TimeInterval[] — Time intervals for a particular day
          - `from` string — Time in format hh:mm
          - `to` string — Time in format hh:mm
      - `ranges` RangesInfo[] — Specific data ranges
        - `from` string, date-time — 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` string, date-time — 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*
      - `ref` 'BusinessHours' | 'AfterHours' — The user's schedule specified for business hours or after hours; it can also be set/retrieved calling the corresponding method
    - `calledNumbers` CalledNumberInfo[] — Answering rules are applied when calling to selected number(s)
      - `phoneNumber` string — Called phone number
    - `callers` CallersInfo[] — Answering rules are applied when calls are received from specified caller(s)
      - `callerId` string — Phone number of a caller
      - `name` string — Contact name of a caller
    - `callHandlingAction` 'ForwardCalls' | 'UnconditionalForwarding' | 'AgentQueue' | 'TransferToExtension' | 'TakeMessagesOnly' | 'PlayAnnouncementOnly' | 'SharedLines' — Specifies how incoming calls are forwarded
    - `forwarding` ForwardingInfo — Forwarding parameters. Returned if 'ForwardCalls' is specified in 'callHandlingAction'. These settings determine the forwarding numbers to which the call will be forwarded
      - `notifyMySoftPhones` boolean — Specifies if the user's softphone(s) are notified before forwarding the incoming call to desk phones and forwarding numbers
      - `notifyAdminSoftPhones` boolean — 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`
      - `softPhonesRingCount` integer — Number of rings before forwarding starts
      - `softPhonesAlwaysRing` boolean — 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
      - `ringingMode` 'Sequentially' | 'Simultaneously' — 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
      - `rules` ForwardingRuleInfo[] — Information on a call forwarding rule
        - `index` integer — Forwarding number (or group) ordinal
        - `ringCount` integer — Number of rings for a forwarding number (or group)
        - `enabled` boolean — Forwarding number status. Returned only if `showInactiveNumbers` is set to `true`
        - `forwardingNumbers` CreateAnsweringRuleForwardingNumberInfo[] — Forwarding number (or group) data
          - `id` string — Internal identifier of a forwarding number
          - `uri` string, uri — Canonical URI of a forwarding/call flip phone number
          - `phoneNumber` string — Forwarding/Call flip phone number
          - `label` string — Forwarding/Call flip number title
          - `type` 'Home' | 'Mobile' | 'Work' | 'PhoneLine' | 'Outage' | 'Other' | 'BusinessMobilePhone' | 'ExternalCarrier' | 'ExtensionApps' — Type of forwarding number
      - `softPhonesPositionTop` boolean — Specifies if desktop and mobile applications of the user are notified before (true) or after (false) forwarding the incoming call to desk phones and forwarding numbers. Applicable only if `notifyMySoftPhones` parameter is set to `true`
      - `mobileTimeout` boolean — Deprecated parameter. Specifies if mobile timeout is activated for the rule
    - `unconditionalForwarding` UnconditionalForwardingInfo — Unconditional forwarding parameters. Returned if 'UnconditionalForwarding' value is specified for the `callHandlingAction` parameter
      - `phoneNumber` string — 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` 'HoldTimeExpiration' | 'MaxCallers' | 'NoAnswer' — Event that initiates forwarding to the specified phone number
    - `queue` QueueInfo — Queue settings applied for department (call queue) extension type, with the 'AgentQueue' value specified as a call handling action
      - `transferMode` 'Rotating' | 'Simultaneous' | 'FixedOrder' — Specifies how calls are transferred to group members
      - `transfer` TransferInfo[] — Call transfer information
        - `extension` TransferExtensionInfo — Transfer extension settings, set/returned if `callHandlingAction` is specified as `TransferToExtension`
          - `id` string — Internal identifier of an extension
          - `uri` string — Canonical URI of an extension resource
          - `name` string — Extension name
          - `extensionNumber` string — Extension number
        - `action` 'HoldTimeExpiration' | 'MaxCallers' | 'NoAnswer' — Event that initiates transferring to the specified extension
      - `noAnswerAction` 'WaitPrimaryMembers' | 'WaitPrimaryAndOverflowMembers' | 'Voicemail' | 'TransferToExtension' | 'UnconditionalForwarding' — Specifies the type of action to be taken if: members are available but no one answers, or all members are busy/unavailable. This option is available for Business hours only. For simultaneous transfer mode only 'WaitPrimaryMembers' and 'WaitPrimaryAndOverflowMembers' are supported
      - `fixedOrderAgents` FixedOrderAgents[] — Information on a call forwarding rule
        - `extension` FixedOrderAgentsExtensionInfo
          - `id` string — Internal identifier of an extension
          - `uri` string, uri — Canonical URI of an extension
          - `extensionNumber` string — Number of extension
          - `name` string — Name of agent extension
        - `index` integer — Ordinal of an agent (call queue member)
      - `holdAudioInterruptionMode` 'Never' | 'WhenMusicEnds' | 'Periodically' — Connecting audio interruption mode
      - `holdAudioInterruptionPeriod` integer — Connecting audio interruption message period in seconds
      - `holdTimeExpirationAction` 'TransferToExtension' | 'UnconditionalForwarding' | 'Voicemail' — Specifies the type of action to be taken after the hold time (waiting for an available call queue member) expires. If 'TransferToExtension' option is selected, the extension specified in `transfer` field is used. The default value is `Voicemail`
      - `agentTimeout` integer — Maximum time in seconds to wait for a call queue member before trying the next member
      - `wrapUpTime` integer — Minimum post-call wrap up time in seconds before agent status is automatically set; the value range is from 0 to 300 sec.
      - `holdTime` integer — Maximum hold time in seconds to wait for an available call queue member
      - `maxCallers` integer — Maximum count of callers on hold; the limitation is 25 callers
      - `maxCallersAction` 'Voicemail' | 'Announcement' | 'TransferToExtension' | 'UnconditionalForwarding' — Specifies the type of action to be taken if count of callers on hold exceeds the supported maximum
      - `unconditionalForwarding` UnconditionalForwardingInfo[]
        - `phoneNumber` string — 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` 'HoldTimeExpiration' | 'MaxCallers' | 'NoAnswer' — Event that initiates forwarding to the specified phone number
    - `transfer` TransferredExtensionInfo
      - `extension` TransferredExtension — Transfer extension settings, set/returned if `callHandlingAction` is specified as `TransferToExtension`
        - `id` string — Internal identifier of an extension
        - `uri` string — Canonical URI of an extension resource
    - `voicemail` VoicemailInfo — Specifies whether to take a voicemail and who should do it
      - `enabled` boolean — If `true` then voicemails are allowed to be received
      - `recipient` RecipientInfo — Recipient data
        - `uri` string, uri — Link to a voicemail recipient extension resource
        - `id` string — Internal identifier of a voicemail recipient
    - `greetings` GreetingInfo[] — Greetings applied for an answering rule; only predefined greetings can be applied, see Dictionary Greeting List
      - `type` 'Introductory' | 'Announcement' | 'AutomaticRecording' | 'BlockedCallersAll' | 'BlockedCallersSpecific' | 'BlockedNoCallerId' | 'BlockedPayPhones' | 'ConnectingMessage' | 'ConnectingAudio' | 'StartRecording' | 'StopRecording' | 'Voicemail' | 'Unavailable' | 'InterruptPrompt' | 'HoldMusic' | 'Company' — Type of greeting, specifying the case when the greeting is played.
      - `preset` PresetInfo
        - `uri` string, uri — Link to a greeting resource
        - `id` string — Internal identifier of a greeting
        - `name` string — Name of a greeting
      - `custom` CustomGreetingInfoRequest
        - `id` string — Internal identifier of a custom user greeting
    - `screening` 'Off' | 'NoCallerId' | 'UnknownCallerId' | 'Always' — 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'
    - `sharedLines` SharedLinesInfo — SharedLines call handling action settings
      - `timeout` integer — Number of seconds to wait before forwarding unanswered calls. The value range is 10 - 80
    - `missedCall` MissedCallInfo — Specifies behavior for the missed call scenario. Returned only if `enabled` parameter of a voicemail is set to 'false'
      - `actionType` 'PlayGreetingAndDisconnect' | 'ConnectToExtension' | 'ConnectToExternalNumber' — 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
      - `extension` MissedCallExtensionInfo — Specifies an extension (a calling group) which should be used for the missed call transfer. Returned only if the `actionType` is set to 'ConnectToExtension'
        - `id` string — Internal identifier of an extension which should be used for the missed call transfer
        - `externalNumber` MissedCallExtensionInfoExternalNumber — Specifies an external PSTN number which should be used for the missed call transfer. Returned only if the actionType is set to `ConnectToExternalNumber`
          - `phoneNumber` string — Phone number to which the call is forwarded. In addition to common [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) 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. Maximum number of digits is 15
  - `paging` EnumeratedPagingModel
    - `perPage` integer, required — Current page size, describes how many items are in each page. Matches "perPage" parameter from the request.
    - `page` integer — 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)
    - `pageStart` integer — The zero-based number of the first element on the current page. Omitted if the page is omitted or result is empty
    - `pageEnd` integer — The zero-based index of the last element on the current page. Omitted if the page is omitted or result is empty
    - `totalPages` integer — The total number of pages in a dataset. May be omitted for some resources due to performance reasons
    - `totalElements` integer — The total number of elements in a dataset. May be omitted for some resource due to performance reasons
  - `navigation` PageNavigationModel — Links to other pages of the current result set
    - `firstPage` PageNavigationUri
      - `uri` string, uri — Canonical URI to retrieve the particular page of the result set
    - `nextPage` PageNavigationUri
      - `uri` string, uri — Canonical URI to retrieve the particular page of the result set
    - `previousPage` PageNavigationUri
      - `uri` string, uri — Canonical URI to retrieve the particular page of the result set
    - `lastPage` PageNavigationUri
      - `uri` string, uri — Canonical URI to retrieve the particular page of the result set

## Other responses

- `400` — General response with **HTTP 400 "Bad request"** status.<br> Reasons: unparsable request, path, query or body parameters are invalid. The error description may contain reference to particular parameter(s) which haven't passed the validation.
- `404` — General response with **HTTP 404 "Not found"** status.<br> Reasons: the entity with given ID (typically specified in a path parameter), is not found or inaccessible
- `500` — General response with **HTTP 500 "Internal Server Error"** status.<br> Reasons: general server-side error.
- `503` — General response with **HTTP 503 "Service not available"** status.<br> Reasons: server cannot process the request because of being overloaded, misconfiguration or other issues.

---

[API](https://skmtc.net/ringcentral/apis/ringcentral-api.md) · [All operations](https://skmtc.net/ringcentral/apis/ringcentral-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ringcentral/ringcentral-api/revisions/8d602198ec97/schema)