Skip to content
Wire2AirWire2Air

Subscribe user

Legacy

Add a mobile number to a campaign's subscriber list, or remove it, with the legacy HTTP API (SubscribeUser.aspx).

Last updated

POSTGEThttps://mzone.wire2air.com/mserver/api/SubscribeUser.aspx
Credential
App key, sent as the APPKEY request parameter
Response
Plain text

Only add people who have agreed to receive your messages.

Parameters

Parameters
ParameterDescription
APPKEY
stringrequired
in body
Your app key. See authentication.
SHORTCODE
stringrequired
in body
The campaign's short code.
Example: 27126
MOBILE NUMBER
stringrequired
in body
The subscriber's mobile number. See the note below about this parameter's name.
Example: 12121234567Max length: 20
KEYWORD
stringrequired
in body
The campaign keyword.
Max length: 20
MESSAGE
stringoptional
in body
A welcome text message.
Max length: 160
NAME
stringoptional
in body
The subscriber's full name.
Max length: 100
EMAILADDRESS
stringoptional
in body
The subscriber's email address.
Max length: 100
CUSTOM1
stringoptional
in body
Custom field 1. CUSTOM2, CUSTOM3 and CUSTOM4 work the same way.
Max length: 100
DOB
stringoptional
in body
Date of birth, as MM/DD/YYYY.
ACTION
stringoptional
in body
ADD subscribes the number; REMOVE unsubscribes it.
Default: ADD

Examples

curl "https://mzone.wire2air.com/mserver/api/SubscribeUser.aspx" \
  --data-urlencode "APPKEY=YOUR_APPKEY" \
  --data-urlencode "SHORTCODE=27126" \
  --data-urlencode "MOBILENUMBER=12121234567" \
  --data-urlencode "KEYWORD=coupon" \
  --data-urlencode "NAME=Sam Lee" \
  --data-urlencode "ACTION=ADD"

Response

Success
ok
ErrorMeaning
Err:300:Invalid User credentialsThe app key is wrong.
Err:700:Missing ShortcodeSHORTCODE is missing.
Err:701:Missing VASIDListed in the previous docs; see the note above.
Err:702:Missing Keyword/Invalid KeywordKEYWORD is missing or not a keyword of yours.
Err:720:Missing Mobile NumberThe mobile number is missing.