vCard API
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)
Forename
Surname
You can also include
Preferred contact number
Mobile phone number
Home phone number
Work phone number
Fax number
Email address
Address
Note
Complete with error and credit usage reporting
HTTP fields
| AQL Username | username |
| AQL Password | password |
| Destination | destination |
| Originator | originator |
| Forename | form_fname |
| Surname | form_lname |
| Preferred number | form_pref |
| Mobile number | form_mobile |
| Home number | form_home |
| Work number | form_work |
| Fax number | form_fax |
| PTT number | form_ptt |
| Email address | form_email |
| Address | form_label |
| Note | form_note |
Example implementation
<html>
<head>
<title>aql vCard generator</title>
</head>
<body>
<form action=http://gw1.aql.com/sms/gw-vcard.php method=post>
<input type=hidden name=action value=send>
<table>
<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> </td>< td><input type=submit></td></tr>
</table>
</form>
</body>
</html>
Please feel free to try and send a vCard
System responses
| |
| GW-OK: | Message sent, number of credits used reported |
| GW-NO_AUTH_DETAILS | Authentication error : Username and password required |
| GW-AUTH_ERROR | Authentication error : Username and password mismatch |
| GW-NO_DESTINATION | Destination field contains no data |
| GW-INVALID_DESTINATION | Destination field contains non-numeric data |
| GW-MSGERROR | Message could not be sent |
| GW-NO_CREDIT | AQL 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 |