Documentation

LogIn

This API is used to order a new Phone number under the account.
Method: Get/Post

Base URL : https://hubbucs.com/site/api/order_phone_number
Mandatory Parameters Sample Description
key 374593457034859 The company account API key, you can get from company settings > API settings
phone_number 9651112222 One of the available phone numbers got from the search phone numbers API


Optional Parameters Sample Description
add_extension_check 1 OR 2 if 1: Will add new extension and link it to this phone number, default value : 2 (Don't Add)
add_extension_number any 2-15 digits number if not sent and add_extension_check=1, an automatic extension number will be created (will check the highest number of extensions on account and choose the next one)
sub_account_id ID of the sub account if this and sub_account_name both not sent, the phone number will be registered under the main account

if it is sent and the id doesn't match an existing sub account (it will return an error)
sub_account_name string if this and sub_account_name both not sent, the phone number will be registered under the main account

if it is sent and the name doesn't match an existing sub account (it will return an error)

Example:


				

Example :

https://hubbucs.com/site/api/order_phone_number?key=12134651Gsuid7349[¶meter=parameter¶meter=parameter]

Response :

  1. {
  2. "message":"success",
  3. "linked_extension":"2545",
  4. "linked_extension_token":"success",
  5. }
  6. ------OR------
  7. {
  8. "error_message":"error message"
  9. }