Skip to content

Commit 22a864c

Browse files
sachinbahukhandi-cometchatsachinbahukhandi-cometchat
committed
Added hideAgentic and onlyAgentic to list conversations OAS
1 parent b5b927c commit 22a864c

File tree

2 files changed

+163
-4
lines changed

2 files changed

+163
-4
lines changed

‎chat-apis.json‎

Lines changed: 41 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2457,6 +2457,14 @@
24572457
"schema": {
24582458
"type": "integer"
24592459
}
2460+
},
2461+
{
2462+
"name": "hideQuotedMessages",
2463+
"in": "query",
2464+
"description": "If set to true, the API response will exclude all quotedMessage nodes from the returned messages. This allows clients to fetch only the messages without any quoted messages.",
2465+
"schema": {
2466+
"type": "boolean"
2467+
}
24602468
}
24612469
],
24622470
"responses": {
@@ -3673,7 +3681,7 @@
36733681
{
36743682
"name": "onlyAgentic",
36753683
"in": "query",
3676-
"description": "Includes only agentic conversations in the list.",
3684+
"description": "Shows only agentic conversations in the list.",
36773685
"schema": {
36783686
"type": "boolean"
36793687
}
@@ -8017,6 +8025,14 @@
80178025
"type": "string"
80188026
}
80198027
}
8028+
},
8029+
{
8030+
"name": "hideQuotedMessages",
8031+
"in": "query",
8032+
"description": "If set to true, the API response will exclude all quotedMessage nodes from the returned messages. This allows clients to fetch only the messages without any quoted messages.",
8033+
"schema": {
8034+
"type": "boolean"
8035+
}
80208036
}
80218037
],
80228038
"responses": {
@@ -8487,6 +8503,14 @@
84878503
"type": "string"
84888504
}
84898505
}
8506+
},
8507+
{
8508+
"name": "hideQuotedMessages",
8509+
"in": "query",
8510+
"description": "If set to true, the API response will exclude all quotedMessage nodes from the returned messages. This allows clients to fetch only the referenced messages without any quoted messages.",
8511+
"schema": {
8512+
"type": "boolean"
8513+
}
84908514
}
84918515
],
84928516
"responses": {
@@ -16113,6 +16137,14 @@
1611316137
"custom"
1611416138
]
1611516139
},
16140+
"quotedMessageId": {
16141+
"description": "ID of the message being quoted.\nIf provided, the send message response will include a `quotedMessage` node\nin the response containing the referenced message object.",
16142+
"type": "string",
16143+
"default": "message",
16144+
"enum": [
16145+
"message"
16146+
]
16147+
},
1611616148
"type": {
1611716149
"description": "Type of the message.",
1611816150
"type": "string"
@@ -17132,6 +17164,14 @@
1713217164
"message"
1713317165
]
1713417166
},
17167+
"quotedMessageId": {
17168+
"description": "ID of the message being quoted.\nIf provided, the send message response will include a `quotedMessage` node\nin the response containing the referenced message object.",
17169+
"type": "string",
17170+
"default": "message",
17171+
"enum": [
17172+
"message"
17173+
]
17174+
},
1713517175
"type": {
1713617176
"description": "Type of the message. The available values are text, image, file, audio, video.",
1713717177
"type": "string",

‎data-import-apis.json‎

Lines changed: 122 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -122,7 +122,7 @@
122122
],
123123
"properties": {
124124
"url": {
125-
"description": "Contains the URL of the attachment. The developer has to make sure that the URL is accessible while calling the data_import API. The API will be downloading the attachment from its current location and upload it to CometChat’s attachment storage.",
125+
"description": "Publicly accessible URL of the attachment.",
126126
"type": "string"
127127
},
128128
"name": {
@@ -387,6 +387,71 @@
387387
}
388388
},
389389
"type": "object"
390+
},
391+
"mentionedUserDetails": {
392+
"description": "Optional field that provides user details when data.text includes a mention, formatted using CometChat’s mention template (<@uid:UID>).",
393+
"properties": {
394+
"<uid>": {
395+
"description": "A map where each key is a user’s unique identifier (UID) and the value is that user’s details. The &lt;uid&gt; will be replaced by the mentioned user’s primary key.",
396+
"properties": {
397+
"": {
398+
"required": [
399+
"uid",
400+
"name"
401+
],
402+
"properties": {
403+
"uid": {
404+
"description": "The primary-key/ unique identifier of the owner. The value should be the same as value of the placeholder <uid> which wraps the mentionedUserDetails object.",
405+
"type": "string"
406+
},
407+
"name": {
408+
"description": "Name of the owner.",
409+
"type": "string"
410+
},
411+
"avatar": {
412+
"description": "URL to the profile picture of the owner.",
413+
"type": "string"
414+
},
415+
"link": {
416+
"description": "Profile page URL of the owner.",
417+
"type": "string"
418+
},
419+
"role": {
420+
"description": "Role of the owner. Should be created already via the Create role API.",
421+
"type": "string"
422+
},
423+
"createdAt": {
424+
"description": "A 10-digit timestamp at which the owner was created.",
425+
"type": "integer"
426+
},
427+
"lastActiveAt": {
428+
"description": "A 10-digit UNIX timestamp at which the owner was most recently online.",
429+
"type": "integer"
430+
},
431+
"metadata": {
432+
"description": "Additional details about the owner.",
433+
"type": "object"
434+
},
435+
"tags": {
436+
"description": "A string array containing owner tags.",
437+
"type": "array",
438+
"items": {
439+
"type": "string"
440+
},
441+
"default": []
442+
},
443+
"deactivatedAt": {
444+
"description": "A 10-digit UNIX timestamp at which the owner was deactivated/soft-deleted/blocked to use the chat services.",
445+
"type": "integer"
446+
}
447+
},
448+
"type": "object"
449+
}
450+
},
451+
"type": "object"
452+
}
453+
},
454+
"type": "object"
390455
}
391456
},
392457
"type": "object"
@@ -402,7 +467,7 @@
402467
"type": "text",
403468
"category": "message",
404469
"data": {
405-
"text": "Hi there,",
470+
"text": "Hi there",
406471
"attachments": [
407472
{
408473
"name": "hi.png",
@@ -446,7 +511,13 @@
446511
},
447512
"tags": [
448513
"tag1"
449-
]
514+
],
515+
"mentionedUserDetails": {
516+
"example-uid-new": {
517+
"uid": "example-uid-new",
518+
"name": "example-uid"
519+
}
520+
}
450521
}
451522
}
452523
}
@@ -2795,6 +2866,14 @@
27952866
"custom"
27962867
]
27972868
},
2869+
"quotedMessageId": {
2870+
"description": "ID of the message being quoted.\nIf provided, the send message response will include a `quotedMessage` node\nin the response containing the referenced message object.",
2871+
"type": "string",
2872+
"default": "message",
2873+
"enum": [
2874+
"message"
2875+
]
2876+
},
27982877
"type": {
27992878
"description": "Type of the message.",
28002879
"type": "string"
@@ -2892,6 +2971,22 @@
28922971
},
28932972
"maxPerDayPerConversation": {
28942973
"type": "integer"
2974+
},
2975+
"includeMessageObjectSetting": {
2976+
"description": "Includes the message object in the email payload",
2977+
"type": "boolean"
2978+
},
2979+
"includeSenderMetadataSetting": {
2980+
"description": "Includes sender metadata in the message object",
2981+
"type": "boolean"
2982+
},
2983+
"includeReceiverMetadataSetting": {
2984+
"description": "Includes receiver metadata in the message object",
2985+
"type": "boolean"
2986+
},
2987+
"includeMessageMetadataSetting": {
2988+
"description": "Includes message metadata in the message object",
2989+
"type": "boolean"
28952990
}
28962991
},
28972992
"type": "object"
@@ -3798,6 +3893,14 @@
37983893
"message"
37993894
]
38003895
},
3896+
"quotedMessageId": {
3897+
"description": "ID of the message being quoted.\nIf provided, the send message response will include a `quotedMessage` node\nin the response containing the referenced message object.",
3898+
"type": "string",
3899+
"default": "message",
3900+
"enum": [
3901+
"message"
3902+
]
3903+
},
38013904
"type": {
38023905
"description": "Type of the message. The available values are text, image, file, audio, video.",
38033906
"type": "string",
@@ -4710,6 +4813,22 @@
47104813
},
47114814
"maxPerDayPerConversation": {
47124815
"type": "integer"
4816+
},
4817+
"includeMessageObjectSetting": {
4818+
"description": "Includes the message object in the SMS payload",
4819+
"type": "boolean"
4820+
},
4821+
"includeSenderMetadataSetting": {
4822+
"description": "Includes sender metadata in the message object",
4823+
"type": "boolean"
4824+
},
4825+
"includeReceiverMetadataSetting": {
4826+
"description": "Includes receiver metadata in the message object",
4827+
"type": "boolean"
4828+
},
4829+
"includeMessageMetadataSetting": {
4830+
"description": "Includes message metadata in the message object",
4831+
"type": "boolean"
47134832
}
47144833
},
47154834
"type": "object"

0 commit comments

Comments
 (0)