Skip to content

Added pin and save limits and the missing message operations to the o… #517

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
pranavkamble-cometchat wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Added pin and save limits and the missing message operations to the o… #517

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4ecf63e
Added pin and save limits and the missing message operations to the o…
pranavkamble-cometchat Sep 10, 2026
ec2704d
docs(rest-api): fix pin/save limit wording, add error and constraint …
pranavkamble-cometchat Sep 10, 2026
29e54a0
Wrong message fixed
pranavkamble-cometchat Sep 11, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions articles/properties-and-constraints.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
| Maximum unread messages per user | No limit |
| Maximum users per app | No limit |
| Maximum bot users per app | 25 |
| User/Group ID (`uid`, `guid`) | Max 100 characters, alpha-dash (`a-z`, `0-9`, `-`, `_`), no spaces. Automatically lowercased. |

Check warning on line 30 in articles/properties-and-constraints.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

articles/properties-and-constraints.mdx#L30 

Did you really mean 'lowercased'?
| User/Group name | Max 100 characters, UTF8mb4 (supports all languages and emojis) |
| User/Group avatar | Must be a valid URL, max 3,000 characters. Image is not stored by CometChat — URL must remain accessible. |
| User profile link | Must be a valid URL, max 3,000 characters |
Expand All @@ -45,7 +45,7 @@
| **Property** | **Constraints** |
| --------------------- | --------------------------------------------------------------------------------------------- |
| Maximum roles per app | 25 |
| Role ID | Max 100 characters, alpha-dash (`a-z`, `0-9`, `-`, `_`), no spaces. Automatically lowercased. |

Check warning on line 48 in articles/properties-and-constraints.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

articles/properties-and-constraints.mdx#L48 

Did you really mean 'lowercased'?
| Role name | Max 100 characters, UTF8mb4 (supports all languages and emojis) |
| Role description | Max 255 characters, UTF8mb4 |
| Role metadata | No limit |
Expand All @@ -59,6 +59,8 @@
| Message `data` object | Arbitrary JSON, UTF8mb4. Reserved keys: `text`, `attachments`, `custom_data`, `metadata`. Max 10 KB for the `data` object. Attachment file size is counted separately. |
| Message tags | Max 25 tags, each up to 100 characters, UTF8mb4 |
| Conversation tags | Max 25 tags, each up to 100 characters, UTF8mb4 |
| Pinned messages per conversation | Configured per app. Pins made on behalf of a user and pins made as the app (without `onBehalfOf`) count against separate budgets. |
| Saved messages per user | Configured per app. Saved messages are private to the user who saved them. |
| Soft-deleted messages retained | Yes |
| Permanently deleted messages (via API) retained | No |

Expand All @@ -70,5 +72,5 @@
| Default video frame rate | 30 FPS |
| Video resolution | Min 180p, max 720p (varies by layout and user bandwidth) |
| Media encryption | SRTP |
| Audio codec | OPUS |

Check warning on line 75 in articles/properties-and-constraints.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

articles/properties-and-constraints.mdx#L75 

Did you really mean 'codec'?
| Video codec | H.264 |

Check warning on line 76 in articles/properties-and-constraints.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

articles/properties-and-constraints.mdx#L76 

Did you really mean 'codec'?
28 changes: 14 additions & 14 deletions calls.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -167,7 +167,7 @@
"totalDuration": "00:00:19",
"hasRecording": false,
"initiatedAt": 1692368168,
"initiator": "superhero8",
"initiator": "cometchat-uid-8",
"mode": "call",
"receiver": "sivamathewstestgroup",
"receiverType": "group",
Expand All @@ -180,7 +180,7 @@
"endedAt": 1692368199,
"participants": [
{
"uid": "superhero2",
"uid": "cometchat-uid-2",
"totalAudioMinutes": 0.31666666666666665,
"totalVideoMinutes": 0,
"isJoined": true,
Expand All @@ -192,7 +192,7 @@
"leftAt": 1692368199
},
{
"uid": "superhero8",
"uid": "cometchat-uid-8",
"totalAudioMinutes": 0.2833333333333333,
"totalVideoMinutes": 0,
"isJoined": true,
Expand All @@ -204,23 +204,23 @@
"leftAt": 1692368197
},
{
"uid": "superhero4",
"uid": "cometchat-uid-4",
"totalAudioMinutes": 0,
"totalVideoMinutes": 0,
"isJoined": false,
"state": "unanswered",
"totalDuration": 0
},
{
"uid": "superhero7",
"uid": "cometchat-uid-7",
"totalAudioMinutes": 0,
"totalVideoMinutes": 0,
"isJoined": false,
"state": "unanswered",
"totalDuration": 0
},
{
"uid": "superhero6",
"uid": "cometchat-uid-6",
"totalAudioMinutes": 0,
"totalVideoMinutes": 0,
"isJoined": false,
Expand All @@ -236,9 +236,9 @@
"totalDuration": "00:00:19",
"hasRecording": false,
"initiatedAt": 1692368113,
"initiator": "superhero8",
"initiator": "cometchat-uid-8",
"mode": "call",
"receiver": "superhero2",
"receiver": "cometchat-uid-2",
"receiverType": "user",
"status": "ended",
"totalDurationInMinutes": 0.31666666666666665,
Expand All @@ -249,7 +249,7 @@
"endedAt": 1692368146,
"participants": [
{
"uid": "superhero8",
"uid": "cometchat-uid-8",
"totalAudioMinutes": 0.26666666666666666,
"totalVideoMinutes": 0,
"totalDuration": 0.26666666666666666,
Expand All @@ -261,7 +261,7 @@
"leftAt": 1692368144
},
{
"uid": "superhero2",
"uid": "cometchat-uid-2",
"totalAudioMinutes": 0.23333333333333334,
"totalVideoMinutes": 0,
"totalDuration": 0.23333333333333334,
Expand Down Expand Up @@ -344,9 +344,9 @@
"metaData": [],
"hasRecording": false,
"initiatedAt": 1692368113,
"initiator": "superhero8",
"initiator": "cometchat-uid-8",
"mode": "call",
"receiver": "superhero2",
"receiver": "cometchat-uid-2",
"receiverType": "user",
"status": "ended",
"tags": [],
Expand All @@ -358,7 +358,7 @@
"endedAt": 1692368146,
"participants": [
{
"uid": "superhero2",
"uid": "cometchat-uid-2",
"totalAudioMinutes": 0.23333333333333334,
"totalVideoMinutes": 0,
"totalDuration": 0.23333333333333334,
Expand All @@ -370,7 +370,7 @@
"leftAt": 1692368146
},
{
"uid": "superhero8",
"uid": "cometchat-uid-8",
"totalAudioMinutes": 0.26666666666666666,
"totalVideoMinutes": 0,
"totalDuration": 0.26666666666666666,
Expand Down
24 changes: 12 additions & 12 deletions calls/webhooks-ringing.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,11 @@

Triggered when a user initiates a call to another user or group.

**Idempotency Key**: `webhook` + `trigger` + `data.call.id` + `data.call.sentAt`

Check warning on line 19 in calls/webhooks-ringing.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

calls/webhooks-ringing.mdx#L19 

Did you really mean 'Idempotency'?

```json
{
"trigger": "call_initiated",

Check warning on line 23 in calls/webhooks-ringing.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

calls/webhooks-ringing.mdx#L23 

Did you really mean 'call_initiated'?
"data": {
"call": {
"id": "52",
Expand All @@ -41,7 +41,7 @@
"role": "default",
"lastActiveAt": 1696933934
},
"entityType": "user"

Check warning on line 44 in calls/webhooks-ringing.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

calls/webhooks-ringing.mdx#L44 

Did you really mean 'entityType'?
},
"on": {
"entity": {
Expand All @@ -50,15 +50,15 @@
"type": "audio",
"initiatedAt": 1696934199
},
"entityType": "call"

Check warning on line 53 in calls/webhooks-ringing.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

calls/webhooks-ringing.mdx#L53 

Did you really mean 'entityType'?
}
}
},
"sentAt": 1696934199,

Check warning on line 57 in calls/webhooks-ringing.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

calls/webhooks-ringing.mdx#L57 

Did you really mean 'sentAt'?
"updatedAt": 1696934199

Check warning on line 58 in calls/webhooks-ringing.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

calls/webhooks-ringing.mdx#L58 

Did you really mean 'updatedAt'?
}
},
"appId": "<appId>",

Check warning on line 61 in calls/webhooks-ringing.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

calls/webhooks-ringing.mdx#L61 

Did you really mean 'appId'?
"region": "<region>",
"webhook": "<webhookID>"
}
Expand Down Expand Up @@ -92,11 +92,11 @@

Triggered when a participant joins the active call.

**Idempotency Key**: `webhook` + `trigger` + `data.sessionId` + `data.occupant.joined_at`

Check warning on line 95 in calls/webhooks-ringing.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

calls/webhooks-ringing.mdx#L95 

Did you really mean 'Idempotency'?

```json
{
"trigger": "call_participant_joined",

Check warning on line 99 in calls/webhooks-ringing.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

calls/webhooks-ringing.mdx#L99 

Did you really mean 'call_participant_joined'?
"data": {
"occupant": {
"joined_at": 1696934573,
Expand Down Expand Up @@ -128,11 +128,11 @@

Triggered when a participant leaves the active call.

**Idempotency Key**: `webhook` + `trigger` + `data.sessionId` + `data.occupant.left_at`

Check warning on line 131 in calls/webhooks-ringing.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

calls/webhooks-ringing.mdx#L131 

Did you really mean 'Idempotency'?

```json
{
"trigger": "call_participant_left",

Check warning on line 135 in calls/webhooks-ringing.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

calls/webhooks-ringing.mdx#L135 

Did you really mean 'call_participant_left'?
"data": {
"occupant": {
"joined_at": 1696934501,
Expand All @@ -155,11 +155,11 @@

Triggered when the call session ends (all participants have left).

**Idempotency Key**: `webhook` + `trigger` + `data.sessionId` + `data.destroyed_at`

Check warning on line 158 in calls/webhooks-ringing.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

calls/webhooks-ringing.mdx#L158 

Did you really mean 'Idempotency'?

```json
{
"trigger": "call_ended",

Check warning on line 162 in calls/webhooks-ringing.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

calls/webhooks-ringing.mdx#L162 

Did you really mean 'call_ended'?
"data": {
"all_occupants": [
{
Expand Down Expand Up @@ -196,18 +196,18 @@
This event is exclusive to 1-on-1 calls. In group calls, all participants can join at any time, so a "busy" state does not apply.
</Note>

**Idempotency Key**: `webhook` + `trigger` + `data.call.id` + `data.call.sentAt`

Check warning on line 199 in calls/webhooks-ringing.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

calls/webhooks-ringing.mdx#L199 

Did you really mean 'Idempotency'?

```json
{
"trigger": "call_busy",

Check warning on line 203 in calls/webhooks-ringing.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

calls/webhooks-ringing.mdx#L203 

Did you really mean 'call_busy'?
"data": {
"call": {
"id": "43414",
"conversationId": "superhero1_user_superhero3",
"sender": "superhero3",
"conversationId": "cometchat-uid-1_user_cometchat-uid-3",
"sender": "cometchat-uid-3",
"receiverType": "user",
"receiver": "superhero1",
"receiver": "cometchat-uid-1",
"category": "call",
"type": "audio",
"data": {
Expand All @@ -229,18 +229,18 @@

Triggered when the caller cancels the call before it is answered.

**Idempotency Key**: `webhook` + `trigger` + `data.call.id` + `data.call.sentAt`

Check warning on line 232 in calls/webhooks-ringing.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

calls/webhooks-ringing.mdx#L232 

Did you really mean 'Idempotency'?

```json
{
"trigger": "call_cancelled",

Check warning on line 236 in calls/webhooks-ringing.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

calls/webhooks-ringing.mdx#L236 

Did you really mean 'call_cancelled'?
"data": {
"call": {
"id": "43408",
"conversationId": "superhero3_user_superhero4",
"sender": "superhero4",
"conversationId": "cometchat-uid-3_user_cometchat-uid-4",
"sender": "cometchat-uid-4",
"receiverType": "user",
"receiver": "superhero3",
"receiver": "cometchat-uid-3",
"category": "call",
"type": "audio",
"data": {
Expand All @@ -266,18 +266,18 @@
In group calls, this event is not triggered — the call remains active as long as at least one member joins.
</Note>

**Idempotency Key**: `webhook` + `trigger` + `data.call.id` + `data.call.sentAt`

Check warning on line 269 in calls/webhooks-ringing.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

calls/webhooks-ringing.mdx#L269 

Did you really mean 'Idempotency'?

```json
{
"trigger": "call_rejected",

Check warning on line 273 in calls/webhooks-ringing.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

calls/webhooks-ringing.mdx#L273 

Did you really mean 'call_rejected'?
"data": {
"call": {
"id": "43406",
"conversationId": "superhero3_user_superhero4",
"sender": "superhero3",
"conversationId": "cometchat-uid-3_user_cometchat-uid-4",
"sender": "cometchat-uid-3",
"receiverType": "user",
"receiver": "superhero4",
"receiver": "cometchat-uid-4",
"category": "call",
"type": "audio",
"data": {
Expand All @@ -299,18 +299,18 @@

Triggered when a call goes unanswered. For group calls, this fires only if no members join at all.

**Idempotency Key**: `webhook` + `trigger` + `data.call.id` + `data.call.sentAt`

Check warning on line 302 in calls/webhooks-ringing.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

calls/webhooks-ringing.mdx#L302 

Did you really mean 'Idempotency'?

```json
{
"trigger": "call_unanswered",

Check warning on line 306 in calls/webhooks-ringing.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

calls/webhooks-ringing.mdx#L306 

Did you really mean 'call_unanswered'?
"data": {
"call": {
"id": "43410",
"conversationId": "superhero3_user_superhero4",
"sender": "superhero4",
"conversationId": "cometchat-uid-3_user_cometchat-uid-4",
"sender": "cometchat-uid-4",
"receiverType": "user",
"receiver": "superhero3",
"receiver": "cometchat-uid-3",
"category": "call",
"type": "audio",
"data": {
Expand Down
Loading