Class SipTrunksApi

Index

Methods

addAccessControlList addCredentialLists create delete deleteAccessControlList deleteCredentialList get list listAccessControlLists listCredentialLists update updateCredentialLists

Methods

addAccessControlList

addAccessControlList(
data: AddAccessControlListToTrunkRequestData,
): Promise<AddAccessControlListToTrunk>
Add ACL to a trunk Add an access control list entry to a trunk.
Parameters
- data: AddAccessControlListToTrunkRequestData
  The data to provide to the API call.
Returns Promise<AddAccessControlListToTrunk>

addCredentialLists

addCredentialLists(
data: AddCredentialListIdsToTrunkRequestData,
): Promise<CredentialListIds>
Add credential lists to SIP trunk Add credential lists to a specified SIP trunk.
Parameters
- data: AddCredentialListIdsToTrunkRequestData
  The data to provide to the API call.
Returns Promise<CredentialListIds>

create

create(data: CreateSipTrunkRequestData): Promise<SipTrunk>
Create SIP trunk Creates a new SIP trunk.
Parameters
- data: CreateSipTrunkRequestData
  The data to provide to the API call.
Returns Promise<SipTrunk>

delete

delete(data: DeleteSipTrunkRequestData): Promise<void>
Delete SIP trunk Delete a SIP trunk by its ID.
Parameters
- data: DeleteSipTrunkRequestData
  The data to provide to the API call.
Returns Promise<void>

deleteAccessControlList

deleteAccessControlList(
data: DeleteAccessControlListFromTrunkRequestData,
): Promise<void>
Delete ACL from trunk Remove an access control list entry from a trunk.
Parameters
- data: DeleteAccessControlListFromTrunkRequestData
  The data to provide to the API call.
Returns Promise<void>

deleteCredentialList

deleteCredentialList(
data: DeleteCredentialListFromTrunkRequestData,
): Promise<void>
Remove credential list from sip trunk
Parameters
- data: DeleteCredentialListFromTrunkRequestData
  The data to provide to the API call.
Returns Promise<void>

get

get(data: GetSipTrunkRequestData): Promise<SipTrunk>
Get SIP Trunk Search for a SIP trunk by ID.
Parameters
- data: GetSipTrunkRequestData
  The data to provide to the API call.
Returns Promise<SipTrunk>

list

list(data?: ListSipTrunksRequestData): ApiListPromise<SipTrunk>
List SIP trunks Returns a list of all SIP trunks. If you specify pagination settings, the list of SIP trunks can be returned separated and sorted into pages.
Parameters
- Optionaldata: ListSipTrunksRequestData
  The data to provide to the API call.
Returns ApiListPromise<SipTrunk>

listAccessControlLists

listAccessControlLists(
data: ListAccessControlListsForTrunkRequestData,
): ApiListPromise<string>
List all ACLs for a trunk Get all access control list entries for a trunk.
Parameters
- data: ListAccessControlListsForTrunkRequestData
  The data to provide to the API call.
Returns ApiListPromise<string>

listCredentialLists

listCredentialLists(
data: ListCredentialListsForTrunkRequestData,
): ApiListPromise<CredentialList>
Get credential lists for SIP trunk Return all the credential lists for a specified SIP trunk.
Parameters
- data: ListCredentialListsForTrunkRequestData
  The data to provide to the API call.
Returns ApiListPromise<CredentialList>

update

update(data: UpdateSipTrunkRequestData): Promise<SipTrunk>
Update SIP trunk Update an existing SIP Trunk by ID. The whole object must be sent. Any missing fields will be set to null.
Parameters
- data: UpdateSipTrunkRequestData
  The data to provide to the API call.
Returns Promise<SipTrunk>

updateCredentialLists

updateCredentialLists(
data: UpdateCredentialListIdsForTrunkRequestData,
): Promise<CredentialListIds>
Bulk update credential lists for a trunk Update the list of credential list entries for a trunk.
Parameters
- data: UpdateCredentialListIdsForTrunkRequestData
  The data to provide to the API call.
Returns Promise<CredentialListIds>