diff --git a/chat-apis.json b/chat-apis.json index f7d39666..ba7e2557 100644 --- a/chat-apis.json +++ b/chat-apis.json @@ -1773,353 +1773,14 @@ ] }, "examples": { - "form-interactive": { - "summary": "Interactive form example", - "value": { - "receiverType": "user", - "data": { - "interactionGoal": { - "type": "allOf", - "elementIds": [ - "element8" - ] - }, - "allowSenderInteraction": true, - "interactiveData": { - "title": "Form Title", - "formFields": [ - { - "elementType": "textInput", - "elementId": "element1", - "defaultValue": "vivek", - "label": "Name", - "optional": false, - "maxLines": 1, - "placeholder": { - "text": "write your name here" - } - }, - { - "elementType": "textInput", - "elementId": "element2", - "label": "Last Name", - "optional": false, - "maxLines": 1 - }, - { - "elementType": "textInput", - "elementId": "element3", - "label": "Address", - "optional": false, - "maxLines": 5 - }, - { - "elementType": "dropdown", - "elementId": "element4", - "label": "Country", - "optional": false, - "defaultValue": "option1", - "options": [ - { - "value": "option1", - "label": "INDIA" - }, - { - "value": "option2", - "label": "AUSTRALIA" - } - ] - }, - { - "elementType": "checkbox", - "elementId": "element5", - "optional": true, - "label": "Services", - "options": [ - { - "value": "option1", - "label": "Garbage" - }, - { - "value": "option2", - "label": "Electricity Bill" - }, - { - "value": "option3", - "label": "Lift" - } - ], - "defaultValue": [ - "option1", - "option2" - ] - }, - { - "elementType": "singleSelect", - "elementId": "element6", - "optional": false, - "label": "Wing", - "defaultValue": "option1", - "options": [ - { - "value": "option1", - "label": "A Wing" - }, - { - "value": "option2", - "label": "B Wing" - } - ] - }, - { - "elementType": "button", - "elementId": "element9", - "buttonText": "About us", - "disableAfterInteracted": true, - "action": { - "actionType": "urlNavigation", - "url": "https://www.cometchat.com" - } - }, - { - "elementType": "dateTime", - "elementId": "element11", - "defaultValue": false, - "label": "Contact Number", - "optional": false, - "mode": "date", - "dateTimeFormat": "Y-m-d H:i:ss", - "timezoneCode": "Asia/Kolkata", - "from1": "2024-02-23T14:30", - "from": "2024-06-23", - "to": "2024-06-24", - "maxLines": 1, - "placeholder": { - "text": "Enter contact number" - } - } - ], - "submitElement": { - "elementType": "button", - "elementId": "element8", - "buttonText": "Submit", - "disableAfterInteracted": true, - "action": { - "actionType": "apiAction", - "url": "https://10893f2ae68f59.api-us.cometchat-staging.com/v3.0/messages", - "method": "POST", - "payload": { - "category": "message", - "type": "text", - "data": { - "text": "Thanks For filling the Form!" - }, - "receiver": "superhero2", - "receiverType": "user" - }, - "headers": { - "appId": "10893f2ae68f59", - "Content-Type": "application/json", - "apiKey": "5797f2d3d103d7d78f085eb46bfd14d5c45ddfdf", - "onBehalfOf": "superhero1" - }, - "dataKey": "CometChatData" - } - } - } - }, - "category": "interactive", - "type": "form", - "receiver": "superhero1", - "tags": [ - "tag1" - ] - } + "Text Message": { + "$ref": "#/components/examples/text-message" }, - "card-interactive": { - "summary": "Interactive card example", - "value": { - "receiverType": "user", - "data": { - "interactionGoal": { - "type": "none" - }, - "allowSenderInteraction": true, - "interactiveData": { - "imageUrl": "https://upload.wikimedia.org/wikipedia/en/e/e1/Thomas_D._Baird_%28low-resolution%29.jpg", - "text": "Thanks For filling the Form!.\n\nWant to make your gifts more special? Now its easy with our personalized card messages!\n\nOur new feature lets you add a custom message on a beautifully designed card, making your gift-giving extra personal and memorable.\nWhether its for a birthday , anniversary , or just because , our card messages will express your feelings perfectly.\n\nTo start creating your own card message:\nChoose the gift\nWrite your heartfelt message\nWell print it on a high-quality card and include it with your gift\nAdd a touch of your own sentiments with our personalized card messages. Make every gift unforgettable. Start creating your card message today!\nVisit our website Website Link or download our app App Link.\n\nExpress more than just words with our Personalized Card Messages.Because its not just a gift, its your feelings.\n", - "cardActions": [ - { - "elementType": "button", - "elementId": "element8", - "buttonText": "Buy now", - "disableAfterInteracted": true, - "action": { - "actionType": "apiAction", - "url": "https://10893f2ae68f59.api-us.cometchat-staging.com/v3.0/messages", - "method": "POST", - "payload": { - "category": "message", - "type": "text", - "data": { - "text": "Thanks For filling the Form!" - }, - "receiver": "group_1695921003310", - "receiverType": "group" - }, - "headers": { - "appId": "10893f2ae68f59", - "Content-Type": "application\\/json", - "apiKey": "5797f2d3d103d7d78f085eb46bfd14d5c45ddfdf", - "onBehalfOf": "superhero1" - }, - "dataKey": "CometChatData" - } - }, - { - "elementType": "button", - "elementId": "element9", - "buttonText": "Navigate", - "disableAfterInteracted": true, - "action": { - "actionType": "urlNavigation", - "url": "https://www.cometchat.com" - } - }, - { - "elementType": "button", - "elementId": "element10", - "buttonText": "Submit", - "disableAfterInteracted": true, - "action": { - "actionType": "apiAction", - "url": "https://10893f2ae68f59.api-us.cometchat-staging.com/v3.0/messages", - "method": "POST", - "payload": { - "category": "message", - "type": "text", - "data": { - "text": "Thanks For filling the Form!" - }, - "receiver": "group_1695921003310", - "receiverType": "group" - }, - "headers": { - "appId": "10893f2ae68f59", - "Content-Type": "application/json", - "apiKey": "5797f2d3d103d7d78f085eb46bfd14d5c45ddfdf", - "onBehalfOf": "superhero1" - }, - "dataKey": "CometChatData" - } - } - ] - } - }, - "category": "interactive", - "type": "card", - "receiver": "superhero1", - "tags": [ - "tag1" - ] - } + "Media Message": { + "$ref": "#/components/examples/media-message" }, - "scheduler-interactive": { - "summary": "Interactive scheduler example", - "value": { - "receiverType": "user", - "receiver": "superhero2", - "category": "interactive", - "type": "scheduler", - "data": { - "receiverType": "user", - "receiver": "superhero2", - "muid": "16Jan3:41423PM", - "interactionGoal": { - "type": "anyAction", - "elementIds": [] - }, - "allowSenderInteraction": false, - "interactiveData": { - "title": "Meet with Dr. Jacob", - "avatarUrl": "https: //data-us.cometchat.io/assets/images/avatars/ironman.png", - "bufferTime": 15, - "icsFileUrl": "https://data-us.cometchat.io/23965108c9b89ad2/media/1704380186_864562419_ab59586ed5ab5f89d2c960457ceee249.ics", - "availability": { - "friday": [ - { - "to": "2359", - "from": "0000" - } - ], - "monday": [ - { - "to": "1700", - "from": "0600" - } - ], - "tuesday": [ - { - "to": "1400", - "from": "1000" - }, - { - "to": "2000", - "from": "1700" - } - ], - "thursday": [ - { - "to": "2359", - "from": "0000" - } - ], - "wednesday": [ - { - "to": "0800", - "from": "0600" - }, - { - "to": "1700", - "from": "1200" - } - ] - }, - "timezoneCode": "Asia/Kolkata", - "duration": 60, - "scheduleElement": { - "action": { - "url": "https://802bba5ae13a7.api-us.cometchat-staging.com/v3.0/messages", - "actionType": "apiAction", - "method": "post", - "dataKey": "", - "headers": { - "accept": "application/json", - "apiKey": "62a32b5140e6b630dab38e2e690d88de9c69d416", - "onBehalfOf": "suryansh1", - "content-type": "application/json" - }, - "payload": { - "data": { - "text": "Meeting Scheduled Successfully!" - }, - "type": "text", - "category": "message", - "receiver": "demo1", - "receiverType": "group" - } - }, - "elementId": "1", - "buttonText": "Schedule", - "elementType": "button", - "disableAfterInteracted": true - }, - "goalCompletionText": "Your meeting has been Scheduled", - "dateRangeStart": "2024-06-09", - "dateRangeEnd": "2024-06-09" - } - } - } + "Custom Message": { + "$ref": "#/components/examples/custom-message" } } } @@ -16959,6 +16620,7 @@ "type": "object" }, "customCategorySchema": { + "title": "custom", "properties": { "receiver": { "description": "The receiver of the message.", @@ -17730,6 +17392,7 @@ "type": "object" }, "interactiveCategorySchema": { + "title": "interactive", "properties": { "receiver": { "description": "The receiver of the message.", @@ -17986,6 +17649,7 @@ "type": "object" }, "messageCategorySchema": { + "title": "message", "properties": { "receiver": { "description": "The receiver of the message.", @@ -19651,6 +19315,57 @@ } } }, + "examples": { + "text-message": { + "summary": "Text Message example", + "value": { + "receiver": "cometchat-uid-2", + "receiverType": "user", + "category": "message", + "type": "text", + "data": { + "text": "Hello" + } + } + }, + "custom-message": { + "summary": "Custom Message example", + "value": { + "receiverType": "user", + "data": { + "customData": { + "text": "Hello there!" + } + }, + "category": "custom", + "type": "text", + "receiver": "cometchat-uid-2", + "tags": [ + "tag1" + ] + } + }, + "media-message": { + "summary": "Media Message example", + "value": { + "receiverType": "user", + "data": { + "text": "Hello there!", + "attachments": [ + { + "name": "ironman.png", + "extension": "png", + "mimeType": "image/png", + "url": "https: //files-.cometchat.io//media/.png?fat=" + } + ] + }, + "category": "message", + "type": "image", + "receiver": "cometchat-uid-2" + } + } + }, "securitySchemes": { "apiKey": { "type": "apiKey", diff --git a/data-import-apis.json b/data-import-apis.json index 85c46fcd..6e1f3458 100644 --- a/data-import-apis.json +++ b/data-import-apis.json @@ -2844,6 +2844,7 @@ "type": "object" }, "customCategorySchema": { + "title": "custom", "properties": { "receiver": { "description": "The receiver of the message.", @@ -3615,6 +3616,7 @@ "type": "object" }, "interactiveCategorySchema": { + "title": "interactive", "properties": { "receiver": { "description": "The receiver of the message.", @@ -3871,6 +3873,7 @@ "type": "object" }, "messageCategorySchema": { + "title": "message", "properties": { "receiver": { "description": "The receiver of the message.", @@ -5536,6 +5539,57 @@ } } }, + "examples": { + "text-message": { + "summary": "Text Message example", + "value": { + "receiver": "cometchat-uid-2", + "receiverType": "user", + "category": "message", + "type": "text", + "data": { + "text": "Hello" + } + } + }, + "custom-message": { + "summary": "Custom Message example", + "value": { + "receiverType": "user", + "data": { + "customData": { + "text": "Hello there!" + } + }, + "category": "custom", + "type": "text", + "receiver": "cometchat-uid-2", + "tags": [ + "tag1" + ] + } + }, + "media-message": { + "summary": "Media Message example", + "value": { + "receiverType": "user", + "data": { + "text": "Hello there!", + "attachments": [ + { + "name": "ironman.png", + "extension": "png", + "mimeType": "image/png", + "url": "https: //files-.cometchat.io//media/.png?fat=" + } + ] + }, + "category": "message", + "type": "image", + "receiver": "cometchat-uid-2" + } + } + }, "securitySchemes": { "apiKey": { "type": "apiKey",