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:
| Name | Type | Description |
|---|---|---|
name | string | - |
config | object | see InboundConfig |
config.alias? | string | - |
config.applicationName | string | - |
config.groupName? | string | - |
config.ipAcls? | string[] | - |
config.password? | string | SIP authentication password as per https://tools.ietf.org/html/rfc3261#section-22.3 |
config.priority | number | - |
options? | object | - |
options.account? | Account | an 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:
| Name | Type | Description |
|---|---|---|
name | string | - |
options? | object | - |
options.account? | Account | an account to use; if not set, defaults to the current account |
options.quiet? | boolean | if true, does not throw if the config does not exist |
Returns: Promise<void>
getConfigByName
▸ getConfigByName(name: string, options?: { account?: Account }): Promise<InboundConfig>
Get inbound SIP config by name
Parameters:
| Name | Type | Description |
|---|---|---|
name | string | an config name |
options? | object | - |
options.account? | Account | an account to use; if not set, defaults to the current account |
Returns: Promise<InboundConfig>
InboundConfig object
listConfigs
▸ listConfigs(options?: { account?: Account }): Promise<{ [name: string]: InboundConfig; }>
List all the inbound SIP configs available to an account.
Parameters:
| Name | Type | Description |
|---|---|---|
options? | object | - |
options.account? | Account | an 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:
| Name | Type | Description |
|---|---|---|
name | string | - |
changes | object | see InboundConfig |
changes.alias? | string | null | - |
changes.applicationName? | string | - |
changes.groupName? | string | null | - |
changes.ipAcls? | string[] | null | - |
changes.password? | string | null | SIP authentication password as per https://tools.ietf.org/html/rfc3261#section-22.3 |
changes.priority? | number | - |
options? | object | - |
options.account? | Account | an account to use; if not set, defaults to the current account |
Returns: Promise<InboundConfig>
an updated config