---
title: "Query scheduled messages for a contact"
method: GET
path: "/v1/projects/{project_id}/contacts/{id}/scheduled"
tags: ["Contact"]
---

# Query scheduled messages for a contact

`GET /v1/projects/{project_id}/contacts/{id}/scheduled`

## Request

- Base URL: `https://api.telerivet.com`
- URL: `https://api.telerivet.com/v1/projects/{project_id}/contacts/{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`)

Queries messages scheduled to this contact (not including messages scheduled to groups that this contact is a member of)

## Path parameters

- `project_id` string, required
- `id` string, required

## Query parameters

- `message_type` 'sms' | 'mms' | 'ussd' | 'ussd_session' | 'call' | 'chat' | 'service'
- `time_created` integer: Unix timestamp in seconds
- `next_time` integer: Unix timestamp in seconds
- `relative_scheduled_id` string: ID of RelativeScheduledMessage
- `pending_review` boolean
- `sort` 'default' | 'next_time'
- `sort_dir` 'asc' | 'desc'
- `page_size` integer
- `offset` integer
- `marker` string
- `count` boolean

## Response `200`

Successful response. When count=1 parameter is provided, returns {"count": N} instead.

- object
  - `data` ScheduledMessage[]: Array of results (omitted when count=1)
    - `id` string: ID of the scheduled message
    - `content` string: Text content of the scheduled message
    - `rrule` string: Recurrence rule for recurring scheduled messages, e.g. 'FREQ=MONTHLY' or 'FREQ=WEEKLY;INTERVAL=2'; see [RFC2445](https://tools.ietf.org/html/rfc2445#section-4.3.10).
    - `timezone_id` string: Timezone ID used to compute times for recurring messages; see [List of tz database time zones Wikipedia article](http://en.wikipedia.org/wiki/List_of_tz_database_time_zones).
    - `recipients` object[]: 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_str` string: A string with a human readable description of the first few recipients (possibly truncated)
    - `group_id` string: ID of the group to send the message to (null if the recipient is an individual contact, or if there are multiple recipients)
    - `contact_id` string: ID of the contact to send the message to (null if the recipient is a group, or if there are multiple recipients)
    - `to_number` string: Phone number to send the message to (null if the recipient is a group, or if there are multiple recipients)
    - `route_id` string: ID of the phone or route the message will be sent from
    - `service_id` string: The service associated with this message (for voice calls, the service defines the call flow)
    - `audio_url` string: 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_created` integer: Time the scheduled message was created in Telerivet
    - `start_time` integer: The time that the message will be sent (or first sent for recurring messages)
    - `end_time` integer, nullable: Time after which a recurring message will stop (not applicable to non-recurring scheduled messages)
    - `prev_time` integer, nullable: The most recent time that Telerivet has sent this scheduled message (null if it has never been sent)
    - `next_time` integer, nullable: The next upcoming time that Telerivet will sent this scheduled message (null if it will not be sent again)
    - `occurrences` integer: Number of times this scheduled message has already been sent
    - `pending_review` boolean: 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_variables` boolean: Set to true if Telerivet will render variables like [[contact.name]] in the message content, false otherwise
    - `track_clicks` boolean: If true, URLs in the message content will automatically be replaced with unique short URLs
    - `media` object[]: Array of media attachments for the text message. This property is undefined for messages that do not contain media files.
      - `url` string: URL of the media file. Note: For files stored by Telerivet (including uploaded files and incoming media attachments), the URL is temporary and may not be valid for more than 1 day.
      - `type` string: MIME type of the media file, or `route_vcard` for the Contact Card of the sending route in a message that has not been sent yet (in which case the other properties are null)
      - `filename` string: Original filename
      - `size` integer: File size in bytes
      - `file_id` string: ID of the stored file, if applicable
    - `route_params` object, 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.
    - `variants` object[], nullable: Alternative message bodies used instead of the default message body when their conditions match. Allows sending different message bodies depending on the route that sends the message, or the contact that the message is sent to. Each variant has conditions and its own message body. When each message is sent, the first variant whose conditions match is used instead of the default message body; if no variant matches, the default message body is used. A variant replaces the entire message body: content, media, route_params, track_clicks and short_link_params that are not specified in the variant are empty, not inherited from the default message body. Conditions are evaluated when the message is sent by a particular basic route, and can use the same variables as outgoing message content: contact variables such as [[contact.name]] and [[contact.vars.\*]], [[to_number]], [[time]], [[project.\*]], and variables of the basic route sending the message: [[phone.type]] (e.g. whatsapp), [[phone.id]], [[phone.vars.\*]], and [[phone.supports_quick_replies]], [[phone.supports_link_button]], [[phone.supports_native_attachments]] (1 if the route supports the feature, otherwise 0). Variables may include filters, e.g. [[contact.vars.language|default:"en"]]. For all available variables, see the [Variable Reference](https://telerivet.com/api/rest#variables). For A/B testing, a variant can have a random split (split_percent) so that it is only used for a random percentage of recipients, e.g. a single variant with split_percent 50 is used for about half of the recipients, and the default message body for the others. A random split can be combined with other conditions to run separate A/B tests for different routes or contacts. Since the first matching variant is used, list more specific variants before more general ones. For example, a variant with a condition `[[contact.vars.language]] is 'fr'` and split_percent 50 must be listed before a variant with only the condition `[[contact.vars.language]] is 'fr'`. Up to 10 variants are supported, each with up to 5 conditions.
      - `conditions` object[]: Conditions for using this variant (up to 5). Required unless the variant has a `split_percent`.
        - `variable` string: Variable to compare (required except when condition type is `contact_is_in_group` or `contact_not_in_group`), surrounded by double square brackets, e.g. `[[phone.type]]` or `[[contact.vars.lang]]`
        - `type` string, required: Type of condition
        - `value` string, required: Value to compare with the variable, or the group name if the condition type is `contact_is_in_group` or `contact_not_in_group`
      - `op` string: Operator to join multiple conditions: `and` (default) or `or`. If `split_percent` is specified, `or` is not supported.
      - `split_percent` integer: For A/B testing, the approximate percentage of recipients (1-100) randomly selected for this variant. Each variant with a `split_percent` is used for a separate random group of recipients, and recipients not selected for any variant receive the default message body (e.g. a single variant with a `split_percent` of 50 is used for about half of the recipients). Recipients are assigned to groups deterministically, so each contact is in the same group for all messages in the same broadcast or campaign. The total `split_percent` of all variants with the same conditions can be at most 100. If `split_percent` is omitted, the variant is used for all recipients that match its conditions.
      - `content` string: Content of the message when this variant is used
      - `media` object[]: Array of media attachments when this variant is used (same format as the `media` parameter)
      - `route_params` object: Route-specific parameters when this variant is used
      - `track_clicks` boolean: Whether to shorten links and track link clicks when this variant is used
      - `short_link_params` object: Parameters for short links when `track_clicks` is enabled (same format as the `short_link_params` parameter)
    - `vars` object: 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_ids` string: IDs of labels to add to the Message
    - `relative_scheduled_id` string: ID of the relative scheduled message this scheduled message was created from, if applicable
    - `project_id` string: ID of the project this scheduled message belongs to
    - `is_template` boolean: Set to true if Telerivet will render variables like [[contact.name]] in the message content
  - `truncated` boolean: True if there are more results
  - `next_marker` string: Marker for pagination
  - `page_size` integer: Number of results per page
  - `sort_dir` 'asc' | 'desc': Sort direction
  - `count` integer: Total count of matching items (only when count=1 parameter is provided)

## Other responses

- `400`: Invalid request parameters
- `401`: Invalid or missing API key or Bearer token
- `404`: Resource not found

---

[API](https://skmtc.dev/telerivet/apis/telerivet-api.md) · [All operations](https://skmtc.dev/telerivet/apis/telerivet-api/llms.txt) · [OpenAPI document](https://skmtc.dev/telerivet/apis/telerivet-api/revisions/4e14b1c8d917?raw)