search

Messages Endpoints

hashtag
Get User Direct Message Threads Ordered by Timestamp

POST /api/v0/get-user-dm-threads-ordered-by-timestamp

Get User Direct Message Threads Ordered by Timestamp returns an array of NewMessageEntryResponse objects for the public key provided in the request body. Each NewMessageEntryResponse object represents the most recent message each in DM conversation a user has. This is useful for showing a list of DM conversations in a user's inbox. The first NewMessageEntryResponse object is the most recent conversation and the last one is the old.

Additionally, a map of public key to ProfileEntryResponse objects for convenience so you don't need to make an extra request to get profile entry responses for the public keys in the response.

Endpoint implementation in backendarrow-up-right.

hashtag
Request Body

Name
Type
Description

UserPublicKeyBase58Check*

String

Public key of the user for whom we want to fetch all DM conversations

{
  "MessageThreads": [
    {
      "ChatType": "DM",
      "SenderInfo": {
        "OwnerPublicKeyBase58Check": "tBCKUr3CEsbbg95oH6nauciz3HKxoExX6DgpcFskffGFFXHy5mtrvt",
        "AccessGroupPublicKeyBase58Check": "tBCKVSfJQqcm88YQANuuRDqxHGRZ6pERLmgG2YsbuTJQ66CypHXc2P",
        "AccessGroupKeyName": "default-key"
      },
      "RecipientInfo": {
        "OwnerPublicKeyBase58Check": "tBCKW665XZnvVZcCfcEmyeecSZGKAdaxwV2SH9UFab6PpSRikg4EJ2",
        "AccessGroupPublicKeyBase58Check": "tBCKVNhD9Kn6WzxT1EdgR3Tf3Yop6CXQSDZnvMLbST6C33DTbsnku4",
        "AccessGroupKeyName": "default-key"
      },
      "MessageInfo": {
        "EncryptedText": "04bec21d8b7ebb8bef474b01adf6a128d4984ba1f2f1f03abeb1612c78477cac0e6bdba24924631a9b4a795d9fd5e82dac8306a0193ec0c8c8c8cee9ca8f8313ec0d393178c1241c00e9aafa380813d0296aefd78eef8eff974dae964b330d3f9e838b1848086c98c1778f434bd6569d7d9de09eb6102fff028f8ca98304a3f7c06833b178f358de11072a05a07f7d77984321",
        "TimestampNanos": 1674622684987966700,
        "TimestampNanosString": "1674622684987966645",
        "ExtraData": null
      }
    }
  ],
  "PublicKeyToProfileEntryResponse": {
    "tBCKUr3CEsbbg95oH6nauciz3HKxoExX6DgpcFskffGFFXHy5mtrvt": null,
    "tBCKW665XZnvVZcCfcEmyeecSZGKAdaxwV2SH9UFab6PpSRikg4EJ2": {
      "PublicKeyBase58Check": "tBCKW665XZnvVZcCfcEmyeecSZGKAdaxwV2SH9UFab6PpSRikg4EJ2",
      "Username": "cloutchaser",
      "Description": "",
      "IsHidden": false,
      "IsReserved": false,
      "IsVerified": false,
      "Comments": null,
      "Posts": null,
      "CoinEntry": {
        "CreatorBasisPoints": 10000,
        "DeSoLockedNanos": 1124400018,
        "NumberOfHolders": 1,
        "CoinsInCirculationNanos": 9999331379,
        "CoinWatermarkNanos": 9999331379,
        "BitCloutLockedNanos": 1124400018
      },
      "DAOCoinEntry": {
        "NumberOfHolders": 3,
        "CoinsInCirculationNanos": "0xd96914214a6b400",
        "MintingDisabled": false,
        "TransferRestrictionStatus": "profile_owner_only"
      },
      "CoinPriceDeSoNanos": 337342594,
      "CoinPriceBitCloutNanos": 337342594,
      "UsersThatHODL": null,
      "IsFeaturedTutorialWellKnownCreator": false,
      "IsFeaturedTutorialUpAndComingCreator": false,
      "ExtraData": {
        "BlogSlugMap": "{\"da39a3ee5e\":\"7f9b91cd09ed5cefa0e2bbe2d70698dc665f3d4d31ee2a3a64c91ead3552ed51\"}"
      },
      "DESOBalanceNanos": 5914499708,
      "BestExchangeRateDESOPerDAOCoin": 0
    }
  }
}

hashtag
Get Paginated Messages for a Direct Message Thread

POST /api/v0/get-paginated-messages-for-dm-thread

Get Paginated Messages For DM Thread returns an array of NewMessageEntryResponse objects based on the conversation defined in the request body. Each NewMessageEntryResponse object represent a message in the a DM conversation. This is useful for showing all messages in a conversation. This first NewMessageEntryResponse object is the most recent message and the last one is the oldest. This endpoint supports pagination.

Additionally, a map of public key to ProfileEntryResponse objects for convenience so you don't need to make an extra request to get profile entry responses for the public keys in the response.

Endpoint implementation in backendarrow-up-right.

hashtag
Request Body

Name
Type
Description

UserGroupOwnerPublicKeyBase58Check*

String

Public key of one of the users in a DM conversation

UserGroupKeyName*

String

Access group key name of UserGroupOwnerPublicKeyBase58Check in the DM conversation

PartyGroupOwnerPublicKeyBase58Check*

String

Public key of the other user in a DM conversation

PartyGroupKeyName*

String

Access group key name of PartyGroupOwnerPublicKeyBase58Check in the DM conversation

StartTimestampString

String

String version of a timestamp in nanos. This defines the start point of the page. Messages newer than this timestamp are excluded.

To get the most recent (but not in the future) messages, set TimestampNanosString to (Date.now()*1e6).toString()

To get the next page of messages, take TimestampNanosString from the last NewMessageEntryResponse object in the previous page's response.

StartTimestamp

uint64

Timestamp in nanos. This is less preferred than passing StartTimestamp string as JSON encoding and decoding can lose precision on these values.

MaxMessagesToFetch

int

Maximum number of messages to fetch. You will always receive this amount of messages or fewer.

hashtag
Get User Group Chat Threads Ordered by Timestamp

POST /api/v0/get-user-group-chat-threads-ordered-by-timestamp

Get User Group Chat Threads Ordered by Timestamp returns an array of NewMessageEntryResponse objects for the public key provided in the request body. Each NewMessageEntryResponse object represents the most recent message each in a group chat a user has. This is useful for showing a list of group chats in a user's inbox. The first NewMessageEntryResponse object is the most recent conversation and the last one is the oldest.

Additionally, a map of public key to ProfileEntryResponse objects for convenience so you don't need to make an extra request to get profile entry responses for the public keys in the response.

Endpoint implementation in backendarrow-up-right.

hashtag
Request Body

Name
Type
Description

UserPublicKeyBase58Check*

String

Public key of the user for whom we want to fetch all DM conversations

hashtag
Get Paginated Messages For Group Chat Thread

POST /api/v0/get-paginated-messages-for-group-chat-thread

Get Paginated Messages For Group Chat Thread returns an array of NewMessageEntryResponse objects based on the group chat defined in the request body. Each NewMessageEntryResponse object represent a message in the group chat. This is useful for showing all messages in a conversation. This first NewMessageEntryResponse object is the most recent message and the last one is the oldest. This endpoint supports pagination.

Additionally, a map of public key to ProfileEntryResponse objects for convenience so you don't need to make an extra request to get profile entry responses for the public keys in the response.

Endpoint implementation in backendarrow-up-right.

hashtag
Request Body

Name
Type
Description

UserPublicKeyBase58Check*

String

Public key of the access group owner who owns this group chat.

AccessGroupKeyName*

String

Name of the access group for which we want to fetch messages.

StartTimestampString

String

String version of a timestamp in nanos. This defines the start point of the page. Messages newer than this timestamp are included. To get the most recent messages of the conversation, pass the current timestamp in nanoseconds converted to a string (not formatted as a timestamp).

To get the most recent (but not in the future) messages, set TimestampNanosString to (Date.now()*1e6).toString()

To get the next page of messages, take TimestampNanosString from the last NewMessageEntryResponse object in the previous page's response.

StartTimestamp

uint64

Timestamp in nanos. This is less preferred than passing StartTimestamp string as JSON encoding and decoding can lose precision on these values.

MaxMessagesToFetch*

int

Maximum number of messages to fetch. You will always receive this amount of messages or fewer.

hashtag
Get All User Message Threads

POST /api/v0/get-all-user-message-threads

Get All User Message Threads Group returns an array of NewMessageEntryResponse objects for the public key provided in the request body. Each NewMessageEntryResponse object represents the most recent message each in a conversation (DM or group chat) a user has. This is useful for showing a list of all conversations in a user's inbox. The first NewMessageEntryResponse object is the most recent conversation and the last one is the oldest.

Additionally, a map of public key to ProfileEntryResponse objects for convenience so you don't need to make an extra request to get profile entry responses for the public keys in the response.

Endpoint implementation in backendarrow-up-right.

hashtag
Request Body

Name
Type
Description

UserPublicKeyBase58Check*

String

Public key of the user for whom we want to fetch all conversations

PreviousPost EndpointsNextAccess Group Endpoints

Last updated

Was this helpful?