PUT/api/v1/postcard-chats/{id}/read
App Bearer,完整注册及VIP准入,公共头与JWEJSON 响应接入指南 ↗

推进本人聊天已读边界

请求参数

路径id为真实会话UUID。正文readThrough必填非负JSON整数,范围0–当前lastSequence,拒绝字符串、浮点、布尔和null;未知字段拒绝。只单向推进当前认证用户的边界,旧值重复提交为幂等读取,不修改对方边界、最后活动或原卡version。

独立App Bearer,完整资料和当前发行渠道VIP准入;管理员Cookie不能替代App身份。所有字段及嵌套模型见明信片接入。强制校验公共请求头中的客户端类型、平台、版本、构建、渠道、安装UUID、请求UUID和时间戳;Accept-Language支持中英日韩,缺省或未知回退英文。HTTPS及开发例外遵循公共协议,不能关闭TLS校验。JSON使用AES/JWE,GET把本次空业务正文的信封置X-Budyoo-JWE,写方法把密文放正文。

请求示例

以下账号、UUID、正文和时间均为合成示意;按实际方法、路径、完整查询串和本次头生成密文,不能直接发送占位信封。示例dev渠道仅用于非prod配置下的隔离验证,正式发行使用实际渠道。API_ORIGIN来自目标环境,凭据只通过变量提供。

加密前业务JSON:

{
  "readThrough": 1
}
curl --request PUT "$API_ORIGIN/api/v1/postcard-chats/44444444-4444-4444-8444-444444444444/read" \
  -H "Accept-Language: zh-CN" \
  -H "X-Client-Type: app" \
  -H "X-Platform: android" \
  -H "X-App-Version: 1.0.0" \
  -H "X-App-Build: 1" \
  -H "X-Channel: dev" \
  -H "X-Device-Id: 77777777-7777-4777-8777-777777777777" \
  -H "X-Request-Id: $REQUEST_UUID" \
  -H "X-Request-Timestamp: $NOW_MILLIS" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "X-Budyoo-Encryption: jwe-v1" \
  -H "Accept: application/jose" \
  -H "Content-Type: application/jose" \
  --data-raw "$REQUEST_JWE"

成功响应

以下成功示例按2026-11-20已部署的统一协议展示;CDN示例为合成对象,默认头像示例使用API通道,真实地址及权限以服务端返回为准。

HTTP200,公共信封code=SUCCESS、errors=[];message按请求语言。data的字段、可空性和游标含义见聊天共享模型。

{
  "code": "SUCCESS",
  "message": "操作成功",
  "data": {
    "id": "44444444-4444-4444-8444-444444444444",
    "cardId": "33333333-3333-4333-8333-333333333333",
    "peer": {
      "profile": {
        "userId": "22222222-2222-4222-8222-222222222222",
        "publicId": "10000001",
        "nickname": "示例旅人",
        "country": "cn",
        "gender": "female",
        "spokenLanguage": "zh",
        "learningLanguage": "en",
        "introduction": "喜欢旅行",
        "avatarId": null,
        "interests": [
          "chat"
        ]
      },
      "avatarUrl": "/api/v1/media/user-avatars/22222222-2222-4222-8222-222222222222",
      "display": {
        "language": "zh-CN",
        "country": {
          "id": "cn",
          "name": "中国",
          "names": {
            "zh-CN": "中国",
            "en": "China",
            "ja": "中国",
            "ko": "중국"
          },
          "flagUrl": "/api/v1/media/country-flags/cn"
        },
        "spokenLanguage": {
          "id": "zh",
          "name": "中文",
          "names": {
            "zh-CN": "中文",
            "en": "Chinese",
            "ja": "中国語",
            "ko": "중국어"
          },
          "nativeName": "中文 / 汉语"
        },
        "learningLanguage": {
          "id": "en",
          "name": "英语",
          "names": {
            "zh-CN": "英语",
            "en": "English",
            "ja": "英語",
            "ko": "영어"
          },
          "nativeName": "English"
        }
      }
    },
    "lastSequence": 1,
    "readSequence": 1,
    "unreadMessageCount": 0,
    "lastMessage": {
      "id": "55555555-5555-4555-8555-555555555555",
      "conversationId": "44444444-4444-4444-8444-444444444444",
      "senderId": "22222222-2222-4222-8222-222222222222",
      "clientRequestId": null,
      "mine": false,
      "type": "TEXT",
      "sequence": 1,
      "body": "你好,很高兴收到你的明信片。",
      "createdAt": "2026-11-11T09:00:00Z"
    },
    "createdAt": "2026-11-11T08:55:00Z",
    "lastActivityAt": "2026-11-11T09:00:00Z"
  },
  "errors": [],
  "mediaDelivery": [
    {
      "path": "/api/v1/media/user-avatars/22222222-2222-4222-8222-222222222222",
      "url": "/api/v1/media/user-avatars/22222222-2222-4222-8222-222222222222",
      "access": "API",
      "expiresAt": null,
      "cacheKey": "/api/v1/media/user-avatars/22222222-2222-4222-8222-222222222222",
      "cacheMaxAgeSeconds": 0,
      "code": "SUCCESS",
      "transport": "API",
      "requestHeaders": {},
      "authorization": null
    }
  ]
}

失败响应

HTTP code 处理
400 BAD_REQUEST / INVALID_CLIENT_HEADERS 字段、JSON类型、长度、边界、分页或公共头错误
401 UNAUTHORIZED 使用有效App身份,管理员Cookie不授予用户身份
403 FORBIDDEN / VIP_REQUIRED / ACCOUNT_DISABLED 注册、当前VIP或账号准入失败
404 NOT_FOUND 会话/父卡不存在、非实际参与者、对方不可用或双向屏蔽,不返回私密内容
409 POSTCARD_CONFLICT 核对尚未接受邀请或父卡当前不可交互状态
426 HTTPS_REQUIRED 使用受信HTTPS,开发例外按公共协议
503 SERVICE_UNAVAILABLE 数据库或必要依赖失败,不把未知结果视为未发送

失败信封示意:

{
  "code": "BAD_REQUEST",
  "message": "请求格式不正确。",
  "data": null,
  "errors": []
}

JWE认证、防重放、超限与网关错误分别见加密协议和入口限制。固定code不翻译,message按四语响应;网关前置拒绝不能当作已认证业务响应。

接入说明

2026-11-20统一媒体交付已部署到唯一正式环境(运行配置仍为dev):已认证App成功响应自动替换受支持用户媒体URL并按需附加顶层mediaDelivery,不再要求能力头;无头、cdn-v1和oss-v1均使用同一结构。服务端选择CDN/OSS/API,客户端按transport加载;原ID、版本、权限、JWE与JSON的no-store保持。非空avatarId及albumPhotoIds按统一规则补充avatarUrl/albumPhotos,单项媒体依赖失败不推翻已提交业务。完整字段、缓存与Flutter验收见统一媒体交付。

仅在内容实际展示后提交明确序号。提交旧边界不会吞掉并发到来的新消息;GET和本人发送不会代替这个动作。返回最新本人未读摘要,不把写入回执当作对方已读。

首信和回信仍执行原人工先审;接受后的专属文本消息按双方同意持久化,不伪造自动回复、互关、送达或对方已读。每张首信独立会话;照片、语音和通用IM会话不通过本接口发送。任一方注销时随原卡清理整个私密会话及正文,历史备份保留遵循原规则。

2026-11-18服务器完整回归1375项,0失败/0错误,1项按环境条件跳过;新增首信照片必填、拆信后直接聊天、会话查询兼容和原邀请路径回归全部通过。完整覆盖收寄、先审后投递、照片权限、幂等、消息序号、明确已读、屏蔽、注销、OSS媒体、JWE及迁移,正向收寄和聊天写入均使用隔离数据库与合成账号。