VoIP Subscription Bundle

A VoIP Bundle is a collection of SIP Users and Phone numbers that represent the customers monthly subscription. A VoIP Bundle must be created before any SIP users or numbers can be created

Become a Reseller

Filter:

All
GET
POST
PUT
DELETE
Chargeable *

* You will be charged every time this command is run.

GET/voip/bundle

Gets all bundles for the account, this will include any previously expired ones as well as any active subscription
Back to top

Request Details

Response Details

Request Details

This command has no URL/Query String parameters
Response Details

200 Response
```
{
    "result" : [
        {
            "created_on" : "2021-06-19",
            "updated_on" : "2021-06-19",
            "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6"
        }
    ],
    "status_code" : 200,
    "status_message" : "OK"
}
```

GET/voip/bundle/{uuid}

Get the specified VoIP Bundle

Request Details

Response Details

Request Details

URL and Query String Parameters

Name
Type
Required

- uuid
- String
- True
The UUID of the bundle to query

Response Details

200 Response

{
    "result" : {
        "created_on" : "2021-06-19",
        "updated_on" : "2021-06-19",
        "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6"
    },
    "status_code" : 200,
    "status_message" : "OK"
}

404 Response

{
    "result" : {},
    "status_code" : 404,
    "status_message" : "Not Found"
}

Chargeable *

POST/voip/bundle

Create a new VoIP Bundle (subscription) for the target customer, the bundle type will change the features available for the customer
Back to top

Request Details

Response Details
Request Details

This command has no URL/Query String parameters

POST body
- Name
- Type
- Required
- auto_renew
  
  Boolean
  
  False
  
  Should this bundle be auto-renewed, will default to false if omitted
- bundle_type
  
  Integer
  
  True
  
  The type of bundle to create, valid values are 1 - Business, 2 - Residential, 3 - Fax Only, 4 - Trunk Only, 5 - Forward Only
JSON all-fields example:
{ "auto_renew" : true, "bundle_type" : 1 }
Response Details

201 Response
```
{
    "result" : {
        "created_on" : "2021-06-19",
        "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6"
    },
    "status_code" : 201,
    "status_message" : "Created"
}
```
400 Response
```
{
    "result" : {},
    "status_code" : 400,
    "status_message" : "Bad Request"
}
```
402 Response
```
{
    "result" : {},
    "status_code" : 402,
    "status_message" : "Payment Required"
}
```
Chargeable *

PUT/voip/bundle/{uuid}

Updates an existing VoIP Bundle
Back to top

Request Details

Response Details
Request Details

URL and Query String Parameters
- Name
- Type
- Required
- uuid
  
  String
  
  True
  
  The UUID of the bundle to update
PUT body
- Name
- Type
- Required
- auto_renew
  
  Boolean
  
  False
  
  Should this bundle be auto-renewed, will default to false if omitted
- bundle_type
  
  Integer
  
  True
  
  The type of bundle to create, valid values are 1 - Business, 2 - Residential, 3 - Fax Only, 4 - Trunk Only, 5 - Forward Only
JSON all-fields example:
{ "auto_renew" : true, "bundle_type" : 1 }
Response Details

200 Response
```
{
    "result" : {
        "created_on" : "2021-06-19",
        "updated_on" : "2021-06-19",
        "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6"
    },
    "status_code" : 200,
    "status_message" : "OK"
}
```
400 Response
```
{
    "result" : {},
    "status_code" : 400,
    "status_message" : "Bad Request"
}
```
402 Response
```
{
    "result" : {},
    "status_code" : 402,
    "status_message" : "Payment Required"
}
```
404 Response
```
{
    "result" : {},
    "status_code" : 404,
    "status_message" : "Not Found"
}
```

Chargeable *

PUT/voip/bundle/{uuid}/renew

Renews an existing VoIP Bundle, this can be done up to 3 days before the expiry date, and up to 5 days following

Request Details

Response Details

Request Details

URL and Query String Parameters

Name
Type
Required

- uuid
- String
- True
The UUID of the bundle to renew

Response Details

200 Response

{
    "result" : {
        "created_on" : "2021-06-19",
        "updated_on" : "2021-06-19",
        "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6"
    },
    "status_code" : 200,
    "status_message" : "OK"
}

400 Response

{
    "result" : {},
    "status_code" : 400,
    "status_message" : "Bad Request"
}

402 Response

{
    "result" : {},
    "status_code" : 402,
    "status_message" : "Payment Required"
}

404 Response

{
    "result" : {},
    "status_code" : 404,
    "status_message" : "Not Found"
}

DELETE/voip/bundle/{uuid}

Suspends the specified VoIP Bundle, this will prevent all outbound and inbound calling.
Back to top

Request Details

Response Details
Request Details

URL and Query String Parameters
- Name
- Type
- Required
- uuid
  
  String
  
  True
  
  The UUID of the bundle to suspend
Response Details

204 Response
```
{
    "result" : {},
    "status_code" : 204,
    "status_message" : "No Content"
}
```
404 Response
```
{
    "result" : {},
    "status_code" : 404,
    "status_message" : "Not Found"
}
```
GET/voip/bundle/{uuid}/details

Get the complete detail for a VoIP bundle, include numbers, users and call packs.
Back to top

Request Details

Response Details
Request Details

URL and Query String Parameters
- Name
- Type
- Required
- uuid
  
  String
  
  True
  
  The UUID of the bundle to get complete details for
Response Details

200 Response
```
{
    "result" : {
        "created_on" : "2021-06-19",
        "updated_on" : "2021-06-19",
        "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6"
    },
    "status_code" : 200,
    "status_message" : "OK"
}
```
404 Response
```
{
    "result" : {},
    "status_code" : 404,
    "status_message" : "Not Found"
}
```