From a092eff0356a7e15517274b525059c39392aa5df Mon Sep 17 00:00:00 2001 From: "shardul.cometchat" Date: Tue, 28 Jul 2026 19:37:14 +0530 Subject: [PATCH 1/2] docs(rest-api): replace real-looking sample contact data in API specs Swap out sample data in the OpenAPI specs that looked like real personal details with obvious placeholders: - chat-apis.json: Update/Get contact details examples now use the placeholder phone +911111111111 instead of a real-looking number. - management-apis.json: Add Tenant request/response examples now use "Example User" / my-email@example.com, matching the placeholders the file already uses elsewhere, and contactNumber is normalized to 1111111111 across all three examples. - management-apis.json: the Add Tenant response example exposed what look like a genuine authKey and apiKey; replaced with and , matching the convention used earlier in the file. Co-Authored-By: Claude Opus 5 --- chat-apis.json | 6 +++--- management-apis.json | 20 ++++++++++---------- 2 files changed, 13 insertions(+), 13 deletions(-) diff --git a/chat-apis.json b/chat-apis.json index 595147810..f98c3ed43 100644 --- a/chat-apis.json +++ b/chat-apis.json @@ -11864,7 +11864,7 @@ "example": { "data": { "email": "someone@example.com", - "phno": "+919591128691" + "phno": "+911111111111" } } } @@ -11903,7 +11903,7 @@ "phno": { "description": "The user's phone number with country code (Ex: +1 for US, +91 for India, etc.)", "type": "string", - "example": "+919591128691" + "example": "+911111111111" } }, "type": "object" @@ -11931,7 +11931,7 @@ "example": { "data": { "email": "someone@example.com", - "phno": "+919591128691" + "phno": "+911111111111" } } } diff --git a/management-apis.json b/management-apis.json index 365391720..86937d2d4 100644 --- a/management-apis.json +++ b/management-apis.json @@ -9456,10 +9456,10 @@ }, "type": "object", "example": { - "name": "Sachin Bahukhandi", - "email": "sachin.bahukhandi+114@cometchat.com", - "password": "sachin@123", - "contactNumber": "8936985734", + "name": "Example User", + "email": "my-email@example.com", + "password": "somePassword#!", + "contactNumber": "1111111111", "role": "engineer", "appName": "Create APP", "appRegion": "us" @@ -9569,7 +9569,7 @@ "name": "Example User", "email": "my-email@example.com", "password": "somePassword#!", - "contactNumber": "1234567890", + "contactNumber": "1111111111", "role": "engineer", "appName": "Create App", "appRegion": "us" @@ -9597,16 +9597,16 @@ }, "example": { "data": { - "name": "Sachin Bahukhandi", - "email": "sachin.bahukhandi+113@cometchat.com", + "name": "Example User", + "email": "my-email@example.com", "createdAt": 1715947984, - "contactNumber": "8936985734", + "contactNumber": "1111111111", "app": { "name": "Create APP", "appId": "2531446b588709f6", "region": "us", - "authKey": "05753974edb58b7ce7c1ab10eb3eb3033e3dd1e9", - "apiKey": "5db447476272190a2cda793e10e59f58bcc17317", + "authKey": "", + "apiKey": "", "createdAt": 1715947984, "plan": "Build" } From eaff6c80ad7b6742aeef3c2f24ef044d879b4592 Mon Sep 17 00:00:00 2001 From: "shardul.cometchat" Date: Tue, 28 Jul 2026 20:25:21 +0530 Subject: [PATCH 2/2] docs(rest-api): redact credentials and standardize sample phone numbers Follow-up to the contact-details cleanup, covering the rest of the real-looking credentials and phone numbers across the API specs. Credentials replaced with placeholders: - Twilio account SIDs and auth tokens (chat-apis.json, management-apis.json) - Reply-webhook tokens for SendGrid, Intercom and Chatwoot. The Intercom and Chatwoot tokens carried a base64 payload decoding to a real appId, so they were generated against an actual app. - CometChat REST API keys (chat-apis.json, data-import-apis.json). The list-keys example uses so it still reads as three keys. - Call session wsChannel.secret (chat-apis.json) Phone numbers standardized to +12125550123, which falls in the 555-0100 to 555-0199 block that NANP permanently reserves for fictional use: - Twilio sender numbers, SMS payload samples, contactNumber examples and the malformed fromMobileNo in the SMS extension settings. - contactNumber examples move from bare 10-digit strings to E.164, since those fields feed SMS notifications and need a country code. - The +91 contact-details examples are left alone so they keep matching the field description, which cites +91 for India. Redaction stops further leakage but does not undo it: these values remain in git history and have been served by the docs site. Any that are still live should be rotated. Co-Authored-By: Claude Opus 5 --- chat-apis.json | 82 +++++++++++++------------- data-import-apis.json | 2 +- management-apis.json | 24 ++++---- notifications/sms-custom-providers.mdx | 4 +- notifications/sms-templates.mdx | 6 +- 5 files changed, 59 insertions(+), 59 deletions(-) diff --git a/chat-apis.json b/chat-apis.json index f98c3ed43..f1f8bd614 100644 --- a/chat-apis.json +++ b/chat-apis.json @@ -77,7 +77,7 @@ }, "example": { "data": { - "apiKey": "f1915e328e249ffaaafd97fb46a57ba55d233fbf", + "apiKey": "", "name": "John's apiKey", "scope": "authOnly", "createdAt": 1625206799 @@ -142,19 +142,19 @@ "example": { "data": [ { - "apiKey": "fcf32d085482db7ef10e971967d70a91cdb6677a", + "apiKey": "", "name": "John's apiKey", "scope": "authOnly", "createdAt": 1631095584 }, { - "apiKey": "0f40b2c254f33d429b1fca5e0eb1cef72c594ddc", + "apiKey": "", "name": "Auth Key", "scope": "authOnly", "createdAt": 1629869272 }, { - "apiKey": "495318bc2e137fb2decf17078abd169a7bd50c8b", + "apiKey": "", "name": "Rest API Key", "scope": "fullAccess", "createdAt": 1629869272 @@ -215,7 +215,7 @@ }, "example": { "data": { - "apiKey": "f1915e328e249ffaaafd97fb46a57ba55d233fbf", + "apiKey": "", "name": "John's apiKey", "scope": "authOnly", "createdAt": 1625206799 @@ -287,7 +287,7 @@ }, "example": { "data": { - "apiKey": "f1915e328e249ffaaafd97fb46a57ba55d233fbf", + "apiKey": "", "name": "John's apiKey", "scope": "authOnly", "createdAt": 1625206799 @@ -343,7 +343,7 @@ "example": { "data": { "success": true, - "message": "The Api Key fcf32d085482db7ef10e971967d70a91cdb6677a has been deleted successfully." + "message": "The Api Key has been deleted successfully." } } } @@ -417,7 +417,7 @@ "default": { "@private": { "email": "user@email.com", - "contactNumber": "0123456789" + "contactNumber": "+12125550123" } } }, @@ -666,7 +666,7 @@ "avatar": "http://placehold.it/120x120&text=image1", "metadata": { "email": "user@email.com", - "contactNumber": "0123456789" + "contactNumber": "+12125550123" }, "status": "offline", "role": "manager", @@ -690,7 +690,7 @@ "link": "https://data-us.cometchat.io/assets", "avatar": "https://data-us.cometchat.io/assets/images/avatars/captainamerica.png", "metadata": { - "contactNumber": "0123456789" + "contactNumber": "+12125550123" }, "status": "offline", "role": "default", @@ -984,7 +984,7 @@ "default": { "@private": { "email": "user@email.com", - "contactNumber": "0123456789" + "contactNumber": "+12125550123" } } }, @@ -1040,7 +1040,7 @@ "avatar": "http://placehold.it/120x120&text=image1", "metadata": { "email": "user@email.com", - "contactNumber": "0123456789" + "contactNumber": "+12125550123" }, "status": "offline", "role": "manager", @@ -5756,7 +5756,7 @@ "link": "https://data-us.cometchat.io/assets", "avatar": "https://data-us.cometchat.io/assets/images/avatars/captainamerica.png", "metadata": { - "contactNumber": "0123456789" + "contactNumber": "+12125550123" }, "status": "offline", "role": "default", @@ -6104,7 +6104,7 @@ "avatar": "http://placehold.it/120x120&text=image1", "metadata": { "email": "user@email.com", - "contactNumber": "0123456789" + "contactNumber": "+12125550123" }, "status": "offline", "role": "manager", @@ -6128,7 +6128,7 @@ "link": "https://data-us.cometchat.io/assets", "avatar": "https://data-us.cometchat.io/assets/images/avatars/captainamerica.png", "metadata": { - "contactNumber": "0123456789" + "contactNumber": "+12125550123" }, "status": "offline", "role": "default", @@ -6306,7 +6306,7 @@ "avatar": "http://placehold.it/120x120&text=image1", "metadata": { "email": "user@email.com", - "contactNumber": "0123456789" + "contactNumber": "+12125550123" }, "status": "offline", "role": "manager", @@ -6330,7 +6330,7 @@ "link": "https://data-us.cometchat.io/assets", "avatar": "https://data-us.cometchat.io/assets/images/avatars/captainamerica.png", "metadata": { - "contactNumber": "0123456789" + "contactNumber": "+12125550123" }, "status": "offline", "role": "default", @@ -9039,7 +9039,7 @@ "receiver": "superhero3", "sessionid": "16469950973f7f6a1ea6d5166db11c929cdbde6a61902e10ba", "wsChannel": { - "secret": "083c2a7f660150e42c2bf07a17231e90980b290d", + "secret": "", "service": "19757e59e8b9669.call", "identity": "[19757e59e8b9669]16469950973f7f6a1ea6d5166db11c929cdbde6a61902e10ba" }, @@ -9126,7 +9126,7 @@ "sessionid": "16469950973f7f6a1ea6d5166db11c929cdbde6a61902e10ba", "startedAt": 1646995512, "wsChannel": { - "secret": "083c2a7f660150e42c2bf07a17231e90980b290d", + "secret": "", "service": "19757e59e8b9669.call", "identity": "[19757e59e8b9669]16469950973f7f6a1ea6d5166db11c929cdbde6a61902e10ba" }, @@ -9703,7 +9703,7 @@ "headers": { "appId": "10893f2ae68f59", "Content-Type": "application/json", - "apiKey": "5797f2d3d103d7d78f085eb46bfd14d5c45ddfdf", + "apiKey": "", "onBehalfOf": "superhero1" }, "dataKey": "CometChatData" @@ -9753,7 +9753,7 @@ "headers": { "appId": "10893f2ae68f59", "Content-Type": "application\\/json", - "apiKey": "5797f2d3d103d7d78f085eb46bfd14d5c45ddfdf", + "apiKey": "", "onBehalfOf": "superhero1" }, "dataKey": "CometChatData" @@ -9790,7 +9790,7 @@ "headers": { "appId": "10893f2ae68f59", "Content-Type": "application/json", - "apiKey": "5797f2d3d103d7d78f085eb46bfd14d5c45ddfdf", + "apiKey": "", "onBehalfOf": "superhero1" }, "dataKey": "CometChatData" @@ -9878,7 +9878,7 @@ "dataKey": "", "headers": { "accept": "application/json", - "apiKey": "62a32b5140e6b630dab38e2e690d88de9c69d416", + "apiKey": "", "onBehalfOf": "suryansh1", "content-type": "application/json" }, @@ -12016,9 +12016,9 @@ }, "example": { "data": { - "twilioAccountSID": "AC91e67951ff7e5e7be8122184e76ae0e6=", - "twilioAuthToken": "71c2301435733997e83db7a3445bc57", - "twilioSenderPhoneNumber": "+13611364718" + "twilioAccountSID": "", + "twilioAuthToken": "", + "twilioSenderPhoneNumber": "+12125550123" } } } @@ -12052,17 +12052,17 @@ "twilioAccountSID": { "description": "The Twilio Account SID", "type": "string", - "example": "AC91e67951ff7e5e7be8122184e76ae0e6" + "example": "" }, "twilioAuthToken": { "description": "The Twilio Auth Token", "type": "string", - "example": "71c2301435733997e83db7a3445bc57" + "example": "" }, "twilioSenderPhoneNumber": { "description": "The Twilio sender phone number", "type": "string", - "example": "+13611364718" + "example": "+12125550123" }, "isEnabled": { "description": "Enable Twilio", @@ -12093,9 +12093,9 @@ }, "example": { "data": { - "twilioAccountSID": "AC91e67951ff7e5e7be8122184e76ae0e6=", - "twilioAuthToken": "71c2301435733997e83db7a3445bc57", - "twilioSenderPhoneNumber": "+13611364718" + "twilioAccountSID": "", + "twilioAuthToken": "", + "twilioSenderPhoneNumber": "+12125550123" } } } @@ -12123,17 +12123,17 @@ "twilioAccountSID": { "description": "The Twilio Account SID", "type": "string", - "example": "AC91e67951ff7e5e7be8122184e76ae0e6" + "example": "" }, "twilioAuthToken": { "description": "The Twilio Auth Token", "type": "string", - "example": "71c2301435733997e83db7a3445bc57" + "example": "" }, "twilioSenderPhoneNumber": { "description": "The Twilio sender phone number", "type": "string", - "example": "+13611364718" + "example": "+12125550123" }, "isEnabled": { "description": "Enable Twilio", @@ -12164,9 +12164,9 @@ }, "example": { "data": { - "twilioAccountSID": "AC91e67951ff7e5e7be8122184e76ae0e6=-", - "twilioAuthToken": "71c2301435733997e83db7a3445bc57", - "twilioSenderPhoneNumber": "+13611364718" + "twilioAccountSID": "", + "twilioAuthToken": "", + "twilioSenderPhoneNumber": "+12125550123" } } } @@ -12355,7 +12355,7 @@ "senderEmail": "noreply@em123.example.com", "senderEmailForReplies": "reply@em123.example.com", "senderName": "Emailer", - "repliesWebhook": "https://notifications-us.cometchat.io/email/v1/sendgrid/replies?token=GY40_1kWlnc2Lo7Lk8vWWxiNJ6BmEEpV4eZsUeMr328" + "repliesWebhook": "https://notifications-us.cometchat.io/email/v1/sendgrid/replies?token=" } } } @@ -12451,7 +12451,7 @@ "senderEmail": "noreply@em123.example.com", "senderEmailForReplies": "reply@em123.example.com", "senderName": "Emailer", - "repliesWebhook": "https://notifications-us.cometchat.io/email/v1/sendgrid/replies?token=GY40_1kWlnc2Lo7Lk8vWWxiNJ6BmEEpV4eZsUeMr328" + "repliesWebhook": "https://notifications-us.cometchat.io/email/v1/sendgrid/replies?token=" } } } @@ -18411,7 +18411,7 @@ "headers": { "appId": "10893f2ae68f59", "Content-Type": "application/json", - "apiKey": "5797f2d3d103d7d78f085eb46bfd14d5c45ddfdf", + "apiKey": "", "onBehalfOf": "superhero1" }, "dataKey": "CometChatData" diff --git a/data-import-apis.json b/data-import-apis.json index 2678590ca..981c90af3 100644 --- a/data-import-apis.json +++ b/data-import-apis.json @@ -3993,7 +3993,7 @@ "headers": { "appId": "10893f2ae68f59", "Content-Type": "application/json", - "apiKey": "5797f2d3d103d7d78f085eb46bfd14d5c45ddfdf", + "apiKey": "", "onBehalfOf": "superhero1" }, "dataKey": "CometChatData" diff --git a/management-apis.json b/management-apis.json index 86937d2d4..eb5bb04cf 100644 --- a/management-apis.json +++ b/management-apis.json @@ -4196,7 +4196,7 @@ "appId": "212663ddb7a2a65a", "customerSupportUid": "cometchat-uid-2", "intercomAccessToken": "EgsDdxRZFUy4tPWDjwmyZvYk", - "webhookURL": "https://intercom-eu.cometchat.io/v1/reply?token=8z2Yn1R2hEVmpENi7HA1pPAv0DfZvMPFT8SBSaRJgwk=eyJhcHBJZCI6IjIxMjY2M2RkYjdhMmE2NmIifQ==" + "webhookURL": "https://intercom-eu.cometchat.io/v1/reply?token=" } } } @@ -4263,7 +4263,7 @@ "appId": "212663ddb7a2a65a", "customerSupportUid": "cometchat-uid-2", "intercomAccessToken": "EgsDdxRZFUy4tPWDjwmyZvYk", - "webhookURL": "https://intercom-eu.cometchat.io/v1/reply?token=8z2Yn1R2hEVmpENi7HA1pPAv0DfZvMPFT8SBSaRJgwk=eyJhcHBJZCI6IjIxMjY2M2RkYjdhMmE2NmIifQ==" + "webhookURL": "https://intercom-eu.cometchat.io/v1/reply?token=" } } } @@ -4321,7 +4321,7 @@ "appId": "212663ddb7a2a65a", "customerSupportUid": "cometchat-uid-2", "intercomAccessToken": "EgsDdxRZFUy4tPWDjwmyZvYk", - "webhookURL": "https://intercom-eu.cometchat.io/v1/reply?token=8z2Yn1R2hEVmpENi7HA1pPAv0DfZvMPFT8SBSaRJgwk=eyJhcHBJZCI6IjIxMjY2M2RkYjdhMmE2NmIifQ==" + "webhookURL": "https://intercom-eu.cometchat.io/v1/reply?token=" } } } @@ -6978,10 +6978,10 @@ "body": { "data": { "settings": { - "fromMobileNo": "+123456790", + "fromMobileNo": "+12125550123", "messageDelay": 60, - "twilioAccountSid": "ACfe6c12T1G2bc530a5151a8eff4155386", - "twilioAuthToken": "6928f0cadd4e6Ag2d431957a7f3a563ef3", + "twilioAccountSid": "", + "twilioAuthToken": "", "websiteURL": "somemail.com", "appId": "10419c123124" } @@ -7326,7 +7326,7 @@ "chatwootInboxId": "12112", "chatwootAccountId": "42113", "appId": "212663ddb7a2b1b", - "webhookURL": "https://chatwoot-eu.cometchat.io/v1/reply?token=K1b_mZsa31lTuNQqbTo7xtRHY0y7UUqXfhsUJltruwM=.eyJhcHBJZCI6IjIxMAY2M2RkYjdhMmE2NmIifQ==" + "webhookURL": "https://chatwoot-eu.cometchat.io/v1/reply?token=" } } } @@ -7395,7 +7395,7 @@ "customerSupportUid": "cometchat-uid-1", "chatwootInboxId": "12123", "chatwootAccountId": "42613", - "webhookURL": "https://chatwoot-eu.cometchat.io/v1/reply?token=K1b_mZsa31lTuNQqbTo7xtRHY0y7UUqXfhsUJltruwM=.eyJhcHBJZCI6IjIxLjY2M2RkYjdhMmE2NmIifQ==" + "webhookURL": "https://chatwoot-eu.cometchat.io/v1/reply?token=" } } } @@ -7455,7 +7455,7 @@ "appId": "212663ddb7a2b1b", "chatwootAccessToken": "EgsXaxRZFUy4atPWDjwmyZvYk", "customerSupportUid": "cometchat-uid-1", - "webhookURL": "https://chatwoot-eu.cometchat.io/v1/reply?token=K1b_mZsa31lTuNQqbTo7xtRHY0y7UUqXfhsUJltruwM=.eyJhcHBJZCI6IjIxMjY2M2RkYjdhNmQ2NmIifQ==" + "webhookURL": "https://chatwoot-eu.cometchat.io/v1/reply?token=" } } } @@ -9459,7 +9459,7 @@ "name": "Example User", "email": "my-email@example.com", "password": "somePassword#!", - "contactNumber": "1111111111", + "contactNumber": "+12125550123", "role": "engineer", "appName": "Create APP", "appRegion": "us" @@ -9569,7 +9569,7 @@ "name": "Example User", "email": "my-email@example.com", "password": "somePassword#!", - "contactNumber": "1111111111", + "contactNumber": "+12125550123", "role": "engineer", "appName": "Create App", "appRegion": "us" @@ -9600,7 +9600,7 @@ "name": "Example User", "email": "my-email@example.com", "createdAt": 1715947984, - "contactNumber": "1111111111", + "contactNumber": "+12125550123", "app": { "name": "Create APP", "appId": "2531446b588709f6", diff --git a/notifications/sms-custom-providers.mdx b/notifications/sms-custom-providers.mdx index d96a92fef..84ee3aaa8 100644 --- a/notifications/sms-custom-providers.mdx +++ b/notifications/sms-custom-providers.mdx @@ -40,7 +40,7 @@ The Custom provider is triggered once for an event in one-on-one conversation. I "data": { "to": { "uid": "cometchat-uid-1", - "phno": "+919299334134", // Optional + "phno": "+12125550123", // Optional "name": "Andrew Joseph" }, "messages": [ @@ -85,7 +85,7 @@ The Custom provider is triggered once for an event in one-on-one conversation. I "data": { "to": { "uid": "cometchat-uid-1", - "phno": "+919299334134", // Optional + "phno": "+12125550123", // Optional "name": "Andrew Joseph" }, "messages": [ diff --git a/notifications/sms-templates.mdx b/notifications/sms-templates.mdx index 56e61ac4b..c29776808 100644 --- a/notifications/sms-templates.mdx +++ b/notifications/sms-templates.mdx @@ -23,7 +23,7 @@ Field meanings: ### One-on-one ```json { - "to": { "uid": "cometchat-uid-1", "phno": "+919299334134", "name": "Andrew Joseph" }, + "to": { "uid": "cometchat-uid-1", "phno": "+12125550123", "name": "Andrew Joseph" }, "messages": [ { "sender": { "uid": "cometchat-uid-4", "name": "Susan Marie" }, "message": "Are we meeting on this weekend?" }, { "sender": { "uid": "cometchat-uid-4", "name": "Susan Marie" }, "message": "📷 Has shared an image" } @@ -36,7 +36,7 @@ Field meanings: ### Group ```json { - "to": { "uid": "cometchat-uid-1", "phno": "+919299334134", "name": "Andrew Joseph" }, + "to": { "uid": "cometchat-uid-1", "phno": "+12125550123", "name": "Andrew Joseph" }, "messages": [ { "sender": { "uid": "cometchat-uid-5", "name": "John Paul" }, "message": "Hello all! What's up?" }, { "sender": { "uid": "cometchat-uid-4", "name": "Susan Marie" }, "message": "📷 Has shared an image" } @@ -71,7 +71,7 @@ Pass payload fields into your SMS provider. Keep messages concise to respect SMS ```js // payload from CometChat const payload = { - to: { phno: '+15551234567', name: 'Andrew Joseph' }, + to: { phno: '+12125550123', name: 'Andrew Joseph' }, senderDetails: { name: 'Susan Marie' }, groupDetails: { name: 'Hiking Group' }, messages: [