Sign in

v1

latestOpenAPI 3.0.3RingCentral API License Agreement2026-08-064871,2921.5 MB
Call Handling Rules

Create Call Handling Rule

Creates a custom call handling rule for a particular caller ID.

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

Path parameters

accountIdstring required

Internal identifier of the RingCentral account (can be set to "~" to indicate that the account associated with current authorization session should be used)

extensionIdstring required

Internal identifier of the RingCentral extension/user (can be set to "~" to indicate that the extension associated with current authorization session should be used)

Request body

enabledboolean

Specifies if the rule is active or inactive. The default value is true

typestring required

Type of an answering rule. The 'Custom' value should be specified

namestring required

Name of an answering rule specified by user

callHandlingAction'ForwardCalls' | 'UnconditionalForwarding' | 'AgentQueue' | 'TransferToExtension' | 'TakeMessagesOnly' | 'PlayAnnouncementOnly' | 'SharedLines'

Specifies how incoming calls are forwarded

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'

Response

OK

uristring uri

Canonical URI to an answering rule resource

idstring

Internal identifier of an answering rule

type'BusinessHours' | 'AfterHours' | 'Custom'

Type of an answering rule

namestring

Name of an answering rule specified by user

enabledboolean

Specifies if an answering rule is active or inactive

callHandlingAction'ForwardCalls' | 'UnconditionalForwarding' | 'AgentQueue' | 'TransferToExtension' | 'TakeMessagesOnly' | 'PlayAnnouncementOnly' | 'SharedLines'

Specifies how incoming calls are forwarded

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'