Skip to content
Wire2AirWire2Air

Keyword register

Legacy

Register a keyword on a short code, point its incoming messages at your URL, or delete it, with the legacy HTTP API.

Last updated

POSTGEThttps://mzone.wire2air.com/mserver/servicemanager/api/RegisterKeywordAPI.aspx
Credential
User ID, password and VASID, sent as request parameters
Response
Plain text

Check that the keyword is free first with keyword lookup. If registration fails with Err:711:Keyword credits not enough, add credits with keyword credits.

Parameters

Parameters
ParameterDescription
USERID
stringrequired
in body
Your Wire2Air user ID.
PASSWORD
stringrequired
in body
Your Wire2Air password.
VASID
stringrequired
in body
Your VASID.
SHORTCODE
stringrequired
in body
The short code to register the keyword on.
Example: 27126
SERVICE NAME
stringrequired
in body
A name for the service. See the note below about this parameter's name.
Example: Order updates
KEYWORD
stringrequired
in body
The keyword. At least 4 characters (Err:710).
Example: orders
PROCESSORURL
stringrequired
in body
The URL of your web service that receives this keyword's messages. See inbound SMS.
Example: https://example.com/wire2air/inbound
HELPMSG
stringrequired
in body
The reply sent when someone texts HELP.
STOPMSG
stringrequired
in body
The reply sent when someone opts out (STOP).
ACTION
stringoptional
in body
ADD registers a new service with the keyword; DELETE deletes the keyword from the service.
Default: ADD

Examples

curl "https://mzone.wire2air.com/mserver/servicemanager/api/RegisterKeywordAPI.aspx" \
  --data-urlencode "USERID=YOUR_USERID" \
  --data-urlencode "PASSWORD=YOUR_PASSWORD" \
  --data-urlencode "VASID=YOUR_VASID" \
  --data-urlencode "SHORTCODE=27126" \
  --data-urlencode "SERVICENAME=Order updates" \
  --data-urlencode "KEYWORD=orders" \
  --data-urlencode "PROCESSORURL=https://example.com/wire2air/inbound" \
  --data-urlencode "HELPMSG=Order updates from Example Co. Reply STOP to cancel." \
  --data-urlencode "STOPMSG=You will no longer receive order updates." \
  --data-urlencode "ACTION=ADD"

Response

Success
SERVICEID:SYSTEM GENERATED SERVICEID
ErrorMeaning
Err:300:Invalid Userid or passwordWrong user ID or password.
Err:700:Missing ShortcodeSHORTCODE is missing.
Err:701:Missing VASIDVASID is missing.
Err:702:Missing KeywordKEYWORD is missing.
Err:703:Missing User NameUSERID is missing.
Err:704:Missing PasswordPASSWORD is missing.
Err:705:Keyword is taken, Please try another keywordThe keyword is already in use on this short code.
Err:706:Service Name is requiredThe service name is missing.
Err:707:Help Message is requiredHELPMSG is missing.
Err:708:Unsubscribe Message is requiredSTOPMSG is missing.
Err:709:Processor URL is requiredPROCESSORURL is missing.
Err:710:Keyword length should be minimum 4 charactersThe keyword is shorter than 4 characters.
Err:711:Keyword credits not enoughNo keyword credits left.
Err:712:Sticky Session not allowedNot described further in the documentation.
Err:714:Missing KeywordListed as well as 702 with the same message.