Get Message

GET /api/v1.0/messages/{message_id}

This endpoint fetch more details about the message.

Path parameters

  • message_id string Required

Responses

  • 200 application/json

    Success Response

    Hide response attributes Show response attributes object
    • id string Required

      Message Id

    • type string Required

      Message Type

    • subtype string Required

      Sub Type

    • text string Required

      Message text

    • url string Required

      URL

    • chat string Required

      Chat Id

    • thread string Required

      Thread

    • task string Required

      Task Id

    • file string Required

      File

    • document string Required

      Document Id

    • entity_key string Required

      Entity Key

    • author string Required

      Author Id

    • replies number Required

      No of Replies

    • repliers array[string] Required

      List of Replier Id

    • tagged array[string] Required

      List of tagged

    • seen_by array[string] Required

      List of Seen by Id

    • hidden array[string] Required

      Hidden

    • doc_attachment string Required

      Document Attachment

    • attachments array[object] Required
      Hide attachments attributes Show attachments attributes object
      • id string Required
      • name string Required
      • size number Required
      • url string Required
      • download string Required
      • thumbnail string Required
      • uploader string Required
      • comments number Required
      • created_at string(date-time) Required
      • googleId string Required
      • googleType string Required
      • processed boolean Required
    • is_edited boolean Required

      Is Edited

    • is_deleted boolean Required

      Is Deleted

    • created_at string(date-time) Required

      Created At

    • updated_at string(date-time) Required

      Updated At

    • annotation_id string Required

      Annottion Id

    • heardBy array[string] Required

      Heard By

    • audio_duration number Required

      Audio duration

    • heard boolean Required

      Is Heard

  • 401

    The client request has not been completed because it lacks valid authentication credentials for the requested resource.

  • 403

    The client does not have access rights to the content.

  • 405

    The request method is known by the server but is not supported by the target resource.

GET /api/v1.0/messages/{message_id}
curl \
 --request GET 'https://openapi.niftypm.com/api/v1.0/messages/{message_id}' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200)
{
  "id": "string",
  "type": "string",
  "hide_link_preview": true,
  "subtype": "string",
  "text": "string",
  "url": "string",
  "chat": "string",
  "thread": "string",
  "task": "string",
  "file": "string",
  "document": "string",
  "entity_key": "string",
  "author": "string",
  "replies": 42.0,
  "repliers": [
    "string"
  ],
  "tagged": [
    "string"
  ],
  "seen_by": [
    "string"
  ],
  "hidden": [
    "string"
  ],
  "doc_attachment": "string",
  "attachments": [
    {
      "id": "string",
      "name": "string",
      "size": 42.0,
      "url": "string",
      "download": "string",
      "thumbnail": "string",
      "uploader": "string",
      "comments": 42.0,
      "created_at": "2025-05-04T09:42:00Z",
      "googleId": "string",
      "googleType": "string",
      "processed": true
    }
  ],
  "is_edited": true,
  "is_deleted": true,
  "created_at": "2025-05-04T09:42:00Z",
  "updated_at": "2025-05-04T09:42:00Z",
  "annotation_id": "string",
  "heardBy": [
    "string"
  ],
  "audio_duration": 42.0,
  "heard": true
}