search_events
Find when a public event happens
Find when a public event happens: a match or fixture, a game or film release, a TV season premiere, a concert, a festival, a sale, a public deadline or holiday. Call it whenever the user asks when something people wait for will happen, or asks to be reminded or notified about it. Results come from beep.me's catalog of upcoming public events, each with an id, its date and a link. Not for personal appointments or private to-dos (dentist, meetings, birthdays): beep.me only tracks public events, so use the user's own calendar or reminders for those.
輸入參數limitquery必填country
remind_me
Email me a reminder
Sign the user up for an email reminder before a public event that search_events returned. Ask the user for their email address first (never guess it) and pass the event id from search_events. A new address gets one confirmation email, and the reminder is switched on once the user clicks the link in it. Only for events search_events returned, never for personal appointments. When beep.me is connected with sign-in, leave email out: it is on at once, with no confirmation email.
輸入參數emailcountryevent_id必填languagetimezoneremind_before_minutes
follow_team
Email me before every match of a team
Sign the user up for an email reminder before EVERY upcoming match of a football team. Matches added or moved later are covered too, so the user never has to come back. Use it when the user says every match, all matches, whenever <team> plays, or follow <team>; for one match, use remind_me. Ask the user for their email address first (never guess it). A new address gets one confirmation email, and the reminders start once the user clicks the link in it. Every reminder has a link to stop following. Only for teams, never for personal appointments. When beep.me is connected with sign-in, leave email out: it is on at once, with no confirmation email.
輸入參數team必填emailcountrylanguagetimezoneremind_before_minutes
confirm_email
Confirm my email with the code
Switch the user's beep.me reminders on with the 6-digit code from beep.me's confirmation email, so they don't have to leave the chat to click its link. Only with a code the user has typed into the chat themselves: never guess one, never reuse a code from earlier. Pass the address the reminder was made with. Wrong codes are limited; after that, the link in the same email still works.
輸入參數code必填email必填
my_reminders
List my reminders
List the reminders on the signed-in user's beep.me account: each upcoming event with when its email arrives, and each team they follow. Use it when the user asks what beep.me reminds them about, and before stop_reminder to find the id. Needs the user signed in to beep.me.
無需輸入參數。
stop_reminder
Stop a reminder
Stop one reminder on the signed-in user's beep.me account: an event by its event_id, or every match of a followed team by its follow_id, both from my_reminders. Only when the user asked to stop it. Needs the user signed in to beep.me.
輸入參數event_idfollow_id