4.18j

TextMarks API V2 - AutoDoc: GroupLeader / broadcast_name_request()

Method: broadcast_name_request() (POST) - Broadcast a name request 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
OPT api_key API Key API Key (Register here)

Test:


Docs:

  • This method broadcasts a standard name request to all members of your TextMark group.
  • Each user will receive a question by SMS asking for his or her name. The user can respond with a name, and that name is set on his or her account and is visible in most message and subscriber reports.
  • If you try to broadcast more than one name request for the same TextMark in a 15 minute period, receive error #2042 (ERR_REQUEST_ALREADY_DONE).
  • To broadcast a custom message to all members, see the broadcast_message method of this API package.
  • To send to individual members only, see the send_one_message method of this API package.

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

More:

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