Skip to content
Wire2AirWire2Air
Wire2AirWire2Air
Log inBook a demoFree trial

Loading the index…

HTTP API

Legacy

The legacy Wire2Air HTTP API (version 2.0) sends credentials as request parameters and answers in plain text. Hosts, credentials, request and response conventions.

Last updated

Endpoints

EndpointMethodURLCredential
Send SMSPOST or GEThttps://msgapi.wire2air.com/smsapi/submitsm.aspxUser ID, password, VASID
Send MMSPOST or GEThttp://mms.wire2air.com/mms/submitmms.aspxUser ID, password, VASID
Credit balancePOST or GEThttps://smsapi.wire2air.com/smsadmin/checksmscredits.aspxUser ID, password, VASID
Carrier lookupGEThttp://carrierlookup.wire2air.com/carrierlookup/default.aspxApp key
Keyword lookupPOST or GEThttps://mzone.wire2air.com/mserver/servicemanager/api/checkkeywordapi.aspxUser ID, password, VASID
Keyword registerPOST or GEThttps://mzone.wire2air.com/mserver/servicemanager/api/RegisterKeywordAPI.aspxUser ID, password, VASID
Keyword creditsPOST or GEThttps://mzone.wire2air.com/mserver/api/subscribekeywords.aspxUser ID, password
Subscribe userPOST or GEThttps://mzone.wire2air.com/mserver/api/SubscribeUser.aspxApp key
Send invitationPOST or GEThttps://mzone.wire2air.com/mserver/api/sendinvitation.aspxApp key

Incoming messages and delivery reports reach you through webhooks.

HTTPS

Six of these endpoints were documented with plain http:// URLs. These docs show https:// wherever the host accepts encrypted connections:

  • msgapi.wire2air.com, smsapi.wire2air.com and mzone.wire2air.com accept https://. The mzone and smsapi endpoints were listed as http:// before; their pages now show https://.
  • mms.wire2air.com (send MMS) redirects https:// requests to http://, so its URL stays http://.
  • carrierlookup.wire2air.com (carrier lookup) presents a certificate for a different host name, so https:// fails and its URL stays http://.

Requests

  • Send parameters as application/x-www-form-urlencoded in the body of a POST. The endpoints also accept GET with the parameters in the query string, but that puts your password or app key in the URL, where servers and proxies log it; carrier lookup is the exception and is GET only.
  • URL-encode every value (see URL encoding).
  • Send one request per message or operation.

Parameter names are given as the documentation writes them, usually in capitals (USERID, VASID); the send SMS examples use lower case (userid, vasid).

Responses

Each endpoint answers with one line of plain text, for example:

Responses
JOBID: 12121234567:85582790
ERR: 301: Failed authentication

Read the HTTP status, then parse the text: a success starts with an endpoint-specific word (JOBID:, SERVICEID:, OK, ok, 000: or a number), and a failure with ERR: or Err:. The error table lists every documented code.

Credentials

The HTTP API uses your account user ID and password with a VASID, or an app key, depending on the endpoint. Find the VASID under Manage Account → API Information in the dashboard. See Authentication.