4.18j

TextMarks API V2 - AutoDoc: TextMarkManager / request_handler()

Method: request_handler() (GET) - Get request handler configuration

Package: TextMarkManager - Manage a TextMark owned by authenticated user (... View package)

Args:

Req? Name Type Description Test
REQ auth_user User User account / phone# used for login
REQ auth_pass Password Password
REQ tm TextMark TextMark keyword/TRI owned by auth_user
OPT api_key API Key API Key (Register here)

Test:


Docs:

  • This method returns the current request handler configuration of the TextMark tm, i.e. what happens when somebody texts the keyword to 41411.
  • The following types of request handlers are possible:
    basic:
    Automatically respond with a preset text message (see set_basic_request_handler()).
    webscrape:
    Make a public web request to get content from a web site (optionally passing along request data as query params), find a specific piece of data, strip out HTML, and respond to the user with SMS (see set_webscrape_request_handler()).
    dynamic:
    Make an HTTP request to a script on a 3rd party server that operates on request data and returns raw text that is sent back to the requesting user as SMS (see set_dynamic_request_handler()).
    silent:
    No response. Other processing may still take place (e.g. auto-join group) (see set_silent_request_handler()).
  • In addition to handler-specific params, these options apply to all TextMarks:
    notify_sms:
    Send SMS notification to TextMark manager each time the TextMark is requested. Includes requesting user's phone#.

Resp:

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

HTTP:

GET http://help.api2.textmarks.com//TextMarkManager/request_handler/

More:

This page documents a single API function request_handler() within the TextMarkManager 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: