4.18h

TextMarks API V2 - AutoDoc: GroupLeader / broadcast_message()

Method: broadcast_message() (POST) - Broadcast alert to all TextMark group members

Package: GroupLeader - Broadcast and manage messages and members (... 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 led by auth_user
REQ msg SMS Text Text message to broadcast
OPT api_key API Key API Key (Register here)

Test:


Docs:

  • This method broadcasts to all members of your TextMark group.
  • To send to individual members only, see the send_one_message method of this API package.
  • There are a number of ways to get members for your group.
  • The TextMark is put in each receiving user's context so that one and two char Contextual Responses (without keyword) are still directed to your TextMark. You may use this to broadcast multiple-choice questions, etc.
  • Broadcast messages are archived and may be retrieved via:
  • If you attempt to broadcast the same message to the same TextMark twice in succession within a day, receive error #2042 (ERR_REQUEST_ALREADY_DONE).

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//GroupLeader/broadcast_message/

More:

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