4.18j

TextMarks API V2 - AutoDoc: Anybody / register_user()

Method: register_user() (POST) - Register a new user and send PIN to phone for confirmation

Package: Anybody - Public data and methods for pre- or anonymous users (... View package)

Args:

Req? Name Type Description Test
REQ api_key API Key API Key (Register here)
REQ phone Phone# Phone# of new user
OPT email E-mail New email address
OPT nick String New user name (must be unique)
OPT affid String Affiliate ID for source of new user

Test:


Docs:

  • The new user receives a random PIN in a welcoming text message on their phone.
  • User can then log in using phone# and new PIN (thereby confirming device ownership), and may then change password to something meaningful.
  • The PIN or password created and sent by this method can be used immediately to authenticate to TextMarks. See the RegisteredUser.login() method.
  • Note that basic phone# ownership verification (for any application) can be performend by using this method in conjunction with RegisteredUser.login().
  • The API Key may optionally provide context for templatizing the SMS messages sent.
  • This call may only be made on a phone# 2 times in a 24hr period, else error #2022 (ERR_REQUEST_OVER_LIMIT).
  • If a user has already authenticated to TextMarks, they are considered registered and will result in error #2042 (ERR_REQUEST_ALREADY_DONE). In these situations you may wish to use Anybody.reset_password() instead. (However if the user opts out, such as by RegisteredUser.opt_out(), you may re-register them).
  • You may only call this method when all of the following requirements are met:
    • A user typed their own phone# into a web form.
    • User checked a checkbox indicating agreement to TextMarks Terms of Service, or your own Terms of Service if such clearly indicate inclusion of TextMarks Terms.
    • User submitted the form no more than 5 minutes previously.
    • "Msg&Data Rates May Apply" or similar language next to phone# input box.

Resp:

JSON response.head.rescode==0 for success, or error code otherwise.
JSON-P callback: (as 'jsonp' param, optional) (blank for none)

HTTP:

POST http://help.api2.textmarks.com//Anybody/register_user/

More:

This page documents a single API function register_user() within the Anybody package of the TextMarks Text Message API.
You may use the interactive form above to invoke this function and observe its actual JSON response.

More resources: