API Overview & Key Information
This Page Provides a brief overview of all the APIs in our API library, for more specific information please see our the API Reference section. If you require any further information for general practices when provisioning or providing support to your customers on PhoneLine+, please see the Gamma Academy or our PL+ partner knowledge base here: PhoneLine+ Partner Portal.
API Rate Limit
The PhoneLine+ Partner API limit is currently 100 requests per minute, per API key.
API Overview
| API Name | Description | Request Type |
|---|---|---|
| Addresses | ||
| Lookup Addresses | This function allows you to lookup a UK address by postcode which can then be used to process emergency services address information or in the device ordering process | GET |
| Authentication | ||
| Get JWT | The JWT serves as the authentication token and should be included in all requests to Partner API endpoints. | POST |
| Customers | ||
| List Customers | This function will pull a list of all Customers that have been provisioned against a Partner Account and their details (I.e Company name and Email) | GET |
| Add Customer | This function will create a new Company account under a PL+ Partner. Plan type for Customer will also be set using this API. | POST |
| Get Customer | This function will provide the details for a specific Customer, providing a more concentrated view of the "list customers" function. | GET |
| Update Customer | This function can be used to update the details of an existing Customer (i.e Company name change) | PUT |
| Delete Customer | This function can be used to delete an existing Customer | DELETE |
| Regrade Customer Contract | This function can be used to change the contract length of an existing Customer | PUT |
| Upgrade Customer Plan | This function can be used to Upgrade a Hardware only Customer to a Standard PL+ Plan | PUT |
| Customer Numbers | ||
| List Customer Numbers | This function will pull a list of all Numbers for a Customer. This will also show whether these Numbers are assigned and to which Users | GET |
| Add Customer Number | This function can be used to add a new number to a Customers number pool | POST |
| Get Customer Number | This function can be used to pull all the details for a specific number. If the number is allocated, it will show who to. | GET |
| Allocate Customer Number | This function can be used to assign a number to a Customer User | PUT |
| Deallocate Customer Number | This function can be used to unassign a number from a Customer User | DELETE |
| Customer Blocked Numbers | ||
| Get all Blocked Numbers for Customer | This function will provide a list of all blocked numbers for a particular Customer | GET |
| Add a Blocked Number for a Customer | This function will block a number from IB/OB calls to/from the chosen Customer | POST |
| Get a Blocked Number by ID | This function allows you to search for a specific number and see if this has been added to the blocked numbers list for the customer specified. | GET |
| Update a Blocked Number by ID | This function allows you to update the specifc barring you have set against a number for a customer. For example updating the directions of which traffic has been blocked (Inbound vs Outbound). | PUT |
| Delete a Blocked Number for Customer by ID | This function allows you to delete a number from the blocked numbers list of the specifed company. | DELETE |
| Customer Users | ||
| List Customer Users | 'This function will provide a list of all Users for a Customer | GET |
| Add Customer User | 'This function allows you to add a new User to an existing PL+ Customer, please be aware when adding a new user to a PhoneLine+ company, they will automatically inherit the same plan and contract length which is set at a company level. | POST |
| Update Customer User | 'This function allows you to update the details of an existing Customer User (Name, Email Address etc.) | PUT |
| Delete Customer User | This function allows you to delete an existing PL+ Customer User | DELETE |
| Resend User Activation Email | This function can be used to resend the account ctivation email for a PL+ Customer User | GET |
| Request Password Reset | This function can be used to send a Password Reset email to a PL+ Customer User | POST |
| Customer User Settings | ||
| Update Call Settings | This function can be used to update Call Settings for a Customer User (e.g reject anonymous calls) | PUT |
| Update Schedule Settings | This function can be used to update schedule settings for out of hours redirects | PUT |
| Customer Orders | ||
| List Customer Orders | This function will provide a list of all Order placed for a Customer | GET |
| Add Customer Order | This function can be used to place a new device order for a PL+ Customer | POST |
| Customer User Devices | ||
| Add Customer User Device | This function can be used to assign a device to a Customer User | POST |
| Numbers | ||
| List Area Codes | This function will provide a list of all area codes supported by PL+ | GET |
| List Available Numbers | This function will provide a list of all available numbers based on the given area code | GET |
| Partner Orders | ||
| List Orders for Partner | This function will provide a list of all device/hardware orders placed by the Partner (and associated details e.g delivery address) | GET |
| Products | ||
| List Products | This function will provide a list of all hardware products available to order | GET |
| Partner Settings | ||
| Get Partner Settings | This function will provide the Customer Name, Address and Contact information for their PL+ account | GET |
| Update Partner Settings | This function can be used to update the partner name, contact or address information. | PUT |
| List User Permissions | This function will provide a list of the user permissions settings for all customer users under a PL+ Partner account. | GET |
| Update User Permissions | This function can be used to update the user permissions settings for all customer users partner. | PUT |
| Stats | ||
| Get Stats | This function will provide a list of counts of active customers, users, and numbers for the Partner | GET |
| Partner Users | ||
| List Users for Partner | This function will provide a list of all existing Partner Users for the PL+ Partner account | GET |
| Add Partner User | This function can be used to add a Partner User to an existing PL+ Partner account | POST |
| Update Partner User | This function can be used to update the details of an existing Partner User | PUT |
| Delete Partner User | This function can be used to Delete a Partner user from a PL+ Partner account | DELETE |
Key Information & Terms
| Term | Definition |
|---|---|
JWT |
JSON Web Token is a user-based method of authentication which we use on all of our PhoneLine+ Partner APIs |
API Key |
This is a unique identifer which enables our servers to track and manage your requests |
Secret Key |
This is a key which we pair with your API Key for authentication purposes. |
API Endpoint |
Application programming interface (API) endpoint, is a URL that acts between the point of contact to receive requests and send responses from our API server. |
Last Used |
On the API section of the partner portal, you will notice a last used date/time is provided, this time/date can show you exactly when the API key specified last made a successful request to one of our PhoneLine+ endpoints. |
Customer ID |
This is a unique identifer which is used to identify a specific PhoneLine+ company |
Company Name |
This is the company name for the end user(s) you are provisioning onto the PhoneLine+ service. |
Plan |
This refers to the product variant of PhoneLine+ that you would like to provision for your end user. |
User ID |
This is a unique identifer which is used to identify a specific user provisioned within a PhoneLine+ company. |
Number ID |
This is a unique identifier which is used to reference a specific number you have associated to PhoneLine+ company/user. |
Blocked Number ID |
This is a unique identifier which is used to reference a specific number which you may have added to a blocked numbers list against a PhoneLine+ company. |
Product ID |
This is a unique identifier used for the specific pieces of hardware we sell on PhoneLine+, this will be required if you want to place any orders with us. |
Brand |
This field refers to the specific brand/manufacturer of hardware we provide, for example Polycom, Yealink etc. |
Model |
This field refers to the specific model for any hardware we provide for example VVX150 (Polycom VVX150) |
MAC Address |
A MAC addres is a unique identifer for any piece of hardware provided, this will be in a 12 digit hexidecimal format. |
Order ID |
This is a unique order ID we will provide for any hardware ordered through Gamma, this ID can be used to track in-flight orders/ |
Admin |
When sending a request to create a new user on a PhoneLine+ customer account, you will be able to specify the type of user being created as an Admin. By doing this you are giving the end user the ability to manage other users and numbers on that PhoneLine+ account. |
Standard |
When sending a request to create a new user on a PhoneLine+ customer account, you will be able to specify the type of user being created as a standard user. By doing this you are restricting the users access to any standard features, as such they will only have access to configure any settings against their own PhoneLine+ account. |
GET |
A GET is a type of HTTP request you can make to our APIs in order to retrieve a particular resource, for example a list of companies, numbers or users. |
POST |
A POST is a type of HTTP request you can make to our APIs in order to create a particular resource, for example creating a PhoneLine+ company or user. |
PUT |
A PUT is a type of HTTP request you can make to our APIs in order to update a particular resource, for example allocating a number to a specific user in PhoneLine+ |
DELETE |
A DELETE is a type of HTTP request you can make to our APIs in order to remove a particular resource, for example deleting a specific end user in PhoneLine+ |
Updated 7 months ago