v1

latestOpenAPI 3.0.02026-07-2447166133.5 KB
Scheduled Messages

List any messages scheduled for the organization

This operation lists the messages that are scheduled to be sent from the organization.

get/scheduledmessages

Query parameters

paginationTokenstring

Token given in a previous response to allow requesting the next page

Example:abcdefghijklmnop

Response

An array of messages that are scheduled for the organization

hasMoreboolean required
paginationTokenstring

Token given in a previous response to allow requesting the next page

totalCountinteger required

Example response

{
  "paginationToken": "abcdefghijklmnop",
  "scheduledMessages": [
    {
      "conversationId": "t_0E5QDGJC03000",
      "createdAt": "2020-04-01T00:00:00Z",
      "id": "scm_26RRC7PQ6JG00",
      "message": {
        "attachments": [
          {
            "data": {
              "mimetype": "audio/mpeg"
            },
            "title": "example.pdf"
          }
        ],
        "text": "Can you look at this @Dr. Smith?"
      },
      "modifiedAt": "2020-04-01T00:00:00Z",
      "scheduledToSendAt": "2020-04-01T00:00:00Z",
      "sendAsInternalMemberId": "entity_0D4QABCC06000"
    }
  ],
  "totalCount": 750
}