4.07a

TextMarks API V2 - AutoDoc: TextMarkManager / set_integration_config()

Method: set_integration_config() (POST) - Set integration 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 owned by auth_user
OPT api_key API Key API Key (Register here)
OPT group_callback_url URL (or NONE) URL to notify on group join/leave events
OPT private_token String Private token for cryptographic use

Test:


Docs:

  • Set integration configuration for the TextMark tm, which are used for advanced system integrations.
  • Only options specified will be changed:
    group_callback_url:
    Optional URL of a script on your server that will receive system-level notifications every time a user joins or leaves the TextMark group.
    • The URL is parameter-substituted similar to that in set_dynamic_request_handler().
    • Pay special attention to the \a param, which will contain SUB or UNSUB depending on the action. (You may use the same script as your request handler dynamic script, because \a is always REQ for requests).
    • Specify "NONE" to clear existing setting.
    • A common format for this URL is:
      http://yoursite.com/yourscript.php?user=\p&action=\a
    private_token:
    Optional secret value shared between TextMark and 3rd party site, used for cryptographic purposes.
    • The \s URL param uses this token to sign requests.
  • See Cryptographically Signed Requests for more information.
  • See integration_config() to read the current settings.

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//TextMarkManager/set_integration_config/

More:

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