Cart Total
$0.00
-
Your shopping cart is empty
Loading
Loading
Hello! Log in Your Account
New customer? Start here
Customer Management
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
VoIP Phone Provisioning
Call Queueing
11 July 2019
By Adrian
By Meg
Create and Manage Sub Resellers of your account
Become a ResellerFilter:
* You will be charged every time this command is run.
Gets the details of all active sub resellers on the account
Back to top
Request Details
Response Details
This command has no URL/Query String parameters
200 Response
{
"result" : [
{
"addresses" : [
{
"city" : "Exampleton",
"country_code" : "GB",
"created_on" : "2019-12-13",
"state" : "",
"street_one" : "1 Example Street",
"street_three" : "",
"street_two" : "",
"updated_on" : "2019-12-13",
"uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6",
"zip" : "EX4M PL3"
}
],
"allow_outbound" : true,
"contact_name" : "Pete's Plumbing and Electrical",
"created_on" : "2019-12-13",
"ip_addresses" : [
{
"created_on" : "2019-12-13",
"ip_range" : "255.255.255.255/32"
}
],
"name" : "Example Sub Reseller",
"phone" : "+443301226000",
"store_front" : "31347d42-00bd-44a5-9b5c-20dc4197a2f7",
"updated_on" : "2019-12-13",
"users" : [
{
"contact_first_name" : "Pete",
"contact_last_name" : "Plumber",
"created_on" : "2019-12-13",
"email" : "pete@example.com",
"name" : "pete_the_plumber",
"password" : "password",
"role_id" : 1,
"updated_on" : "2019-12-13",
"uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6"
}
],
"uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6"
}
],
"status_code" : 200,
"status_message" : "OK"
}Gets the details for a specific sub reseller on the account
Back to top
Request Details
Response Details
URL and Query String Parameters
Name
Type
Required
uuid
String
True
The UUID of the Sub Reseller to be queried
200 Response
{
"result" : {
"addresses" : [
{
"city" : "Exampleton",
"country_code" : "GB",
"created_on" : "2019-12-13",
"state" : "",
"street_one" : "1 Example Street",
"street_three" : "",
"street_two" : "",
"updated_on" : "2019-12-13",
"uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6",
"zip" : "EX4M PL3"
}
],
"allow_outbound" : true,
"contact_name" : "Pete's Plumbing and Electrical",
"created_on" : "2019-12-13",
"ip_addresses" : [
{
"created_on" : "2019-12-13",
"ip_range" : "255.255.255.255/32"
}
],
"name" : "Example Sub Reseller",
"phone" : "+443301226000",
"store_front" : "31347d42-00bd-44a5-9b5c-20dc4197a2f7",
"updated_on" : "2019-12-13",
"users" : [
{
"contact_first_name" : "Pete",
"contact_last_name" : "Plumber",
"created_on" : "2019-12-13",
"email" : "pete@example.com",
"name" : "pete_the_plumber",
"password" : "password",
"role_id" : 1,
"updated_on" : "2019-12-13",
"uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6"
}
],
"uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6"
},
"status_code" : 200,
"status_message" : "OK"
}404 Response
{
"result" : {},
"status_code" : 404,
"status_message" : "Not Found"
}Creates a new sub reseller
Back to top
Request Details
Response Details
This command has no URL/Query String parameters
POST body
Name
Type
Required
addresses
Array of Reseller Address
False
A list of this Reseller's Addresses
contact_name
String
True
The contact name for this Reseller
name
String
True
The name of this Reseller
phone
String
False
The phone number for this Reseller
store_front
String
False
The UUID of the Store this Reseller belongs to
users
Array of Reseller User
False
A list of this Reseller's Users.
An Allowed IP Range is a range of IP Addresses in CIDR notation that has been white-listed for access to the API.
ip_range
String
True
The IP Address Range in CIDR notation
A Reseller User provides access credentials to use the API or Web Portal for a specific reseller
contact_first_name
String
False
This Reseller User's first name
contact_last_name
String
False
This Reseller User's last name
String
True
This Reseller User's email address
name
String
True
This Reseller User's username
password
String
True
This Reseller User's password
role_id
int
True
This Reseller User's role id, which determines their level of access.
Valid roles are
A Reseller Address is a geographical address used for billing of a reseller
city
String
True
The town/city of the address
country_code
String
True
The Country ISO Code
state
String
False
The county/state of the street address
street_one
String
True
The first line of the street address
street_three
String
False
The third line of the street address
street_two
String
False
The second line of the street address
zip
String
True
The Zip/Post Code
JSON all-fields example:
{
"addresses" : [
{
"city" : "Exampleton",
"country_code" : "GB",
"state" : "",
"street_one" : "1 Example Street",
"street_three" : "",
"street_two" : "",
"zip" : "EX4M PL3"
}
],
"contact_name" : "Pete's Plumbing and Electrical",
"name" : "Example Sub Reseller",
"phone" : "+443301226000",
"store_front" : "31347d42-00bd-44a5-9b5c-20dc4197a2f7",
"users" : [
{
"contact_first_name" : "Pete",
"contact_last_name" : "Plumber",
"email" : "pete@example.com",
"name" : "pete_the_plumber",
"password" : "password",
"role_id" : 1
}
]
}201 Response
{
"result" : {
"addresses" : [
{
"city" : "Exampleton",
"country_code" : "GB",
"created_on" : "2019-12-13",
"state" : "",
"street_one" : "1 Example Street",
"street_three" : "",
"street_two" : "",
"uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6",
"zip" : "EX4M PL3"
}
],
"allow_outbound" : true,
"contact_name" : "Pete's Plumbing and Electrical",
"created_on" : "2019-12-13",
"ip_addresses" : [
{
"created_on" : "2019-12-13",
"ip_range" : "255.255.255.255/32"
}
],
"name" : "Example Sub Reseller",
"phone" : "+443301226000",
"store_front" : "31347d42-00bd-44a5-9b5c-20dc4197a2f7",
"users" : [
{
"contact_first_name" : "Pete",
"contact_last_name" : "Plumber",
"created_on" : "2019-12-13",
"email" : "pete@example.com",
"name" : "pete_the_plumber",
"password" : "password",
"role_id" : 1,
"uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6"
}
],
"uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6"
},
"status_code" : 201,
"status_message" : "Created"
}400 Response
{
"result" : {},
"status_code" : 400,
"status_message" : "Bad Request"
}404 Response
{
"result" : {},
"status_code" : 404,
"status_message" : "Not Found"
}Updates a sub reseller
Back to top
Request Details
Response Details
URL and Query String Parameters
Name
Type
Required
uuid
String
True
The UUID of the Sub Reseller to be updated
PUT body
Name
Type
Required
addresses
Array of Reseller Address
False
A list of this Reseller's Addresses
contact_name
String
True
The contact name for this Reseller
name
String
True
The name of this Reseller
phone
String
False
The phone number for this Reseller
store_front
String
False
The UUID of the Store this Reseller belongs to
users
Array of Reseller User
False
A list of this Reseller's Users.
An Allowed IP Range is a range of IP Addresses in CIDR notation that has been white-listed for access to the API.
ip_range
String
True
The IP Address Range in CIDR notation
A Reseller User provides access credentials to use the API or Web Portal for a specific reseller
contact_first_name
String
False
This Reseller User's first name
contact_last_name
String
False
This Reseller User's last name
String
True
This Reseller User's email address
name
String
True
This Reseller User's username
password
String
True
This Reseller User's password
role_id
int
True
This Reseller User's role id, which determines their level of access.
Valid roles are
A Reseller Address is a geographical address used for billing of a reseller
city
String
True
The town/city of the address
country_code
String
True
The Country ISO Code
state
String
False
The county/state of the street address
street_one
String
True
The first line of the street address
street_three
String
False
The third line of the street address
street_two
String
False
The second line of the street address
zip
String
True
The Zip/Post Code
JSON all-fields example:
{
"contact_name" : "Pete's Plumbing and Electrical",
"name" : "Example Sub Reseller",
"phone" : "+443301226000",
"store_front" : "31347d42-00bd-44a5-9b5c-20dc4197a2f7"
}200 Response
{
"result" : {
"addresses" : [
{
"city" : "Exampleton",
"country_code" : "GB",
"created_on" : "2019-12-13",
"state" : "",
"street_one" : "1 Example Street",
"street_three" : "",
"street_two" : "",
"updated_on" : "2019-12-13",
"uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6",
"zip" : "EX4M PL3"
}
],
"allow_outbound" : true,
"contact_name" : "Pete's Plumbing and Electrical",
"created_on" : "2019-12-13",
"ip_addresses" : [
{
"created_on" : "2019-12-13",
"ip_range" : "255.255.255.255/32"
}
],
"name" : "Example Sub Reseller",
"phone" : "+443301226000",
"store_front" : "31347d42-00bd-44a5-9b5c-20dc4197a2f7",
"updated_on" : "2019-12-13",
"users" : [
{
"contact_first_name" : "Pete",
"contact_last_name" : "Plumber",
"created_on" : "2019-12-13",
"email" : "pete@example.com",
"name" : "pete_the_plumber",
"password" : "password",
"role_id" : 1,
"updated_on" : "2019-12-13",
"uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6"
}
],
"uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6"
},
"status_code" : 200,
"status_message" : "OK"
}400 Response
{
"result" : {},
"status_code" : 400,
"status_message" : "Bad Request"
}404 Response
{
"result" : {},
"status_code" : 404,
"status_message" : "Not Found"
}409 Response
{
"result" : {},
"status_code" : 409,
"status_message" : "Conflict"
}Updates whether a sub reseller can make international calls
Back to top
Request Details
Response Details
URL and Query String Parameters
Name
Type
Required
uuid
String
True
The UUID of the Sub Reseller to be updated
PUT body
Name
Type
Required
addresses
Array of Reseller Address
False
A list of this Reseller's Addresses
contact_name
String
True
The contact name for this Reseller
name
String
True
The name of this Reseller
phone
String
False
The phone number for this Reseller
store_front
String
False
The UUID of the Store this Reseller belongs to
users
Array of Reseller User
False
A list of this Reseller's Users.
An Allowed IP Range is a range of IP Addresses in CIDR notation that has been white-listed for access to the API.
ip_range
String
True
The IP Address Range in CIDR notation
A Reseller User provides access credentials to use the API or Web Portal for a specific reseller
contact_first_name
String
False
This Reseller User's first name
contact_last_name
String
False
This Reseller User's last name
String
True
This Reseller User's email address
name
String
True
This Reseller User's username
password
String
True
This Reseller User's password
role_id
int
True
This Reseller User's role id, which determines their level of access.
Valid roles are
A Reseller Address is a geographical address used for billing of a reseller
city
String
True
The town/city of the address
country_code
String
True
The Country ISO Code
state
String
False
The county/state of the street address
street_one
String
True
The first line of the street address
street_three
String
False
The third line of the street address
street_two
String
False
The second line of the street address
zip
String
True
The Zip/Post Code
JSON all-fields example:
{
"contact_name" : "Pete's Plumbing and Electrical",
"name" : "Example Sub Reseller",
"phone" : "+443301226000",
"store_front" : "31347d42-00bd-44a5-9b5c-20dc4197a2f7"
}200 Response
{
"result" : {
"addresses" : [
{
"city" : "Exampleton",
"country_code" : "GB",
"created_on" : "2019-12-13",
"state" : "",
"street_one" : "1 Example Street",
"street_three" : "",
"street_two" : "",
"updated_on" : "2019-12-13",
"uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6",
"zip" : "EX4M PL3"
}
],
"allow_outbound" : true,
"contact_name" : "Pete's Plumbing and Electrical",
"created_on" : "2019-12-13",
"ip_addresses" : [
{
"created_on" : "2019-12-13",
"ip_range" : "255.255.255.255/32"
}
],
"name" : "Example Sub Reseller",
"phone" : "+443301226000",
"store_front" : "31347d42-00bd-44a5-9b5c-20dc4197a2f7",
"updated_on" : "2019-12-13",
"users" : [
{
"contact_first_name" : "Pete",
"contact_last_name" : "Plumber",
"created_on" : "2019-12-13",
"email" : "pete@example.com",
"name" : "pete_the_plumber",
"password" : "password",
"role_id" : 1,
"updated_on" : "2019-12-13",
"uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6"
}
],
"uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6"
},
"status_code" : 200,
"status_message" : "OK"
}400 Response
{
"result" : {},
"status_code" : 400,
"status_message" : "Bad Request"
}404 Response
{
"result" : {},
"status_code" : 404,
"status_message" : "Not Found"
}409 Response
{
"result" : {},
"status_code" : 409,
"status_message" : "Conflict"
}Deletes the specified sub reseller
Back to top
Request Details
Response Details
This command has no URL/Query String parameters
204 Response
{
"result" : {},
"status_code" : 204,
"status_message" : "No Content"
}400 Response
{
"result" : {},
"status_code" : 400,
"status_message" : "Bad Request"
}404 Response
{
"result" : {},
"status_code" : 404,
"status_message" : "Not Found"
}
