Nifty Developer API

Get Messages

GET /api/v1.0/messages

Bearer

This endpoint fetch the list of recent messages.

Query parameters

chat_id string

Chat ID
message_id string

Message ID
task_id string

Task ID
file_id string

File ID
doc_id string

Document ID
entity_key string

Entity Key
limit string

No of records per page
offset string

Record Offset
before_id string

Before ID
after_id string

After ID
before_date string

Before Date
after_date string

After Date
annotation_id string

Annotation ID
type string

Type
useCache boolean

Use Cache

Responses

• 200

Success Response
Hide response attributes Show response attributes object
- messages array[object] Required
  
  List of messages
  
  Hide messages attributes Show messages attributes
  
  id string Required
  
  Message Id
  
  type string Required
  
  Message Type
  
  hide_link_preview boolean Required
  
  Hide Link Preview
  
  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
  
  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
- has_more boolean Required
  
  Has more row flag
• 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

curl \
 -X GET https://openapi.niftypm.com/api/v1.0/messages \
 -H "Authorization: Bearer $ACCESS_TOKEN"

Response examples (200)

{
  "messages": [
    {
      "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": "2023-05-04T09:42:00+00:00",
          "googleId": "string",
          "googleType": "string",
          "processed": true
        }
      ],
      "is_edited": true,
      "is_deleted": true,
      "created_at": "2023-05-04T09:42:00+00:00",
      "updated_at": "2023-05-04T09:42:00+00:00",
      "annotation_id": "string",
      "heardBy": [
        "string"
      ],
      "audio_duration": 42.0,
      "heard": true
    }
  ],
  "has_more": true
}