Messages

Get Messages

GET

https://openapi.niftypm.com

/api/v1.0/messages

This endpoint fetch the list of recent messages.

Get 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

Example: 25

offset

string

Record Offset

Example: 0

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

Get Messages › Responses

Success Response

GetMessagesResponse

MessageResponse[] · required

List of messages

has_more

boolean · required

Has more row flag

GET/api/v1.0/messages

curl https://openapi.niftypm.com/api/v1.0/messages \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "messages": [
    {
      "id": "id",
      "type": "type",
      "hide_link_preview": true,
      "subtype": "subtype",
      "text": "text",
      "url": "url",
      "chat": "chat",
      "thread": "thread",
      "task": "task",
      "file": "file",
      "document": "document",
      "entity_key": "entity_key",
      "author": "author",
      "replies": 0,
      "repliers": [
        "string"
      ],
      "tagged": [
        "string"
      ],
      "seen_by": [
        "string"
      ],
      "hidden": [
        "string"
      ],
      "doc_attachment": "doc_attachment",
      "attachments": [
        {
          "id": "id",
          "name": "name",
          "size": 0,
          "url": "url",
          "download": "download",
          "thumbnail": "thumbnail",
          "uploader": "uploader",
          "comments": 0,
          "created_at": "2024-08-25T15:00:00Z",
          "googleId": "googleId",
          "googleType": "googleType",
          "processed": true
        }
      ],
      "is_edited": true,
      "is_deleted": true,
      "created_at": "2024-08-25T15:00:00Z",
      "updated_at": "2024-08-25T15:00:00Z",
      "annotation_id": "annotation_id",
      "heardBy": [
        "string"
      ],
      "audio_duration": 0,
      "heard": true
    }
  ],
  "has_more": true
}

json

application/json

Create Message

POST

https://openapi.niftypm.com

/api/v1.0/messages

This endpoint creates a new message.

Create Message › Request Body

CreateMessageDto

type

string · required

Message Type

text

string · required

Message Text

url

string · required

URL

doc_attachment

string · required

Document Attachment

entity_key

string · required

Entity Key

chat_id

string · required

Chat ID

message_id

string · required

Message ID

task_id

string · required

Task ID

file_id

string · required

File ID

doc_id

string · required

Document ID

task

object

Task Details

external_files

string[]

List of External files

nifty_files

string[]

List of Nifty Files

date

string · date-time

Date

bot_name

string

BOT Name

bot_avatar

string

BOT Avtar

hidden

string[]

Hidden

emails

string

Emails

annotation_id

string

Annotation ID

context_text

string

Context Text

audio_duration

string

Audion Duration

Create Message › Responses

The resource created successfully

CreateMessageResponse

message

string · required

data

object · required

POST/api/v1.0/messages

curl https://openapi.niftypm.com/api/v1.0/messages \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "type": "type",
  "text": "text",
  "url": "url",
  "doc_attachment": "doc_attachment",
  "entity_key": "entity_key",
  "chat_id": "chat_id",
  "message_id": "message_id",
  "task_id": "task_id",
  "file_id": "file_id",
  "doc_id": "doc_id",
  "task": {},
  "external_files": [
    "string"
  ],
  "nifty_files": [
    "string"
  ],
  "date": "2024-08-25T15:00:00Z",
  "bot_name": "bot_name",
  "bot_avatar": "bot_avatar",
  "hidden": [
    "string"
  ],
  "emails": "emails",
  "annotation_id": "annotation_id",
  "context_text": "context_text",
  "audio_duration": "audio_duration"
}'

Example Request Body

{
  "type": "type",
  "text": "text",
  "url": "url",
  "doc_attachment": "doc_attachment",
  "entity_key": "entity_key",
  "chat_id": "chat_id",
  "message_id": "message_id",
  "task_id": "task_id",
  "file_id": "file_id",
  "doc_id": "doc_id",
  "task": {},
  "external_files": [
    "string"
  ],
  "nifty_files": [
    "string"
  ],
  "date": "2024-08-25T15:00:00Z",
  "bot_name": "bot_name",
  "bot_avatar": "bot_avatar",
  "hidden": [
    "string"
  ],
  "emails": "emails",
  "annotation_id": "annotation_id",
  "context_text": "context_text",
  "audio_duration": "audio_duration"
}

json

Example Responses

{
  "message": "message",
  "data": {}
}

json

application/json

Get Message

GET

https://openapi.niftypm.com

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

This endpoint fetch more details about the message.

Get Message › path Parameters

message_id

string · required

Get Message › Responses

Success Response

MessageResponse

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

string[] · required

List of Replier Id

tagged

string[] · required

List of tagged

seen_by

string[] · required

List of Seen by Id

hidden

string[] · required

Hidden

doc_attachment

string · required

Document Attachment

FileChildResponse[] · 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

string[] · required

Heard By

audio_duration

number · required

Audio duration

heard

boolean · required

Is Heard

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

curl https://openapi.niftypm.com/api/v1.0/messages/:message_id \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "id": "id",
  "type": "type",
  "hide_link_preview": true,
  "subtype": "subtype",
  "text": "text",
  "url": "url",
  "chat": "chat",
  "thread": "thread",
  "task": "task",
  "file": "file",
  "document": "document",
  "entity_key": "entity_key",
  "author": "author",
  "replies": 0,
  "repliers": [
    "string"
  ],
  "tagged": [
    "string"
  ],
  "seen_by": [
    "string"
  ],
  "hidden": [
    "string"
  ],
  "doc_attachment": "doc_attachment",
  "attachments": [
    {
      "id": "id",
      "name": "name",
      "size": 0,
      "url": "url",
      "download": "download",
      "thumbnail": "thumbnail",
      "uploader": "uploader",
      "comments": 0,
      "created_at": "2024-08-25T15:00:00Z",
      "googleId": "googleId",
      "googleType": "googleType",
      "processed": true
    }
  ],
  "is_edited": true,
  "is_deleted": true,
  "created_at": "2024-08-25T15:00:00Z",
  "updated_at": "2024-08-25T15:00:00Z",
  "annotation_id": "annotation_id",
  "heardBy": [
    "string"
  ],
  "audio_duration": 0,
  "heard": true
}

json

application/json

Update Message

PUT

https://openapi.niftypm.com

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

This endpoint update the message.

Update Message › path Parameters

message_id

string · required

Message ID

Update Message › Request Body

EditMessageDto

text

string

Message Text

object[]

List of External Files

hide_link_preview

boolean

Hide link preview

nifty_files

string[]

List of Nifty Files

Update Message › Responses

Success Response

No data returned

Remove Message

DELETE

https://openapi.niftypm.com

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

This endpoint removes the message.

Remove Message › path Parameters

message_id

string · required

Message ID

Remove Message › Responses

The record has been updated successfully.

DeleteMessageResponse

message_id

string · required

Message ID

message

string · required

Message

Mark Message seen

POST

https://openapi.niftypm.com

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

This endpoint marks the message as seen by the member.

Mark Message seen › path Parameters

message_id

string · required

Message ID

Mark Message seen › Responses

The resource created successfully

SeeMessageResponse

message_ids

string[] · required

List of all message id

message

string · required

Message

Mark Message heard

POST

https://openapi.niftypm.com

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

This endpoint marks the message as heard by the member.

Mark Message heard › path Parameters

message_id

string · required

Message ID

Mark Message heard › Responses

The resource created successfully

HearMessageResponse

message_id

string · required

Message ID

message

string · required

Message

Members Milestones & Lists

Nifty API v1.0

Messages

Get Messages

GET

https://openapi.niftypm.com

/api/v1.0/messages

This endpoint fetch the list of recent messages.

Get 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

Example: 25

offset

string

Record Offset

Example: 0

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

Get Messages › Responses

Success Response

GetMessagesResponse

MessageResponse[] · required

List of messages

has_more

boolean · required

Has more row flag

GET/api/v1.0/messages

curl https://openapi.niftypm.com/api/v1.0/messages \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "messages": [
    {
      "id": "id",
      "type": "type",
      "hide_link_preview": true,
      "subtype": "subtype",
      "text": "text",
      "url": "url",
      "chat": "chat",
      "thread": "thread",
      "task": "task",
      "file": "file",
      "document": "document",
      "entity_key": "entity_key",
      "author": "author",
      "replies": 0,
      "repliers": [
        "string"
      ],
      "tagged": [
        "string"
      ],
      "seen_by": [
        "string"
      ],
      "hidden": [
        "string"
      ],
      "doc_attachment": "doc_attachment",
      "attachments": [
        {
          "id": "id",
          "name": "name",
          "size": 0,
          "url": "url",
          "download": "download",
          "thumbnail": "thumbnail",
          "uploader": "uploader",
          "comments": 0,
          "created_at": "2024-08-25T15:00:00Z",
          "googleId": "googleId",
          "googleType": "googleType",
          "processed": true
        }
      ],
      "is_edited": true,
      "is_deleted": true,
      "created_at": "2024-08-25T15:00:00Z",
      "updated_at": "2024-08-25T15:00:00Z",
      "annotation_id": "annotation_id",
      "heardBy": [
        "string"
      ],
      "audio_duration": 0,
      "heard": true
    }
  ],
  "has_more": true
}

json

application/json

Create Message

POST

https://openapi.niftypm.com

/api/v1.0/messages

This endpoint creates a new message.

Create Message › Request Body

CreateMessageDto

type

string · required

Message Type

text

string · required

Message Text

url

string · required

URL

doc_attachment

string · required

Document Attachment

entity_key

string · required

Entity Key

chat_id

string · required

Chat ID

message_id

string · required

Message ID

task_id

string · required

Task ID

file_id

string · required

File ID

doc_id

string · required

Document ID

task

object

Task Details

external_files

string[]

List of External files

nifty_files

string[]

List of Nifty Files

date

string · date-time

Date

bot_name

string

BOT Name

bot_avatar

string

BOT Avtar

hidden

string[]

Hidden

emails

string

Emails

annotation_id

string

Annotation ID

context_text

string

Context Text

audio_duration

string

Audion Duration

Create Message › Responses

The resource created successfully

CreateMessageResponse

message

string · required

data

object · required

POST/api/v1.0/messages

curl https://openapi.niftypm.com/api/v1.0/messages \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "type": "type",
  "text": "text",
  "url": "url",
  "doc_attachment": "doc_attachment",
  "entity_key": "entity_key",
  "chat_id": "chat_id",
  "message_id": "message_id",
  "task_id": "task_id",
  "file_id": "file_id",
  "doc_id": "doc_id",
  "task": {},
  "external_files": [
    "string"
  ],
  "nifty_files": [
    "string"
  ],
  "date": "2024-08-25T15:00:00Z",
  "bot_name": "bot_name",
  "bot_avatar": "bot_avatar",
  "hidden": [
    "string"
  ],
  "emails": "emails",
  "annotation_id": "annotation_id",
  "context_text": "context_text",
  "audio_duration": "audio_duration"
}'

Example Request Body

{
  "type": "type",
  "text": "text",
  "url": "url",
  "doc_attachment": "doc_attachment",
  "entity_key": "entity_key",
  "chat_id": "chat_id",
  "message_id": "message_id",
  "task_id": "task_id",
  "file_id": "file_id",
  "doc_id": "doc_id",
  "task": {},
  "external_files": [
    "string"
  ],
  "nifty_files": [
    "string"
  ],
  "date": "2024-08-25T15:00:00Z",
  "bot_name": "bot_name",
  "bot_avatar": "bot_avatar",
  "hidden": [
    "string"
  ],
  "emails": "emails",
  "annotation_id": "annotation_id",
  "context_text": "context_text",
  "audio_duration": "audio_duration"
}

json

Example Responses

{
  "message": "message",
  "data": {}
}

json

application/json

Get Message

GET

https://openapi.niftypm.com

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

This endpoint fetch more details about the message.

Get Message › path Parameters

message_id

string · required

Get Message › Responses

Success Response

MessageResponse

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

string[] · required

List of Replier Id

tagged

string[] · required

List of tagged

seen_by

string[] · required

List of Seen by Id

hidden

string[] · required

Hidden

doc_attachment

string · required

Document Attachment

FileChildResponse[] · 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

string[] · required

Heard By

audio_duration

number · required

Audio duration

heard

boolean · required

Is Heard

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

curl https://openapi.niftypm.com/api/v1.0/messages/:message_id \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "id": "id",
  "type": "type",
  "hide_link_preview": true,
  "subtype": "subtype",
  "text": "text",
  "url": "url",
  "chat": "chat",
  "thread": "thread",
  "task": "task",
  "file": "file",
  "document": "document",
  "entity_key": "entity_key",
  "author": "author",
  "replies": 0,
  "repliers": [
    "string"
  ],
  "tagged": [
    "string"
  ],
  "seen_by": [
    "string"
  ],
  "hidden": [
    "string"
  ],
  "doc_attachment": "doc_attachment",
  "attachments": [
    {
      "id": "id",
      "name": "name",
      "size": 0,
      "url": "url",
      "download": "download",
      "thumbnail": "thumbnail",
      "uploader": "uploader",
      "comments": 0,
      "created_at": "2024-08-25T15:00:00Z",
      "googleId": "googleId",
      "googleType": "googleType",
      "processed": true
    }
  ],
  "is_edited": true,
  "is_deleted": true,
  "created_at": "2024-08-25T15:00:00Z",
  "updated_at": "2024-08-25T15:00:00Z",
  "annotation_id": "annotation_id",
  "heardBy": [
    "string"
  ],
  "audio_duration": 0,
  "heard": true
}

json

application/json

Update Message

PUT

https://openapi.niftypm.com

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

This endpoint update the message.

Update Message › path Parameters

message_id

string · required

Message ID

Update Message › Request Body

EditMessageDto

text

string

Message Text

object[]

List of External Files

hide_link_preview

boolean

Hide link preview

nifty_files

string[]

List of Nifty Files

Update Message › Responses

Success Response

No data returned

Remove Message

DELETE

https://openapi.niftypm.com

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

This endpoint removes the message.

Remove Message › path Parameters

message_id

string · required

Message ID

Remove Message › Responses

The record has been updated successfully.

DeleteMessageResponse

message_id

string · required

Message ID

message

string · required

Message

Mark Message seen

POST

https://openapi.niftypm.com

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

This endpoint marks the message as seen by the member.

Mark Message seen › path Parameters

message_id

string · required

Message ID

Mark Message seen › Responses

The resource created successfully

SeeMessageResponse

message_ids

string[] · required

List of all message id

message

string · required

Message

Mark Message heard

POST

https://openapi.niftypm.com

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

This endpoint marks the message as heard by the member.

Mark Message heard › path Parameters

message_id

string · required

Message ID

Mark Message heard › Responses

The resource created successfully

HearMessageResponse

message_id

string · required

Message ID

message

string · required

Message

Members Milestones & Lists