Skip to content

Note

Chat message object

Fields

attached_audio_url · String · url for note audio
attached_image_url · String · url for note image
content · String · note content
conversation_id · ID · conversation id
created_at · String! · required · The time at which this note was created
creator · User · User who created note
creator_display_name · String · Display name of the creator based on conversation type and user permissions
cursor · Cursor! · required · Pagination cursor
deleted_by_user · Boolean! · required · True if this note deleted by a user
document_id · ID · id for note document
document_name · String · Name of attached document
id · ID! · required · The unique identifier of the note
image_name · String · Name of attached image
is_autoresponse · Boolean! · required · True if this note is using as auto response message
on_behalf_user · User · A User which created a Note on behalf of a Conversation Owner
recipient_id · ID · receiver of note
deprecated Use conversation_memberships of conversation instead
scheduled_at · String · Scheduled sent at
task · Task · Get associated task with a chat message
updated_at · String! · required · The time at which this note was updated or marked as deleted by a user
user_id · ID · creator of note
viewed · Boolean · conditional to see if user recipient viewed note. In community chats, you need to pass in a viewer_id

Used By

Definition

"""
Chat message object
"""
type Note {
"""
url for note audio
"""
attached_audio_url: String
"""
url for note image
"""
attached_image_url: String
"""
note content
"""
content: String
"""
conversation id
"""
conversation_id: ID
"""
The time at which this note was created
"""
created_at: String!
"""
User who created note
"""
creator: User
"""
Display name of the creator based on conversation type and user permissions
"""
creator_display_name: String
"""
Pagination cursor
"""
cursor: Cursor!
"""
True if this note deleted by a user
"""
deleted_by_user: Boolean!
"""
id for note document
"""
document_id: ID
"""
Name of attached document
"""
document_name: String
"""
The unique identifier of the note
"""
id: ID!
"""
Name of attached image
"""
image_name: String
"""
True if this note is using as auto response message
"""
is_autoresponse: Boolean!
"""
A User which created a Note on behalf of a Conversation Owner
"""
on_behalf_user: User
"""
receiver of note
"""
recipient_id: ID
@deprecated(reason: "Use conversation_memberships of conversation instead")
"""
Scheduled sent at
"""
scheduled_at: String
"""
Get associated task with a chat message
"""
task: Task
"""
The time at which this note was updated or marked as deleted by a user
"""
updated_at: String!
"""
creator of note
"""
user_id: ID
"""
conditional to see if user recipient viewed note. In community chats, you need to pass in a viewer_id
"""
viewed(
"""
ID of the user that you want to check has viewed the note
"""
viewer_id: ID
): Boolean
}