Methods

Objects

did/store

DID store: reserve and order DIDs.

Method Description
did/store.buy_order Buy an order (after calling "reserve")
did/store.cancel_order Cancel an order (after calling "reserve")
did/store.cancel_subscription Cancel a DID subscription. The DID will be removed from your account <...
did/store.get_quota_status Get your store quota status
did/store.get_quote Get a quote without reserving DIDs
did/store.reserve Reserve DIDs before ordering. Your booking is held for a maximum of 5 ...
did/store.view_order View your order (after calling "reserve")

Methods

did/store.buy_order

Description

Buy an order (after calling "reserve")

Signature

method: did/store.buy_order

params: [string token]

Parameters

Parameter Type Description NULL
token string Order token NO

Result

Type Description Format/Object
object Buy status Object: DID.Store.BuyStatus

See Also

did/store.cancel_order

Description

Cancel an order (after calling "reserve")

Signature

method: did/store.cancel_order

params: [string token]

Parameters

Parameter Type Description NULL
token string Order token NO

Result

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

See Also

did/store.cancel_subscription

Description

Cancel a DID subscription. The DID will be removed from your account when the subscription expires (date_end_contract in DID object). If date_end_contract is in the past, the DID will be removed immediately.

Signature

method: did/store.cancel_subscription

params: [string hash]

Parameters

Parameter Type Description NULL
hash string DID ID.
Format: hash (Unique object identifier)
NO

Result

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

did/store.get_quota_status

Description

Get your store quota status

Signature

method: did/store.get_quota_status

params: []

Parameters

No parameters.

Result

Type Description Format/Object
object Quota status Object: DID.Store.QuotaStatus

did/store.get_quote

Description

Get a quote without reserving DIDs

Signature

method: did/store.get_quote

params: [int area_code_id, string class, int quantity]

Parameters

Parameter Type Description NULL
area_code_id int Area code ID NO
class string DID class
Values: "CLASSIC", "GOLD"
NO
quantity int Quantity needed NO

Result

Type Description Format/Object
object Quote Object: DID.Store.Quote

See Also

did/store.reserve

Description

Reserve DIDs before ordering. Your booking is held for a maximum of 5 minutes.

Signature

method: did/store.reserve

params: [int area_code_id, string class, int quantity, string mode]

Parameters

Parameter Type Description NULL
area_code_id int Area code ID NO
class string DID class
Values: "CLASSIC", "GOLD"
NO
quantity int Quantity NO
mode string Assignment mode
Values: "RANDOM", "SEQUENTIAL"
NO

Result

Type Description Format/Object
object Reservation status Object: DID.Store.Reservation

See Also

did/store.view_order

Description

View your order (after calling "reserve")

Signature

method: did/store.view_order

params: [string token]

Parameters

Parameter Type Description NULL
token string Order token NO

Result

Type Description Format/Object
object Reservation status Object: DID.Store.Reservation

See Also