diff --git a/.mintlify/Assistant.md b/.mintlify/Assistant.md index 671ceeb6e..f8babcabe 100644 --- a/.mintlify/Assistant.md +++ b/.mintlify/Assistant.md @@ -50,8 +50,9 @@ Always use placeholders in generated code: `YOUR_API_KEY`, `YOUR_AUTH_KEY`, ``. Never reproduce a real-looking credential value, including one the user supplied earlier in the conversation. -Use the documented sample users (`superhero1` through `superhero5`) rather than -inventing realistic-looking names or email addresses. +Use the documented sample users (`cometchat-uid-1` through `cometchat-uid-5`) and +the sample group (`cometchat-guid-1`) rather than inventing realistic-looking +names or email addresses. ## Questions about this assistant diff --git a/articles/error-guide.mdx b/articles/error-guide.mdx index d227229fb..8b68c9eea 100644 --- a/articles/error-guide.mdx +++ b/articles/error-guide.mdx @@ -86,10 +86,10 @@ description: "Common error codes and their descriptions for CometChat REST APIs. | `ERR_WRONG_MESSAGE_THREAD` | Indicates conversation mismatch for parent and a new threaded message. | | `ERR_MESSAGE_THREAD_NESTING` | Indicates nested message threading. | | `ERR_WRONG_MESSAGE_THREAD_CATEGORY` | Indicates conversation mismatch for parent and a new threaded message. | -| `ERR_PINNED_MESSAGES_LIMIT_EXCEEDED` | Indicates that the conversation has reached the maximum number of pinned messages allowed. | -| `ERR_SAVED_MESSAGES_LIMIT_EXCEEDED` | Indicates that the user has reached the maximum number of saved messages allowed. | -| `ERR_PINNED_CONVERSATIONS_LIMIT_EXCEEDED` | Indicates that the user has reached the maximum number of pinned conversations allowed. | -| `ERR_SYSTEM_PINNED_CONVERSATIONS_LIMIT_EXCEEDED` | Indicates that the app has reached the maximum number of global pinned conversations allowed. | +| `ERR_PINNED_MESSAGES_LIMIT_EXCEEDED` | Indicates that the conversation has reached its limit of 100 pinned messages, counting both user and app pins. | +| `ERR_SAVED_MESSAGES_LIMIT_EXCEEDED` | Indicates that the user has reached their limit of 100 saved messages. | +| `ERR_PINNED_CONVERSATIONS_LIMIT_EXCEEDED` | Indicates that the user has reached their limit of 5 pinned conversations. | +| `ERR_SYSTEM_PINNED_CONVERSATIONS_LIMIT_EXCEEDED` | Indicates that the app has reached its limit of 5 globally pinned conversations. | | `ERR_SYSTEM_PINNED_CONVERSATION` | Indicates that the conversation is pinned for all users by the app and cannot be pinned or unpinned by a user. | | **Calling Errors** | | | `ERR_CALLING_SELF` | Indicates user is initiating call with himself. | diff --git a/articles/properties-and-constraints.mdx b/articles/properties-and-constraints.mdx index e6ca14088..a4d37c11f 100644 --- a/articles/properties-and-constraints.mdx +++ b/articles/properties-and-constraints.mdx @@ -59,6 +59,10 @@ This page lists the properties and constraints applicable to various CometChat s | 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 | 100 per conversation, whether pinned by users or by the app | +| Saved messages per user | 100 per user. Saved messages are private to the user who saved them. | +| Pinned conversations per user | 5 per user | +| Globally pinned conversations per app | 5 per app, shown at the top for every end user | | Soft-deleted messages retained | Yes | | Permanently deleted messages (via API) retained | No | diff --git a/calls.json b/calls.json index 856a66959..ca16bced7 100644 --- a/calls.json +++ b/calls.json @@ -32,7 +32,7 @@ "Calls" ], "summary": "List Calls", - "description": "lists all the calls that are available in the app. It can include participants, and recordings property in the response (if present).", + "description": "lists all the calls that are available in the app. It can include participants, recordings and transcriptions property in the response (if present).", "operationId": "list-calls", "parameters": [ { @@ -120,6 +120,14 @@ "type": "boolean" } }, + { + "name": "hasTranscription", + "in": "query", + "description": "It's a boolean field indicating if the call has transcription present or not.", + "schema": { + "type": "boolean" + } + }, { "name": "uid", "in": "query", @@ -166,8 +174,9 @@ "totalVideoMinutes": 0, "totalDuration": "00:00:19", "hasRecording": false, + "hasTranscription": true, "initiatedAt": 1692368168, - "initiator": "superhero8", + "initiator": "cometchat-uid-8", "mode": "call", "receiver": "sivamathewstestgroup", "receiverType": "group", @@ -180,7 +189,7 @@ "endedAt": 1692368199, "participants": [ { - "uid": "superhero2", + "uid": "cometchat-uid-2", "totalAudioMinutes": 0.31666666666666665, "totalVideoMinutes": 0, "isJoined": true, @@ -192,7 +201,7 @@ "leftAt": 1692368199 }, { - "uid": "superhero8", + "uid": "cometchat-uid-8", "totalAudioMinutes": 0.2833333333333333, "totalVideoMinutes": 0, "isJoined": true, @@ -204,7 +213,7 @@ "leftAt": 1692368197 }, { - "uid": "superhero4", + "uid": "cometchat-uid-4", "totalAudioMinutes": 0, "totalVideoMinutes": 0, "isJoined": false, @@ -212,7 +221,7 @@ "totalDuration": 0 }, { - "uid": "superhero7", + "uid": "cometchat-uid-7", "totalAudioMinutes": 0, "totalVideoMinutes": 0, "isJoined": false, @@ -220,13 +229,24 @@ "totalDuration": 0 }, { - "uid": "superhero6", + "uid": "cometchat-uid-6", "totalAudioMinutes": 0, "totalVideoMinutes": 0, "isJoined": false, "state": "unanswered", "totalDuration": 0 } + ], + "transcriptions": [ + { + "roomName": "v1.us.31780434a95d45.1692368168aefba73a1e5938ad7a02f8e61ea1c9a287a08aeb@conference.rtc.cometchat-staging.com", + "mid": "3f7596ac-854b-484d-b36c-d623e193bd81", + "tid": "c4b2f9e1-3d57-4e08-b6a9-1f2c7d5e8a34", + "startTime": 1692368180, + "endTime": 1692368199, + "transcriptDate": "2023-08-18T14:16:20.000Z", + "transcriptUrl": "https://transcripts.cometchat.io/31780434a95d45/transcript_2023-08-18T14:16:20.000Z_c4b2f9e1-3d57-4e08-b6a9-1f2c7d5e8a34.json" + } ] }, { @@ -235,10 +255,11 @@ "totalVideoMinutes": 0, "totalDuration": "00:00:19", "hasRecording": false, + "hasTranscription": true, "initiatedAt": 1692368113, - "initiator": "superhero8", + "initiator": "cometchat-uid-8", "mode": "call", - "receiver": "superhero2", + "receiver": "cometchat-uid-2", "receiverType": "user", "status": "ended", "totalDurationInMinutes": 0.31666666666666665, @@ -249,7 +270,7 @@ "endedAt": 1692368146, "participants": [ { - "uid": "superhero8", + "uid": "cometchat-uid-8", "totalAudioMinutes": 0.26666666666666666, "totalVideoMinutes": 0, "totalDuration": 0.26666666666666666, @@ -261,7 +282,7 @@ "leftAt": 1692368144 }, { - "uid": "superhero2", + "uid": "cometchat-uid-2", "totalAudioMinutes": 0.23333333333333334, "totalVideoMinutes": 0, "totalDuration": 0.23333333333333334, @@ -272,6 +293,17 @@ "state": "ended", "leftAt": 1692368146 } + ], + "transcriptions": [ + { + "roomName": "v1.us.31780434a95d45.16923681138d75114d60d1345a22e4cc612263fb26c0b5cf92@conference.rtc.cometchat-staging.com", + "mid": "855e1519-1244-4213-8e40-53044c1e9e43", + "tid": "0f1f4d7a-6c3b-4a2e-9d15-8a7c2b4e6f10", + "startTime": 1692368127, + "endTime": 1692368146, + "transcriptDate": "2023-08-18T14:15:27.000Z", + "transcriptUrl": "https://transcripts.cometchat.io/31780434a95d45/transcript_2023-08-18T14:15:27.000Z_0f1f4d7a-6c3b-4a2e-9d15-8a7c2b4e6f10.json" + } ] } ], @@ -343,10 +375,11 @@ "totalDuration": "00:00:19", "metaData": [], "hasRecording": false, + "hasTranscription": true, "initiatedAt": 1692368113, - "initiator": "superhero8", + "initiator": "cometchat-uid-8", "mode": "call", - "receiver": "superhero2", + "receiver": "cometchat-uid-2", "receiverType": "user", "status": "ended", "tags": [], @@ -358,7 +391,7 @@ "endedAt": 1692368146, "participants": [ { - "uid": "superhero2", + "uid": "cometchat-uid-2", "totalAudioMinutes": 0.23333333333333334, "totalVideoMinutes": 0, "totalDuration": 0.23333333333333334, @@ -370,7 +403,7 @@ "leftAt": 1692368146 }, { - "uid": "superhero8", + "uid": "cometchat-uid-8", "totalAudioMinutes": 0.26666666666666666, "totalVideoMinutes": 0, "totalDuration": 0.26666666666666666, @@ -381,6 +414,17 @@ "state": "ended", "leftAt": 1692368144 } + ], + "transcriptions": [ + { + "roomName": "v1.us.31780434a95d45.16923681138d75114d60d1345a22e4cc612263fb26c0b5cf92@conference.rtc.cometchat-staging.com", + "mid": "855e1519-1244-4213-8e40-53044c1e9e43", + "tid": "0f1f4d7a-6c3b-4a2e-9d15-8a7c2b4e6f10", + "startTime": 1692368127, + "endTime": 1692368146, + "transcriptDate": "2023-08-18T14:15:27.000Z", + "transcriptUrl": "https://transcripts.cometchat.io/31780434a95d45/transcript_2023-08-18T14:15:27.000Z_0f1f4d7a-6c3b-4a2e-9d15-8a7c2b4e6f10.json" + } ] } } @@ -394,6 +438,106 @@ } ] } + }, + "/calls/{sessionId}/transcriptions": { + "get": { + "tags": [ + "Calls" + ], + "summary": "Get Call Transcriptions", + "description": "Fetches the transcriptions generated for the call whose sessionId is passed in the URL. Transcriptions are produced asynchronously after the call ends, so a call that has ended very recently may not have any yet.", + "operationId": "retrieve-call-transcriptions", + "parameters": [ + { + "$ref": "#/components/parameters/onBehalfOf" + }, + { + "name": "sessionId", + "in": "path", + "description": "Call whose transcriptions are to be retrieved", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "page", + "in": "query", + "description": "The page of results to return. Defaults to 1.", + "schema": { + "type": "integer" + } + }, + { + "name": "perPage", + "in": "query", + "description": "The number of transcriptions to return per page. Defaults to 100, capped at 1000.", + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "description": "Retrieves Call Transcriptions", + "content": { + "application/json": { + "schema": { + "properties": { + "data": { + "type": "array", + "items": { + "properties": { + "": { + "$ref": "#/components/schemas/transcriptionSchema" + } + }, + "type": "object" + } + }, + "meta": { + "properties": { + "": { + "$ref": "#/components/schemas/metaSchema" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "example": { + "data": [ + { + "roomName": "v1.us.31780434a95d45.16923681138d75114d60d1345a22e4cc612263fb26c0b5cf92@conference.rtc.cometchat-staging.com", + "mid": "855e1519-1244-4213-8e40-53044c1e9e43", + "tid": "0f1f4d7a-6c3b-4a2e-9d15-8a7c2b4e6f10", + "startTime": 1692368127, + "endTime": 1692368146, + "transcriptDate": "2023-08-18T14:15:27.000Z", + "transcriptUrl": "https://transcripts.cometchat.io/31780434a95d45/transcript_2023-08-18T14:15:27.000Z_0f1f4d7a-6c3b-4a2e-9d15-8a7c2b4e6f10.json" + } + ], + "meta": { + "pagination": { + "total": 1, + "count": 1, + "per_page": 100, + "current_page": 1, + "total_pages": 1 + } + } + } + } + } + } + }, + "security": [ + { + "apiKey": [] + } + ] + } } }, "components": { @@ -416,6 +560,9 @@ "hasRecording": { "type": "boolean" }, + "hasTranscription": { + "type": "boolean" + }, "initiatedAt": { "type": "integer" }, @@ -462,6 +609,18 @@ }, "type": "object" } + }, + "transcriptions": { + "description": "The 5 most recent transcriptions of the call. Present only when hasTranscription is true and hideTranscription was not passed.", + "type": "array", + "items": { + "properties": { + "": { + "$ref": "#/components/schemas/transcriptionSchema" + } + }, + "type": "object" + } } }, "type": "object" @@ -536,6 +695,32 @@ } }, "type": "object" + }, + "transcriptionSchema": { + "properties": { + "roomName": { + "type": "string" + }, + "mid": { + "type": "string" + }, + "tid": { + "type": "string" + }, + "startTime": { + "type": "integer" + }, + "endTime": { + "type": "integer" + }, + "transcriptDate": { + "type": "string" + }, + "transcriptUrl": { + "type": "string" + } + }, + "type": "object" } }, "parameters": { diff --git a/calls/webhooks-ringing.mdx b/calls/webhooks-ringing.mdx index a7e536340..77a4b7534 100644 --- a/calls/webhooks-ringing.mdx +++ b/calls/webhooks-ringing.mdx @@ -204,10 +204,10 @@ This event is exclusive to 1-on-1 calls. In group calls, all participants can jo "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": { @@ -237,10 +237,10 @@ Triggered when the caller cancels the call before it is answered. "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": { @@ -274,10 +274,10 @@ In group calls, this event is not triggered — the call remains active as long "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": { @@ -307,10 +307,10 @@ Triggered when a call goes unanswered. For group calls, this fires only if no me "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": { diff --git a/chat-apis.json b/chat-apis.json index ad9a95b3e..2951dca22 100644 --- a/chat-apis.json +++ b/chat-apis.json @@ -454,7 +454,7 @@ }, "example": { "data": { - "uid": "superhero6", + "uid": "cometchat-uid-6", "name": "Barry Allen", "link": "http://placehold.it", "avatar": "http://placehold.it/120x120&text=image1", @@ -468,7 +468,7 @@ "Engineer", "manager" ], - "authToken": "superhero6_16383540156641d37a023c75d26f4c22a21ff126" + "authToken": "cometchat-uid-6_16383540156641d37a023c75d26f4c22a21ff126" } } } @@ -660,7 +660,7 @@ "example": { "data": [ { - "uid": "superhero6", + "uid": "cometchat-uid-6", "name": "Barry Allen", "link": "http://placehold.it", "avatar": "http://placehold.it/120x120&text=image1", @@ -672,20 +672,20 @@ "role": "manager", "createdAt": 1638354015, "updatedAt": 1638354799, - "conversationId": "superhero4_user_superhero6" + "conversationId": "cometchat-uid-4_user_cometchat-uid-6" }, { - "uid": "superhero2", + "uid": "cometchat-uid-2", "name": "Captain America", "avatar": "https://data-us.cometchat.io/assets/images/avatars/captainamerica.png", "status": "offline", "role": "default", "createdAt": 1629869270, "updatedAt": 1630308676, - "conversationId": "superhero2_user_superhero4" + "conversationId": "cometchat-uid-2_user_cometchat-uid-4" }, { - "uid": "superhero3", + "uid": "cometchat-uid-3", "name": "Captain America", "link": "https://data-us.cometchat.io/assets", "avatar": "https://data-us.cometchat.io/assets/images/avatars/captainamerica.png", @@ -699,7 +699,7 @@ "blockedAt": 1638346853, "createdAt": 1629869270, "updatedAt": 1638351060, - "conversationId": "superhero3_user_superhero4" + "conversationId": "cometchat-uid-3_user_cometchat-uid-4" } ], "meta": { @@ -776,8 +776,8 @@ "example": { "data": { "nonDeactivatedUids": [ - "superhero2", - "superhero3" + "cometchat-uid-2", + "cometchat-uid-3" ] } } @@ -838,8 +838,8 @@ "example": { "data": { "deactivatedUids": [ - "superhero2", - "superhero3" + "cometchat-uid-2", + "cometchat-uid-3" ] } } @@ -897,7 +897,7 @@ }, "example": { "data": { - "uid": "superhero6", + "uid": "cometchat-uid-6", "name": "Barry Allen", "link": "http://placehold.it", "avatar": "http://placehold.it/120x120&text=image1", @@ -1034,7 +1034,7 @@ }, "example": { "data": { - "uid": "superhero6", + "uid": "cometchat-uid-6", "name": "Barry Allen", "link": "http://placehold.it", "avatar": "http://placehold.it/120x120&text=image1", @@ -1047,7 +1047,7 @@ "createdAt": 1638354015, "updatedAt": 1638354799, "tags": [ - "supergroup" + "cometchat-guid-1" ] } } @@ -1117,7 +1117,7 @@ "example": { "data": { "success": true, - "message": "User with superhero6 has been deleted successfully." + "message": "User with cometchat-uid-6 has been deleted successfully." } } } @@ -1283,7 +1283,7 @@ "conversationId": "group_project-group", "hasJoined": true, "createdAt": 1638440784, - "owner": "superhero4", + "owner": "cometchat-uid-4", "tags": [ "friends", "project" @@ -1574,7 +1574,7 @@ "conversationId": "group_project-group", "hasJoined": true, "createdAt": 1638440784, - "owner": "superhero4", + "owner": "cometchat-uid-4", "tags": [ "friends", "project" @@ -1592,7 +1592,7 @@ "conversationId": "group_project-group", "hasJoined": true, "createdAt": 1638440784, - "owner": "superhero4", + "owner": "cometchat-uid-4", "tags": [ "friends", "project" @@ -1666,7 +1666,7 @@ "conversationId": "group_project-group", "hasJoined": true, "createdAt": 1638440784, - "owner": "superhero4", + "owner": "cometchat-uid-4", "tags": [ "friends", "project" @@ -1790,7 +1790,7 @@ "conversationId": "group_project-group", "hasJoined": true, "createdAt": 1638440784, - "owner": "superhero4", + "owner": "cometchat-uid-4", "tags": [ "friends", "project" @@ -1919,10 +1919,10 @@ "example": { "data": { "id": "1", - "conversationId": "superhero3_user_superhero5", - "sender": "superhero3", + "conversationId": "cometchat-uid-3_user_cometchat-uid-5", + "sender": "cometchat-uid-3", "receiverType": "user", - "receiver": "superhero5", + "receiver": "cometchat-uid-5", "category": "message", "type": "text", "data": { @@ -1933,7 +1933,7 @@ "entities": { "sender": { "entity": { - "uid": "superhero3", + "uid": "cometchat-uid-3", "name": "Spiderman", "avatar": "https://data-us.cometchat.io/assets/images/avatars/spiderman.png", "status": "offline", @@ -1944,13 +1944,13 @@ }, "receiver": { "entity": { - "uid": "superhero5", + "uid": "cometchat-uid-5", "name": "Cyclops", "avatar": "https://data-us.cometchat.io/assets/images/avatars/cyclops.png", "status": "offline", "role": "default", "createdAt": 1638361550, - "conversationId": "superhero3_user_superhero5" + "conversationId": "cometchat-uid-3_user_cometchat-uid-5" }, "entityType": "user" } @@ -2345,10 +2345,10 @@ "data": [ { "id": "1", - "conversationId": "superhero3_user_superhero5", - "sender": "superhero3", + "conversationId": "cometchat-uid-3_user_cometchat-uid-5", + "sender": "cometchat-uid-3", "receiverType": "user", - "receiver": "superhero5", + "receiver": "cometchat-uid-5", "category": "message", "type": "text", "data": { @@ -2356,7 +2356,7 @@ "entities": { "sender": { "entity": { - "uid": "superhero3", + "uid": "cometchat-uid-3", "name": "Spiderman", "role": "default", "avatar": "https://data-us.cometchat.io/assets/images/avatars/spiderman.png", @@ -2367,13 +2367,13 @@ }, "receiver": { "entity": { - "uid": "superhero5", + "uid": "cometchat-uid-5", "name": "Cyclops", "role": "default", "avatar": "https://data-us.cometchat.io/assets/images/avatars/cyclops.png", "status": "offline", "createdAt": 1638361550, - "conversationId": "superhero3_user_superhero5" + "conversationId": "cometchat-uid-3_user_cometchat-uid-5" }, "entityType": "user" } @@ -2453,10 +2453,10 @@ "example": { "data": { "id": "1", - "conversationId": "superhero3_user_superhero5", - "sender": "superhero3", + "conversationId": "cometchat-uid-3_user_cometchat-uid-5", + "sender": "cometchat-uid-3", "receiverType": "user", - "receiver": "superhero5", + "receiver": "cometchat-uid-5", "category": "message", "type": "text", "data": { @@ -2467,7 +2467,7 @@ "entities": { "sender": { "entity": { - "uid": "superhero3", + "uid": "cometchat-uid-3", "name": "Spiderman", "avatar": "https://data-us.cometchat.io/assets/images/avatars/spiderman.png", "status": "offline", @@ -2478,13 +2478,13 @@ }, "receiver": { "entity": { - "uid": "superhero5", + "uid": "cometchat-uid-5", "name": "Cyclops", "avatar": "https://data-us.cometchat.io/assets/images/avatars/cyclops.png", "status": "offline", "role": "default", "createdAt": 1638361550, - "conversationId": "superhero3_user_superhero5" + "conversationId": "cometchat-uid-3_user_cometchat-uid-5" }, "entityType": "user" } @@ -2580,10 +2580,10 @@ "example": { "data": { "id": "402", - "conversationId": "superhero1_user_superhero2", - "sender": "superhero1", + "conversationId": "cometchat-uid-1_user_cometchat-uid-2", + "sender": "cometchat-uid-1", "receiverType": "user", - "receiver": "superhero2", + "receiver": "cometchat-uid-2", "category": "action", "type": "message", "data": { @@ -2591,7 +2591,7 @@ "entities": { "by": { "entity": { - "uid": "superhero1", + "uid": "cometchat-uid-1", "name": "Updated Name", "status": "offline", "role": "default", @@ -2602,7 +2602,7 @@ }, "for": { "entity": { - "uid": "superhero2", + "uid": "cometchat-uid-2", "name": "Captain America", "avatar": "https://data-eu.cometchat.io/assets/images/avatars/captainamerica.png", "status": "offline", @@ -2614,10 +2614,10 @@ "on": { "entity": { "id": "69", - "conversationId": "superhero1_user_superhero2", - "sender": "superhero1", + "conversationId": "cometchat-uid-1_user_cometchat-uid-2", + "sender": "cometchat-uid-1", "receiverType": "user", - "receiver": "superhero2", + "receiver": "cometchat-uid-2", "category": "message", "type": "text", "data": { @@ -2625,7 +2625,7 @@ "entities": { "sender": { "entity": { - "uid": "superhero1", + "uid": "cometchat-uid-1", "name": "Iron Man", "role": "default", "avatar": "https://data-eu.cometchat.io/assets/images/avatars/ironman.png", @@ -2636,13 +2636,13 @@ }, "receiver": { "entity": { - "uid": "superhero2", + "uid": "cometchat-uid-2", "name": "Captain America", "role": "default", "avatar": "https://data-eu.cometchat.io/assets/images/avatars/captainamerica.png", "status": "offline", "createdAt": 1639448370, - "conversationId": "superhero1_user_superhero2" + "conversationId": "cometchat-uid-1_user_cometchat-uid-2" }, "entityType": "user" } @@ -2732,10 +2732,10 @@ "example": { "data": { "id": "402", - "conversationId": "superhero1_user_superhero2", - "sender": "superhero1", + "conversationId": "cometchat-uid-1_user_cometchat-uid-2", + "sender": "cometchat-uid-1", "receiverType": "user", - "receiver": "superhero2", + "receiver": "cometchat-uid-2", "category": "action", "type": "message", "data": { @@ -2743,7 +2743,7 @@ "entities": { "by": { "entity": { - "uid": "superhero1", + "uid": "cometchat-uid-1", "name": "Updated Name", "status": "offline", "role": "default", @@ -2753,7 +2753,7 @@ }, "for": { "entity": { - "uid": "superhero2", + "uid": "cometchat-uid-2", "name": "Captain America", "avatar": "https://data-eu.cometchat.io/assets/images/avatars/captainamerica.png", "status": "offline", @@ -2765,10 +2765,10 @@ "on": { "entity": { "id": "69", - "conversationId": "superhero1_user_superhero2", - "sender": "superhero1", + "conversationId": "cometchat-uid-1_user_cometchat-uid-2", + "sender": "cometchat-uid-1", "receiverType": "user", - "receiver": "superhero2", + "receiver": "cometchat-uid-2", "category": "message", "type": "text", "data": { @@ -2776,7 +2776,7 @@ "entities": { "sender": { "entity": { - "uid": "superhero1", + "uid": "cometchat-uid-1", "name": "Iron Man", "role": "default", "avatar": "https://data-eu.cometchat.io/assets/images/avatars/ironman.png", @@ -2787,13 +2787,13 @@ }, "receiver": { "entity": { - "uid": "superhero2", + "uid": "cometchat-uid-2", "name": "Captain America", "role": "default", "avatar": "https://data-eu.cometchat.io/assets/images/avatars/captainamerica.png", "status": "offline", "createdAt": 1639448370, - "conversationId": "superhero1_user_superhero2" + "conversationId": "cometchat-uid-1_user_cometchat-uid-2" }, "entityType": "user" } @@ -2841,7 +2841,7 @@ { "name": "id", "in": "path", - "description": "Id of the message whose details are to be fetched.", + "description": "Id of the interactive message being marked as interacted.", "required": true, "schema": { "type": "string" @@ -2892,7 +2892,7 @@ "example": { "data": { "success": true, - "message": "The message id 7 has been marked as interacted for the user superhero1." + "message": "The message id 7 has been marked as interacted for the user cometchat-uid-1." } } } @@ -2969,10 +2969,10 @@ "id": "1", "messageId": "2", "reaction": ":reaction", - "uid": "superhero1", + "uid": "cometchat-uid-1", "reactedAt": 1700210335, "reactedBy": { - "uid": "superhero1", + "uid": "cometchat-uid-1", "name": "Iron Man", "status": "offline", "role": "default", @@ -2983,10 +2983,10 @@ "id": "2", "messageId": "2", "reaction": "😅", - "uid": "superhero1", + "uid": "cometchat-uid-1", "reactedAt": 1700210456, "reactedBy": { - "uid": "superhero1", + "uid": "cometchat-uid-1", "name": "Iron Man", "status": "offline", "role": "default", @@ -2997,15 +2997,15 @@ "id": "5", "messageId": "2", "reaction": "😒", - "uid": "superhero2", + "uid": "cometchat-uid-2", "reactedAt": 1700230866, "reactedBy": { - "uid": "superhero2", + "uid": "cometchat-uid-2", "name": "Captain America", "status": "offline", "role": "default", "createdAt": 1698934987, - "conversationId": "superhero1_user_superhero2" + "conversationId": "cometchat-uid-1_user_cometchat-uid-2" } } ], @@ -3109,10 +3109,10 @@ "id": "1", "messageId": "1", "reaction": "😅", - "uid": "superhero1", + "uid": "cometchat-uid-1", "reactedAt": 1702638595, "reactedBy": { - "uid": "superhero1", + "uid": "cometchat-uid-1", "name": "Iron Man", "avatar": "https://data-us.cometchat.io/assets/images/avatars/ironman.png", "status": "available", @@ -3206,10 +3206,10 @@ "example": { "data": { "id": "2", - "conversationId": "superhero1_user_superhero2", - "sender": "superhero1", + "conversationId": "cometchat-uid-1_user_cometchat-uid-2", + "sender": "cometchat-uid-1", "receiverType": "user", - "receiver": "superhero2", + "receiver": "cometchat-uid-2", "category": "message", "type": "text", "data": { @@ -3217,7 +3217,7 @@ "entities": { "sender": { "entity": { - "uid": "superhero1", + "uid": "cometchat-uid-1", "name": "Iron Man", "role": "default", "status": "offline" @@ -3226,11 +3226,11 @@ }, "receiver": { "entity": { - "uid": "superhero2", + "uid": "cometchat-uid-2", "name": "Captain America", "role": "default", "status": "offline", - "conversationId": "superhero1_user_superhero2" + "conversationId": "cometchat-uid-1_user_cometchat-uid-2" }, "entityType": "user" } @@ -3333,10 +3333,10 @@ "example": { "data": { "id": "2", - "conversationId": "superhero1_user_superhero2", - "sender": "superhero1", + "conversationId": "cometchat-uid-1_user_cometchat-uid-2", + "sender": "cometchat-uid-1", "receiverType": "user", - "receiver": "superhero2", + "receiver": "cometchat-uid-2", "category": "message", "type": "text", "data": { @@ -3344,7 +3344,7 @@ "entities": { "sender": { "entity": { - "uid": "superhero1", + "uid": "cometchat-uid-1", "name": "Iron Man", "role": "default", "status": "offline" @@ -3353,11 +3353,11 @@ }, "receiver": { "entity": { - "uid": "superhero2", + "uid": "cometchat-uid-2", "name": "Captain America", "role": "default", "status": "offline", - "conversationId": "superhero1_user_superhero2" + "conversationId": "cometchat-uid-1_user_cometchat-uid-2" }, "entityType": "user" } @@ -3399,7 +3399,7 @@ "Messages" ], "summary": "Pin Message", - "description": "Pins a message in its conversation. Without the onBehalfOf header the message is pinned as the app itself (app_system); with it, the message is pinned as that user and their scope permissions apply.", + "description": "Pins a message in its conversation. Without the onBehalfOf header the message is pinned as the app itself (app_system); with it, the message is pinned as that user and their scope permissions apply. A conversation can hold up to 100 pinned messages. Pins made on behalf of a user and pins made as the app share this limit. Exceeding this limit returns ERR_PINNED_MESSAGES_LIMIT_EXCEEDED.", "operationId": "pin-message", "parameters": [ { @@ -3443,10 +3443,10 @@ "example": { "data": { "id": "2", - "conversationId": "superhero1_user_superhero2", - "sender": "superhero1", + "conversationId": "cometchat-uid-1_user_cometchat-uid-2", + "sender": "cometchat-uid-1", "receiverType": "user", - "receiver": "superhero2", + "receiver": "cometchat-uid-2", "category": "message", "type": "text", "data": { @@ -3471,7 +3471,7 @@ "example": { "error": { "code": "ERR_PINNED_MESSAGES_LIMIT_EXCEEDED", - "message": "The number of pinned messages for the conversation with id superhero1_user_superhero2 exceeds the allowed limit of 5." + "message": "The number of pinned messages for the conversation with id cometchat-uid-1_user_cometchat-uid-2 has reached the allowed limit of 100." } } } @@ -3549,10 +3549,10 @@ "example": { "data": { "id": "2", - "conversationId": "superhero1_user_superhero2", - "sender": "superhero1", + "conversationId": "cometchat-uid-1_user_cometchat-uid-2", + "sender": "cometchat-uid-1", "receiverType": "user", - "receiver": "superhero2", + "receiver": "cometchat-uid-2", "category": "message", "type": "text", "data": { @@ -3595,7 +3595,7 @@ "Messages" ], "summary": "Save Message", - "description": "Saves a message for a user. Saved messages are private to that user, so the onBehalfOf header is required. Idempotent - re-saving keeps the original savedAt.", + "description": "Saves a message for a user. Saved messages are private to that user, so the onBehalfOf header is required. Idempotent - re-saving keeps the original savedAt. A user can save up to 100 messages. Exceeding this limit returns ERR_SAVED_MESSAGES_LIMIT_EXCEEDED.", "operationId": "save-message", "parameters": [ { @@ -3633,10 +3633,10 @@ "example": { "data": { "id": "2", - "conversationId": "superhero1_user_superhero2", - "sender": "superhero1", + "conversationId": "cometchat-uid-1_user_cometchat-uid-2", + "sender": "cometchat-uid-1", "receiverType": "user", - "receiver": "superhero2", + "receiver": "cometchat-uid-2", "category": "message", "type": "text", "data": { @@ -3660,7 +3660,7 @@ "example": { "error": { "code": "ERR_SAVED_MESSAGES_LIMIT_EXCEEDED", - "message": "The number of saved messages for the user with uid superhero1 exceeds the allowed limit of 100." + "message": "The number of saved messages for the user with uid cometchat-uid-1 has reached the allowed limit of 100." } } } @@ -3716,10 +3716,10 @@ "example": { "data": { "id": "2", - "conversationId": "superhero1_user_superhero2", - "sender": "superhero1", + "conversationId": "cometchat-uid-1_user_cometchat-uid-2", + "sender": "cometchat-uid-1", "receiverType": "user", - "receiver": "superhero2", + "receiver": "cometchat-uid-2", "category": "message", "type": "text", "data": { @@ -3943,7 +3943,7 @@ "lastMessage": { "id": "50", "conversationId": "group_project-group", - "sender": "superhero4", + "sender": "cometchat-uid-4", "receiverType": "group", "receiver": "project-group", "category": "action", @@ -3953,7 +3953,7 @@ "entities": { "by": { "entity": { - "uid": "superhero4", + "uid": "cometchat-uid-4", "name": "Wolverine", "role": "default", "avatar": "https://data-us.cometchat.io/assets/images/avatars/wolverine.png", @@ -3964,7 +3964,7 @@ }, "on": { "entity": { - "uid": "superhero3", + "uid": "cometchat-uid-3", "link": "https://data-us.cometchat.io/assets", "name": "Captain America", "role": "default", @@ -3972,7 +3972,7 @@ "status": "offline", "createdAt": 1629869270, "updatedAt": 1629964825, - "conversationId": "superhero3_user_superhero4" + "conversationId": "cometchat-uid-3_user_cometchat-uid-4" }, "entityType": "user" }, @@ -3982,10 +3982,10 @@ "icon": "http://placehold.it/120x120&text=image1", "name": "Project Group1", "type": "private", - "owner": "superhero4", + "owner": "cometchat-uid-4", "createdAt": 1630071341, "updatedAt": 1630305525, - "updatedBy": "superhero4", + "updatedBy": "cometchat-uid-4", "description": "project related discussions between members", "membersCount": 4, "conversationId": "group_project-group" @@ -4014,9 +4014,9 @@ "conversationId": "group_project-group", "hasJoined": true, "createdAt": 1630071341, - "owner": "superhero4", + "owner": "cometchat-uid-4", "updatedAt": 1630308875, - "updatedBy": "superhero4" + "updatedBy": "cometchat-uid-4" } } ], @@ -4068,13 +4068,13 @@ "example": { "data": [ { - "conversationId": "supergroup", + "conversationId": "group_cometchat-guid-1", "conversationType": "group", "pinnedBy": "app_system", "pinnedAt": 1700210300 }, { - "conversationId": "superhero1_user_superhero2", + "conversationId": "cometchat-uid-1_user_cometchat-uid-2", "conversationType": "user", "pinnedBy": "app_system", "pinnedAt": 1700210299 @@ -4096,7 +4096,7 @@ "Conversations" ], "summary": "Replace Global Pinned Conversations", - "description": "Replaces the whole global pinned conversation list - the conversations pinned at the top for every end user. The array is the desired final state and order - entries that are absent get unpinned, new entries get pinned, and array order becomes display order. Send an empty array to clear the list.", + "description": "Replaces the whole global pinned conversation list - the conversations pinned at the top for every end user. The array is the desired final state and order - entries that are absent get unpinned, new entries get pinned, and array order becomes display order. Send an empty array to clear the list. An app can pin up to 5 conversations globally. Exceeding this limit returns ERR_SYSTEM_PINNED_CONVERSATIONS_LIMIT_EXCEEDED.", "operationId": "replace-global-pinned-conversations", "requestBody": { "required": true, @@ -4125,10 +4125,10 @@ }, "example": [ { - "guid": "supergroup" + "guid": "cometchat-guid-1" }, { - "uid": "superhero2" + "uid": "cometchat-uid-2" } ] } @@ -4157,13 +4157,13 @@ "example": { "data": [ { - "conversationId": "supergroup", + "conversationId": "group_cometchat-guid-1", "conversationType": "group", "pinnedBy": "app_system", "pinnedAt": 1700210300 }, { - "conversationId": "superhero1_user_superhero2", + "conversationId": "cometchat-uid-1_user_cometchat-uid-2", "conversationType": "user", "pinnedBy": "app_system", "pinnedAt": 1700210299 @@ -4183,7 +4183,7 @@ "example": { "error": { "code": "ERR_SYSTEM_PINNED_CONVERSATIONS_LIMIT_EXCEEDED", - "message": "The number of pinned conversations exceeds the allowed limit of 5." + "message": "The number of pinned conversations has reached the allowed limit of 5." } } } @@ -4243,7 +4243,7 @@ "lastMessage": { "id": "50", "conversationId": "group_project-group", - "sender": "superhero4", + "sender": "cometchat-uid-4", "receiverType": "group", "receiver": "project-group", "category": "action", @@ -4253,7 +4253,7 @@ "entities": { "by": { "entity": { - "uid": "superhero4", + "uid": "cometchat-uid-4", "name": "Wolverine", "role": "default", "avatar": "https://data-us.cometchat.io/assets/images/avatars/wolverine.png", @@ -4264,7 +4264,7 @@ }, "on": { "entity": { - "uid": "superhero3", + "uid": "cometchat-uid-3", "link": "https://data-us.cometchat.io/assets", "name": "Captain America", "role": "default", @@ -4272,7 +4272,7 @@ "status": "offline", "createdAt": 1629869270, "updatedAt": 1629964825, - "conversationId": "superhero3_user_superhero4" + "conversationId": "cometchat-uid-3_user_cometchat-uid-4" }, "entityType": "user" }, @@ -4282,10 +4282,10 @@ "icon": "http://placehold.it/120x120&text=image1", "name": "Project Group1", "type": "private", - "owner": "superhero4", + "owner": "cometchat-uid-4", "createdAt": 1630071341, "updatedAt": 1630305525, - "updatedBy": "superhero4", + "updatedBy": "cometchat-uid-4", "description": "project related discussions between members", "membersCount": 4, "conversationId": "group_project-group" @@ -4314,9 +4314,9 @@ "conversationId": "group_project-group", "hasJoined": true, "createdAt": 1630071341, - "owner": "superhero4", + "owner": "cometchat-uid-4", "updatedAt": 1630308875, - "updatedBy": "superhero4" + "updatedBy": "cometchat-uid-4" } } ] @@ -4430,7 +4430,7 @@ "lastMessage": { "id": "50", "conversationId": "group_project-group", - "sender": "superhero4", + "sender": "cometchat-uid-4", "receiverType": "group", "receiver": "project-group", "category": "action", @@ -4440,7 +4440,7 @@ "entities": { "by": { "entity": { - "uid": "superhero4", + "uid": "cometchat-uid-4", "name": "Wolverine", "role": "default", "avatar": "https://data-us.cometchat.io/assets/images/avatars/wolverine.png", @@ -4451,7 +4451,7 @@ }, "on": { "entity": { - "uid": "superhero3", + "uid": "cometchat-uid-3", "link": "https://data-us.cometchat.io/assets", "name": "Captain America", "role": "default", @@ -4459,7 +4459,7 @@ "status": "offline", "createdAt": 1629869270, "updatedAt": 1629964825, - "conversationId": "superhero3_user_superhero4" + "conversationId": "cometchat-uid-3_user_cometchat-uid-4" }, "entityType": "user" }, @@ -4469,10 +4469,10 @@ "icon": "http://placehold.it/120x120&text=image1", "name": "Project Group1", "type": "private", - "owner": "superhero4", + "owner": "cometchat-uid-4", "createdAt": 1630071341, "updatedAt": 1630305525, - "updatedBy": "superhero4", + "updatedBy": "cometchat-uid-4", "description": "project related discussions between members", "membersCount": 4, "conversationId": "group_project-group" @@ -4496,9 +4496,9 @@ "conversationId": "group_project-group", "hasJoined": true, "createdAt": 1630071341, - "owner": "superhero4", + "owner": "cometchat-uid-4", "updatedAt": 1630308875, - "updatedBy": "superhero4" + "updatedBy": "cometchat-uid-4" } } ] @@ -4576,7 +4576,7 @@ "lastMessage": { "id": "50", "conversationId": "group_project-group", - "sender": "superhero4", + "sender": "cometchat-uid-4", "receiverType": "group", "receiver": "project-group", "category": "action", @@ -4586,7 +4586,7 @@ "entities": { "by": { "entity": { - "uid": "superhero4", + "uid": "cometchat-uid-4", "name": "Wolverine", "role": "default", "avatar": "https://data-us.cometchat.io/assets/images/avatars/wolverine.png", @@ -4597,7 +4597,7 @@ }, "on": { "entity": { - "uid": "superhero3", + "uid": "cometchat-uid-3", "link": "https://data-us.cometchat.io/assets", "name": "Captain America", "role": "default", @@ -4605,7 +4605,7 @@ "status": "offline", "createdAt": 1629869270, "updatedAt": 1629964825, - "conversationId": "superhero3_user_superhero4" + "conversationId": "cometchat-uid-3_user_cometchat-uid-4" }, "entityType": "user" }, @@ -4615,10 +4615,10 @@ "icon": "http://placehold.it/120x120&text=image1", "name": "Project Group1", "type": "private", - "owner": "superhero4", + "owner": "cometchat-uid-4", "createdAt": 1630071341, "updatedAt": 1630305525, - "updatedBy": "superhero4", + "updatedBy": "cometchat-uid-4", "description": "project related discussions between members", "membersCount": 4, "conversationId": "group_project-group" @@ -4647,9 +4647,9 @@ "conversationId": "group_project-group", "hasJoined": true, "createdAt": 1630071341, - "owner": "superhero4", + "owner": "cometchat-uid-4", "updatedAt": 1630308875, - "updatedBy": "superhero4" + "updatedBy": "cometchat-uid-4" } } ] @@ -4727,7 +4727,7 @@ "example": { "data": { "success": true, - "message": "The conversation superhero1_user_superhero2 has been deleted successfully for UID superhero1." + "message": "The conversation cometchat-uid-1_user_cometchat-uid-2 has been deleted successfully for UID cometchat-uid-1." } } } @@ -4747,7 +4747,7 @@ "Conversations" ], "summary": "Pin User Conversation", - "description": "Pins a one-to-one conversation for a user, so it appears at the top of their conversation list. Pins are per user, so the onBehalfOf header is required. Idempotent - re-pinning keeps the original pinnedAt.", + "description": "Pins a one-to-one conversation for a user, so it appears at the top of their conversation list. Pins are per user, so the onBehalfOf header is required. Idempotent - re-pinning keeps the original pinnedAt. A user can pin up to 5 conversations. Exceeding this limit returns ERR_PINNED_CONVERSATIONS_LIMIT_EXCEEDED.", "operationId": "pin-user-conversation", "parameters": [ { @@ -4772,9 +4772,9 @@ }, "example": { "data": { - "conversationId": "superhero1_user_superhero2", + "conversationId": "cometchat-uid-1_user_cometchat-uid-2", "conversationType": "user", - "pinnedBy": "superhero1", + "pinnedBy": "cometchat-uid-1", "pinnedAt": 1700210300 } } @@ -4791,7 +4791,7 @@ "example": { "error": { "code": "ERR_PINNED_CONVERSATIONS_LIMIT_EXCEEDED", - "message": "The number of pinned conversations for the user with uid superhero1 exceeds the allowed limit of 5." + "message": "The number of pinned conversations for the user with uid cometchat-uid-1 has reached the allowed limit of 5." } } } @@ -4850,7 +4850,7 @@ }, "example": { "data": { - "conversationId": "superhero1_user_superhero2", + "conversationId": "cometchat-uid-1_user_cometchat-uid-2", "conversationType": "user" } } @@ -5126,7 +5126,7 @@ "lastMessage": { "id": "50", "conversationId": "group_project-group", - "sender": "superhero4", + "sender": "cometchat-uid-4", "receiverType": "group", "receiver": "project-group", "category": "action", @@ -5136,7 +5136,7 @@ "entities": { "by": { "entity": { - "uid": "superhero4", + "uid": "cometchat-uid-4", "name": "Wolverine", "role": "default", "avatar": "https://data-us.cometchat.io/assets/images/avatars/wolverine.png", @@ -5147,7 +5147,7 @@ }, "on": { "entity": { - "uid": "superhero3", + "uid": "cometchat-uid-3", "link": "https://data-us.cometchat.io/assets", "name": "Captain America", "role": "default", @@ -5155,7 +5155,7 @@ "status": "offline", "createdAt": 1629869270, "updatedAt": 1629964825, - "conversationId": "superhero3_user_superhero4" + "conversationId": "cometchat-uid-3_user_cometchat-uid-4" }, "entityType": "user" }, @@ -5165,10 +5165,10 @@ "icon": "http://placehold.it/120x120&text=image1", "name": "Project Group1", "type": "private", - "owner": "superhero4", + "owner": "cometchat-uid-4", "createdAt": 1630071341, "updatedAt": 1630305525, - "updatedBy": "superhero4", + "updatedBy": "cometchat-uid-4", "description": "project related discussions between members", "membersCount": 4, "conversationId": "group_project-group" @@ -5192,9 +5192,9 @@ "conversationId": "group_project-group", "hasJoined": true, "createdAt": 1630071341, - "owner": "superhero4", + "owner": "cometchat-uid-4", "updatedAt": 1630308875, - "updatedBy": "superhero4" + "updatedBy": "cometchat-uid-4" } } ] @@ -5272,7 +5272,7 @@ "lastMessage": { "id": "50", "conversationId": "group_project-group", - "sender": "superhero4", + "sender": "cometchat-uid-4", "receiverType": "group", "receiver": "project-group", "category": "action", @@ -5282,7 +5282,7 @@ "entities": { "by": { "entity": { - "uid": "superhero4", + "uid": "cometchat-uid-4", "name": "Wolverine", "role": "default", "avatar": "https://data-us.cometchat.io/assets/images/avatars/wolverine.png", @@ -5293,7 +5293,7 @@ }, "on": { "entity": { - "uid": "superhero3", + "uid": "cometchat-uid-3", "link": "https://data-us.cometchat.io/assets", "name": "Captain America", "role": "default", @@ -5301,7 +5301,7 @@ "status": "offline", "createdAt": 1629869270, "updatedAt": 1629964825, - "conversationId": "superhero3_user_superhero4" + "conversationId": "cometchat-uid-3_user_cometchat-uid-4" }, "entityType": "user" }, @@ -5311,10 +5311,10 @@ "icon": "http://placehold.it/120x120&text=image1", "name": "Project Group1", "type": "private", - "owner": "superhero4", + "owner": "cometchat-uid-4", "createdAt": 1630071341, "updatedAt": 1630305525, - "updatedBy": "superhero4", + "updatedBy": "cometchat-uid-4", "description": "project related discussions between members", "membersCount": 4, "conversationId": "group_project-group" @@ -5343,9 +5343,9 @@ "conversationId": "group_project-group", "hasJoined": true, "createdAt": 1630071341, - "owner": "superhero4", + "owner": "cometchat-uid-4", "updatedAt": 1630308875, - "updatedBy": "superhero4" + "updatedBy": "cometchat-uid-4" } } ] @@ -5413,7 +5413,7 @@ "example": { "data": { "success": true, - "message": "The conversation superhero1_user_superhero2 has been deleted successfully for UID superhero1." + "message": "The conversation cometchat-uid-1_user_cometchat-uid-2 has been deleted successfully for UID cometchat-uid-1." } } } @@ -5433,7 +5433,7 @@ "Conversations" ], "summary": "Pin Group Conversation", - "description": "Pins a group conversation for a user, so it appears at the top of their conversation list. Pins are per user, so the onBehalfOf header is required. Idempotent - re-pinning keeps the original pinnedAt.", + "description": "Pins a group conversation for a user, so it appears at the top of their conversation list. Pins are per user, so the onBehalfOf header is required. Idempotent - re-pinning keeps the original pinnedAt. A user can pin up to 5 conversations. Exceeding this limit returns ERR_PINNED_CONVERSATIONS_LIMIT_EXCEEDED.", "operationId": "pin-group-conversation", "parameters": [ { @@ -5458,9 +5458,9 @@ }, "example": { "data": { - "conversationId": "supergroup", + "conversationId": "group_cometchat-guid-1", "conversationType": "group", - "pinnedBy": "superhero1", + "pinnedBy": "cometchat-uid-1", "pinnedAt": 1700210300 } } @@ -5477,7 +5477,7 @@ "example": { "error": { "code": "ERR_PINNED_CONVERSATIONS_LIMIT_EXCEEDED", - "message": "The number of pinned conversations for the user with uid superhero1 exceeds the allowed limit of 5." + "message": "The number of pinned conversations for the user with uid cometchat-uid-1 has reached the allowed limit of 5." } } } @@ -5536,7 +5536,7 @@ }, "example": { "data": { - "conversationId": "supergroup", + "conversationId": "group_cometchat-guid-1", "conversationType": "group" } } @@ -5816,8 +5816,8 @@ }, "example": { "data": { - "uid": "superhero1", - "authToken": "superhero1_1630306819c3027ce530b2367f3c97b4106f0cb8", + "uid": "cometchat-uid-1", + "authToken": "cometchat-uid-1_1630306819c3027ce530b2367f3c97b4106f0cb8", "createdAt": 1630306819 } } @@ -5893,8 +5893,8 @@ "example": { "data": [ { - "uid": "superhero1", - "authToken": "superhero1_1630306819c3027ce530b2367f3c97b4106f0cb8", + "uid": "cometchat-uid-1", + "authToken": "cometchat-uid-1_1630306819c3027ce530b2367f3c97b4106f0cb8", "createdAt": 1630306819 } ], @@ -5958,7 +5958,7 @@ "example": { "data": { "success": true, - "message": "Cleared Auth Tokens successfully for uid superhero1." + "message": "Cleared Auth Tokens successfully for uid cometchat-uid-1." } } } @@ -6015,8 +6015,8 @@ }, "example": { "data": { - "uid": "superhero1", - "authToken": "superhero1_1630306819c3027ce530b2367f3c97b4106f0cb8", + "uid": "cometchat-uid-1", + "authToken": "cometchat-uid-1_1630306819c3027ce530b2367f3c97b4106f0cb8", "createdAt": 1630306819 } } @@ -6108,8 +6108,8 @@ }, "example": { "data": { - "uid": "superhero1", - "authToken": "superhero1_1630306819c3027ce530b2367f3c97b4106f0cb8", + "uid": "cometchat-uid-1", + "authToken": "cometchat-uid-1_1630306819c3027ce530b2367f3c97b4106f0cb8", "createdAt": 1630306819 } } @@ -6178,7 +6178,7 @@ "example": { "data": { "success": true, - "message": "User with superhero6 has been deleted successfully." + "message": "User with cometchat-uid-6 has been deleted successfully." } } } @@ -6277,12 +6277,12 @@ "example": { "data": { "usersToBan": { - "superhero6": { + "cometchat-uid-6": { "success": true } }, "admins": { - "superhero1": { + "cometchat-uid-1": { "success": true, "data": { "id": "32", @@ -6307,7 +6307,7 @@ }, "on": { "entity": { - "uid": "superhero1", + "uid": "cometchat-uid-1", "name": "Iron Man", "role": "default", "avatar": "https://data-us.cometchat.io/assets/images/avatars/ironman.png", @@ -6326,7 +6326,7 @@ "project" ], "type": "public", - "owner": "superhero2", + "owner": "cometchat-uid-2", "createdAt": 1625460947, "description": "project related discussions between members", "membersCount": 2, @@ -6342,7 +6342,7 @@ } }, "moderators": { - "superhero3": { + "cometchat-uid-3": { "success": true, "data": { "id": "33", @@ -6367,7 +6367,7 @@ }, "on": { "entity": { - "uid": "superhero3", + "uid": "cometchat-uid-3", "name": "Spiderman", "role": "default", "avatar": "https://data-us.cometchat.io/assets/images/avatars/spiderman.png", @@ -6387,7 +6387,7 @@ "project" ], "type": "public", - "owner": "superhero2", + "owner": "cometchat-uid-2", "createdAt": 1625460947, "updatedAt": 1625460972, "description": "project related discussions between members", @@ -6404,7 +6404,7 @@ } }, "participants": { - "superhero4": { + "cometchat-uid-4": { "success": true, "data": { "id": "34", @@ -6429,7 +6429,7 @@ }, "on": { "entity": { - "uid": "superhero4", + "uid": "cometchat-uid-4", "name": "Wolverine", "role": "default", "avatar": "https://data-us.cometchat.io/assets/images/avatars/wolverine.png", @@ -6448,7 +6448,7 @@ "project" ], "type": "public", - "owner": "superhero2", + "owner": "cometchat-uid-2", "createdAt": 1625460947, "updatedAt": 1625460973, "description": "project related discussions between members", @@ -6463,7 +6463,7 @@ "updatedAt": 1625460973 } }, - "superhero5": { + "cometchat-uid-5": { "success": true, "data": { "id": "35", @@ -6488,7 +6488,7 @@ }, "on": { "entity": { - "uid": "superhero5", + "uid": "cometchat-uid-5", "name": "Cyclops", "role": "default", "avatar": "https://data-us.cometchat.io/assets/images/avatars/cyclops.png", @@ -6507,7 +6507,7 @@ "project" ], "type": "public", - "owner": "superhero2", + "owner": "cometchat-uid-2", "createdAt": 1625460947, "updatedAt": 1625460973, "description": "project related discussions between members", @@ -6604,7 +6604,7 @@ "example": { "data": [ { - "uid": "superhero2", + "uid": "cometchat-uid-2", "name": "Captain America", "avatar": "https://data-us.cometchat.io/assets/images/avatars/captainamerica.png", "status": "offline", @@ -6613,10 +6613,10 @@ "joinedAt": 1638360106, "createdAt": 1629869270, "updatedAt": 1630308676, - "conversationId": "superhero2_user_superhero4" + "conversationId": "cometchat-uid-2_user_cometchat-uid-4" }, { - "uid": "superhero3", + "uid": "cometchat-uid-3", "name": "Captain America", "link": "https://data-us.cometchat.io/assets", "avatar": "https://data-us.cometchat.io/assets/images/avatars/captainamerica.png", @@ -6629,10 +6629,10 @@ "joinedAt": 1638360106, "createdAt": 1629869270, "updatedAt": 1638351060, - "conversationId": "superhero3_user_superhero4" + "conversationId": "cometchat-uid-3_user_cometchat-uid-4" }, { - "uid": "superhero5", + "uid": "cometchat-uid-5", "name": "Cyclops", "avatar": "https://data-us.cometchat.io/assets/images/avatars/cyclops.png", "status": "offline", @@ -6640,10 +6640,10 @@ "scope": "moderator", "joinedAt": 1638360106, "createdAt": 1629869270, - "conversationId": "superhero4_user_superhero5" + "conversationId": "cometchat-uid-4_user_cometchat-uid-5" }, { - "uid": "superhero4", + "uid": "cometchat-uid-4", "name": "Wolverine", "avatar": "https://data-us.cometchat.io/assets/images/avatars/wolverine.png", "status": "offline", @@ -6742,8 +6742,8 @@ }, "example": { "data": { - "guid": "supergroup", - "uid": "superhero2", + "guid": "cometchat-guid-1", + "uid": "cometchat-uid-2", "scope": "participant", "joinedAt": 1631690303 } @@ -6792,7 +6792,7 @@ "example": { "data": { "success": true, - "message": "The member with superhero3 has been kicked from the Group with supergroup." + "message": "The member with cometchat-uid-3 has been kicked from the Group with cometchat-guid-1." } } } @@ -6841,7 +6841,7 @@ "example": { "data": { "success": true, - "message": "The user with uid superhero3 has been banned from the Group with supergroup." + "message": "The user with uid cometchat-uid-3 has been banned from the Group with cometchat-guid-1." } } } @@ -6888,7 +6888,7 @@ "example": { "data": { "success": true, - "message": "The user with uid superhero3 has been banned from the Group with supergroup." + "message": "The user with uid cometchat-uid-3 has been banned from the Group with cometchat-guid-1." } } } @@ -6963,7 +6963,7 @@ "example": { "data": [ { - "uid": "superhero6", + "uid": "cometchat-uid-6", "name": "Barry Allen", "link": "http://placehold.it", "avatar": "http://placehold.it/120x120&text=image1", @@ -6975,20 +6975,20 @@ "role": "manager", "createdAt": 1638354015, "updatedAt": 1638354799, - "conversationId": "superhero4_user_superhero6" + "conversationId": "cometchat-uid-4_user_cometchat-uid-6" }, { - "uid": "superhero2", + "uid": "cometchat-uid-2", "name": "Captain America", "avatar": "https://data-us.cometchat.io/assets/images/avatars/captainamerica.png", "status": "offline", "role": "default", "createdAt": 1629869270, "updatedAt": 1630308676, - "conversationId": "superhero2_user_superhero4" + "conversationId": "cometchat-uid-2_user_cometchat-uid-4" }, { - "uid": "superhero3", + "uid": "cometchat-uid-3", "name": "Captain America", "link": "https://data-us.cometchat.io/assets", "avatar": "https://data-us.cometchat.io/assets/images/avatars/captainamerica.png", @@ -7002,7 +7002,7 @@ "blockedAt": 1638346853, "createdAt": 1629869270, "updatedAt": 1638351060, - "conversationId": "superhero3_user_superhero4" + "conversationId": "cometchat-uid-3_user_cometchat-uid-4" } ], "meta": { @@ -7086,11 +7086,11 @@ "example": { "data": { "accepted": { - "superhero2": { + "cometchat-uid-2": { "success": true, "message": "Created relationship with status accepted." }, - "superhero3": { + "cometchat-uid-3": { "success": true, "message": "Created relationship with status accepted." } @@ -7165,7 +7165,7 @@ "example": { "data": [ { - "uid": "superhero6", + "uid": "cometchat-uid-6", "name": "Barry Allen", "link": "http://placehold.it", "avatar": "http://placehold.it/120x120&text=image1", @@ -7177,20 +7177,20 @@ "role": "manager", "createdAt": 1638354015, "updatedAt": 1638354799, - "conversationId": "superhero4_user_superhero6" + "conversationId": "cometchat-uid-4_user_cometchat-uid-6" }, { - "uid": "superhero2", + "uid": "cometchat-uid-2", "name": "Captain America", "avatar": "https://data-us.cometchat.io/assets/images/avatars/captainamerica.png", "status": "offline", "role": "default", "createdAt": 1629869270, "updatedAt": 1630308676, - "conversationId": "superhero2_user_superhero4" + "conversationId": "cometchat-uid-2_user_cometchat-uid-4" }, { - "uid": "superhero3", + "uid": "cometchat-uid-3", "name": "Captain America", "link": "https://data-us.cometchat.io/assets", "avatar": "https://data-us.cometchat.io/assets/images/avatars/captainamerica.png", @@ -7204,7 +7204,7 @@ "blockedAt": 1638346853, "createdAt": 1629869270, "updatedAt": 1638351060, - "conversationId": "superhero3_user_superhero4" + "conversationId": "cometchat-uid-3_user_cometchat-uid-4" } ], "meta": { @@ -7357,9 +7357,9 @@ }, "example": { "data": { - "superhero4": { + "cometchat-uid-4": { "success": true, - "message": "The user with UID superhero1 has blocked user with UID superhero3 successfully." + "message": "The user with UID cometchat-uid-1 has blocked user with UID cometchat-uid-3 successfully." } } } @@ -7438,9 +7438,9 @@ }, "example": { "data": { - "superhero4": { + "cometchat-uid-4": { "success": true, - "message": "The user with UID superhero1 has blocked user with UID superhero3 successfully." + "message": "The user with UID cometchat-uid-1 has blocked user with UID cometchat-uid-3 successfully." } } } @@ -7525,7 +7525,7 @@ "example": { "data": [ { - "uid": "superhero6", + "uid": "cometchat-uid-6", "name": "Barry Allen", "link": "http://placehold.it", "avatar": "http://placehold.it/120x120&text=image1", @@ -7539,10 +7539,10 @@ "blockedAt": 1638346853, "createdAt": 1629869270, "updatedAt": 1638351060, - "conversationId": "superhero3_user_superhero4" + "conversationId": "cometchat-uid-3_user_cometchat-uid-4" }, { - "uid": "superhero2", + "uid": "cometchat-uid-2", "name": "Captain America", "link": "http://placehold.it", "avatar": "http://placehold.it/120x120&text=image1", @@ -7556,7 +7556,7 @@ "blockedAt": 1638346853, "createdAt": 1629869270, "updatedAt": 1638351060, - "conversationId": "superhero1_user_superhero2" + "conversationId": "cometchat-uid-1_user_cometchat-uid-2" } ], "meta": { @@ -8496,7 +8496,7 @@ "required": true, "schema": { "type": "string", - "example": "supergroup" + "example": "cometchat-guid-1" } }, { @@ -8607,7 +8607,7 @@ "required": true, "schema": { "type": "string", - "example": "supergroup" + "example": "cometchat-guid-1" } }, { @@ -8825,7 +8825,7 @@ "required": true, "schema": { "type": "string", - "example": "supergroup" + "example": "cometchat-guid-1" } }, { @@ -9025,10 +9025,10 @@ "example": { "data": { "id": "2", - "conversationId": "superhero3_user_superhero5", - "sender": "superhero3", + "conversationId": "cometchat-uid-3_user_cometchat-uid-5", + "sender": "cometchat-uid-3", "receiverType": "user", - "receiver": "superhero5", + "receiver": "cometchat-uid-5", "category": "message", "type": "text", "data": { @@ -9039,7 +9039,7 @@ "entities": { "sender": { "entity": { - "uid": "superhero3", + "uid": "cometchat-uid-3", "name": "Spiderman", "avatar": "https://data-us.cometchat.io/assets/images/avatars/spiderman.png", "status": "offline", @@ -9050,13 +9050,13 @@ }, "receiver": { "entity": { - "uid": "superhero5", + "uid": "cometchat-uid-5", "name": "Cyclops", "avatar": "https://data-us.cometchat.io/assets/images/avatars/cyclops.png", "status": "offline", "role": "default", "createdAt": 1638361550, - "conversationId": "superhero3_user_superhero5" + "conversationId": "cometchat-uid-3_user_cometchat-uid-5" }, "entityType": "user" } @@ -9172,10 +9172,10 @@ "data": [ { "id": "2", - "conversationId": "superhero3_user_superhero5", - "sender": "superhero3", + "conversationId": "cometchat-uid-3_user_cometchat-uid-5", + "sender": "cometchat-uid-3", "receiverType": "user", - "receiver": "superhero5", + "receiver": "cometchat-uid-5", "category": "message", "type": "text", "data": { @@ -9183,7 +9183,7 @@ "entities": { "sender": { "entity": { - "uid": "superhero3", + "uid": "cometchat-uid-3", "name": "Spiderman", "role": "default", "avatar": "https://data-us.cometchat.io/assets/images/avatars/spiderman.png", @@ -9194,13 +9194,13 @@ }, "receiver": { "entity": { - "uid": "superhero5", + "uid": "cometchat-uid-5", "name": "Cyclops", "role": "default", "avatar": "https://data-us.cometchat.io/assets/images/avatars/cyclops.png", "status": "offline", "createdAt": 1638361550, - "conversationId": "superhero3_user_superhero5" + "conversationId": "cometchat-uid-3_user_cometchat-uid-5" }, "entityType": "user" } @@ -9846,10 +9846,10 @@ "data": [ { "id": "1776", - "conversationId": "superhero2_user_superhero3", - "sender": "superhero2", + "conversationId": "cometchat-uid-2_user_cometchat-uid-3", + "sender": "cometchat-uid-2", "receiverType": "user", - "receiver": "superhero3", + "receiver": "cometchat-uid-3", "category": "call", "type": "audio", "data": { @@ -9857,7 +9857,7 @@ "entities": { "by": { "entity": { - "uid": "superhero2", + "uid": "cometchat-uid-2", "name": "Captain America", "role": "default", "avatar": "https://data-eu.cometchat.io/assets/images/avatars/captainamerica.png", @@ -9871,7 +9871,7 @@ "entities": { "sender": { "entity": { - "uid": "superhero2", + "uid": "cometchat-uid-2", "name": "Captain America", "role": "default", "avatar": "https://data-eu.cometchat.io/assets/images/avatars/captainamerica.png", @@ -9881,12 +9881,12 @@ }, "receiver": { "entity": { - "uid": "superhero3", + "uid": "cometchat-uid-3", "name": "Spiderman", "role": "default", "avatar": "https://data-eu.cometchat.io/assets/images/avatars/spiderman.png", "status": "offline", - "conversationId": "superhero2_user_superhero3" + "conversationId": "cometchat-uid-2_user_cometchat-uid-3" }, "entityType": "user" } @@ -9898,10 +9898,10 @@ } }, "type": "audio", - "sender": "superhero2", + "sender": "cometchat-uid-2", "status": "initiated", "joinedAt": 1646995097, - "receiver": "superhero3", + "receiver": "cometchat-uid-3", "sessionid": "16469950973f7f6a1ea6d5166db11c929cdbde6a61902e10ba", "wsChannel": { "secret": "083c2a7f660150e42c2bf07a17231e90980b290d", @@ -9910,18 +9910,18 @@ }, "initiatedAt": 1646995097, "receiverType": "user", - "conversationId": "superhero2_user_superhero3" + "conversationId": "cometchat-uid-2_user_cometchat-uid-3" }, "entityType": "call" }, "for": { "entity": { - "uid": "superhero3", + "uid": "cometchat-uid-3", "name": "Spiderman", "role": "default", "avatar": "https://data-eu.cometchat.io/assets/images/avatars/spiderman.png", "status": "offline", - "conversationId": "superhero2_user_superhero3" + "conversationId": "cometchat-uid-2_user_cometchat-uid-3" }, "entityType": "user" } @@ -9932,10 +9932,10 @@ }, { "id": "1777", - "conversationId": "superhero2_user_superhero3", - "sender": "superhero3", + "conversationId": "cometchat-uid-2_user_cometchat-uid-3", + "sender": "cometchat-uid-3", "receiverType": "user", - "receiver": "superhero2", + "receiver": "cometchat-uid-2", "category": "call", "type": "video", "data": { @@ -9943,7 +9943,7 @@ "entities": { "by": { "entity": { - "uid": "superhero3", + "uid": "cometchat-uid-3", "name": "Spiderman", "role": "default", "avatar": "https://data-eu.cometchat.io/assets/images/avatars/spiderman.png", @@ -9957,7 +9957,7 @@ "entities": { "sender": { "entity": { - "uid": "superhero2", + "uid": "cometchat-uid-2", "name": "Captain America", "role": "default", "avatar": "https://data-eu.cometchat.io/assets/images/avatars/captainamerica.png", @@ -9967,12 +9967,12 @@ }, "receiver": { "entity": { - "uid": "superhero3", + "uid": "cometchat-uid-3", "name": "Spiderman", "role": "default", "avatar": "https://data-eu.cometchat.io/assets/images/avatars/spiderman.png", "status": "offline", - "conversationId": "superhero2_user_superhero3" + "conversationId": "cometchat-uid-2_user_cometchat-uid-3" }, "entityType": "user" } @@ -9984,10 +9984,10 @@ } }, "type": "video", - "sender": "superhero2", + "sender": "cometchat-uid-2", "status": "ongoing", "joinedAt": 1646995512, - "receiver": "superhero3", + "receiver": "cometchat-uid-3", "sessionid": "16469950973f7f6a1ea6d5166db11c929cdbde6a61902e10ba", "startedAt": 1646995512, "wsChannel": { @@ -9997,18 +9997,18 @@ }, "initiatedAt": 1646995097, "receiverType": "user", - "conversationId": "superhero2_user_superhero3" + "conversationId": "cometchat-uid-2_user_cometchat-uid-3" }, "entityType": "call" }, "for": { "entity": { - "uid": "superhero2", + "uid": "cometchat-uid-2", "name": "Captain America", "role": "default", "avatar": "https://data-eu.cometchat.io/assets/images/avatars/captainamerica.png", "status": "offline", - "conversationId": "superhero2_user_superhero3" + "conversationId": "cometchat-uid-2_user_cometchat-uid-3" }, "entityType": "user" } @@ -10324,10 +10324,10 @@ "data": [ { "id": "1", - "conversationId": "superhero3_user_superhero5", - "sender": "superhero3", + "conversationId": "cometchat-uid-3_user_cometchat-uid-5", + "sender": "cometchat-uid-3", "receiverType": "user", - "receiver": "superhero5", + "receiver": "cometchat-uid-5", "category": "message", "type": "text", "data": { @@ -10335,7 +10335,7 @@ "entities": { "sender": { "entity": { - "uid": "superhero3", + "uid": "cometchat-uid-3", "name": "Spiderman", "role": "default", "avatar": "https://data-us.cometchat.io/assets/images/avatars/spiderman.png", @@ -10346,13 +10346,13 @@ }, "receiver": { "entity": { - "uid": "superhero5", + "uid": "cometchat-uid-5", "name": "Cyclops", "role": "default", "avatar": "https://data-us.cometchat.io/assets/images/avatars/cyclops.png", "status": "offline", "createdAt": 1638361550, - "conversationId": "superhero3_user_superhero5" + "conversationId": "cometchat-uid-3_user_cometchat-uid-5" }, "entityType": "user" } @@ -10562,14 +10562,14 @@ "data": { "text": "Thanks For filling the Form!" }, - "receiver": "superhero2", + "receiver": "cometchat-uid-2", "receiverType": "user" }, "headers": { "appId": "10893f2ae68f59", "Content-Type": "application/json", "apiKey": "5797f2d3d103d7d78f085eb46bfd14d5c45ddfdf", - "onBehalfOf": "superhero1" + "onBehalfOf": "cometchat-uid-1" }, "dataKey": "CometChatData" } @@ -10578,7 +10578,7 @@ }, "category": "interactive", "type": "form", - "receiver": "superhero1", + "receiver": "cometchat-uid-1", "tags": [ "tag1" ] @@ -10619,7 +10619,7 @@ "appId": "10893f2ae68f59", "Content-Type": "application\\/json", "apiKey": "5797f2d3d103d7d78f085eb46bfd14d5c45ddfdf", - "onBehalfOf": "superhero1" + "onBehalfOf": "cometchat-uid-1" }, "dataKey": "CometChatData" } @@ -10656,7 +10656,7 @@ "appId": "10893f2ae68f59", "Content-Type": "application/json", "apiKey": "5797f2d3d103d7d78f085eb46bfd14d5c45ddfdf", - "onBehalfOf": "superhero1" + "onBehalfOf": "cometchat-uid-1" }, "dataKey": "CometChatData" } @@ -10666,7 +10666,7 @@ }, "category": "interactive", "type": "card", - "receiver": "superhero1", + "receiver": "cometchat-uid-1", "tags": [ "tag1" ] @@ -10676,12 +10676,12 @@ "summary": "Interactive scheduler example", "value": { "receiverType": "user", - "receiver": "superhero2", + "receiver": "cometchat-uid-2", "category": "interactive", "type": "scheduler", "data": { "receiverType": "user", - "receiver": "superhero2", + "receiver": "cometchat-uid-2", "muid": "16Jan3:41423PM", "interactionGoal": { "type": "anyAction", @@ -10789,10 +10789,10 @@ "example": { "data": { "id": "1", - "conversationId": "superhero3_user_superhero5", - "sender": "superhero3", + "conversationId": "cometchat-uid-3_user_cometchat-uid-5", + "sender": "cometchat-uid-3", "receiverType": "user", - "receiver": "superhero5", + "receiver": "cometchat-uid-5", "category": "message", "type": "text", "data": { @@ -10803,7 +10803,7 @@ "entities": { "sender": { "entity": { - "uid": "superhero3", + "uid": "cometchat-uid-3", "name": "Spiderman", "avatar": "https://data-us.cometchat.io/assets/images/avatars/spiderman.png", "status": "offline", @@ -10814,13 +10814,13 @@ }, "receiver": { "entity": { - "uid": "superhero5", + "uid": "cometchat-uid-5", "name": "Cyclops", "avatar": "https://data-us.cometchat.io/assets/images/avatars/cyclops.png", "status": "offline", "role": "default", "createdAt": 1638361550, - "conversationId": "superhero3_user_superhero5" + "conversationId": "cometchat-uid-3_user_cometchat-uid-5" }, "entityType": "user" } @@ -12259,13 +12259,13 @@ "data": { "pushTokens": [ { - "authToken": "superhero3_1710141033938cf7e3c67cc44465440d4efac8de", + "authToken": "cometchat-uid-3_1710141033938cf7e3c67cc44465440d4efac8de", "pushTokenType": "chat", "createdAt": "2024-03-11T07:27:59.412Z", "platform": "fcm_android", "providerId": "fcm-provider-2", "pushToken": "{{uid3}}_fcm_android_asia_kolkata_4_new_mgmt", - "uid": "superhero3", + "uid": "cometchat-uid-3", "updatedAt": "2024-03-13T11:24:47.776Z" } ] @@ -12328,13 +12328,13 @@ "data": { "pushTokens": [ { - "authToken": "superhero3_1710141033938cf7e3c67cc44465440d4efac8de", + "authToken": "cometchat-uid-3_1710141033938cf7e3c67cc44465440d4efac8de", "pushTokenType": "chat", "createdAt": "2024-03-11T07:27:59.412Z", "platform": "fcm_android", "providerId": "fcm-provider-2", "pushToken": "{{uid3}}_fcm_android_asia_kolkata_4_new_mgmt", - "uid": "superhero3", + "uid": "cometchat-uid-3", "updatedAt": "2024-03-13T11:24:47.776Z" } ] @@ -12394,13 +12394,13 @@ "data": { "pushTokens": [ { - "authToken": "superhero3_1710141033938cf7e3c67cc44465440d4efac8de", + "authToken": "cometchat-uid-3_1710141033938cf7e3c67cc44465440d4efac8de", "pushTokenType": "chat", "createdAt": "2024-03-11T07:27:59.412Z", "platform": "fcm_android", "providerId": "fcm-provider-2", "pushToken": "{{uid3}}_fcm_android_asia_kolkata_4_new_mgmt", - "uid": "superhero3", + "uid": "cometchat-uid-3", "updatedAt": "2024-03-13T11:24:47.776Z" } ] @@ -15452,10 +15452,10 @@ "message": { "id": "65", "muid": "_5zytzmceo", - "conversationId": "superhero1_user_superhero2", - "sender": "superhero1", + "conversationId": "cometchat-uid-1_user_cometchat-uid-2", + "sender": "cometchat-uid-1", "receiverType": "user", - "receiver": "superhero2", + "receiver": "cometchat-uid-2", "category": "message", "type": "image", "data": { @@ -15476,7 +15476,7 @@ "entities": { "sender": { "entity": { - "uid": "superhero1", + "uid": "cometchat-uid-1", "name": "Iron Man", "avatar": "https://data-eu.cometchat.io/assets/images/avatars/ironman.png", "status": "offline", @@ -15486,12 +15486,12 @@ }, "receiver": { "entity": { - "uid": "superhero2", + "uid": "cometchat-uid-2", "name": "Captain America", "avatar": "https://data-eu.cometchat.io/assets/images/avatars/captainamerica.png", "status": "offline", "role": "default", - "conversationId": "superhero1_user_superhero2" + "conversationId": "cometchat-uid-1_user_cometchat-uid-2" }, "entityType": "user" } @@ -17137,7 +17137,7 @@ "properties": { "authToken": { "type": "string", - "example": "superhero3_1710141033938cf7e3c67cc44465440d" + "example": "cometchat-uid-3_1710141033938cf7e3c67cc44465440d" }, "timezone": { "type": "string", @@ -18287,7 +18287,7 @@ "guid": { "description": "Group identifier", "type": "string", - "example": "supergroup" + "example": "cometchat-guid-1" }, "scope": { "description": "Scope identifier", @@ -18529,7 +18529,7 @@ "guid": { "description": "Group identifier", "type": "string", - "example": "supergroup" + "example": "cometchat-guid-1" }, "scope": { "description": "Scope identifier", @@ -19857,14 +19857,14 @@ "data": { "text": "Thanks For filling the Form!" }, - "receiver": "superhero2", + "receiver": "cometchat-uid-2", "receiverType": "user" }, "headers": { "appId": "10893f2ae68f59", "Content-Type": "application/json", "apiKey": "5797f2d3d103d7d78f085eb46bfd14d5c45ddfdf", - "onBehalfOf": "superhero1" + "onBehalfOf": "cometchat-uid-1" }, "dataKey": "CometChatData" } @@ -19873,7 +19873,7 @@ }, "category": "interactive", "type": "form", - "receiver": "superhero1", + "receiver": "cometchat-uid-1", "tags": [ "tag1" ] diff --git a/data-import-apis.json b/data-import-apis.json index cd7e55dc0..18c6849d5 100644 --- a/data-import-apis.json +++ b/data-import-apis.json @@ -498,11 +498,11 @@ }, "receiverUserDetails": { "uid": "r123", - "name": "superhero", + "name": "Iron Man", "type": "public", "description": "Hello group", "icon": "https://data-eu.cometchat.io/assets/images/avatars/ironman.png", - "owner": "superhero1", + "owner": "cometchat-uid-1", "avatar": "https://data-eu.cometchat.io/assets/images/avatars/ironman.png", "createdAt": "1674228536", "metadata": { @@ -607,7 +607,7 @@ "receiver": { "entity": { "uid": "r123", - "name": "superhero", + "name": "Iron Man", "avatar": "https://data-eu.cometchat.io/assets/images/avatars/ironman.png", "metadata": { "key": "value" @@ -935,10 +935,10 @@ "name": "guid1", "createdAt": "1673421419", "type": "public", - "owner": "superhero1", + "owner": "cometchat-uid-1", "groupOwnerDetails": { - "uid": "superhero1", - "name": "superhero1" + "uid": "cometchat-uid-1", + "name": "cometchat-uid-1" } } } @@ -982,7 +982,7 @@ "type": "public", "conversationId": "group_guid1", "createdAt": 1673421419, - "owner": "superhero1" + "owner": "cometchat-uid-1" } } } @@ -1272,7 +1272,7 @@ "properties": { "authToken": { "type": "string", - "example": "superhero3_1710141033938cf7e3c67cc44465440d" + "example": "cometchat-uid-3_1710141033938cf7e3c67cc44465440d" }, "timezone": { "type": "string", @@ -2422,7 +2422,7 @@ "guid": { "description": "Group identifier", "type": "string", - "example": "supergroup" + "example": "cometchat-guid-1" }, "scope": { "description": "Scope identifier", @@ -2664,7 +2664,7 @@ "guid": { "description": "Group identifier", "type": "string", - "example": "supergroup" + "example": "cometchat-guid-1" }, "scope": { "description": "Scope identifier", @@ -3992,14 +3992,14 @@ "data": { "text": "Thanks For filling the Form!" }, - "receiver": "superhero2", + "receiver": "cometchat-uid-2", "receiverType": "user" }, "headers": { "appId": "10893f2ae68f59", "Content-Type": "application/json", "apiKey": "5797f2d3d103d7d78f085eb46bfd14d5c45ddfdf", - "onBehalfOf": "superhero1" + "onBehalfOf": "cometchat-uid-1" }, "dataKey": "CometChatData" } @@ -4008,7 +4008,7 @@ }, "category": "interactive", "type": "form", - "receiver": "superhero1", + "receiver": "cometchat-uid-1", "tags": [ "tag1" ] diff --git a/docs.json b/docs.json index 035cebab9..55f42de73 100644 --- a/docs.json +++ b/docs.json @@ -6002,7 +6002,8 @@ "icon": "phone", "pages": [ "rest-api/calls-apis/list-calls", - "rest-api/calls-apis/get-call" + "rest-api/calls-apis/get-call", + "rest-api/calls-apis/get-call-transcriptions" ] }, { diff --git a/rest-api/calls-apis/get-call-transcriptions.mdx b/rest-api/calls-apis/get-call-transcriptions.mdx new file mode 100644 index 000000000..b95ebf29e --- /dev/null +++ b/rest-api/calls-apis/get-call-transcriptions.mdx @@ -0,0 +1,60 @@ +--- +title: "Get Call Transcriptions" +sidebarTitle: "Get Call Transcriptions" +openapi: get /calls/{sessionId}/transcriptions +description: "Retrieve the transcriptions generated for a CometChat call by sessionId, with pagination and links to the transcript files." +--- + +Retrieve the transcriptions generated for a specific call using its session ID. Each entry describes one transcript file, including the window it covers and the URL to download it. + +## When to Use + +| Scenario | Description | +|----------|-------------| +| Transcript playback | Fetch the transcript file URLs for a completed call | +| Compliance and archival | Export call transcripts into your own retention system | +| Long calls | Page through calls that produced more than the 5 transcripts embedded in the call object | +| Search and analytics | Feed transcript content into downstream indexing or summarisation | + +## Example Request + +```bash +curl -X GET "https://{appId}.call-{region}.cometchat.io/v3/calls/v1.us.31780434a95d45.16923681138d75114d60d1345a22e4cc612263fb26c0b5cf92/transcriptions" \ + -H "apikey: YOUR_REST_API_KEY" +``` + +## Response Details + +Each entry in the `data` array describes one transcript file: + +| Property | Type | Description | +|----------|------|-------------| +| `roomName` | string | The conference room the transcript belongs to | +| `mid` | string | Unique meeting identifier; absent when the transcript covers the whole session | +| `tid` | string | Unique transcript identifier | +| `startTime` | integer | UNIX timestamp when the transcribed segment started | +| `endTime` | integer | UNIX timestamp when the transcribed segment ended | +| `transcriptDate` | string | ISO 8601 timestamp of when the transcript was produced | +| `transcriptUrl` | string | URL to the transcript file | + + +Transcriptions are generated asynchronously after a call ends, so a call that has just finished may return an empty `data` array. Fields with no value are omitted from the response rather than returned as `null`. + + +## Pagination + +Results are paginated, newest transcript first. Use `page` and `perPage` to page through them. + +| Parameter | Default | Maximum | +|-----------|---------|---------| +| `page` | 1 | — | +| `perPage` | 100 | 1000 | + +```bash +curl -X GET "https://{appId}.call-{region}.cometchat.io/v3/calls/{sessionId}/transcriptions?page=2&perPage=50" \ + -H "apikey: YOUR_REST_API_KEY" +``` + +## Relationship to the Call Object + +The [List Calls](/rest-api/calls-apis/list-calls) and [Get Call](/rest-api/calls-apis/get-call) responses embed the **5 most recent** transcriptions on each call whose `hasTranscription` is `true`. Use this endpoint when a call has more than 5 transcripts, or when you need to page through them. diff --git a/rest-api/calls-apis/list-calls.mdx b/rest-api/calls-apis/list-calls.mdx index cd6dffeae..bb4d8df8a 100644 --- a/rest-api/calls-apis/list-calls.mdx +++ b/rest-api/calls-apis/list-calls.mdx @@ -2,7 +2,7 @@ title: "List Calls" sidebarTitle: "List Calls" openapi: get /calls -description: "lists all the calls that are available in the app. It can include participants, and recordings property in the response (if present)." +description: "lists all the calls that are available in the app. It can include participants, recordings and transcriptions property in the response (if present)." --- Retrieve a paginated list of all calls in your application. Use query parameters to filter by call type, status, date range, and more. @@ -14,6 +14,7 @@ Retrieve a paginated list of all calls in your application. Use query parameters | Get all video calls | `type=video` | | Get ongoing calls | `status=ongoing` | | Get calls with recordings | `hasRecording=true` | +| Get calls with transcriptions | `hasTranscription=true` | | Get calls for a specific user | `uid=user123` | | Get group calls only | `receiverType=group` | | Get calls from a specific date | `startedAt=1692368000` | diff --git a/rest-api/calls-apis/overview.mdx b/rest-api/calls-apis/overview.mdx index 8c31611eb..1e84df8f2 100644 --- a/rest-api/calls-apis/overview.mdx +++ b/rest-api/calls-apis/overview.mdx @@ -1,10 +1,10 @@ --- title: "Calls APIs Overview" sidebarTitle: "Overview" -description: "Retrieve CometChat call logs, session details, participant metrics, durations, and recordings with Calls REST APIs." +description: "Retrieve CometChat call logs, session details, participant metrics, durations, recordings, and transcriptions with Calls REST APIs." --- -The Calls API provides programmatic access to call logs and analytics. Use these APIs to retrieve call history, participant details, duration metrics, and recording information for your application. +The Calls API provides programmatic access to call logs and analytics. Use these APIs to retrieve call history, participant details, duration metrics, recording information, and call transcriptions for your application. ## Base URL @@ -42,10 +42,11 @@ curl -X GET "https://{appId}.call-{region}.cometchat.io/v3/calls" \ ## Available Endpoints -| Operation | Method | Endpoint | Description | -| --------------------------------------------- | ------ | -------------------- | ----------------------------------- | -| [List Calls](/rest-api/calls-apis/list-calls) | `GET` | `/calls` | Retrieve a paginated list of calls | -| [Get Call](/rest-api/calls-apis/get-call) | `GET` | `/calls/{sessionId}` | Retrieve details of a specific call | +| Operation | Method | Endpoint | Description | +| ----------------------------------------------------------------------------------- | ------ | ------------------------------------- | ---------------------------------------- | +| [List Calls](/rest-api/calls-apis/list-calls) | `GET` | `/calls` | Retrieve a paginated list of calls | +| [Get Call](/rest-api/calls-apis/get-call) | `GET` | `/calls/{sessionId}` | Retrieve details of a specific call | +| [Get Call Transcriptions](/rest-api/calls-apis/get-call-transcriptions) | `GET` | `/calls/{sessionId}/transcriptions` | Retrieve the transcriptions of a call | ## Call Properties @@ -62,9 +63,11 @@ curl -X GET "https://{appId}.call-{region}.cometchat.io/v3/calls" \ | `totalDuration` | string | Duration in timer format (e.g., `00:05:30`) | | `totalParticipants` | integer | Number of participant entries (multi-device joins counted separately) | | `hasRecording` | boolean | Whether the call has a recording | +| `hasTranscription` | boolean | Whether the call has a transcription | | `startedAt` | integer | UNIX timestamp when the call was initiated | | `endedAt` | integer | UNIX timestamp when the call ended | | `participants` | array | Details of individual participants | +| `transcriptions` | array | The 5 most recent transcriptions, when `hasTranscription` is `true` | ## Participant Properties @@ -90,6 +93,20 @@ curl -X GET "https://{appId}.call-{region}.cometchat.io/v3/calls" \ | `endTime` | integer | UNIX timestamp when recording ended | | `recording_url` | string | URL to the recording file | +## Transcription Properties + +| Property | Type | Description | +| ---------------- | ------- | ---------------------------------------------------------------------- | +| `roomName` | string | The conference room the transcript belongs to | +| `mid` | string | Unique meeting identifier; absent when the transcript covers the whole session | +| `tid` | string | Unique transcript identifier | +| `startTime` | integer | UNIX timestamp when the transcribed segment started | +| `endTime` | integer | UNIX timestamp when the transcribed segment ended | +| `transcriptDate` | string | ISO 8601 timestamp of when the transcript was produced | +| `transcriptUrl` | string | URL to the transcript file | + +Calls with `hasTranscription: true` embed their 5 most recent transcriptions in the List Calls and Get Call responses. Use [Get Call Transcriptions](/rest-api/calls-apis/get-call-transcriptions) to page through all of them. + ## Pagination List endpoints return paginated results: diff --git a/rest-api/conversations.mdx b/rest-api/conversations.mdx index 700f352d2..8b683c7ee 100644 --- a/rest-api/conversations.mdx +++ b/rest-api/conversations.mdx @@ -10,6 +10,8 @@ A **Conversation** represents an ongoing message exchange between a user and ano - Conversations are automatically created when the first message is exchanged. - For groups with more than **300 members**, conversations and unread message counts are not updated. - Conversations can have up to **25 tags**, each up to 100 characters (UTF8mb4). +- A user can pin up to **5 conversations**. Exceeding this limit returns `ERR_PINNED_CONVERSATIONS_LIMIT_EXCEEDED`. +- An app can pin up to **5 conversations globally**, shown at the top for every end user. Exceeding this limit returns `ERR_SYSTEM_PINNED_CONVERSATIONS_LIMIT_EXCEEDED`. - The `lastMessage` property is not visible if the message has been deleted or if a new group has no messages yet. ### How conversations connect to other resources diff --git a/rest-api/messages.mdx b/rest-api/messages.mdx index 6950e467c..c31142f67 100644 --- a/rest-api/messages.mdx +++ b/rest-api/messages.mdx @@ -12,6 +12,8 @@ A **Message** is the core unit of communication in CometChat. Users can send tex - The `data` object within a message must not exceed **10 KB**. It accepts any JSON structure with UTF8mb4 encoding. - Messages can have up to **25 tags**, each up to 100 characters (UTF8mb4). - Soft-deleted messages remain in the database. Permanently deleted messages (via API) are removed entirely. +- A conversation can hold up to **100 pinned messages**. Pins made on behalf of a user and pins made as the app (without `onBehalfOf`) share this limit. Exceeding this limit returns `ERR_PINNED_MESSAGES_LIMIT_EXCEEDED`. +- A user can save up to **100 messages**. Saved messages are private to the user who saved them. Exceeding this limit returns `ERR_SAVED_MESSAGES_LIMIT_EXCEEDED`. - For groups with more than **300 members**, unread message counts and conversations are not updated. - Delivery and read receipts are sent for groups of up to **300 online users**. @@ -25,22 +27,32 @@ A **Message** is the core unit of communication in CometChat. Users can send tex ### Available operations -| Operation | Method | Endpoint | Description | -| ------------------------------------------------------------------- | -------- | --------------------------- | ------------------------------------------------ | -| [Send Message](/rest-api/messages/send-message) | `POST` | `/messages` | Send a message to a user or group | -| [List Messages](/rest-api/messages/list-messages) | `GET` | `/messages` | Retrieve all messages for the authenticated user | -| [List User Messages](/rest-api/messages/list-user-messages) | `GET` | `/users/{uid}/messages` | Retrieve messages in a 1-on-1 conversation | -| [List Group Messages](/rest-api/messages/list-group-messages) | `GET` | `/groups/{guid}/messages` | Retrieve messages in a group conversation | -| [Get Message](/rest-api/messages/get-message) | `GET` | `/messages/{id}` | Retrieve a specific message by ID | -| [Update Message](/rest-api/messages/update-message) | `PUT` | `/messages/{id}` | Edit a sent message | -| [Delete Message](/rest-api/messages/delete-message) | `DELETE` | `/messages/{id}` | Soft-delete or permanently delete a message | -| [Send Threaded Message](/rest-api/messages/send-threaded-message) | `POST` | `/messages/{id}/thread` | Reply to a message in a thread | -| [List Threaded Messages](/rest-api/messages/list-threaded-messages) | `GET` | `/messages/{id}/thread` | Retrieve all replies in a thread | -| [Send Bot Message](/rest-api/messages/send-bot-message) | `POST` | `/bots/{uid}/messages` | Send a message as a bot user | -| [Add Reaction](/rest-api/messages/add-reaction) | `POST` | `/messages/{id}/reactions` | Add an emoji reaction to a message | -| [Remove Reaction](/rest-api/messages/remove-reaction) | `DELETE` | `/messages/{id}/reactions/{reaction}` | Remove an emoji reaction from a message | -| [List All Reactions](/rest-api/messages/list-all-reactions) | `GET` | `/messages/{id}/reactions` | List all reactions on a message | -| [List Reactions by Emoji](/rest-api/messages/list-reactions-with-a-specific-emoji-unicode) | `GET` | `/messages/{id}/reactions/{reaction}` | List reactions filtered by a specific emoji | +| Operation | Method | Endpoint | Description | +| ------------------------------------------------------------------------------------------ | -------- | ------------------------------------- | ----------------------------------------------------- | +| [Send Message](/rest-api/messages/send-message) | `POST` | `/messages` | Send a message to a user or group | +| [List Messages](/rest-api/messages/list-messages) | `GET` | `/messages` | Retrieve all messages for the authenticated user | +| [List User Messages](/rest-api/messages/list-user-messages) | `GET` | `/users/{uid}/messages` | Retrieve messages in a 1-on-1 conversation | +| [List Group Messages](/rest-api/messages/list-group-messages) | `GET` | `/groups/{guid}/messages` | Retrieve messages in a group conversation | +| [Get Message](/rest-api/messages/get-message) | `GET` | `/messages/{id}` | Retrieve a specific message by ID | +| [Update Message](/rest-api/messages/update-message) | `PUT` | `/messages/{id}` | Edit a sent message | +| [Delete Message](/rest-api/messages/delete-message) | `DELETE` | `/messages/{id}` | Soft-delete or permanently delete a message | +| [Pin Message](/rest-api/messages/pin-message) | `POST` | `/messages/{id}/pin` | Pin a message in its conversation | +| [Unpin Message](/rest-api/messages/unpin-message) | `DELETE` | `/messages/{id}/pin` | Unpin a message | +| [Save Message](/rest-api/messages/save-message) | `POST` | `/messages/{id}/save` | Save a message to a user's private saved list | +| [Unsave Message](/rest-api/messages/unsave-message) | `DELETE` | `/messages/{id}/save` | Remove a message from a user's saved list | +| [Mark Message As Interacted](/rest-api/messages/mark-message-as-interacted) | `PATCH` | `/messages/{id}/interacted` | Mark elements of an interactive message as interacted | +| [Send Threaded Message](/rest-api/messages/send-threaded-message) | `POST` | `/messages/{id}/thread` | Reply to a message in a thread | +| [List Threaded Messages](/rest-api/messages/list-threaded-messages) | `GET` | `/messages/{id}/thread` | Retrieve all replies in a thread | +| [List Threads](/rest-api/messages/list-threads) | `GET` | `/threads` | List threads across conversations | +| [Subscribe Thread](/rest-api/messages/subscribe-thread) | `POST` | `/messages/{id}/thread/subscription` | Subscribe a user to a thread | +| [Unsubscribe Thread](/rest-api/messages/unsubscribe-thread) | `DELETE` | `/messages/{id}/thread/subscription` | Unsubscribe a user from a thread | +| [Send Bot Message](/rest-api/messages/send-bot-message) | `POST` | `/bots/{uid}/messages` | Send a message as a bot user | +| [Add Reaction](/rest-api/messages/add-reaction) | `POST` | `/messages/{id}/reactions` | Add an emoji reaction to a message | +| [Remove Reaction](/rest-api/messages/remove-reaction) | `DELETE` | `/messages/{id}/reactions/{reaction}` | Remove an emoji reaction from a message | +| [List All Reactions](/rest-api/messages/list-all-reactions) | `GET` | `/messages/{id}/reactions` | List all reactions on a message | +| [List Reactions by Emoji](/rest-api/messages/list-reactions-with-a-specific-emoji-unicode) | `GET` | `/messages/{id}/reactions/{reaction}` | List reactions filtered by a specific emoji | + +Save Message, Unsave Message, Mark Message As Interacted, Subscribe Thread and Unsubscribe Thread require the `onBehalfOf` header, since they act for a specific user. Pin Message and Unpin Message accept it optionally — without it the message is pinned as the app itself. ### Message properties @@ -58,13 +70,15 @@ A **Message** is the core unit of communication in CometChat. Users can send tex ### Error handling -| Error Code | Description | -| --------------------------- | ------------------------------------------- | -| `AUTH_ERR_EMPTY_APIKEY` | API key is missing from the request headers | -| `AUTH_ERR_APIKEY_NOT_FOUND` | The provided API key is invalid | -| `ERR_MSG_NOT_FOUND` | The specified message does not exist | -| `ERR_UID_NOT_FOUND` | The receiver UID does not exist | -| `ERR_GUID_NOT_FOUND` | The receiver group GUID does not exist | +| Error Code | Description | +| ------------------------------------ | ----------------------------------------------------- | +| `AUTH_ERR_EMPTY_APIKEY` | API key is missing from the request headers | +| `AUTH_ERR_APIKEY_NOT_FOUND` | The provided API key is invalid | +| `ERR_MSG_NOT_FOUND` | The specified message does not exist | +| `ERR_UID_NOT_FOUND` | The receiver UID does not exist | +| `ERR_GUID_NOT_FOUND` | The receiver group GUID does not exist | +| `ERR_PINNED_MESSAGES_LIMIT_EXCEEDED` | The conversation has reached its pinned-message limit | +| `ERR_SAVED_MESSAGES_LIMIT_EXCEEDED` | The user has reached their saved-message limit | For the complete list of error codes, see [Error Guide](/articles/error-guide). diff --git a/sdk/flutter/v4/delivery-read-receipts.mdx b/sdk/flutter/v4/delivery-read-receipts.mdx index ca2605290..c584e965f 100644 --- a/sdk/flutter/v4/delivery-read-receipts.mdx +++ b/sdk/flutter/v4/delivery-read-receipts.mdx @@ -232,7 +232,7 @@ CometChat.markMessageAsUnread( | Parameter | Type | Description | Sample Value | |-----------|------|-------------|--------------| -| `conversationId` | `String` | Unique identifier for the conversation | `"user_superhero1"` | +| `conversationId` | `String` | Unique identifier for the conversation | `"user_cometchat-uid-1"` | | `conversationType` | `String` | Type of conversation | `"user"` or `"group"` | | `unreadMessageCount` | `int` | Updated unread message count | `5` | | `lastMessage` | `BaseMessage` | The last message in the conversation | Message object | @@ -364,7 +364,7 @@ CometChat.getMessageReceipts(messageId, onSuccess: (List message |-----------|------|-------------|--------------| | `messageId` | `int` | The ID of the message | `10101` | | `sender` | `User` | User who triggered the receipt | User object | -| `receiverId` | `String` | ID of the receiver | `"superhero1"` | +| `receiverId` | `String` | ID of the receiver | `"cometchat-uid-1"` | | `receiverType` | `String` | Type of receiver | `"user"` or `"group"` | | `receiptType` | `String` | Type of receipt | `"delivered"` or `"read"` | | `deliveredAt` | `DateTime` | Timestamp when delivered | `DateTime` object | diff --git a/ui-kit/react/methods.mdx b/ui-kit/react/methods.mdx index 8e62a71cb..4a930787c 100644 --- a/ui-kit/react/methods.mdx +++ b/ui-kit/react/methods.mdx @@ -100,7 +100,7 @@ Session storage is cleared when the browser tab is closed. Use this mode if you Log in a user by UID. Requires `authKey` in UIKitSettings. ```tsx -const user = await CometChatUIKit.login("superhero1"); +const user = await CometChatUIKit.login("cometchat-uid-1"); ``` | Parameter | Type | Description | diff --git a/ui-kit/react/v5/integration/next-js.mdx b/ui-kit/react/v5/integration/next-js.mdx index 02e01b7e3..7dd83f130 100644 --- a/ui-kit/react/v5/integration/next-js.mdx +++ b/ui-kit/react/v5/integration/next-js.mdx @@ -643,7 +643,7 @@ const CometChatNoSSR: React.FC = () => { console.log("Initialization completed successfully"); CometChatUIKit.getLoggedinUser().then((loggedInUser) => { if (!loggedInUser) { - CometChatUIKit.login("superhero1") + CometChatUIKit.login("cometchat-uid-1") .then((user) => { console.log("Login Successful", { user }); setUser(user);