Message Flagging

Use message flagging when a signed-in user reports a chat message. The SDKs expose three client-side actions: flag a message, unflag a message, and check whether the current user has already flagged a fetched message. Flagged messages are sent to the moderation backend. Keep product policy, review workflow, and enforcement copy outside the SDK integration layer so this page stays focused on the calls your app makes.

Platform Surface

Platform	Flag	Unflag	Check current user’s flag
Android	`messageRepository.flagMessage(messageId)` or `flagMessage(messageId, reason, detail?)`	`messageRepository.unflagMessage(messageId)`	`message.isFlaggedByMe()` on a fetched `AmityMessage`
iOS	`messageRepository.flagMessage(withId:)` or `flagMessage(withId:reason:detail:)`	`messageRepository.unflagMessage(withId:)`	`messageRepository.isMessageFlaggedByMe(withId:)`
TypeScript	`MessageRepository.flagMessage(messageId)` or `flagMessage(messageId, { reason, detail? })`	`MessageRepository.unflagMessage(messageId)`	`MessageRepository.isMessageFlaggedByMe(messageId)`
Flutter	`messageRepository.flagMessage(messageId:reason:)` or `message.flagWithReason(reason)`	`messageRepository.unflag(messageId)` or `message.unflag()`	`message.isFlaggedByMe` on a fetched `AmityMessage`

Parameters

Operation	Parameter	Required	Platforms	Description
Flag	`messageId`	Yes	All	Message ID to report.
Flag	`reason`	No on Android, iOS, TypeScript; yes on Flutter `flagMessage`	All	One reason category. Android, iOS, and TypeScript use `AmityContentFlagReasonType` (`ContentFlagReasonEnum` before TypeScript 7.31.0), Flutter uses `AmityContentFlagReason`. See Flag reasons.
Flag	`detail`	No	Android, iOS, TypeScript	The reporter’s own words, for any reason including Others. Needs a `reason`. Sent as given; omitted when not set. The server limits it to 300 characters.
Unflag	`messageId`	Yes	All	Message ID whose report should be removed for the current user.
Check flag state	`messageId`	Yes	iOS, TypeScript	Message ID to check through the repository.
Check flag state	Fetched message object	Yes	Android, Flutter	`isFlaggedByMe` on a fetched `AmityMessage`.

Flag A Message

Flag a message with a reason so your product can route it into review, and add the reporter’s own words as detail when they give some. Use the no-reason call when your UI only offers a single “Report” action.

// Reason with the reporter's own words
messageRepository
    .flagMessage(
        messageId = messageId,
        reason = AmityContentFlagReasonType.SPAM_OR_SCAMS,
        detail = "Same promo link sent to every member",
    )
    .subscribe(
        { showSuccessMessage() },
        { error -> handleFlagError(error) },
    )

// No reason
messageRepository
    .flagMessage(messageId = messageId)
    .subscribe(
        { showSuccessMessage() },
        { error -> handleFlagError(error) },
    )

// Reason with the reporter's own words
try await messageRepository.flagMessage(
    withId: "message-id",
    reason: .spamOrScams,
    detail: "Same promo link sent to every member"
)

// Reason only: type the reason explicitly so the current call is used
try await messageRepository.flagMessage(
    withId: "message-id",
    reason: AmityContentFlagReasonType.spamOrScams
)

// No reason
try await messageRepository.flagMessage(withId: "message-id")

showSuccessMessage("Message flagged")

import { AmityContentFlagReasonType, MessageRepository } from '@amityco/ts-sdk';

// Reason with the reporter's own words
const flagged = await MessageRepository.flagMessage(messageId, {
  reason: AmityContentFlagReasonType.SpamOrScams,
  detail: 'Same promo link sent to every member',
});

renderResults(flagged);

// No reason
await MessageRepository.flagMessage(messageId);

final flaggedMessage = await AmityChatClient.newMessageRepository()
    .flagMessage(
      messageId: messageId,
      reason: AmityContentFlagReason.spamOrScams,
    );

final isFlaggedByMe = flaggedMessage.isFlaggedByMe;

Report Child Endangerment

Flag a message that endangers a child, including suspected child sexual abuse material (CSAM), with the Child endangerment reason. Send it as its own reason, not as Others with a detail, so these reports reach moderators under their own category. A detail is optional.

messageRepository
    .flagMessage(
        messageId = messageId,
        reason = AmityContentFlagReasonType.CHILD_ENDANGERMENT,
    )
    .subscribe(
        { showSuccessMessage() },
        { error -> handleFlagError(error) },
    )

// Type the reason explicitly so the current call is used
try await messageRepository.flagMessage(
    withId: "message-id",
    reason: AmityContentFlagReasonType.childEndangerment
)

import { AmityContentFlagReasonType, MessageRepository } from '@amityco/ts-sdk';

await MessageRepository.flagMessage(messageId, {
  reason: AmityContentFlagReasonType.ChildEndangerment,
});

Report With Others

Use the Others reason when none of the categories fit. On Android, iOS, and TypeScript, put the reporter’s explanation in detail, as for any other reason. Flutter carries the text on its Others reason.

messageRepository
    .flagMessage(
        messageId = messageId,
        reason = AmityContentFlagReasonType.OTHERS,
        detail = "Contains sensitive account information",
    )
    .subscribe(
        { showSuccessMessage() },
        { error -> handleFlagError(error) },
    )

try await messageRepository.flagMessage(
    withId: "message-id",
    reason: .others,
    detail: "Contains sensitive account information"
)

import { AmityContentFlagReasonType, MessageRepository } from '@amityco/ts-sdk';

const flagged = await MessageRepository.flagMessage(messageId, {
  reason: AmityContentFlagReasonType.Others,
  detail: 'Contains sensitive account information',
});

renderResults(flagged);

final flaggedMessage = await AmityChatClient.newMessageRepository()
    .flagMessage(
      messageId: messageId,
      reason: AmityContentFlagReason.others(
        'Contains sensitive account information',
      ),
    );

final flagCount = flaggedMessage.flagCount;

The earlier calls that took only a reason are deprecated but still work on Android, iOS, and TypeScript: flagMessage(messageId, reason) with a reason string on TypeScript, and with AmityContentFlagReason on Android and iOS, where custom text was passed as Others("...") / .others("..."). Move custom text to detail with the Others reason. Flagging with only a message ID is not deprecated on these platforms. On Flutter, the repository flag(messageId) is deprecated; use flagMessage(messageId:reason:).

Unflag A Message

Remove the current user’s flag from a message when the user reverses the report action.

messageRepository
    .unflagMessage(messageId = messageId)
    .subscribe(
        { showSuccessMessage() },
        { error -> handleUnflagError(error) },
    )

try await messageRepository.unflagMessage(withId: "message-id")
showSuccessMessage("Message unflagged")

import { MessageRepository } from '@amityco/ts-sdk';

const unflagged = await MessageRepository.unflagMessage(messageId);

renderResults(unflagged);

final unflaggedMessage = await AmityChatClient.newMessageRepository()
    .unflag(messageId);

final isFlaggedByMe = unflaggedMessage.isFlaggedByMe;

Check Flag State

TypeScript and iOS can ask the repository for the current user’s flag state by message ID. Android and Flutter expose the state on fetched message objects. Read flag state before rendering selected or disabled report controls.

messageRepository
    .getMessage(messageId = messageId)
    .subscribe(
        { fetchedMessage ->
            val isFlaggedByMe = fetchedMessage.isFlaggedByMe()
            updateMessageUI(messageId, isFlaggedByMe)
        },
        { error -> handleGeneralError(error) },
    )

let isFlaggedByMe = try await messageRepository
    .isMessageFlaggedByMe(withId: "message-id")

showSuccessMessage(isFlaggedByMe)

import { MessageRepository } from '@amityco/ts-sdk';

const isFlaggedByMe =
  await MessageRepository.isMessageFlaggedByMe(messageId);

updateUI({ isFlaggedByMe });

final fetchedMessage = await AmityChatClient.newMessageRepository()
    .getMessage(messageId);

final isFlaggedByMe = fetchedMessage.isFlaggedByMe;

Platform Notes

Reason with optional detail ships in TypeScript 7.29.0 and in the October 2026 iOS and Android releases.
The Child endangerment reason ships in TypeScript 7.31.0 and in the next Android and iOS releases. Flutter’s AmityContentFlagReason does not include it.
On iOS, when you omit detail, write the reason with its type, for example AmityContentFlagReasonType.spamOrScams. The shorthand .spamOrScams on its own selects the deprecated call.
A flag without a reason is recorded with a default reason: Others on TypeScript and Android, and Against community guidelines on iOS.
Flutter has no separate detail; the reporter’s text travels on AmityContentFlagReason.others(...).

Query Messages

Refresh list state after flag or unflag actions.

Edit and Delete Messages

Modify or soft-delete your own messages.

Content Moderation

Connect message reports to your moderation operating model.

Powered by

Getting Started

Fundamentals

Social

Chat

Video

Release Notes

Migration Guides

Support

Platform Surface

Parameters

Flag A Message

Report Child Endangerment

Report With Others

Unflag A Message

Check Flag State

Platform Notes

Query Messages

Edit and Delete Messages

Content Moderation

​Platform Surface

​Parameters

​Flag A Message

​Report Child Endangerment

​Report With Others

​Unflag A Message

​Check Flag State

​Platform Notes

​Related Topics

Query Messages

Edit and Delete Messages

Content Moderation

Platform Surface

Parameters

Flag A Message

Report Child Endangerment

Report With Others

Unflag A Message

Check Flag State

Platform Notes

Related Topics