ScheduledMessage

Get scheduled message by ID

Retrieves the scheduled message with the given ID.

get/v1/projects/{project_id}/scheduled/{id}

Request

  • Base URL: https://api.telerivet.com
  • URL: https://api.telerivet.com/v1/projects/{project_id}/scheduled/{id}
  • 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

idstring required

ID of the scheduled message

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.