iPilot Management API

iPilot Management API (v1.7)

Download OpenAPI specification:Download

Introduction

This API provides the ability to retrieve and manage certain elements within the iPilot system.

OpenAPI Specification

This API is documented in OpenAPI format.

Authentication

iPilot requires two authentication elements:

  • User credentials
  • and an API Key

To request an API Key please email a request for an iPilot API Key to support@nuwave.com

Once you have received your API Key you will then have the ability to authenticate with your iPilot Credentials, and begin accessing the functions described below.

Authorization

This section provides details on authenticating and getting the access token needed for subsequent API calls.

Get authentication token

Securityapi_key
Request
header Parameters
Cookie
string
Request Body schema: application/x-www-form-urlencoded
required

iPilot User credentials

username
string
password
string
instance
string
Responses
200

200 response

400

400 response

401

401 response

404

404 response

post/oauth2/authorize
Request samples 
Response samples 
application/json
{
  • "access_token": "be28f26100853a0b64b7082ae02cc3c6",
  • "expires_at": "1605397396"
}
Accounts
This section provides the ability to manage Accounts in the iPilot system. You can retrieve, create, update and delete accounts through this section. This is where you will be able to manage Vendor, Customer and User account types.


Get current account details
Retrieves the current logged in account details


Securityx-access-token 
Request 
query Parameters
instance
string
 Default:  "nuwave"
this would be your platform identifier, [instance].ipilot.io


 
header Parameters
x-api-key
string
 
Cookie
string
 
Responses 
200
200 response


400
Bad request please check your request and try again


401
Not authorized


403
Forbidden not allowed to get accounts


get/accounts
Request samples 
Response samples 
application/json
{
  • "accountType": "Reseller | Customer | User",
  • "resellerAccount": {
    },
  • "customerAccount": {
    },
  • "userAccount": {
    }
}
Get list of customers under current account login
Retrieves the list of customers based on the current logged in account (Reseller, Admin etc.)


Securityx-access-token 
Request 
query Parameters
instance
string
 Default:  "nuwave"
this would be your platform identifier, [instance].ipilot.io


 
limit
string
 Default:  1
page number to return


 
filter
string
Filter for account results, example
filter=customerAccount.customerId:26 


 
customerLimit
string
 Default:  10
page number to return of customers


 
header Parameters
x-api-key
string
 
Cookie
string
 
Responses 
200
200 response


400
Bad request please check your request and try again


401
Not authorized


403
Forbidden not allowed to get accounts


get/accounts/customers
Request samples 
Response samples 
application/json
[
  • {
    }
]
Get list of resellers under current account login
Retrieves the list of resellers based on the current logged in account (Reseller, Admin etc.)


Securityx-access-token 
Request 
query Parameters
instance
string
 Default:  "nuwave"
this would be your platform identifier, [instance].ipilot.io


 
limit
string
 Default:  1
page number to return


 
header Parameters
x-api-key
string
 
Cookie
string
 
Responses 
200
200 response


400
Bad request please check your request and try again


401
Not authorized


403
Forbidden not allowed to get accounts


get/accounts/resellers
Request samples 
Response samples 
application/json
[
  • {
    }
]
Create a new account
Creates a new account


Securityx-access-token 
Request 
header Parameters
Cookie
string
 
x-api-key
string
 
Request Body schema: application/json
required
 Array 
accountType
required
string
 Enum: "Reseller" "Customer" "User"  
object (ResellerAccountUpdate) 
 
object (CustomerAccountUpdate) 
 
object (UserAccount) 
 
Responses 
200
200 response


400
Bad request please check your request and try again


401
Not authorized


403
Forbidden not allowed to create account


post/accounts/resellers
Request samples 
Response samples 
application/json
{
  • "statusCode": "200",
  • "status": "No error"
}
Delete or deactivate an account
Deletes an iPilot account.  Note that all numbers must already be deprovisioned and deleted before delete will succeed


Securityx-access-token 
Request 
path Parameters
id
required
string
 
header Parameters
x-api-key
string
 
Cookie
string
 
Responses 
200
200 response


400
Bad request please check your request and try again


401
Not authorized


403
Forbidden not allowed to delete account


delete/accounts/{id}
Request samples 
Get Account details
Returns back account details


Securityx-access-token 
Request 
path Parameters
id
required
string
 
header Parameters
x-api-key
string
 
Cookie
string
 
Responses 
200
200 response


400
Bad request please check your request and try again


401
Not authorized


get/accounts/{id}
Request samples 
Response samples 
application/json
{
  • "accountType": "Reseller | Customer | User",
  • "resellerAccount": {
    },
  • "customerAccount": {
    },
  • "userAccount": {
    }
}
Update account details
Update account details


Securityx-access-token 
Request 
path Parameters
id
required
string
 
header Parameters
x-api-key
string
 
Cookie
string
 
Request Body schema: application/json
required
accountType
required
string
 Enum: "Reseller" "Customer" "User"  
object (ResellerAccount) 
 
object (CustomerAccount) 
 
object (UserAccount) 
 
Responses 
200
200 response


400
Bad request please check your request and try again


401
Not authorized


403
Forbidden not allowed to delete account


put/accounts/{id}
Request samples 
Response samples 
application/json
{
  • "statusCode": "200",
  • "status": "No error"
}
Call Forwarding
This section provides the ability to manage call forwarding for your phone numbers.


Add call forwarding for phone number(s)
Add call forwarding for phone number(s)


Securityx-access-token 
Request 
header Parameters
Cookie
string
 
x-api-key
string
 
Request Body schema: application/json
required
telephoneNumbers
Array of arrays
 
callForwardNumber
required
string
 
countryCode
required
string
 
Responses 
200
200 response


400
Bad request please check your request and try again


401
Not authorized


403
Forbidden not allowed to create account


post/callForwarding/{customerId}
Request samples 
Response samples 
application/json
{
  • "statusCode": "200",
  • "status": "No error"
}
Update call forwarding
Update call forwarding


Securityx-access-token 
Request 
path Parameters
id
required
string
 
header Parameters
x-api-key
string
 
Cookie
string
 
Request Body schema: application/json
required
telephoneNumbers
Array of arrays
 
callForwardNumber
required
string
 
countryCode
required
string
 
Responses 
200
200 response


400
Bad request please check your request and try again


401
Not authorized


403
Forbidden not allowed to delete account


put/callForwarding/{customerId}
Request samples 
Response samples 
application/json
{
  • "statusCode": "200",
  • "status": "No error"
}
Retrieve call forwarding details
Retrieve call forwarding details


Securityx-access-token 
Request 
path Parameters
resellerId
required
number
 
customerId
required
number
 
phoneNumber
required
number
 
header Parameters
x-api-key
string
 
Cookie
string
 
Responses 
200
200 response


400
Bad request please check your request and try again


401
Not authorized


403
Forbidden not allowed to get departments


get/callForwarding/{customerId}/{phoneNumber}
Request samples 
Response samples 
application/json
{
  • "telephoneNumbers": [
    ],
  • "callForwardNumber": "E164 format phone number 12223334444",
  • "countryCode": "Two character country code US | CA | MX etc."
}
Remove call forwarding from telephone number
Remove call forwarding from telephone number


Securityx-access-token 
Request 
path Parameters
id
required
string
 
header Parameters
x-api-key
string
 
Cookie
string
 
Responses 
200
200 response


400
Bad request please check your request and try again


401
Not authorized


403
Forbidden not allowed to add emergency addresses to customer


delete/callForwarding/{id}
Request samples 
Response samples 
application/json
{
  • "statusCode": "200",
  • "status": "No error"
}
Calling Party Number
This section provides the ability to manage calling party number (CPN) for your phone numbers.


Add calling party number for phone number(s)
Add calling party number for phone number(s)


Securityx-access-token 
Request 
header Parameters
Cookie
string
 
x-api-key
string
 
Request Body schema: application/json
required
telephoneNumbers
Array of arrays
 
cpnNumber
required
string
 
countryCode
required
string
 
Responses 
200
200 response


400
Bad request please check your request and try again


401
Not authorized


403
Forbidden not allowed to create account


post/callingPartyNumber/{customerId}
Request samples 
Response samples 
application/json
{
  • "statusCode": "200",
  • "status": "No error"
}
Retrieve calling party number details
Retrieve calling party number details


Securityx-access-token 
Request 
path Parameters
phoneNumber
required
number
 
header Parameters
x-api-key
string
 
Cookie
string
 
Responses 
200
200 response


400
Bad request please check your request and try again


401
Not authorized


403
Forbidden not allowed to get departments


get/callingPartyNumber/{phoneNumber}
Request samples 
Response samples 
application/json
{
  • "telephoneNumbers": [
    ],
  • "cpnNumber": "E164 format phone number 12223334444",
  • "countryCode": "Two character country code US | CA | MX etc."
}
Remove calling party number from telephone number
Remove calling party number from telephone number


Securityx-access-token 
Request 
path Parameters
phoneNumber
required
string
 
header Parameters
x-api-key
string
 
Cookie
string
 
Responses 
200
200 response


400
Bad request please check your request and try again


401
Not authorized


403
Forbidden not allowed to add emergency addresses to customer


delete/callingPartyNumber/{phoneNumber}
Request samples 
Response samples 
application/json
{
  • "statusCode": "200",
  • "status": "No error"
}
Carrier Management
This section provides the ability to access Carrier Management funcionality, getting carriers available, uploading numbers to a carrier, removing numbers.


Retrieve list of carriers
Retrieve list of Carriers


Securityx-access-token 
Request 
path Parameters
subomain
required
string
 
query Parameters
instance
string
 Default:  "nuwave"
this would be your platform identifier, [instance].ipilot.io


 
customerId
required
number
 Default:  1
this would be the customer id field


 
header Parameters
x-api-key
string
 
Responses 
200
200 response


400
Bad request please check your request and try again


401
Not authorized


403
Forbidden not allowed to get carriers


get/msteams/{subdomain}/carriers
Request samples 
Response samples 
application/json
[
  • {
    }
]
Get Carrier Numbers
Returns back carrier numbers


Securityx-access-token 
Request 
path Parameters
id
required
string
 
subomain
required
string
 
query Parameters
instance
string
 Default:  "nuwave"
this would be your platform identifier, [instance].ipilot.io


 
customerId
required
number
 Default:  1
this would be the customer id field


 
header Parameters
x-api-key
string
 
Cookie
string
 
Responses 
200
200 response


400
Bad request please check your request and try again


401
Not authorized


get/msteams/{subdomain}/carriers/{id}/numbers
Request samples 
Response samples 
application/json
{
  • "accountType": "Reseller | Customer | User",
  • "resellerAccount": {
    },
  • "customerAccount": {
    },
  • "userAccount": {
    }
}
Upload phone numbers to carrier
Upload phone numbers to carrier


Securityx-access-token 
Request 
path Parameters
id
required
string
 
subdomain
required
string
 
header Parameters
x-api-key
string
 
Cookie
string
 
Request Body schema: application/json
required
 Array 
number
string
 
countryCode
string
 
Responses 
200
200 response


400
Bad request please check your request and try again


401
Not authorized


403
Forbidden not allowed to upload numbers to carrier management


post/msteams/{subdomain}/carriers/{id}/numbers
Request samples 
Response samples 
application/json
{
  • "statusCode": "200",
  • "status": "No error"
}
CNAM
This section provides the ability to manage outbound CNAM for your phone numbers.


Add outbound CNAM for phone number(s)
Add outbound CNAM for phone number(s)


Securityx-access-token 
Request 
header Parameters
Cookie
string
 
x-api-key
string
 
Request Body schema: application/json
required
telephoneNumbers
Array of arrays
 
callingName
required
string
 
firstName
required
string
 
lastName
required
string
 
businessName
string
 
Responses 
200
200 response


400
Bad request please check your request and try again


401
Not authorized


403
Forbidden not allowed to create account


post/cnam/{customerId}
Request samples 
Response samples 
application/json
{
  • "statusCode": "200",
  • "status": "No error"
}
Retrieve CNAM details
Retrieve CNAM details


Securityx-access-token 
Request 
path Parameters
phoneNumber
required
number
 
header Parameters
x-api-key
string
 
Cookie
string
 
Responses 
200
200 response


400
Bad request please check your request and try again


401
Not authorized


403
Forbidden not allowed to get departments


get/cnam/{phoneNumber}
Request samples 
Response samples 
application/json
{
  • "telephoneNumbers": [
    ],
  • "callingName": "John Doe",
  • "firstName": "John",
  • "lastName": "Doe",
  • "businessName": "John Doe Inc."
}
Remove CNAM from telephone number
Remove CNAM from telephone number


Securityx-access-token 
Request 
path Parameters
phoneNumber
required
string
 
header Parameters
x-api-key
string
 
Cookie
string
 
Responses 
200
200 response


400
Bad request please check your request and try again


401
Not authorized


403
Forbidden not allowed to add emergency addresses to customer


delete/cnam/{phoneNumber}
Request samples 
Response samples 
application/json
{
  • "statusCode": "200",
  • "status": "No error"
}
Disaster Plans
This section provides the ability to manage your disaster plans for your phone numbers.


Add disaster plan for phone number(s)
Add disaster plan for phone number(s)


Securityx-access-token 
Request 
path Parameters
customerId
required
number
 
header Parameters
Cookie
string
 
x-api-key
string
 
Request Body schema: application/json
required
telephoneNumbers
Array of arrays
 
callForwardNumber
required
string
 
disasterPlanID
required
string
 
countryCode
required
string
 
Responses 
200
200 response


400
Bad request please check your request and try again


401
Not authorized


403
Forbidden not allowed to create account


post/disasterPlan/{customerId}
Request samples 
Response samples 
application/json
{
  • "statusCode": "200",
  • "status": "No error"
}
Retrieve Disaster Plan details
Retrieve Disaster Plan details


Securityx-access-token 
Request 
path Parameters
customerId
required
number
 
header Parameters
x-api-key
string
 
Cookie
string
 
Responses 
200
200 response


400
Bad request please check your request and try again


401
Not authorized


403
Forbidden not allowed to get departments


get/disasterPlan/{customerId}
Request samples 
Response samples 
application/json
{
  • "telephoneNumbers": [
    ],
  • "callForwardNumber": "E164 format phone number 12223334444",
  • "disasterPlanID": "DAS-123456",
  • "countryCode": "Two character country code US | CA | MX etc."
}
Update disaster plan
Update disaster plan


Securityx-access-token 
Request 
path Parameters
customerId
required
string
 
header Parameters
x-api-key
string
 
Cookie
string
 
Request Body schema: application/json
required
telephoneNumbers
Array of arrays
 
callForwardNumber
required
string
 
disasterPlanID
required
string
 
countryCode
required
string
 
Responses 
200
200 response


400
Bad request please check your request and try again


401
Not authorized


403
Forbidden not allowed to delete account


put/disasterPlan/{customerId}
Request samples 
Response samples 
application/json
{
  • "statusCode": "200",
  • "status": "No error"
}
Remove Disaster Plans from telephone number
Remove Disaster Plans from telephone number


Securityx-access-token 
Request 
path Parameters
phoneNumber
required
string
 
header Parameters
x-api-key
string
 
Cookie
string
 
Responses 
200
200 response


400
Bad request please check your request and try again


401
Not authorized


403
Forbidden not allowed to add emergency addresses to customer


delete/disasterPlan/{customerId}
Request samples 
Response samples 
application/json
{
  • "statusCode": "200",
  • "status": "No error"
}
Site Management
This section provides the ability to manage sites inside of iPilot, retrieving, adding, removing, users in sites.


Retrieve list of sites
Retrieve list of sites


Securityx-access-token 
Request 
query Parameters
limit
string
 Default:  1
page number to return


 
siteLimit
string
 Default:  10
page number to return of sites


 
header Parameters
x-api-key
string
 
Cookie
string
 
Responses 
200
200 response


400
Bad request please check your request and try again


401
Not authorized


403
Forbidden not allowed to get departments


get/site
Request samples 
Response samples 
application/json
[
  • {
    }
]
Create a new Site
Creates a new Site


Securityx-access-token 
Request 
header Parameters
Cookie
string
 
x-api-key
string
 
Request Body schema: application/json
required
 Array 
departmentName
required
string
 
Responses 
200
200 response


400
Bad request please check your request and try again


401
Not authorized


403
Forbidden not allowed to create department


post/site
Request samples 
Response samples 
application/json
{
  • "statusCode": "200",
  • "status": "No error"
}
Removes a site
Removes an iPilot site.  Note that all users must already be removed from a site otherwise this command will fail due to users still be assigned to this site.


Securityx-access-token 
Request 
path Parameters
id
required
string
 
header Parameters
x-api-key
string
 
Cookie
string
 
Responses 
200
200 response


400
Bad request please check your request and try again


401
Not authorized


403
Forbidden not allowed to delete department


delete/site/{id}
Request samples 
Get Site details
Returns back site details


Securityx-access-token 
Request 
path Parameters
id
required
string
 
header Parameters
x-api-key
string
 
Cookie
string
 
Responses 
200
200 response


400
Bad request please check your request and try again


401
Not authorized


get/site/{id}
Request samples 
Response samples 
application/json
{
  • "departmentName": "Sales | Marketing | Site Location A"
}
Update site details
Update site details


Securityx-access-token 
Request 
path Parameters
id
required
string
 
header Parameters
x-api-key
string
 
Cookie
string
 
Request Body schema: application/json
required
departmentName
required
string
 
Responses 
200
200 response


400
Bad request please check your request and try again


401
Not authorized


403
Forbidden not allowed to remove department


put/site/{id}
Request samples 
Response samples 
application/json
{
  • "statusCode": "200",
  • "status": "No error"
}
Emergency Addresses
This section provides the ability manage Emeregency Services addresses, retrieving, updating, adding and/or removing.


Get Emergency Addresses
Returns back emergency addresses


Securityx-access-token 
Request 
path Parameters
subdomain
required
string
 
header Parameters
x-api-key
string
 
Cookie
string
 
Responses 
200
200 response


400
Bad request please check your request and try again


401
Not authorized


get/msteams/{subdomain}/emergency/addresses
Request samples 
Response samples 
application/json
[
  • {
    }
]
Add emergency address to account
Add emergency addresses to customer account


Request 
path Parameters
id
required
string
 
header Parameters
x-api-key
string
 
Cookie
string
 
Request Body schema: application/json
required
locationId
number
Location ID


 
name
string
Address Location Name


 
streetNumber
string
Address Street Number


 
streetName
string
Address Street Name


 
addressType
string
Address Type


 
addressDescription
string
Address Description


 
countryCode
string
Country Code


 
postalCode
string
Postal Code


 
stateCode
string
State Code


 
city
string
City


 
Responses 
200
200 response


400
Bad request please check your request and try again


401
Not authorized


403
Forbidden not allowed to add emergency addresses to customer


post/msteams/{subdomain}/emergency/addresses
Request samples 
Response samples 
application/json
{
  • "statusCode": "200",
  • "status": "No error"
}
Update emergency address on account
Add emergency addresses to customer account


Request 
path Parameters
subdomain
required
string
 
id
required
string
 
header Parameters
x-api-key
string
 
Cookie
string
 
Request Body schema: application/json
required
locationId
number
Location ID


 
name
string
Address Location Name


 
streetNumber
string
Address Street Number


 
streetName
string
Address Street Name


 
addressType
string
Address Type


 
addressDescription
string
Address Description


 
countryCode
string
Country Code


 
postalCode
string
Postal Code


 
stateCode
string
State Code


 
city
string
City


 
Responses 
200
200 response


400
Bad request please check your request and try again


401
Not authorized


403
Forbidden not allowed to add emergency addresses to customer


put/msteams/{subdomain}/emergency/addresses/{id}
Request samples 
Response samples 
application/json
{
  • "statusCode": "200",
  • "status": "No error"
}
Remove emergency address from account
Remove emergency addresses from customer account


Securityx-access-token 
Request 
path Parameters
subdomain
required
string
 
id
required
string
 
header Parameters
x-api-key
string
 
Cookie
string
 
Responses 
200
200 response


400
Bad request please check your request and try again


401
Not authorized


403
Forbidden not allowed to add emergency addresses to customer


delete/msteams/{subdomain}/emergency/addresses/{id}
Request samples 
Response samples 
application/json
{
  • "statusCode": "200",
  • "status": "No error"
}
International Calling
This section provides the ability to manage international calling for your phone numbers.


Enable international calling for phone number(s)
Enable international calling for phone number(s)


Securityx-access-token 
Request 
header Parameters
Cookie
string
 
x-api-key
string
 
Request Body schema: application/json
required
 Array 
telephoneNumber
required
string
 
criteria
required
string
 
Responses 
200
200 response


400
Bad request please check your request and try again


401
Not authorized


403
Forbidden not allowed to create account


post/internationalCalling/{customerId}
Request samples 
Response samples 
application/json
{
  • "statusCode": "200",
  • "status": "No error"
}
Retrieve international calling on phone number
Retrieve international calling on phone number


Securityx-access-token 
Request 
path Parameters
phoneNumber
required
number
 
header Parameters
x-api-key
string
 
Cookie
string
 
Responses 
200
200 response


400
Bad request please check your request and try again


401
Not authorized


403
Forbidden not allowed to get departments


get/internationalCalling/{phoneNumber}
Request samples 
Response samples 
application/json
{
  • "telephoneNumber": "E164 format phone number 12223334444",
  • "criteria": "ALLOW-ALL-INTL"
}
Remove international calling from phone number
Remove international calling from phone number


Securityx-access-token 
Request 
path Parameters
phoneNumber
required
string
 
header Parameters
x-api-key
string
 
Cookie
string
 
Responses 
200
200 response


400
Bad request please check your request and try again


401
Not authorized


403
Forbidden not allowed to add emergency addresses to customer


delete/internationalCalling/{phoneNumber}
Request samples 
Response samples 
application/json
{
  • "statusCode": "200",
  • "status": "No error"
}
Microsoft Teams
This section provides the ability to manage the Microsoft Teams functionality in the iPilot system. You have the ability to retrieve numbers available for provisioining, provisioning a user to a phone number, retrieving user detailed information, updating user detailed information etc.


Retrieves list of configured iPilot customer identifiers for Microsoft Teams, also known as subdomain.
Returns back list of configured customer identifiers the authenticated user has permission to access.


Securityx-access-token 
Request 
query Parameters
limit
string
 
page
string
 
header Parameters
x-api-key
string
 
Cookie
string
 
Responses 
200
200 response


400
400 response


401
401 response


402
402 response


403
403 response


404
404 response


405
405 response


get/msteams
Request samples 
Unprovision a user from a phone number
Unprovision user from phone number returning it into pool


Securityx-access-token 
Request 
path Parameters
subDomain
required
string
Customer Identifier as listed in iPilot


 
id
required
string
 
header Parameters
x-api-key
string
 
Cookie
string
 
Responses 
200
200 response


400
400 response


401
401 response


402
402 response


403
403 response


404
404 response


405
405 response


delete/msteams/{subDomain}/users/{id}
Request samples 
Get detailed user information
Returns back a single user detail record


Securityx-access-token 
Request 
path Parameters
subDomain
required
string
Customer identifier as listed in iPilot


 
id
required
string
 
header Parameters
x-api-key
string
 
Cookie
string
 
Responses 
200
200 response


400
400 response


401
401 response


402
402 response


403
403 response


404
404 response


405
405 response


get/msteams/{subDomain}/users/{id}
Request samples 
Response samples 
application/json
{
  • "id": "123",
  • "upn": "test.user@example.com",
  • "firstName": "Test",
  • "lastName": "User",
  • "note": "Sales",
  • "status": "configured",
  • "telephoneNumber": "1234567890"
}
Update detailed user information
Update a single user detail record


Securityx-access-token 
Request 
path Parameters
subDomain
required
string
Customer identifier as listed in iPilot


 
id
required
string
 
header Parameters
x-api-key
string
 
Cookie
string
 
Request Body schema: application/json
required
upn
required
string
 
firstName
string
 
lastName
string
 
note
string
 
telephoneNumber
required
string
 Default:  ""
An unassigned phone number in application pool OR leave blank for next available free number.  If no numbers available in pool, fails with error_blah


 
Responses 
200
200 response


400
400 response


401
401 response


402
402 response


403
403 response


404
404 response


405
405 response


put/msteams/{subDomain}/users/{id}
Request samples 
Response samples 
application/json
{
  • "statusCode": "200",
  • "status": "No error"
}
Retreive list of numbers available and provisioned user
Return back a list of provisioned users


Securityx-access-token 
Request 
path Parameters
subDomain
required
string
Customer identifier as listed in iPilot


 
query Parameters
limit
string
 Default:  1
page number to return


 
telephoneNumber
string
 Default:  "all"
Filter by status


 Enum: "all" "configured" "not configured" "unassigned" "assigned" "failed to assign" "failed to unassign" "failed to grant policy" "invalid upn" "stopped" "pending stopped" "queued" "pending assign" "pending unassign"  
note
string
Filter by last name


 
status
string
Filter by first name


 
page
string
Filter by UPN


 
firstName
string
Filter by note


 
lastName
string
Filter by telephoneNumber


 
upn
string
 
header Parameters
x-api-key
string
 
Cookie
string
 
Responses 
200
200 response


400
400 response


401
401 response


402
402 response


403
403 response


404
404 response


405
405 response


get/msteams/{subDomain}/users
Request samples 
Response samples 
application/json
[
  • {
    }
]
Provision a new user UPN to a telephone number
Provisions a user to a telephone number


Securityx-access-token 
Request 
path Parameters
subDomain
required
string
Customer identifier as listed in iPilot


 
header Parameters
Cookie
string
 
x-api-key
string
 
Request Body schema: application/json
required
 Array 
upn
required
string
 
firstName
string
 
lastName
string
 
note
string
 
telephoneNumber
required
string
 Default:  ""
An unassigned phone number in application pool OR leave blank for next available free number.  If no numbers available in pool, fails with error_blah


 
Responses 
200
200 response


400
400 response


401
401 response


402
402 response


403
403 response


404
404 response


405
405 response


post/msteams/{subDomain}/users
Request samples 
Response samples 
application/json
{
  • "statusCode": "200",
  • "status": "No error"
}
Get numbers that are available in pool
Return list of available numbers.  Numbers must be ordered through iPilot portal first


Securityx-access-token 
Request 
path Parameters
subDomain
required
string
Customer identifier as listed in iPilot


 
query Parameters
limit
string
 Default:  100
Limits the number of items on a page


 
telephoneNumber
string
 Default:  1
page number to return


 
status
string
 Default:  "all"
Filter by status


 Enum: "all" "pending foc" "received foc" "ported" "new"  
page
string
Filter by UPN


 Enum: "all" "added" "not added"  
upn
string
 
header Parameters
x-api-key
string
 
Cookie
string
Filter by telephoneNumber


 
Responses 
200
200 response


400
400 response


401
401 response


402
402 response


403
403 response


404
404 response


405
405 response


get/msteams/{subDomain}/numbers
Request samples 
Response samples 
application/json
[
  • {
    }
]
Zoom
This section provides the ability to manage the Zoom peering exchange phone numbers in the iPilot system. You have the ability to retrieve numbers available for provisioining, provisioning a user to a phone number, retrieving user detailed information, updating user detailed information etc.


Retrieves list of Zoom phone number inventory
Retrieves list of Zoom phone number inventory


Securityx-access-token 
Request 
query Parameters
limit
string
 
page
string
 
header Parameters
x-api-key
string
 
Cookie
string
 
Responses 
200
200 response


400
400 response


401
401 response


402
402 response


403
403 response


404
404 response


405
405 response


get/zoom
Request samples 
Provision/Peer phone number to Zoom Account.
Provisions/Peers phone number(s) to the linked Zoom Account.


Securityx-access-token 
Request 
header Parameters
Cookie
string
 
x-api-key
string
 
Request Body schema: application/json
required
 Array 
provisionAction
required
string
 
telephoneNumber
required
string
 
provisionTo
required
string
 
userType
required
string
 
note
string
 
Responses 
200
200 response


400
Bad request please check your request and try again


401
Not authorized


403
Forbidden not allowed to create department


post/zoom
Request samples 
Response samples 
application/json
{
  • "statusCode": "200",
  • "status": "No error"
}
Get information on provisioned/peered numbers
Returns back information for provisioned/peered numbers for a customer account in Zoom


Securityx-access-token 
Request 
path Parameters
id
required
string
Customer ID


 
header Parameters
x-api-key
string
 
Cookie
string
 
Responses 
200
200 response


400
400 response


401
401 response


402
402 response


403
403 response


404
404 response


405
405 response


get/zoom/provisionTo/{id}
Request samples 
Response samples 
application/json
{
  • "id": "123",
  • "upn": "test.user@example.com",
  • "firstName": "Test",
  • "lastName": "User",
  • "note": "Sales",
  • "status": "configured",
  • "telephoneNumber": "1234567890"
}