4.18j

TextMarks API V2 - AutoDoc: TextMarkManager / route_config()

Method: route_config() (GET) - Get sticky duration, and phone #'s associated with a TextMark

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 route settings of the TextMark tm, determining how the TextMark can be accessed (including phone#s it is hosted on, sticky settings).
  • The returned fields include:
    phones:
    EITHER a CSL of supported phones and/or short codes (eg 41411) OR as single asterisk "*" indicating system-wide support.
    sticky_duration:
    Number of seconds (or 0) that user "sessions" with this TextMark persist (thus bypassing requirement to prefix requests with the keyword).

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

More:

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