Get mass message

Get details of a specific mass message

Permission Required: messages:read

GET /v2/access/mass-messages/:massMessageId

Get mass message

cURL

curl --request GET \
  --url https://api.ofauth.com/v2/access/mass-messages/:massMessageId \
  --header 'apiKey: <api-key>' \
  --header 'x-connection-id: <api-key>'

200

{
  "id": 123,
  "text": "<string>",
  "fromUser": {
    "id": 123,
    "name": "<string>"
  },
  "media": [
    {
      "id": 123,
      "convertedToVideo": true,
      "canView": true,
      "hasError": true,
      "createdAt": "<string>",
      "isReady": true,
      "releaseForms": [
        {
          "id": 123,
          "name": "<string>",
          "partnerSource": "<string>",
          "type": "<string>",
          "user": {
            "view": "<string>",
            "id": 123,
            "name": "<string>",
            "username": "<string>",
            "isVerified": true,
            "avatar": "<string>",
            "avatarThumbs": {
              "c50": "<string>",
              "c144": "<string>"
            },
            "ivStatus": "<string>",
            "isFromGuest": true
          }
        }
      ],
      "duration": 123,
      "hasCustomPreview": true,
      "videoSources": {
        "240": "<string>",
        "720": "<string>"
      },
      "files": {
        "full": {
          "url": "<string>",
          "sources": [
            {
              "url": "<string>",
              "width": 123,
              "height": 123,
              "type": "<string>"
            }
          ],
          "width": 123,
          "height": 123,
          "size": 123
        },
        "thumb": {
          "url": "<string>",
          "width": 123,
          "height": 123,
          "size": 123
        },
        "preview": {
          "url": "<string>",
          "options": [
            {
              "url": "<string>",
              "width": 123,
              "height": 123,
              "type": "<string>"
            }
          ],
          "width": 123,
          "height": 123,
          "size": 123
        },
        "squarePreview": {
          "url": "<string>",
          "width": 123,
          "height": 123,
          "size": 123
        }
      }
    }
  ],
  "previews": [
    123
  ],
  "isMediaReady": true,
  "mediaCount": 123,
  "lockedText": true,
  "responseType": "<string>",
  "giphyId": "<string>",
  "isFree": true,
  "isTip": true,
  "isReportedByMe": true,
  "isCouplePeopleMedia": true,
  "queueId": 123,
  "isMarkdownDisabled": true,
  "releaseForms": null,
  "isFromQueue": true,
  "canUnsendQueue": true,
  "unsendSecondsQueue": 123,
  "isOpened": true,
  "isNew": true,
  "createdAt": "<string>",
  "changedAt": "<string>",
  "cancelSeconds": 123,
  "isLiked": true,
  "canPurchase": true,
  "canPurchaseReason": "<string>",
  "canReport": true,
  "canBePinned": true,
  "isPinned": true
}

Authorizations

apiKey · string · header · required

Your OFAuth API key for authenticating requests.

x-connection-id · string · header · required

Requires a connection via the x-connection-id header.

Path Parameters

massMessageId · string · required

Response

200

application/json

Successful response

id · number · required

text · string · required

fromUser · object · required

Option 1

Option 2

Show child attributes

media · object[] · required

Show child attributes

previews · number[] · required

isMediaReady · boolean

mediaCount · number

lockedText · boolean

responseType · string

giphyId · string | null

isFree · boolean

isTip · boolean

isReportedByMe · boolean

isCouplePeopleMedia · boolean

queueId · number

isMarkdownDisabled · boolean

releaseForms · unknown

isFromQueue · boolean

canUnsendQueue · boolean

unsendSecondsQueue · number

isOpened · boolean

isNew · boolean

createdAt · string

changedAt · string

cancelSeconds · number

isLiked · boolean

canPurchase · boolean

canPurchaseReason · string

canReport · boolean

canBePinned · boolean

isPinned · boolean