Package: GroupLeader - Broadcast and manage messages and members (... All packages)
This API package is for users who have been assigned "Group Leader" status on a specific TextMark and wish to broadcast messages, manage messages, manage members, etc. Each TextMark (identified by keyword) also represents a "group" with members who can communicate and coordinate with each other.
PLEASE NOTE: Currently the TextMark manager (the user who created the TextMark) is automatically assigned as the TextMark's group leader, and no additional leaders may be assigned. In the future, you will be able to appoint multiple group leaders.
All methods in this API package require both TextMarks authentication credentials (user nick or phone# and password/PIN) as well as the keyword of a TextMark for which that user is a group leader.
See RegisteredUser.create_textmark()
for how to create a TextMark, and
TextMarkManager.set_group_config()
for how to enable and configure group mode.
GET Methods:
-
members()(GET) - List users who have joined a TextMark group
-
has_member()(GET) - Check if specific user is member of a TextMark group
-
messages()(GET) - List recently posted group/TextMark messages
-
scheduled_broadcasts()(GET) - List pending scheduled alert broadcasts
POST Methods:
-
send_one_message()(POST) - Send text message to a single TextMark group member
-
broadcast_message()(POST) - Broadcast alert to all TextMark group members
-
schedule_broadcast()(POST) - Schedule a future broadcast alert to all TextMark group members
-
reschedule_broadcasts()(POST) - Batch upload and replace all scheduled broadcast alerts on keyword
-
broadcast_name_request()(POST) - Broadcast a name request to all TextMark group members
-
delete_message()(POST) - Delete a previously sent TextMark group message
-
unschedule_broadcast()(POST) - Cancel a scheduled future broadcast alert
-
kick_member()(POST) - Kick a user out of the group
-
copy_members()(POST) - Copy group members from another group