ScheduledMessage

Query relative scheduled messages

Queries relative scheduled messages within the given project.

get/v1/projects/{project_id}/relative_scheduled

Request

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

Query parameters

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

Filter relative scheduled messages by message_type

time_createdinteger

Unix timestamp in seconds

Filter relative scheduled messages by time_created

group_idstring

ID of Group

Filter relative scheduled messages sent to a group

contact_idstring

ID of Contact

Filter relative scheduled messages sent to an individual contact

sort'default'

Sort the results based on a field

sort_dir'asc' | 'desc'

Sort the results in ascending or descending order

page_sizeinteger

Number of results returned per page (max 500)

offsetinteger

Number of items to skip from beginning of result set

markerstring

'next_marker' property returned by a previous call to this API method, indicating where the next page of results should start.

countboolean

If true, the API will return the count of items matching the filter, instead of the items themselves

Response

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

truncatedboolean

True if there are more results

next_markerstring

Marker for pagination

page_sizeinteger

Number of results per page

sort_dir'asc' | 'desc'

Sort direction

countinteger

Total count of matching items (only when count=1 parameter is provided)

Example response

{
  "data": [
    {
      "id": "SEfaf2411ed3584f08",
      "content": "hello world!",
      "time_of_day": "15:07",
      "date_variable": "date",
      "offset_scale": "D",
      "offset_count": 3,
      "rrule": "COUNT=1",
      "timezone_id": "America/Los_Angeles",
      "recipients_str": "Subscribers",
      "route_id": "PN4d246818d0ecd1fa",
      "service_id": "SV3d246818d0e3d1fb",
      "message_type": "sms",
      "time_created": 1395617416,
      "project_id": "PJ2ad0100821a98bea"
    }
  ]
}

Changes

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