RESTful APIs

Developer friendly. High performance.

Find our RESTful APIs at api.aql.com.

Other APIs

We provide a wide variety of communication APIs to allow businesses to seamlessly integrate their processes with the services we offer. Here you will find APIs related to our messaging, telecommunications and mobile services.

Inbound SMS

Inbound SMS relay API
All aql numbers support inbound SMS messaging. To provide the maximum flexibility to your business, we provide this API to allow you full control over how and where these SMS messages are delivered.

Inbound SMS to UK landline numbers API
This page provides information on how to integrate with our Inbound UK landline numbers API.

Inbound SMS to virtual mobile numbers API
The virtual mobile numbers API pushes notifications to you. This documentation provides information on how to accept and process these HTTP requests.

Number activation API
If we've datafilled your own number ranges for you, then you will still need to notify some networks that the number is live so that they can activate the routing for these. This typically takes 1-2 business days. To pass your number(s) to these networks, you can make use of the number activation API.

Number control API
Once a number has been provisioned using the provisioning API, it may be configured using our extensive number control API.

Shared short codes API
Use our shared premium SMS platform API documentation to integrate short codes with your systems or softwares.

SMS relay activation
Once your number ranges or individual numbers have been passed to the networks for SMS datafill, some networks require notification that the number is live so that they can activate the routing for these. To pass your number(s) to these networks, you can make use of the following API.


Outbound SMS

Send SMS API
Send SMS via our RESTful API.
Documentation can be found at https://api.aql.com/doc/.
The old api version is available on pdf here

Send SMS via SOAP API
You can seamlessly integrate your applications with aql's outbound SMS messaging service via SOAP using our SOAP API.

Send SMS via UDH API
If you require the ability to specify sms headers for sending concatenated messages or vCards for example, you can make use of our UDH gateway. This gateway is accessible via HTTP POST using the UDH API.

SMPP protocol
SMPP is an industry standard, reliable method of sending a high number of messages. Our documentation leads you through the process of integrating with our SMPP service.

vCard API
The vCard API lets developers use a HTTP request to generate and send a vCard to a mobile device.

Voice push API
The text to speech service provided by aql is an easy to use method of converting text into voice via a telephone call.

WAP push API
Our WAP push API allows you to push files to users using WAP.


Mobile

SIM admin API
This API lets you to administer USIMs that have been allocated.

Three 3G network coverage API
This API is used to check H3G UK Network 3G data coverage information using postcode.


Telecoms

999 API for hosted number ranges
This API is designed to allow partners who have their number ranges hosted with aql to update their interface with BT’s 999 system. This will provide an easy method for the update of BT’s 999 record details for our customers.

999 API return codes
These are a list of the codes returned by 999 API and 999 API for hosted number ranges.

999 emergency service access API
Allows holders of aql numbers to update their subscriber details with BT’s 999 system. This provides an easy method for the update of BT’s 999 record details for our customers.

Email to fax reseller API
Manage email to fax services quickly and easily. Create, list, change, and manage services from one easy-to-use API.

IAX configuration
This documentation provides a sample IAX configuration file to help you get connected to aql's wholesale gateways.

Looking Glass API
The Looking Glass API is for checking domains and email addresses. You do not have to be logged in to use this facility.

Network lookup API
Our network lookup API can provide you with a more detailed response for your network lookups, including an indication of how the information was discovered, by sending a request via HTTP POST to our gateway, allowing quick integration with your own services.

Nokia OTA configuration API
Configuration of VoIP settings on mobile devices is a barrier to take-up of VoIP services on mobiles. aql has six years of experience in over the air (OTA) configuration of Nokia handsets, and our Nokia OTA configuration API will give you the tools to manage this service.

Number activation API
If we've datafilled your own number ranges for you, then you will still need to notify some networks that the number is live so that they can activate the routing for these. This typically takes 1-2 business days. To pass your number(s) to these networks, you can make use of the number activation API.

Number control API
Once a number has been provisioned using the provisioning API, it may be configured using our extensive number control API.

Number provisioning API
aql have an OFCOM number allocation in almost every UK town and city available for realtime allocation via our API, allowing our channel partners and reseller to search for particular numbers and allocate them instantly. Gain full control of your numbers: the Number Provisioning API enables you to instantly provision and configure number for use as VoIP, call forwarding or Fax.

Return mode
Information about and definition of return-mode and return-format parameters.

Wholesale fax provisioning API
Wholesale customers can provision fax services on their own, non-aql, numbering using the wholesale fax API.