Methods

Objects

voip/sip/subscriber

Manage SIP Subscribers.

Method Description
voip/sip/subscriber.assign_dids Assign multiple DIDs to a SIP Subscriber.
voip/sip/subscriber.create Create a SIP Subscriber. The password is auto generated.
voip/sip/subscriber.delete Delete a SIP Subscriber.
voip/sip/subscriber.edit Edit a SIP Subscriber.
voip/sip/subscriber.get Get informations on a SIP Subscriber.
voip/sip/subscriber.remove_dids Remove multiple DIDs from a SIP Subscriber.
voip/sip/subscriber.search Search through SIP Subscribers.
voip/sip/subscriber.search_dids Search through DIDs assigned to a SIP Subscriber.

Methods

voip/sip/subscriber.assign_dids

Description

Assign multiple DIDs to a SIP Subscriber.

Signature

method: voip/sip/subscriber.assign_dids

params: [int id, array dids]

Parameters

Parameter Type Description NULL
id int SIP.Subscriber 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/subscriber.create

Description

Create a SIP Subscriber. The password is auto generated.

Signature

method: voip/sip/subscriber.create

params: [object properties, object options]

Parameters

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

Result

Type Description Format/Object
object The created SIP Subscriber. Object: SIP.Subscriber

voip/sip/subscriber.delete

Description

Delete a SIP Subscriber.

Signature

method: voip/sip/subscriber.delete

params: [int id]

Parameters

Parameter Type Description NULL
id int SIP.Subscriber ID NO

Result

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

voip/sip/subscriber.edit

Description

Edit a SIP Subscriber.

Signature

method: voip/sip/subscriber.edit

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

Parameters

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

Result

Type Description Format/Object
object The edited SIP Subscriber. Object: SIP.Subscriber

voip/sip/subscriber.get

Description

Get informations on a SIP Subscriber.

Signature

method: voip/sip/subscriber.get

params: [int id]

Parameters

Parameter Type Description NULL
id int SIP.Subscriber ID NO

Result

Type Description Format/Object
object The requested SIP Subscriber. Object: SIP.Subscriber

voip/sip/subscriber.remove_dids

Description

Remove multiple DIDs from a SIP Subscriber.

Signature

method: voip/sip/subscriber.remove_dids

params: [int id, array dids]

Parameters

Parameter Type Description NULL
id int SIP.Subscriber 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/subscriber.search

Description

Search through SIP Subscribers.

Signature

method: voip/sip/subscriber.search

params: [object filters, object options]

Parameters

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

Result

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

voip/sip/subscriber.search_dids

Description

Search through DIDs assigned to a SIP Subscriber.

Signature

method: voip/sip/subscriber.search_dids

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

Parameters

Parameter Type Description NULL
id int SIP.Subscriber ID NO
filters object Search filters
Object: DID.SearchFilters 		NO
options object Search options
Object: Search.Options 		NO

Result

Type Description Format/Object
object The found DIDs. Object: Search.Results

See Also

  • Object: DID