4.18j

TextMarks API V2 - AutoDoc: Anybody / simulate_request()

Method: simulate_request() (POST) - Simulate a TextMark request, as if by text message

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 req String Request text
OPT auth_user User User account / phone# used for login
OPT auth_pass Password Password

Test:


Docs:

  • Handles text requests similarly to TextMarks Mobile-Originated SMS gateway:
    • Request typically starts with a TextMark keyword.
    • If TextMark requested is dynamic, remote script is executed as usual.
    • Response is returned within API response (as response) rather than sent as text message.
  • If valid auth_user is specified, the request is as if it were sent by that user's phone.
  • With no auth_user, the request is anonymous.
  • Additional TextMark meta-information may be included in tm node of response.
  • Only one response is returned, and complex requests that result in multiple text messages are not recommended.

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/simulate_request/

More:

This page documents a single API function simulate_request() 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: