ScheduledMessage

Schedule a message

Schedules a message to a group or single contact. Note that Telerivet only sends scheduled messages approximately once every 15 seconds, so it is not possible to control the exact second at which a scheduled message is sent.

Only one of the parameters group_id, to_number, and contact_id should be provided.

With message_type=service, schedules an automated service (such as a poll) to be invoked for a group or an individual contact. Any service that can be triggered for a contact can be scheduled via this method, whether or not the service actually sends a message.

post/v1/projects/{project_id}/scheduled

Request

  • Base URL: https://api.telerivet.com
  • URL: https://api.telerivet.com/v1/projects/{project_id}/scheduled
  • Auth: one of:
    • HTTP basic
    • OAuth 2 (authorization code, authorization URL https://telerivet.com/oauth/authorize, token URL https://api.telerivet.com/oauth/token)

Path parameters

project_idstring required

ID of the Project

Request body

message_type'text' | 'sms' | 'mms' | 'ussd' | 'call' | 'chat' | 'service'

Type of message to send

contentstring

Content of the message to schedule

group_idstring

ID of the group to send the message to

to_numberstring

Phone number to send the message to

contact_idstring

ID of the contact to send the message to

start_timeinteger

The time that the message will be sent (or first sent for recurring messages)

start_time_offsetinteger

Number of seconds from now until the message is sent

rrulestring

A recurrence rule describing the how the schedule repeats, e.g. 'FREQ=MONTHLY' or 'FREQ=WEEKLY;INTERVAL=2'; see https://tools.ietf.org/html/rfc2445#section-4.3.10. (UNTIL is ignored; use end_time parameter instead).

route_idstring

ID of the phone or route to send the message from

service_idstring

Service to invoke for each recipient (when message_type is call or service)

audio_urlstring

The URL of an MP3 file to play when the contact answers the call (when message_type is call).

If audio_url is provided, the text-to-speech voice is not used to say content, although you can optionally use content to indicate the script for the audio.

For best results, use an MP3 file containing only speech. Music is not recommended because the audio quality will be low when played over a phone line.

tts_lang'en-US' | 'en-GB' | 'en-GB-WLS' | 'en-AU' | 'en-IN' | 'da-DK' | 'nl-NL' | 'fr-FR' | 'fr-CA' | 'de-DE' | 'is-IS' | 'it-IT' | 'pl-PL' | 'pt-BR' | 'pt-PT' | 'ru-RU' | 'es-ES' | 'es-US' | 'sv-SE'

The language of the text-to-speech voice (when message_type is call)

tts_voice'female' | 'male'

The name of the text-to-speech voice (when message_type=call)

track_clicksboolean

If true, URLs in the message content will automatically be replaced with unique short URLs.

short_link_paramsobject

If track_clicks is true, short_link_params may be used to specify custom parameters for each short link in the message. The following parameters are supported:

domain (string): A custom short domain name to use for the short links. The domain name must already be registered for your project or organization.

expiration_sec (integer): The number of seconds after the message is created (queued to send) when the short links will stop forwarding to the destination URL. If null, the short links will not expire.

replace_variablesboolean

Set to true to evaluate variables like [[contact.name]] in message content. (See available variables)

route_paramsobject

Route-specific parameters to use when sending the message.

When sending messages via chat apps such as WhatsApp, the route_params parameter can be used to send messages with app-specific features such as quick replies and link buttons.

For more details, see Route-Specific Parameters.

label_idsstring

Array of IDs of labels to add to the sent messages (maximum 5). Does not apply when message_type=service, since the labels are determined by the service itself.

timezone_idstring

TZ database timezone ID; see List of tz database time zones Wikipedia article.

end_timeinteger

Time after which a recurring message will stop (not applicable to non-recurring scheduled messages)

end_time_offsetinteger

Number of seconds from now until the recurring message will stop

varsobject

Custom variables to set for this scheduled message, which will be copied to each message sent from this scheduled message

Example request

{
  "content": "Reminder!",
  "to_number": "+16505550234",
  "start_time_offset": 86400
}

Response

Successful response

idstring

ID of the scheduled message

contentstring

Text content of the scheduled message

rrulestring

Recurrence rule for recurring scheduled messages, e.g. 'FREQ=MONTHLY' or 'FREQ=WEEKLY;INTERVAL=2'; see RFC2445.

timezone_idstring

Timezone ID used to compute times for recurring messages; see List of tz database time zones Wikipedia article.

recipientsobject[]

List of recipients. Each recipient is an object with a string type property, which may be "phone_number", "group", or "filter".

If the type is "phone_number", the phone_number property will be set to the recipient's phone number.

If the type is "group", the group_id property will be set to the ID of the group, and the group_name property will be set to the name of the group.

If the type is "filter", the filter_type property (string) and filter_params property (object) describe the filter used to send the broadcast. (API clients should not rely on a particular value or format of the filter_type or filter_params properties, as they may change without notice.)

recipients_strstring

A string with a human readable description of the first few recipients (possibly truncated)

group_idstring

ID of the group to send the message to (null if the recipient is an individual contact, or if there are multiple recipients)

contact_idstring

ID of the contact to send the message to (null if the recipient is a group, or if there are multiple recipients)

to_numberstring

Phone number to send the message to (null if the recipient is a group, or if there are multiple recipients)

route_idstring

ID of the phone or route the message will be sent from

service_idstring

The service associated with this message (for voice calls, the service defines the call flow)

audio_urlstring

For voice calls, the URL of an MP3 file to play when the contact answers the call

tts_lang'en-US' | 'en-GB' | 'en-GB-WLS' | 'en-AU' | 'en-IN' | 'da-DK' | 'nl-NL' | 'fr-FR' | 'fr-CA' | 'de-DE' | 'is-IS' | 'it-IT' | 'pl-PL' | 'pt-BR' | 'pt-PT' | 'ru-RU' | 'es-ES' | 'es-US' | 'sv-SE'

For voice calls, the language of the text-to-speech voice

tts_voice'female' | 'male'

For voice calls, the text-to-speech voice

message_type'sms' | 'mms' | 'ussd' | 'ussd_session' | 'call' | 'chat' | 'service'

Type of scheduled message

time_createdinteger

Time the scheduled message was created in Telerivet

start_timeinteger

The time that the message will be sent (or first sent for recurring messages)

end_timeinteger nullable

Time after which a recurring message will stop (not applicable to non-recurring scheduled messages)

prev_timeinteger nullable

The most recent time that Telerivet has sent this scheduled message (null if it has never been sent)

next_timeinteger nullable

The next upcoming time that Telerivet will sent this scheduled message (null if it will not be sent again)

occurrencesinteger

Number of times this scheduled message has already been sent

pending_reviewboolean

True if Message Review is enabled for this project and this scheduled message is awaiting approval by a reviewer. It will not be sent unless it is approved before its scheduled time; if it has no scheduled time, it will be sent immediately upon approval.

replace_variablesboolean

Set to true if Telerivet will render variables like [[contact.name]] in the message content, false otherwise

track_clicksboolean

If true, URLs in the message content will automatically be replaced with unique short URLs

route_paramsobject nullable

Route-specific parameters to use when sending the message.

When sending messages via chat apps such as WhatsApp, the route_params parameter can be used to send messages with app-specific features such as quick replies and link buttons.

For more details, see Route-Specific Parameters.

varsobject

Custom variables stored for this scheduled message (copied to Message when sent). Variable names may be up to 32 characters in length and can contain the characters a-z, A-Z, 0-9, and _. Values may be strings, numbers, or boolean (true/false). String values may be up to 4096 bytes in length when encoded as UTF-8. Up to 100 variables are supported per object. Setting a variable to null will delete the variable.

label_idsstring

IDs of labels to add to the Message

relative_scheduled_idstring

ID of the relative scheduled message this scheduled message was created from, if applicable

project_idstring

ID of the project this scheduled message belongs to

is_templateboolean

Set to true if Telerivet will render variables like [[contact.name]] in the message content

Example response

{
  "id": "SEfaf2411ed3584f08",
  "content": "hello world!",
  "rrule": "COUNT=1",
  "timezone_id": "America/Los_Angeles",
  "recipients_str": "+16505550123, Subscribers",
  "route_id": "PN4d246818d0ecd1fa",
  "service_id": "SV3d246818d0e3d1fb",
  "message_type": "sms",
  "time_created": 1395617416,
  "start_time": 1395617516,
  "next_time": 1395617516,
  "relative_scheduled_id": "PJ2ad0100821a98bea",
  "project_id": "PJ2ad0100821a98bea"
}

Changes

No recorded changes to this operation across all 1 revision of this API.