Loading
Cart Total
$0.00
-
Your shopping cart is empty
Loading
Hello! Log in Your Account
New customer? Start here
VoIP Bundle (Subscriptions)
Storefronts
Customer Management
VoIP Bundle (Subscriptions)
SIP Account Management
Audio Management
Phone Numbers & Call Routing
Phone Calls & CDR Data
VoIP Phone Short Code
eFax Management
Voicemails & Mailboxes
Caller ID
SIP Trunks
Wallboard Statistics
VoIP Phone Provisioning
Call Queueing
Phone Books
VoIP Phone Speed Dial
Text (SMS) Messaging
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 ResellerFilter:
* You will be charged every time this command is run.
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
This command has no URL/Query String parameters
200 Response
{
"result" : [
{
"created_on" : "2023-05-30",
"updated_on" : "2023-05-30",
"uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6"
}
],
"status_code" : 200,
"status_message" : "OK"
}
Gets the specified VoIP Bundle
Back to top
Request Details
Response Details
URL and Query String Parameters
Name
Type
Required
uuid
String
True
The UUID of the bundle to query
200 Response
{
"result" : {
"created_on" : "2023-05-30",
"updated_on" : "2023-05-30",
"uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6"
},
"status_code" : 200,
"status_message" : "OK"
}
404 Response
{
"result" : {},
"status_code" : 404,
"status_message" : "Not Found"
}
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
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 9 - Starting Out, 10 - Flying High, 11 - Enterprise
JSON all-fields example:
{
"auto_renew" : true,
"bundle_type" : 9
}
201 Response
{
"result" : {
"created_on" : "2023-05-30",
"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"
}
Updates an existing VoIP Bundle
Back to top
Request Details
Response 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 9 - Starting Out, 10 - Flying High, 11 - Enterprise
JSON all-fields example:
{
"auto_renew" : true,
"bundle_type" : 9
}
200 Response
{
"result" : {
"created_on" : "2023-05-30",
"updated_on" : "2023-05-30",
"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"
}
Renews an existing VoIP Bundle, this can be done up to 3 days before the expiry date, and up to 5 days following
Back to top
Request Details
Response Details
URL and Query String Parameters
Name
Type
Required
uuid
String
True
The UUID of the bundle to renew
200 Response
{
"result" : {
"created_on" : "2023-05-30",
"updated_on" : "2023-05-30",
"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"
}
Suspends the specified VoIP Bundle, this will prevent all outbound and inbound calling.
Back to top
Request Details
Response Details
URL and Query String Parameters
Name
Type
Required
uuid
String
True
The UUID of the bundle to suspend
204 Response
{
"result" : {},
"status_code" : 204,
"status_message" : "No Content"
}
404 Response
{
"result" : {},
"status_code" : 404,
"status_message" : "Not Found"
}
Gets the complete detail for a VoIP bundle, include numbers, users and call packs.
Back to top
Request Details
Response Details
URL and Query String Parameters
Name
Type
Required
uuid
String
True
The UUID of the bundle to get complete details for
200 Response
{
"result" : {
"created_on" : "2023-05-30",
"updated_on" : "2023-05-30",
"uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6"
},
"status_code" : 200,
"status_message" : "OK"
}
404 Response
{
"result" : {},
"status_code" : 404,
"status_message" : "Not Found"
}