[features] message cancellation

[capcom6]

Summary by CodeRabbit

• Documentation
  • Added guidance for cancelling pending messages, including the two-phase flow, example API call, and response/error cases.
  • Updated message status tracking to include cancellation states and lifecycle transitions/terminal outcomes (including multi-recipient “all cancelled”).
  • Documented the sms:cancelled webhook event, including payload example and multipart behavior.
  • Expanded JWT scope documentation to include messages:cancel and mapped it to the message cancellation endpoint.

[coderabbitai]

Warning

Review limit reached

@capcom6, we couldn't start this review because you've reached your PR review rate limit.

More reviews will be available in 58 minutes and 45 seconds. Learn how PR review limits work.

Your organization has used up its prepaid credits, and credit purchases are no longer available. Enable the review add-on in the billing tab to keep reviews running — you're only billed for reviews past your plan's rate limits ($0.25/file).

⌛ How to resolve this issue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based credits.

🚦 How do rate limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please see our Fair Usage Limits Policy for further information.

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: d69b1a44-d715-494d-9635-0b8a39a00ae5

📥 Commits

Reviewing files that changed from the base of the PR and between 8c09669 and f971d00.

📒 Files selected for processing (4)

• docs/features/sending-messages.md
• docs/features/status-tracking.md
• docs/features/webhooks.md
• docs/integration/authentication.md

📝 Walkthrough

Walkthrough

Adds documentation for cancelling pending messages, including the new cancel scope, lifecycle states, and sms:cancelled webhook coverage.

Changes

Message cancellation docs

Layer / File(s)	Summary
Cancellation scope and API docs docs/integration/authentication.md, docs/features/sending-messages.md	Adds messages:cancel to the scope table, maps DELETE /3rdparty/v1/messages/:id to it, and documents the cancellation flow, response, and 400 Bad Request case.
Cancellation lifecycle states docs/features/status-tracking.md	Extends the lifecycle diagram, status definitions, and scenario table with Cancelling and Cancelled.
Cancelled webhook event docs/features/webhooks.md	Updates webhook schemas to use sender/recipient, adds sms:cancelled reference/test/example content, and documents multipart cancellation behavior.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

• android-sms-gateway/docs-web#72: Updates the same webhook schema documentation area in docs/features/webhooks.md.
• android-sms-gateway/docs-web#79: Updates the message status lifecycle docs that this PR extends with cancellation states.
• android-sms-gateway/docs-web#152: Updates JWT scope and endpoint-to-scope mapping docs that this PR extends for messages:cancel.

Suggested labels

ready

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly matches the main change: adding message cancellation support.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands.}

[cloudflare-workers-and-pages]

Deploying docs with    Cloudflare Pages

Latest commit:	f971d00
Status:	✅  Deploy successful!
Preview URL:	https://3146a14b.docs-7wm.pages.dev
Branch Preview URL:	https://features-message-calcellatio.docs-7wm.pages.dev

View logs

[capcom6]

@coderabbitai full review

[coderabbitai]

✅ Action performed

Full review finished.

[capcom6]

@coderabbitai full review

[coderabbitai]

✅ Action performed

Full review finished.

[capcom6]

@coderabbitai full review

[coderabbitai]

✅ Action performed

Full review finished.

[capcom6]

@coderabbitai full review

[coderabbitai]

✅ Action performed

Full review finished.

[capcom6]

@coderabbitai full review

[coderabbitai]

✅ Action performed

Full review finished.

[capcom6]

@coderabbitai full review

[coderabbitai]

✅ Action performed

Full review finished.

[capcom6]

@coderabbitai full review

[coderabbitai]

✅ Action performed

Full review finished.

[coderabbitai]

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/features/status-tracking.md`:
- Around line 57-59: Add the missing non-cancelled outcomes to the state
transition diagram around the Cancelling state in the status-tracking
documentation, since the cancel flow can still resolve to Sent, Delivered, or
Failed. Update the diagram entries for Cancelling so it includes those terminal
paths, or explicitly adjust the wording/structure to make it clear those
outcomes bypass Cancelling; use the Cancelling, Cancelled, Sent, Delivered, and
Failed symbols to locate the section.

In `@docs/features/webhooks.md`:
- Around line 59-64: The sms:cancelled webhook documentation still describes
recipient as the receiving device and nullable, which conflicts with the
outbound event shape. Update the sms:cancelled field description in the webhooks
docs so recipient is clearly documented as the destination phone number for the
cancelled outgoing message, using the existing sms:cancelled section and
recipient field label as the reference point.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

• Push a commit to this branch (recommended)
• Create a new PR with the fixes

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: b2306062-6d0e-4370-ac65-5da06d0e3846

📥 Commits

Reviewing files that changed from the base of the PR and between b2c212a and 3ff680f.

📒 Files selected for processing (4)

• docs/features/sending-messages.md
• docs/features/status-tracking.md
• docs/features/webhooks.md
• docs/integration/authentication.md