inboundConfigs

sip.inboundConfigs

Table of contents

Interfaces

Functions

createConfig

createConfig(name: string, config: { alias?: string ; applicationName: string ; groupName?: string ; ipAcls?: string[] ; password?: string ; priority: number }, options?: { account?: Account }): Promise<InboundConfig>

Create a new inbound SIP config.

Parameters:

NameTypeDescription
namestring-
configobjectsee InboundConfig
config.alias?string-
config.applicationNamestring-
config.groupName?string-
config.ipAcls?string[]-
config.password?stringSIP authentication password as per https://tools.ietf.org/html/rfc3261#section-22.3
config.prioritynumber-
options?object-
options.account?Accountan account to use; if not set, defaults to the current account

Returns: Promise<InboundConfig>

a newly-created config


deleteConfig

deleteConfig(name: string, options?: { account?: Account ; quiet?: boolean }): Promise<void>

Delete an inbound SIP config from the Dasha platform.

Parameters:

NameTypeDescription
namestring-
options?object-
options.account?Accountan account to use; if not set, defaults to the current account
options.quiet?booleanif true, does not throw if the config does not exist

Returns: Promise<void>


listConfigs

listConfigs(options?: { account?: Account }): Promise<{ [name: string]: InboundConfig; }>

List all the inbound SIP configs available to an account.

Parameters:

NameTypeDescription
options?object-
options.account?Accountan account to use; if not set, defaults to the current account

Returns: Promise<{ [name: string]: InboundConfig; }>

a dictionary of InboundConfig objects by their names


updateConfig

updateConfig(name: string, changes: { alias?: string | null ; applicationName?: string ; groupName?: string | null ; ipAcls?: string[] | null ; password?: string | null ; priority?: number }, options?: { account?: Account }): Promise<InboundConfig>

Update an inbound SIP config. Pass null in the optional fields to reset to defaults.

Parameters:

NameTypeDescription
namestring-
changesobjectsee InboundConfig
changes.alias?string | null-
changes.applicationName?string-
changes.groupName?string | null-
changes.ipAcls?string[] | null-
changes.password?string | nullSIP authentication password as per https://tools.ietf.org/html/rfc3261#section-22.3
changes.priority?number-
options?object-
options.account?Accountan account to use; if not set, defaults to the current account

Returns: Promise<InboundConfig>

an updated config

Found a mistake? Email us, and we'll send you a free t-shirt!

Enroll in beta

Request invite to our private Beta program for developers to join the waitlist. No spam, we promise.