4.18h

TextMarks API V2 - AutoDoc: GroupLeader / schedule_broadcast()

Method: schedule_broadcast() (POST) - Schedule a future 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 datetime YYYY-MM-DD HH:MM:SS Date/Time (UTC) Date+Time to schedule broadcast
REQ tz String Time Zone of datetime specified (see docs)
REQ msg SMS Text Text message to broadcast
OPT api_key API Key API Key (Register here)

Test:


Docs:

  • This method schedules a future broadcast to all members of your TextMark group.
  • To send an immediate broadcast and for more information about broadcasting messages, see the broadcast_message() method of this API package.
  • See scheduled_broadcasts() to list currently scheduled broadcasts.
  • See unschedule_broadcast() to cancel scheduled alerts.
  • Only after the scheduled broadcast is actually sent does it appears like a regular broadcast (and can, e.g. be seen by GroupLeader.messages()).
  • The datetime param specifies the year, month, date, hours, and minutes for when the broadcast should go out. These values are interpreted as being in the time zone specified by tz, and are not UTC values (even though the automatic documentation indicates UTC).
  • The tz param determines how the datetime param is interpreted. It may be any of:
    • TZ_UTC
    • TZ_Pacific
    • TZ_Mountain
    • TZ_Central
    • TZ_Eastern
  • Scheduled delivery makes no guarantees of granularity below 15 minutes. Accurate timing is done on a best effort only.
  • If the time parameters are invalid or in the past, receive error #2010 (ERR_REQUEST_INVALID_PARAMS).

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/schedule_broadcast/

More:

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