outboundConfigs

sip.outboundConfigs

• OutboundConfig

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

Create a new outbound SIP config.

Returns: Promise<OutboundConfig>

a newly created config

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

Delete an outbound SIP config from the Dasha platform.

Returns: Promise<void>

▸ getConfigByName(name: string, options?: { account?: Account }): Promise<OutboundConfig>

Get outbound SIP config by name

Returns: Promise<OutboundConfig>

OutboundConfig object

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

List all outbound SIP configs available to an account.

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

a dictionary of OutboundConfig objects by their name

▸ updateConfig(name: string, patch: { account?: string | null ; cps?: number | null ; domain?: string | null ; fromUser?: 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.

Returns: Promise<OutboundConfig>

an updated config