Class SipRoutingRulesResource

SIP routing rules. A rule binds provisioned phone numbers (see PhoneNumbersResource) to a dispatch target (a room or agent).

Index

Constructors

Methods

create delete get list update

Constructors

constructor

new SipRoutingRulesResource(http: HttpClient): SipRoutingRulesResource
Parameters
- http: HttpClient
Returns SipRoutingRulesResource

Methods

create

create(options: CreateRoutingRuleOptions): Promise<SipRoutingRule>
Parameters
- options: CreateRoutingRuleOptions
Returns Promise<SipRoutingRule>

delete

delete(ruleId: string): Promise<MessageResponse>
Parameters
- ruleId: string
Returns Promise<MessageResponse>

get

get(ruleId: string): Promise<SipRoutingRule>
Parameters
- ruleId: string
Returns Promise<SipRoutingRule>

list

list(params?: ListRoutingRulesParams): Promise<Page<SipRoutingRule>>
Parameters
- params: ListRoutingRulesParams = {}
Returns Promise<Page<SipRoutingRule>>

update

update(
ruleId: string,
options: UpdateRoutingRuleOptions,
): Promise<SipRoutingRule>
Parameters
- ruleId: string
- options: UpdateRoutingRuleOptions
Returns Promise<SipRoutingRule>