Skip to content

[Conversation] Detail

  • Endpoint Path: /api/v2/conversation/{conversationId}/detail
  • Method: GET
  • Request: Rest

Headers Optional Parameter

Parameter NamePublic Mode (Required)Private Mode (Required)
X-Fresns-Aidrequiredrequired
X-Fresns-Aid-Tokenrequiredrequired
X-Fresns-Uidrequiredrequired
X-Fresns-Uid-Tokenrequiredrequired

Rest Params

Parameter NameTypeRequiredDescription
conversationIdNumberrequiredConversation ID

Query Params

Parameter NameTypeRequiredDescription
whitelistKeysStringoptionalWhitelist key names, only returns key-value pairs for the given key names
Multiple separated by English commas, supports "dot notation" for multi-dimensional arrays
Valid only for the user parameter
blacklistKeysStringoptionalBlacklist key names, removes specified key-value pairs from the returned data
Multiple separated by English commas, supports "dot notation" for multi-dimensional arrays
Valid only for the user parameter

Return

json
{
    "code": 0,
    "message": "ok",
    "data": {
        "id": "Number / Conversation ID",
        "user": {
            // User information for the conversation with me, empty if the user has been deactivated.
            // Common Data Structure -> User Info
        },
        "messageCount": "Number / Total message count",
        "unreadCount": "Number / Unread message count in the conversation"
    }
}

Released under the Apache-2.0 License