Support mark as read by token API (#1443)

line/line-openapi#115

## Support for "Mark as Read" by Token API

We have released a new **Mark as Read API** that allows developers to
mark a user’s messages as read.
Previously, this functionality was available only to partners, but it is
now publicly available.

When your server receives a user message via Webhook, the `MessageEvent`
will include a new field: `markAsReadToken`.
By calling the Mark as Read API with this token, all messages in the
chat room **up to and including** that message will be marked as read.

> **Note:** This feature assumes that your service uses the chat feature
through Official Account Manager.
> If chat is not enabled, messages from users are automatically marked
as read, making this API unnecessary.

For more details, please refer to the release note:
https://developers.line.biz/en/news/2025/11/05/mark-as-read/

Co-authored-by: github-actions <github-actions@github.com>

Author: github-actions[bot]

lib/messaging-api/.openapi-generator/FILES

@@ -121,6 +121,7 @@ model/locationAction.ts
 model/locationMessage.ts
 model/lotteryAcquisitionConditionRequest.ts
 model/lotteryAcquisitionConditionResponse.ts
+model/markMessagesAsReadByTokenRequest.ts
 model/markMessagesAsReadRequest.ts
 model/membersIdsResponse.ts
 model/membership.ts

lib/messaging-api/api/messagingApiClient.ts

@@ -28,6 +28,7 @@ import { GroupMemberCountResponse } from "../model/groupMemberCountResponse.js";
 import { GroupSummaryResponse } from "../model/groupSummaryResponse.js";
 import { GroupUserProfileResponse } from "../model/groupUserProfileResponse.js";
 import { IssueLinkTokenResponse } from "../model/issueLinkTokenResponse.js";
+import { MarkMessagesAsReadByTokenRequest } from "../model/markMessagesAsReadByTokenRequest.js";
 import { MarkMessagesAsReadRequest } from "../model/markMessagesAsReadRequest.js";
 import { MembersIdsResponse } from "../model/membersIdsResponse.js";
 import { MembershipListResponse } from "../model/membershipListResponse.js";
@@ -1632,6 +1633,39 @@ export class MessagingApiClient {
     const parsedBody = text ? JSON.parse(text) : null;
     return { httpResponse: res, body: parsedBody };
   }
+  /**
+   * Mark messages from users as read by token
+   * @param markMessagesAsReadByTokenRequest
+   *
+   * @see <a href="https://developers.line.biz/en/reference/messaging-api/#mark-as-read"> Documentation</a>
+   */
+  public async markMessagesAsReadByToken(
+    markMessagesAsReadByTokenRequest: MarkMessagesAsReadByTokenRequest,
+  ): Promise<Types.MessageAPIResponseBase> {
+    return (
+      await this.markMessagesAsReadByTokenWithHttpInfo(
+        markMessagesAsReadByTokenRequest,
+      )
+    ).body;
+  }
+
+  /**
+   * Mark messages from users as read by token.
+   * This method includes HttpInfo object to return additional information.
+   * @param markMessagesAsReadByTokenRequest
+   *
+   * @see <a href="https://developers.line.biz/en/reference/messaging-api/#mark-as-read"> Documentation</a>
+   */
+  public async markMessagesAsReadByTokenWithHttpInfo(
+    markMessagesAsReadByTokenRequest: MarkMessagesAsReadByTokenRequest,
+  ): Promise<Types.ApiResponseType<Types.MessageAPIResponseBase>> {
+    const params = markMessagesAsReadByTokenRequest;
+
+    const res = await this.httpClient.post("/v2/bot/chat/markAsRead", params);
+    const text = await res.text();
+    const parsedBody = text ? JSON.parse(text) : null;
+    return { httpResponse: res, body: parsedBody };
+  }
   /**
    * An API that efficiently sends the same message to multiple user IDs. You can\'t send messages to group chats or multi-person chats.
    * @param multicastRequest

lib/messaging-api/model/markMessagesAsReadByTokenRequest.ts

@@ -0,0 +1,20 @@
+/**
+ * LINE Messaging API
+ * This document describes LINE Messaging API.
+ *
+ * The version of the OpenAPI document: 0.0.1
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+export type MarkMessagesAsReadByTokenRequest = {
+  /**
+   * Token used to mark messages as read.
+   *
+   * @see <a href="https://developers.line.biz/en/reference/messaging-api/#mark-as-read-request-body">markAsReadToken Documentation</a>
+   */
+  markAsReadToken: string /**/;
+};

lib/messaging-api/model/models.ts

@@ -116,6 +116,7 @@ export * from "./locationAction.js";
 export * from "./locationMessage.js";
 export * from "./lotteryAcquisitionConditionRequest.js";
 export * from "./lotteryAcquisitionConditionResponse.js";
+export * from "./markMessagesAsReadByTokenRequest.js";
 export * from "./markMessagesAsReadRequest.js";
 export * from "./membersIdsResponse.js";
 export * from "./membership.js";

lib/messaging-api/tests/api/MessagingApiClientTest.spec.ts

@@ -17,6 +17,7 @@ import { GroupMemberCountResponse } from "../../model/groupMemberCountResponse.j
 import { GroupSummaryResponse } from "../../model/groupSummaryResponse.js";
 import { GroupUserProfileResponse } from "../../model/groupUserProfileResponse.js";
 import { IssueLinkTokenResponse } from "../../model/issueLinkTokenResponse.js";
+import { MarkMessagesAsReadByTokenRequest } from "../../model/markMessagesAsReadByTokenRequest.js";
 import { MarkMessagesAsReadRequest } from "../../model/markMessagesAsReadRequest.js";
 import { MembersIdsResponse } from "../../model/membersIdsResponse.js";
 import { MembershipListResponse } from "../../model/membershipListResponse.js";
@@ -4455,6 +4456,86 @@ describe("MessagingApiClient", () => {
     server.close();
   });
 
+  it("markMessagesAsReadByTokenWithHttpInfo", async () => {
+    let requestCount = 0;
+
+    const server = createServer((req, res) => {
+      requestCount++;
+
+      equal(req.method, "POST");
+      const reqUrl = new URL(req.url, "http://localhost/");
+      equal(reqUrl.pathname, "/v2/bot/chat/markAsRead");
+
+      equal(req.headers["authorization"], `Bearer ${channel_access_token}`);
+      equal(req.headers["user-agent"], "@line/bot-sdk/1.0.0-test");
+
+      res.writeHead(200, { "Content-Type": "application/json" });
+      res.end(JSON.stringify({}));
+    });
+    await new Promise(resolve => {
+      server.listen(0);
+      server.on("listening", resolve);
+    });
+
+    const serverAddress = server.address();
+    if (typeof serverAddress === "string" || serverAddress === null) {
+      throw new Error("Unexpected server address: " + serverAddress);
+    }
+
+    const client = new MessagingApiClient({
+      channelAccessToken: channel_access_token,
+      baseURL: `http://localhost:${String(serverAddress.port)}/`,
+    });
+
+    const res = await client.markMessagesAsReadByTokenWithHttpInfo(
+      // markMessagesAsReadByTokenRequest: MarkMessagesAsReadByTokenRequest
+      {} as unknown as MarkMessagesAsReadByTokenRequest, // paramName=markMessagesAsReadByTokenRequest
+    );
+
+    equal(requestCount, 1);
+    server.close();
+  });
+
+  it("markMessagesAsReadByToken", async () => {
+    let requestCount = 0;
+
+    const server = createServer((req, res) => {
+      requestCount++;
+
+      equal(req.method, "POST");
+      const reqUrl = new URL(req.url, "http://localhost/");
+      equal(reqUrl.pathname, "/v2/bot/chat/markAsRead");
+
+      equal(req.headers["authorization"], `Bearer ${channel_access_token}`);
+      equal(req.headers["user-agent"], "@line/bot-sdk/1.0.0-test");
+
+      res.writeHead(200, { "Content-Type": "application/json" });
+      res.end(JSON.stringify({}));
+    });
+    await new Promise(resolve => {
+      server.listen(0);
+      server.on("listening", resolve);
+    });
+
+    const serverAddress = server.address();
+    if (typeof serverAddress === "string" || serverAddress === null) {
+      throw new Error("Unexpected server address: " + serverAddress);
+    }
+
+    const client = new MessagingApiClient({
+      channelAccessToken: channel_access_token,
+      baseURL: `http://localhost:${String(serverAddress.port)}/`,
+    });
+
+    const res = await client.markMessagesAsReadByToken(
+      // markMessagesAsReadByTokenRequest: MarkMessagesAsReadByTokenRequest
+      {} as unknown as MarkMessagesAsReadByTokenRequest, // paramName=markMessagesAsReadByTokenRequest
+    );
+
+    equal(requestCount, 1);
+    server.close();
+  });
+
   it("multicastWithHttpInfo", async () => {
     let requestCount = 0;
 

lib/webhook/model/audioMessageContent.ts

@@ -24,4 +24,8 @@ export type AudioMessageContent = MessageContentBase & {
    * Length of audio file (milliseconds)
    */
   duration?: number /**/;
+  /**
+   * Token used to mark the message as read.
+   */
+  markAsReadToken?: string /**/;
 };

lib/webhook/model/fileMessageContent.ts

@@ -24,4 +24,8 @@ export type FileMessageContent = MessageContentBase & {
    * File size in bytes
    */
   fileSize: number /**/;
+  /**
+   * Token used to mark the message as read.
+   */
+  markAsReadToken?: string /**/;
 };

lib/webhook/model/imageMessageContent.ts

@@ -28,4 +28,8 @@ export type ImageMessageContent = MessageContentBase & {
    * Quote token to quote this message.
    */
   quoteToken: string /**/;
+  /**
+   * Token used to mark the message as read.
+   */
+  markAsReadToken?: string /**/;
 };

lib/webhook/model/locationMessageContent.ts

@@ -32,4 +32,8 @@ export type LocationMessageContent = MessageContentBase & {
    * Longitude
    */
   longitude: number /**/;
+  /**
+   * Token used to mark the message as read.
+   */
+  markAsReadToken?: string /**/;
 };

lib/webhook/model/stickerMessageContent.ts

@@ -57,6 +57,12 @@ export type StickerMessageContent = MessageContentBase & {
    * @see <a href="https://developers.line.biz/en/reference/messaging-api/#wh-sticker">quotedMessageId Documentation</a>
    */
   quotedMessageId?: string /**/;
+  /**
+   * Token used to mark the message as read.
+   *
+   * @see <a href="https://developers.line.biz/en/reference/messaging-api/#wh-sticker">markAsReadToken Documentation</a>
+   */
+  markAsReadToken?: string /**/;
 };
 
 export namespace StickerMessageContent {