outboundConfigs

sip.outboundConfigs

Table of contents

Interfaces

Functions

createConfig

createConfig(name: string, config: OutboundConfig & { password?: string }, options?: { account?: Account }): Promise<OutboundConfig>

Create a new outbound SIP config.

Parameters:

NameTypeDescription
namestring-
configOutboundConfig & { password?: string }see OutboundConfig
options?object-
options.account?Accountan account to use; if not set, defaults to the current account

Returns: Promise<OutboundConfig>

a newly created config


deleteConfig

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

Delete an outbound 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 complain if the config does not exist

Returns: Promise<void>


listConfigs

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

List all outbound 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]: OutboundConfig; }>

a dictionary of OutboundConfig objects by their name


updateConfig

updateConfig(name: string, patch: { account?: string | null ; domain?: string | null ; password?: string | null ; server?: string | null ; transport?: "tcp" | "udp" | null }, options?: { account?: Account }): Promise<OutboundConfig>

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

Parameters:

NameTypeDescription
namestring-
patchobjectsee OutboundConfig
patch.account?string | null-
patch.domain?string | null-
patch.password?string | nullauthorization password, if one is needed
patch.server?string | null-
patch.transport?"tcp" | "udp" | null-
options?object-
options.account?Accountan account to use; if not set, defaults to the current account

Returns: Promise<OutboundConfig>

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.