latestSwagger 2.02026-08-101561322.2 MB

3e4029d19684

Scheduled Messages

Find scheduled messages

<a class="try-sandbox-link" href="https://sandbox.textmagic.com/#/Messages%3A%20Schedule%0A/searchScheduledMessages" target="_blank">Try in sandbox</a><br>

get/api/v2/schedules/search

Query parameters

pageinteger

Fetch specified results page.

limitinteger

The number of results per page.

querystring

Find messages by specified search query.

idsstring

Find schedules by ID(s).

status'x' | 'a' | 'c'

Fetch schedules with a specific status: a - actual, c - completed, x - all.

orderBy'id' | 'nextSend' | 'lastSend'

Order results by some field. Default is id.

direction'asc' | 'desc'

Order direction. Default is desc.

Response

Returned when successful.

pageinteger required

pageCountinteger required

The total number of pages.

limitinteger required

The number of results per page.

Example response

{
  "page": 1,
  "pageCount": 10,
  "limit": 10,
  "resources": [
    {
      "id": 562,
      "nextSend": "2014-10-13T05:00:00+0000",
      "rrule": "FREQ=DAILY;INTERVAL=2;COUNT=5;",
      "session": {
        "id": 4991,
        "startTime": "2015-06-19T09:48:24+0000",
        "text": "Hello {First name}!",
        "source": "O",
        "referenceId": "my_reference_id_4991",
        "price": 3.45,
        "numbersCount": 18,
        "destination": "t",
        "initiatorId": 305
      },
      "lastSent": "2015-06-19T09:48:24+0000",
      "contactName": "15 recipients",
      "parameters": {
        "text": "I Love Textmagic!",
        "recipients": {
          "contacts": [
            39318
          ],
          "groups": [
            39318
          ],
          "numbers": [
            "447860021130"
          ],
          "filteredViews": [
            39318
          ]
        }
      },
      "type": "once",
      "summary": "Every 2 weeks on Monday, Tuesday, Thursday at 10:30 (UTC+03:00)",
      "textParameters": {
        "cost": 0.04,
        "parts": 6,
        "chars": 125,
        "encoding": "ISO-8859-1",
        "countries": [
          "US"
        ],
        "charsetLabel": "ISO-8859-1"
      },
      "firstOccurrence": "2015-06-19T09:48:24+0000",
      "lastOccurrence": "2015-06-19T09:48:24+0000",
      "recipientsCount": 2,
      "timezone": "Europe/Tallinn",
      "completed": true,
      "avatar": "avatars/dummy_avatar.png",
      "createdAt": "2015-06-19T09:48:24+0000"
    }
  ]
}