APIs and documentation

vCard API


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

In this section...

Use an http request to generate and send a vCard

Specify your vCard information and send it using HTTP POST or GET.
Our system will create the vCard and transmit it to it's destination.

Your vCard must include

Destination number (the API can handle most common number formats - +447xxx xxxxxx)
Originator (16 numeric characters or 11 alphanumeric characters)

You can also include

Preferred contact number
Mobile phone number
Home phone number
Work phone number
Fax number
Email address

Complete with error and credit usage reporting

HTTP fields

AQL Usernameusername
AQL Passwordpassword
Preferred numberform_pref
Mobile numberform_mobile
Home numberform_home
Work numberform_work
Fax numberform_fax
PTT numberform_ptt
Email addressform_email

Example implementation

<title>aql vCard generator</title>
<form action=http://gw1.aql.com/sms/gw-vcard.php method=post>
<input type=hidden name=action value=send>
<tr><td>AQL Username</td><td><input type=text name=username></td></tr>
<tr><td>AQL Password</td><td><input type=password name=password></td></tr>
<tr><td>Destination</td><td><input type=text name=destination></td></tr>
<tr><td>Originator</td><td><input type=text name=originator></td></tr>
<tr><td>Forename</td><td><input type=text name=form_fname></td></tr>
<tr><td>Surname</td><td><input type=text name=form_lname></td></tr>
<tr><td>Preferred number</td><td><input type=text name=form_pref></td></tr>
<tr><td>Mobile number</td><td><input type=text name=form_mobile></td></tr>
<tr><td>Home number</td><td><input type=text name=form_home></td></tr>
<tr><td>Work number</td><td><input type=text name=form_work></td></tr>
<tr><td>Fax number</td><td><input type=text name=form_fax></td></tr>
<tr><td>PTT number</td><td><input type=text name=form_ptt></td></tr>
<tr><td>Email address</td><td><input type=text name=form_email></td></tr>
<tr><td>Address</td><td><input type=text name=form_label></td></tr>
<tr><td>Note</td><td><input type=text name=form_note></td></tr>
<tr><td>&nbsp;</td>< td><input type=submit></td></tr>

Please feel free to try and send a vCard


System responses

GW-OK:Message sent, number of credits used reported
GW-NO_AUTH_DETAILSAuthentication error : Username and password required
GW-AUTH_ERRORAuthentication error : Username and password mismatch
GW-NO_DESTINATIONDestination field contains no data
GW-INVALID_DESTINATIONDestination field contains non-numeric data
GW-MSGERRORMessage could not be sent
GW-NO_CREDITaql account has insufficient credit(s). If a message comprises more than 160 characters, several credits will be used as we will need to send several concatenated messages.
GW-ERROR:Other error, non-acknowledged messages reported

Back to Documentation and APIs

Follow us on Twitter

Like us on Facebook

Connect to us on LinkedIn

Where we are

13-15 Hunslet Road
LS10 1JQ
Telephone 01133 20 30 40