4.18h

TextMarks API V2 - AutoDoc: RegisteredUser / join_group()

Method: join_group() (POST) - Join (subscribe to) a TextMark group

Package: RegisteredUser - Manage authenticated user's account/profile (... 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 group to join
OPT api_key API Key API Key (Register here)

Test:


Docs:

  • Groups are identified by TextMark keyword. A TextMark's group is the set of users who have joined/subscribed to it. (Note that not all TextMarks enable group functionality, but most do)
  • Join groups to subscribe to their messages, participate in discussions, or interact with 3rd party applications.
  • Joining a group allows the group leaders to see your phone# and manually (or via system integration) send text messages to your phone.
  • Some groups also allow members to SMS broadcast-chat in real-time with all other members (without revealing any phone#s).
  • Users can leave a group any time (see leave_group()) to no longer receive group-related messages.
  • This method immediately joins the registered/authenticated user to the group. See the method Anybody.invite_to_group() for a way to invite a new user to join without requiring any authentication.
  • If the user is already a member of the group, receive error #2042 (ERR_REQUEST_ALREADY_DONE).
  • Receive system-level join/leave notifications by setting the "group_callback_url" in TextMarkManager.set_integration_config()

Resp:

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

HTTP:

POST https://api2ssl.textmarks.com//RegisteredUser/join_group/

More:

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