Methods

Objects

voip/sip/trunk

Manage SIP Trunks.

Method Description
voip/sip/trunk.origination_assign_dids Assign multiple DIDs to a SIP Origination.
voip/sip/trunk.origination_remove_dids Remove multiple DIDs from a SIP Origination.
voip/sip/trunk.originationCreate Create a SIP Trunk Origination.
voip/sip/trunk.originationDelete Delete a SIP Trunk Origination.
voip/sip/trunk.originationEdit Edit a SIP Trunk Origination.
voip/sip/trunk.originationGet Get informations on a SIP Trunk Origination.
voip/sip/trunk.originationSearch Search through SIP Trunk Originations.
voip/sip/trunk.terminationCreate Create a SIP Trunk Termination.
voip/sip/trunk.terminationDelete Delete a SIP Trunk Termination.
voip/sip/trunk.terminationEdit Edit a SIP Trunk Termination.
voip/sip/trunk.terminationGet Get informations on a SIP Trunk Termination.
voip/sip/trunk.terminationSearch Search through SIP Trunk Terminations.

Methods

voip/sip/trunk.origination_assign_dids

Description

Assign multiple DIDs to a SIP Origination.

Signature

method: voip/sip/trunk.origination_assign_dids

params: [int id, array dids]

Parameters

Parameter Type Description NULL
id int SIP Origination ID NO
dids array Multiple DIDs to assign
Format: hash (Unique object identifier)
NO

Result

Type Description Format/Object
bool Always TRUE (throws an Exception otherwise).

See Also

  • Object: DID

voip/sip/trunk.origination_remove_dids

Description

Remove multiple DIDs from a SIP Origination.

Signature

method: voip/sip/trunk.origination_remove_dids

params: [int id, array dids]

Parameters

Parameter Type Description NULL
id int SIP Origination ID NO
dids array Multiple DIDs to remove
Format: hash (Unique object identifier)
NO

Result

Type Description Format/Object
bool Always TRUE (throws an Exception otherwise).

See Also

  • Object: DID

voip/sip/trunk.originationCreate

Description

Create a SIP Trunk Origination.

Signature

method: voip/sip/trunk.originationCreate

params: [object properties, object options]

Parameters

Parameter Type Description NULL
properties object Object properties
Object: SIP.TrunkOrigination.Properties
NO
options object Object options
Object: SIP.TrunkOrigination.Options
NO

Result

Type Description Format/Object
object The created SIP Trunk Origination. Object: SIP.TrunkOrigination

voip/sip/trunk.originationDelete

Description

Delete a SIP Trunk Origination.

Signature

method: voip/sip/trunk.originationDelete

params: [int id]

Parameters

Parameter Type Description NULL
id int SIP.TrunkOrigination ID NO

Result

Type Description Format/Object
bool Always TRUE (throws an Exception otherwise).

voip/sip/trunk.originationEdit

Description

Edit a SIP Trunk Origination.

Signature

method: voip/sip/trunk.originationEdit

params: [int id, object properties, object options]

Parameters

Parameter Type Description NULL
id int SIP.TrunkOrigination ID NO
properties object Object properties
Object: SIP.TrunkOrigination.Properties
NO
options object Object options
Object: SIP.TrunkOrigination.Options
NO

Result

Type Description Format/Object
object The edited SIP Trunk Origination. Object: SIP.TrunkOrigination

voip/sip/trunk.originationGet

Description

Get informations on a SIP Trunk Origination.

Signature

method: voip/sip/trunk.originationGet

params: [int id]

Parameters

Parameter Type Description NULL
id int SIP.TrunkOrigination ID NO

Result

Type Description Format/Object
object The requested SIP Trunk Origination. Object: SIP.TrunkOrigination

voip/sip/trunk.originationSearch

Description

Search through SIP Trunk Originations.

Signature

method: voip/sip/trunk.originationSearch

params: [object filters, object options]

Parameters

Parameter Type Description NULL
filters object Search filters
Object: SIP.TrunkOrigination.SearchFilters
NO
options object Search options
Object: Search.Options
NO

Result

Type Description Format/Object
object The found SIP Trunk Originations. Object: Search.Results

voip/sip/trunk.terminationCreate

Description

Create a SIP Trunk Termination.

Signature

method: voip/sip/trunk.terminationCreate

params: [object properties, object options]

Parameters

Parameter Type Description NULL
properties object Object properties
Object: SIP.TrunkTermination.Properties
NO
options object Object options
Object: SIP.TrunkTermination.Options
NO

Result

Type Description Format/Object
object The created SIP Trunk Termination. Object: SIP.TrunkTermination

voip/sip/trunk.terminationDelete

Description

Delete a SIP Trunk Termination.

Signature

method: voip/sip/trunk.terminationDelete

params: [int id]

Parameters

Parameter Type Description NULL
id int SIP.TrunkTermination ID NO

Result

Type Description Format/Object
bool Always TRUE (throws an Exception otherwise).

voip/sip/trunk.terminationEdit

Description

Edit a SIP Trunk Termination.

Signature

method: voip/sip/trunk.terminationEdit

params: [int id, object properties, object options]

Parameters

Parameter Type Description NULL
id int SIP.TrunkTermination ID NO
properties object Object properties
Object: SIP.TrunkTermination.Properties
NO
options object Object options
Object: SIP.TrunkTermination.Options
NO

Result

Type Description Format/Object
object The edited SIP Trunk Termination. Object: SIP.TrunkTermination

voip/sip/trunk.terminationGet

Description

Get informations on a SIP Trunk Termination.

Signature

method: voip/sip/trunk.terminationGet

params: [int id]

Parameters

Parameter Type Description NULL
id int SIP.TrunkTermination ID NO

Result

Type Description Format/Object
object The requested SIP Trunk Termination. Object: SIP.TrunkTermination

voip/sip/trunk.terminationSearch

Description

Search through SIP Trunk Terminations.

Signature

method: voip/sip/trunk.terminationSearch

params: [object filters, object options]

Parameters

Parameter Type Description NULL
filters object Search filters
Object: SIP.TrunkTermination.SearchFilters
NO
options object Search options
Object: Search.Options
NO

Result

Type Description Format/Object
object The found SIP Trunk Terminations. Object: Search.Results