The purpose of this document is to provide a high-level overview of the API services that are offered by Gamma. Whilst every effort has been made to ensure this document is comprehensive, reference should be made to the individual API documentation for a more detailed list of features.
What is an API? #
An Application Programming Interface which allows different applications to talk to each other. In essence, it is a server that listens for a particular request(s), acts on them, and then returns a response to the client that made the request. APIs are vital to the functioning of the modern web and allow companies the world over to integrate with each other’s systems.
There are many wonderful resources online to help you better understand APIs, whether you are an experienced developer or curious to learn more. The Gamma Developer site contains everything you need to know about the APIs that we offer along with specifications on each API.
Set up #
The below table must be completed by the channel partner who can then raise the request into API@Gamma.co.uk, but this can also be done by internal stakeholders on behalf of the partner should this be needed. Once an email with the relevant form has been provided the team will conduct validation checks before processing, after which full confirmation will sent to confirming access has been granted.
Recommendation: To mitigate setbacks please ensure all fields on the template/table are filled out with the correct details and requirements. Also, if additional support is needed before putting the request through, please don’t hesitate to contact us via emailing API@gamma.co.uk.
Required Info | Details |
Environment | UAT (Testing platform), Production (Live) or Both |
Username | This must be 6-20 characters and alphanumeric |
Contact Name | This is the first and last name of the key contact, this person will likely be contacted in the event of outages/ password resets/ errors |
Email Address | This will be the primary contact email address for outages, password resets and debugging, ideally the email will be monitored and, in a position, to provide technical details |
Roles | Which API the customer is planning on consuming, if SIP, which actions they are planning to perform on the API instead of the Portal (e.g. add DDIs to endpoint, create new endpoint etc. If it’s not SIP, there will be a default role set for the API in question. |
Client |
A list of clients they require access to, this should be briefly checked against the portal to ensure the organisation has access to those clients, IAMs will likely already have this covered.
|
Support process #
The first port of call for any API issue should always be the Developer website. Our APIs are designed to be self-service, and the documentation should contain the relevant information required by a technical contact. Our support is limited to issues with the service rather than assistance in getting a partner’s API code to work.
If there is still an issue, the ‘Contact Us’ section Reporting a Fault contains the details that should be captured and raised into the support teams which can also be reached by emailing api@Gamma.co.uk. However, unless there is an incident or wider unavailability, the matter will be treated as a service request and managed by the relevant support teams.
Please note: Channel Partners & Account Managers should email API@gamma.co.uk directly if they require additional support with setting up their API or if they have any questions relating to the API documentation.
API Capabilities #
Mobile Provisioning and Management #
-Authentication: HTTP Basic (Base 64 encoded username: password), short-form Client Id (i.e., 44001234 -> 1234)
-Company Management
-Create New Company
-Update Company
-Remove Company
-Service Provisioning
-Provision New Service
-Cancel Order
-Service Management
-Activate/Cease Service
-Change IMEI/MSISDN/USIM
-Reset PIN
-Suspend/Resume Service
-Un-Blacklist Handset
-Change Tariff
-Renew Funding
-Update Contact Details
-Service Options
-Update Network Services/Bars
-Update Call Forwarding
-Update Bolt-Ons
-Update Configuration
-Service Roaming
-Update Roaming Configuration
-Update Notification Options
-Update EU Max Charge
-Porting
-Port In
-Cancel Port In
-Port Out
-Cancel Port Out
-Accepting STAC
-Cancel Accepted STAC
-Issuing a STAC
-Cancel an Issued STAC
-View & Search Services
View:
-Call Forwards
-Handset Details
-Network Bars
-Network Services
-Service History
-Porting Details
-STAC Details
-Requests
-Service
-Bolt-Ons
Search:
-Services
-MSISDNs
-USIMs
-Companies
-Connect
-Check Connection
-(De)allocate Number
-APN
-Add APN
-Remove APN
-Update APN
Gamma SIP Trunks #
-Authentication: HTTP Basic (Base 64 encoded username: password), short-form Client Id (i.e., 44001234 -> 1234)
-Provisioning
-New Gamma SIP Trunks Order
-Cease Gamma SIP Trunks Service
-Service Management
-View Endpoint
-Change History
-DDI Ranges
-Customer Contact Details
-Call Diverts
-Fraud Management
-Call Barring
-Codec Configuration
-Privacy Settings
-Network CLI
-Update Endpoint
-Customer Contact Details
-Enable/Disable CLI Flexibility
-Customer Contact Details
-Order Numbers (no specific numbers, only by area code and from the general available pool of numbers)
-Call Diverts
-Fraud Management
-Call Barring
-Codec Configuration
-Privacy Settings
-Network CLI
-Information
-Area Codes Supported by Gamma SIP Trunks
-CPE Supported by Gamma SIP Trunks
-Nature of Business
-Search Codec Profiles
-Check availability of DDIs for an Area Code
Inbound #
-Authentication: HTTP Basic (Base 64 encoded username:password), short-form Client Id (i.e., 44001234 -> 1234), CompanyRef (Inbound company name), AdminUser (of the Inbound company)
-Provisioning
-Search Numbers
-Reserve Numbers
-Delete Numbers
-Statistics
-CDR
-View Information
-Bookmark
-Call Recording
-View Information
-Bookmark
-Voicemail
-View Information
-Bookmark
-User & Call Plan Management
-Call Setup
-View Call Plan
-Create/Update Call Plan
-Deactivate Call Plan
-View Announcements on Company
-View Numbers on Company
Access Suitability Checker #
-Authentication: Bearer token
-Address Lookup
-Postcode Suitability Check
-Address Key Suitability Check
-CLI Suitability Check
Ethernet Quoting #
-Authentication: HTTP Basic (Base 64 encoded username:password), short-form Client Id (i.e., 44001234 -> 1234)
-Ethernet Quoting
GNP #
-Authentication: Bearer token
-Validate BT Openreach Installation Details
-View GNP Order Summary
-Submit GNP order to be Processed
-View Order History for a GNP Order
-View GNP Orders End User Customer Details
-View GNP Orders Product Details
-View GNP Orders Billing Account Contact Details
-View GNP Orders Number Details
-Find dates with the capacity for your port order
-View list of dates you can port your order on
-Check if it is possible to port a specific number to Gamma
-Submit GNP Order to be Checked for Validity
Emergency Contact Details #
-Authentication: Bearer token
-Number
-View Numbers with a given status in the ECD system
-View History of Recent Requests for a Number
-View Most Recently Added Update Address
-999 Health Check for Numbers on Billing Account
-Request
-Retrieve Previous ECD Requests
-Submit a New Request
-View List of Numbers for Existing Bulk Request (and Current Status)
-View a Specific Bulk Request
Useful Information: number of our APIs provide XSD (XML Schema Definition), which tells you how to structure an XML request. There are several libraries to read these, and it can also be done online. (E.g., https://xmlgrid.net/)
When sending a request, it is important to ensure the request URL is URL Encoded. This means replacing symbols with identifiers, and there are resources online to help with this. (E.g., https://meyerweb.com/eric/tools/dencoder/)