Creates a merchant account in SwiftChat platform. You must verify your merchant account by clicking the verification link sent to your email ID on sign-up.
\nRequest Parameters
\n","urlObject":{"path":["merchants"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[{"id":"e9aa8691-5db7-4146-9142-fc371537cdee","name":"Sign-Up","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{ \n \"name\": \"Test Merchant\",\n \"email\": \"test.merchant@test.com\",\n \"password\": \"Password@1234\"\n}","options":{"raw":{"language":"json"}}},"url":"{{URL}}/merchants"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"id\": \"0149360934334354\"\n}"}],"_postman_id":"57d73550-1c15-41a5-ac7e-0ba20b60b3e4"},{"name":"Login","event":[{"listen":"test","script":{"id":"242469d1-b60b-4a49-a689-74a8fdb6b750","exec":["var jsonData = pm.response.json();","pm.environment.set(\"Access-Token\", jsonData.token);"],"type":"text/javascript"}}],"id":"2ea1577c-10d2-4196-8ad7-f576bfa424a9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"email\": \"Logs in to your merchant account in SwiftChat platform.
\nRequest Parameters
\n","urlObject":{"path":["merchants","login"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[{"id":"e2f478c9-3793-493f-90aa-dc8aea13bd8d","name":"Login","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"email\": \"test.merchant@test.com\",\n \"password\": \"Password@1234\"\n}","options":{"raw":{"language":"json"}}},"url":"{{URL}}/merchants/login"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{ \n \"merchant_id\": \"0149360934334354\",\n \"token\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJtZXJjaGFudF9pZCI6IjAxNDkzNjA5MzQzMzQzNTQiLCJzdGF0dXMiOiJQRU5ESU5HX1JFVklFVyIsImlhdCI6MTY1MTA0NTM5NywiZXhwIjoxNjUxNjUwMTk3LCJhdWQiOiJtZXJjaGFudCIsImlzcyI6IkNvbnZlR2VuaXVzIn0.AGtKhpc8C2OikeJMgI35bq1owwNWGkDa2a1g1ixsqTI\",\n \"expiration_time\": 1651650197\n}"}],"_postman_id":"2ea1577c-10d2-4196-8ad7-f576bfa424a9"},{"name":"Get-Merchant-Details","event":[{"listen":"test","script":{"id":"f5f23013-0d0b-4d03-97d3-5c430f804c2f","exec":[""],"type":"text/javascript"}}],"id":"dddff149-1b8d-4b66-a9ee-c78243693674","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{Access-Token}}"},"isInherited":false},"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{URL}}/merchants/{{Merchant-ID}}","description":"Retrieves your merchant details, such as name, account created date, email that is associated with the account, that are available in SwiftChat platform by Merchant ID.
\n","urlObject":{"path":["merchants","{{Merchant-ID}}"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[{"id":"799c4d6d-ce2e-468b-8dda-1c5cdd802bd0","name":"Get-Merchant-Details","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{URL}}/merchants/{{Merchant-ID}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"merchant_id\": \"0149360934334354\",\n \"name\": \"Test Merchant\",\n \"email\": \"test.merchant@test.com\",\n \"email_verified\": 1,\n \"status\": \"ACTIVE\",\n \"status_reason\": null,\n \"created_at\": \"2022-03-17T13:00:05.000Z\"\n}"}],"_postman_id":"dddff149-1b8d-4b66-a9ee-c78243693674"},{"name":"Get-API-Key-OTP","event":[{"listen":"test","script":{"id":"774b41de-fd5e-46bd-989b-12a612b74cdc","exec":[""],"type":"text/javascript"}}],"id":"ead847f4-a2a2-4cea-9b63-0344872e8d21","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{Access-Token}}"},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{URL}}/merchants/{{Merchant-ID}}/api-key/otp","description":"Sends an OTP to your merchant email ID, which you must use to verify your merchant account if you want to generate a new API key.
\nYou can generate a new API key when the key is compromised or lost.
\n","urlObject":{"path":["merchants","{{Merchant-ID}}","api-key","otp"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[{"id":"d4a57c9a-9058-4143-bd9c-5f4572fe0c37","name":"Get-API-Key-OTP","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{URL}}/merchants/{{Merchant-ID}}/api-key/otp"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"ead847f4-a2a2-4cea-9b63-0344872e8d21"},{"name":"Verify-API-Key-OTP","event":[{"listen":"test","script":{"id":"774b41de-fd5e-46bd-989b-12a612b74cdc","exec":[""],"type":"text/javascript"}}],"id":"70a69c50-f27e-4804-a697-de5bb0a51ee4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{Access-Token}}"},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"otp\": \"Verifies your merchant account though the OTP, which you have received in your merchant email account by Post Get-API-Key-OTP API request.
You must verify your merchant account through this API request to generate a new API Key.
\nRequest Parameters
\n","urlObject":{"path":["merchants","{{Merchant-ID}}","api-key","otp","verify"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[{"id":"dcf299e3-d08b-474d-b15d-1ffb83f5fa27","name":"Verify-API-Key-OTP","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"otp\": \"771498\"\n}","options":{"raw":{"language":"json"}}},"url":"{{URL}}/merchants/{{Merchant-ID}}/api-key/otp/verify"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"token\": \"Fg-MTCepsbOmYMrAKikYq\"\n}"}],"_postman_id":"70a69c50-f27e-4804-a697-de5bb0a51ee4"},{"name":"Generate-API-Key","event":[{"listen":"test","script":{"id":"abce7ab4-0f45-41dc-b05c-915feec0b236","exec":["var jsonData = pm.response.json();","pm.environment.set(\"API-Key\", jsonData.api_key);"],"type":"text/javascript"}}],"id":"fa17656f-5092-4de4-a4f4-a6779e67413c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{Access-Token}}"},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"token\": \"Generates a new API key, which you can use to issue any call in SwiftChat platform. You can generate a new API key when the key is compromised or lost.
\nYou must verify your merchant account to generate a new API key.
\nRequest Parameters
\n","urlObject":{"path":["merchants","{{Merchant-ID}}","api-key","generate"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[{"id":"e62152d8-04d6-41ab-a148-fa29656f1ee3","name":"Generate-API-Key","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"token\": \"Fg-MTCepsbOmYMrAKikYq\"\n}","options":{"raw":{"language":"json"}}},"url":"{{URL}}/merchants/{{Merchant-ID}}/api-key/generate"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"api_key\": \"bd4736fb-a478-4902-945f-86ab2t098g65\"\n}"}],"_postman_id":"fa17656f-5092-4de4-a4f4-a6779e67413c"},{"name":"Get-API-Key","event":[{"listen":"test","script":{"id":"f5f23013-0d0b-4d03-97d3-5c430f804c2f","exec":["var jsonData = pm.response.json();","pm.environment.set(\"API-Key\", jsonData.api_key);"],"type":"text/javascript"}}],"id":"3ed63aad-3f81-4f42-b0a0-8406feb59716","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{Access-Token}}"},"isInherited":false},"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{URL}}/merchants/{{Merchant-ID}}/api-key","description":"Gets the API key for your merchant account, which you can use to issue all the SwiftChat API calls, such as creating a bot, configuring a bot, and retrieving the webhook.
\nYou must enter the API key to issue any call in SwiftChat API.
\n","urlObject":{"path":["merchants","{{Merchant-ID}}","api-key"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[{"id":"3dacae31-2f61-45dd-ba8d-85d082ce790c","name":"Get-API-Key","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{URL}}/merchants/{{Merchant-ID}}/api-key"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"api_key\": \"bd4736fb-a478-4902-945f-86ab2t098g65\"\n}"}],"_postman_id":"3ed63aad-3f81-4f42-b0a0-8406feb59716"}],"id":"5c627151-c474-4c5c-a37c-9cd3c1a4e1e7","description":"Enables you to create and access your merchant account in the SwiftChat platform.
\nWith your merchant account, you can:
\n- \n
Create and manage bots or mini-apps for your business.
\n \nCommunicate with users using pre-approved templates through bots.
\n \nCreate a webhook for your bot to receive user messages.
\n \nGet a shareable link of the bot or mini-app for marketing and distribution purposes.
\n \n
Use this API to:
\n- \n
Sign up for a merchant account in Swiftchat merchant Platform.
\n \nLogin to your merchant account.
\n \nRetrieve the API key to manage your merchant account.
\n \nGenerate a new API key when you want to change the existing API key.
\n \n
Creates a bot to communicate with users though text or media.
\nRequest Parameters
\nCreate Bot Configuration Object
\n","urlObject":{"path":["bots"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[{"id":"84c48240-ea74-4b59-aaf4-0bcdcff75d57","name":"Create-Bot - Mobile","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"mobile\": \"+91XXXXXXXXXX\",\n \"configuration\": {\n \"name\": \"Test Bot\",\n \"category\": \"Education\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{URL}}/bots"},"status":"Created","code":201,"_postman_previewlanguage":"plain","header":null,"cookie":[],"responseTime":null,"body":"Created"}],"_postman_id":"ad3dd63a-8656-4ec8-a94d-d5a8a1fc3b37"},{"name":"Create-Bot-with-Email","id":"5220b358-a2e0-4ad0-bf70-73337a2ebacf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{API-Key}}"},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"email\": \"Creates a bot to communicate with users though text or media.
\nRequest Parameters
\nCreate Bot Configuration Object
\n","urlObject":{"path":["bots"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[{"id":"1c60eeb5-ddf5-43f1-94a8-384d05dcee66","name":"Create-Bot - Email","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"email\": \"abc@xyz.com\",\n \"configuration\": {\n \"name\": \"Test Bot\",\n \"category\": \"Eductaion\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{URL}}/bots"},"status":"Created","code":201,"_postman_previewlanguage":"plain","header":null,"cookie":[],"responseTime":null,"body":"Created"}],"_postman_id":"5220b358-a2e0-4ad0-bf70-73337a2ebacf"},{"name":"Verify-Bot-Mobile","event":[{"listen":"test","script":{"id":"01d1d9c7-c53b-45d6-8eb3-eb4576151f54","exec":[""],"type":"text/javascript"}}],"id":"a5fa0876-d1b1-48de-a475-dad2ff467071","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{API-Key}}"},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"mobile\": \"Verifies the mobile number that is linked to the bot.
\nRequest Parameters
\n","urlObject":{"path":["bots","verify"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[{"id":"461048ce-0821-479e-b6f1-48830fd4a8e4","name":"Verify-Bot - Mobile","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"mobile\": \"+91XXXXXXXXXX\",\n \"otp\": \"123456\"\n}","options":{"raw":{"language":"json"}}},"url":"{{URL}}/bots/verify"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"id\": \"0295758414350769\"\n}"}],"_postman_id":"a5fa0876-d1b1-48de-a475-dad2ff467071"},{"name":"Verify-Bot-Email","id":"86f4aa41-9120-42a4-896e-7c8868e8ae1d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{API-Key}}"},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"email\": \"Verifies the email ID that is linked to the bot.
\nRequest Parameters
\n","urlObject":{"path":["bots","verify"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[{"id":"d1fd2dd0-5221-4b49-92be-7001a375ed0f","name":"Verify-Bot - Email","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"email\": \"abc@xyz.com\",\n \"otp\": \"123456\",\n \"country_code\": \"IN\"\n}","options":{"raw":{"language":"json"}}},"url":"{{URL}}/bots/verify"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"id\": \"0295758414350769\"\n}"}],"_postman_id":"86f4aa41-9120-42a4-896e-7c8868e8ae1d"},{"name":"Get-Bots","id":"040d3f56-34cf-4407-8fe3-d2b7c1800df1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{API-Key}}"},"isInherited":false},"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{URL}}/merchants/{{Merchant-ID}}/bots","description":"Retrieves the available list of bots that are associated with your merchant account in SwiftChat platform.
\n","urlObject":{"path":["merchants","{{Merchant-ID}}","bots"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[{"id":"7071cd29-7abd-49df-9d57-d62c302e333f","name":"Get-Bots","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{URL}}/merchants/{{Merchant-ID}}/bots"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"name\": \"Test Bot\",\n \"bot_id\": \"0295758414350769\",\n \"mobile\": \"+91XXXXXXXXXX\"\n },\n {\n \"name\": \"Test Bot 2\",\n \"bot_id\": \"0221741349325852\",\n \"mobile\": \"+91XXXXXXXXXX\"\n },\n {\n \"name\": \"Test Bot 2\",\n \"bot_id\": \"0221741349325852\",\n \"email\": \"abcd@gmail.com\"\n }\n ]\n}"}],"_postman_id":"040d3f56-34cf-4407-8fe3-d2b7c1800df1"},{"name":"Get-Configuration","id":"dcec067f-ee6f-481c-8495-f5503e7226ff","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{API-Key}}"},"isInherited":false},"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{URL}}/bots/{{Bot-ID}}/configuration","description":"Retrieves the configuration of the bot such as name, category, description, bot icon, and more.
\n","urlObject":{"path":["bots","{{Bot-ID}}","configuration"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[{"id":"7d1a104c-f499-4b91-b406-990ae123304e","name":"Get-Configuration","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{URL}}/bots/{{Bot-ID}}/configuration"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"name\": \"Test Bot\",\n \"photo\": \"https://test-kluster-public-bucket.s3.ap-south-1.amazonaws.com/configuration/0295758414350769/photo\",\n \"bot_uuid\": \"0295758414350769\",\n \"category\": \"Education\",\n \"description\": \"Closing the gap in educational achievement for children and youth in India.\",\n \"welcome_text\": \"Hello, Welcome to the bot\",\n \"persistent_menu\": {\n \"buttons\": [\n {\n \"id\": 1,\n \"body\": \"Add Student\",\n \"icon\": \"registration\",\n \"reply\": \"I want to add another profile.\"\n },\n {\n \"id\": 2,\n \"body\": \"Change Medium\",\n \"icon\": \"edit-registration\",\n \"reply\": \"Change my medium of instruction.\"\n }\n ]\n },\n \"allow_user_media\": true,\n \"allow_custom_response\": false,\n \"customer_support_email\": \"support@test.com\",\n \"customer_support_phone\": \"+91XXXXXXXXXX\"\n}"}],"_postman_id":"dcec067f-ee6f-481c-8495-f5503e7226ff"},{"name":"Update-Configuration","id":"63e1020e-7458-4870-8969-372caab02a75","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{API-Key}}"},"isInherited":false},"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"Updates the configuration of the bot, such as name, description, category, and persistent menu.
\nRequest Parameters
\nPersistent Menu
\nPersistent Menu Button
\nShare Message Template
\n","urlObject":{"path":["bots","{{Bot-ID}}","configuration"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[{"id":"e1bb7a74-9052-412e-a03a-8f2212ecd4af","name":"Update-Configuration","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"Test Bot\",\n \"category\": \"Education\",\n \"description\": \"Closing the gap in educational achievement for children and youth in India.\",\n \"welcome_text\": \"Welcome to Test Bot.\",\n \"allow_user_media\": true,\n \"customer_support_email\": \"support@test.com\",\n \"customer_support_url\": \"Updates the icon of the bot in the SwiftChat platform.
\nThe supported file formats are PNG and JPEG.
\nThe maximum size limit: 50 KB
\n","urlObject":{"path":["bots","{{Bot-ID}}","configuration","photo"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[{"id":"0ec583d5-e2cf-4d69-b238-933a6608115e","name":"Update-Photo","originalRequest":{"method":"PUT","header":[],"body":{"mode":"formdata","formdata":[{"key":"type","value":"image/png","type":"text"},{"key":"file","type":"file","src":"/Users/Shared/photo.png"}]},"url":"{{URL}}/bots/{{Bot-ID}}/configuration/photo"},"status":"OK","code":200,"_postman_previewlanguage":"plain","header":null,"cookie":[],"responseTime":null,"body":"OK"}],"_postman_id":"c15941e9-93c2-45f5-b0a9-2886710354e3"},{"name":"Update-Webhook-URL","id":"64b47f71-5a3d-418e-b94f-13935032524b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{API-Key}}"},"isInherited":false},"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"webhook_url\": \"Updates the webhook URL. The messages from the users to the bot are sent to the provided webhook URL that is associated with the bot.
\nWebhook Data Format
\nThe messages from the users to the bot are sent to the provided webhook URL. Following are the formats that you see in the webhook, based on the type of message, such as text, image, and button.
\nNote: In addition to the existing keys or fields in the JSON, such as _message_id_, _conversation_id_, _timestamp_, new keys can be added in the JSON, along with the new updates.
Text
\n{\n \"from\": \"+91XXXXXXXXXX\",\n \"type\": \"text\",\n \"text\": {\n \"body\": \"27031202302\"\n },\n \"timestamp\": \"2022-03-28T11:00:25.339Z\",\n \"message_id\": \"bd919bb7-c73a-49d8-b90c-80083a1b2091\",\n \"conversation_id\": \"CIKOThJQBE3WO9vaeETyx\",\n \"conversation_initiated_by\": \"+91XXXXXXXXXX\"\n}\n\nImage
\n{\n \"from\": \"+65XXXXXXXXXX\",\n \"type\": \"image\",\n \"image\": {\n \"id\": \"RFygbMmRRHKJPKZb-kVm9\",\n \"body\": \"Test\",\n \"content_type\": \"image/png\"\n },\n \"timestamp\": \"2022-03-28T11:00:25.339Z\",\n \"message_id\": \"xd919bb7-c73a-49d8-b90c-80083a1b2091\",\n \"conversation_id\": \"CIKOThJQBE3WO9vaeETyx\",\n \"conversation_initiated_by\": \"+91XXXXXXXXXX\"\n}\n\nDocument
\n{\n \"from\": \"+91XXXXXXXXXX\",\n \"type\": \"document\",\n \"document\": {\n \"id\": \"9NpquRkniOpPblFPRp6zJ\",\n \"name\": \"test.pdf\",\n \"body\": \"Test\",\n \"content_type\": \"application/pdf\"\n },\n \"timestamp\": \"2022-05-20T10:36:52.913Z\",\n \"message_id\": \"6a61c3e7-2d63-48e8-a54a-49c819dc8c1b\",\n \"conversation_id\": \"CIKOThJQBE3WO9vaeETyx\",\n \"conversation_initiated_by\": \"+91XXXXXXXXXX\"\n}\n\nVideo
\n{\n \"from\": \"+65XXXXXXXXXX\",\n \"type\": \"video\",\n \"video\": {\n \"id\": \"jSPIxnO3GpItl9WLwEKSS\",\n \"title\": \"Test\",\n \"content_type\": \"video/mp4\"\n },\n \"timestamp\": \"2022-05-20T10:56:52.315Z\",\n \"message_id\": \"e2bcd22d-76f2-47f2-9cef-de9ad869c381\",\n \"conversation_id\": \"CIKOThJQBE3WO9vaeETyx\",\n \"conversation_initiated_by\": \"+91XXXXXXXXXX\"\n}\n\nAudio
\n{\n \"from\": \"+91XXXXXXXXXX\",\n \"type\": \"audio\",\n \"audio\": {\n \"id\": \"qFuZm9uKGr3XgQPTKB0g7\",\n \"title\": \"Test\",\n \"body\": \"Test Caption\",\n \"content_type\": \"audio/mpeg\"\n },\n \"timestamp\": \"2022-05-20T10:44:44.032Z\",\n \"message_id\": \"544a08c3-3169-4fce-9086-c661d30eeca7\",\n \"conversation_id\": \"CIKOThJQBE3WO9vaeETyx\",\n \"conversation_initiated_by\": \"+91XXXXXXXXXX\"\n}\n\nButton-Response
\n{\n \"from\": \"+91XXXXXXXXXX\",\n \"type\": \"button_response\",\n \"button_response\": {\n \"button_index\": 1,\n \"body\": \"Class 1\"\n },\n \"timestamp\": \"2022-03-28T11:11:20.390Z\",\n \"message_id\": \"9c26983f-7c4c-49b1-b434-d35fdab044de\",\n \"conversation_id\": \"CIKOThJQBE3WO9vaeETyx\",\n \"conversation_initiated_by\": \"+91XXXXXXXXXX\"\n}\n\nMulti-Select-Button-Response
\n{\n \"from\": \"+91XXXXXXXXXX\",\n \"type\": \"multi_select_button_response\",\n \"multi_select_button_response\": [\n {\n \"button_index\": 0,\n \"body\": \"Option 1\"\n },\n {\n \"button_index\": 2,\n \"body\": \"Option 3\"\n }\n ],\n \"timestamp\": \"2022-03-28T11:26:13.370Z\",\n \"message_id\": \"168ccdd9-69a1-4515-a844-95d325c83cca\",\n \"conversation_id\": \"CIKOThJQBE3WO9vaeETyx\",\n \"conversation_initiated_by\": \"+91XXXXXXXXXX\"\n}\n\nPersistent-Menu-Response
\n{\n \"from\": \"+91XXXXXXXXXX\",\n \"type\": \"persistent_menu_response\",\n \"persistent_menu_response\": {\n \"id\": 2,\n \"body\": \"Change my medium.\"\n },\n \"timestamp\": \"2022-03-28T11:21:30.358Z\",\n \"message_id\": \"8c001c0d-8c38-433a-811e-2c325b45bca6\",\n \"conversation_id\": \"CIKOThJQBE3WO9vaeETyx\",\n \"conversation_initiated_by\": \"+91XXXXXXXXXX\"\n}\n\nMessage-Rating
\n{ \n \"from\": \"+91XXXXXXXXXX\",\n \"type\": \"message_rated\",\n \"rating\": {\n \"type\": \"star\",\n \"star\": {\n \"value\": 1\n },\n \"review\": \"This message helped\"\n },\n \"timestamp\": \"2021-12-06T09:36:14.875Z\",\n \"message_id\": \"9064410b-fbe0-40c6-9de4-c1353832fae7\"\n}\n\nDate
\n{\n \"from\": \"+91XXXXXXXXXX\",\n \"type\": \"date\",\n \"date\": {\n \"day\": 12,\n \"month\": 7,\n \"year\": 2022\n },\n \"timestamp\": \"2022-03-28T11:21:30.358Z\",\n \"message_id\": \"8c001c0d-8c38-433a-811e-2c325b45bca6\",\n \"conversation_id\": \"CIKOThJQBE3WO9vaeETyx\",\n \"conversation_initiated_by\": \"+91XXXXXXXXXX\"\n}\n\nMedia List
\n{\n \"from\": \"+91XXXXXXXXXX\",\n \"type\": \"media_list\",\n \"media_list\": [\n {\n \"type\": \"image\",\n \"image\": {\n \"id\": \"eQXPig_uYwW8XelHkVl2p\"\n }\n },\n {\n \"type\": \"image\",\n \"image\": {\n \"id\": \"UoWHdlPMPx1ObFkBW7IWz\"\n }\n }\n ],\n \"timestamp\": \"2022-03-28T11:26:13.370Z\",\n \"message_id\": \"168ccdd9-69a1-4515-a844-95d325c83cca\",\n \"conversation_id\": \"CIKOThJQBE3WO9vaeETyx\",\n \"conversation_initiated_by\": \"+91XXXXXXXXXX\"\n}\n\nForm Response
\n{\n \"fields\": [ \n {\n \"id\": \"722e5397-63eb-4c2b-a726-84fe6fed7fc9\",\n \"type\": \"text\", \n \"value\": \"Jane Doe\", \n \"is_sensitive\": false, \n \"reply_label\": \"Name\"\n },\n {\n \"id\": \"722e5397-63eb-4c2b-a726-84fe6fed7fc9\",\n \"type\": \"dropdown\",\n \"value\": \"7\",\n \"reply_label\": \"Grade\"\n },\n {\n \"id\": \"722e5397-63eb-4c2b-a726-84fe6fed7fc9\",\n \"type\": \"dropdown\",\n \"value\": \"female\",\n \"reply_label\": \"Gender\"\n },\n {\n \"id\": \"722e5397-63eb-4c2b-a726-84fe6fed7fc9\",\n \"type\": \"dropdown\",\n \"value\": \"Science\",\n \"reply_label\": \"Subject\"\n },\n {\n \"id\": \"722e5397-63eb-4c2b-a726-84fe6fed7fc9\",\n \"type\": \"date\",\n \"value\": {\n day: 23,\n month: 05\n year: 2000,\n },\n \"reply_label\": \"DOB\"\n }\n ]\n}\n\nRetrieves the webhook URL. The messages from the users to the bot are sent to the webhook URL that is associated with the bot.
\n","urlObject":{"path":["bots","{{Bot-ID}}","webhook-url"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[{"id":"d22abb12-b9e7-4fd5-a4be-af930c162a2c","name":"Get-Webhook-URL","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{URL}}/bots/{{Bot-ID}}/webhook-url"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"webhook_url\": \"https://test.com/webhook\"\n}"}],"_postman_id":"22f21847-c79d-4931-910d-98d14aaf02ee"},{"name":"Get-Shareable-Link","id":"c8480f01-aed4-4587-8b8f-d22e20bfa3f7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{API-Key}}"},"isInherited":false},"method":"GET","header":[],"url":"{{URL}}/bots/{{Bot-ID}}/shareable-link","description":"Retrieves the shareable link of the bot, which you can use for marketing and distribution purposes.
\n","urlObject":{"path":["bots","{{Bot-ID}}","shareable-link"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[{"id":"971bd964-1594-45d9-a293-f0fd9605a002","name":"Get-Shareable-Link","originalRequest":{"method":"GET","header":[],"url":"{{URL}}/bots/{{Bot-ID}}/shareable-link"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"shareable_link\": \"https://cgweb.page.link/?link=https%3A%2F%2Fweb.convegenius.ai%3FbotId%3D0295758414350769&apn=ai.convegenius.app\"\n}"}],"_postman_id":"c8480f01-aed4-4587-8b8f-d22e20bfa3f7"}],"id":"918ee200-72a0-41d7-830c-8923344b0434","description":"Enables you to create and manage bots. With bots, you can communicate with users and provide the requested information through text or media.
\nUse this API to:
\n- \n
Retrieve all the available bots associated with your merchant account.
\n \nCreate and verify a bot.
\n \nRetrieve or update the bot configuration.
\n \nUpdate the bot icon and welcome text on the SwiftChat platform.
\n \nRetrieve or update webhook URL to receive the user messages.
\n \nRetrieve the shareable link of the bot for marketing and distribution purposes.
\n \n
Creates a mini-app to enable the users to use your app on the SwiftChat platform.
\nRequest Parameters
\nCreate Mini-app Configuration Object
\n","urlObject":{"path":["mini-apps"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[{"id":"38e9aaee-b270-446c-bfa5-2eb9dba5dd47","name":"Create-Mini-App - Mobile","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"mobile\": \"Creates a mini-app to enable the users to use your app on the SwiftChat platform.
\nRequest Parameters
\nCreate Mini-app Configuration Object
\n","urlObject":{"path":["mini-apps"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[{"id":"0237cc91-7682-44af-89ee-1b3bc4c1decd","name":"Create-Mini-App - Email","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"email\": \"Verifies the mobile number that is linked to the mini-app.
\nRequest Parameters
\n","urlObject":{"path":["mini-apps","verify"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[{"id":"b3eebc29-650c-403b-bd46-7d121f1bbb26","name":"Verify-Mini-App - Mobile","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"mobile\": \"+91XXXXXXXXXX\",\n \"otp\": \"123456\"\n}","options":{"raw":{"language":"json"}}},"url":"{{URL}}/mini-apps/verify"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"mini_app_id\": \"0495758414350769\"\n}"}],"_postman_id":"239713ec-83fc-4910-a2bc-56f0532e9f3f"},{"name":"Verify-Mini-App-Email","id":"ee578c18-9c64-4c12-80ed-767c88c8ce5e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{API-Key}}"},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"email\": \"Verifies the email ID that is linked to the mini-app.
\nRequest Parameters
\n","urlObject":{"path":["mini-apps","verify"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[{"id":"7b5c65ae-13c5-46c3-b73c-18941fc0d084","name":"Verify-Mini-App - Email","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"email\": \"abc@xyz.com\",\n \"otp\": \"123456\",\n \"country_code\": \"IN\"\n}","options":{"raw":{"language":"json"}}},"url":"{{URL}}/mini-apps/verify"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"mini_app_id\": \"0495758414350769\"\n}"}],"_postman_id":"ee578c18-9c64-4c12-80ed-767c88c8ce5e"},{"name":"Get-Mini-Apps","id":"9e3c21c1-5855-42fb-a592-1d40344564aa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{API-Key}}"},"isInherited":false},"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{URL}}/merchants/{{Merchant-ID}}/mini-apps","description":"Retrieves the available list of mini-apps that are associated with your merchant account in SwiftChat platform.
\n","urlObject":{"path":["merchants","{{Merchant-ID}}","mini-apps"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[{"id":"9902d556-ad26-45d5-b9b6-b85e46ae6f3c","name":"Get-Mini-Apps","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{URL}}/merchants/{{Merchant-ID}}/mini-apps"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"mini_app_id\": \"0492974687529852\",\n \"mobile\": \"+91XXXXXXXXXX\",\n \"name\": \"Rewards\",\n \"status\": \"ACTIVE\",\n \"launch_url\": \"https://dev-bot.convegenius.ai/rewards\"\n },\n {\n \"mini_app_id\": \"0418909948363841\",\n \"mobile\": \"+91XXXXXXXXXX\",\n \"name\": \"Live Quiz\",\n \"status\": \"ACTIVE\",\n \"launch_url\": \"https://dev-bot.convegenius.ai/live-quiz\"\n },\n {\n \"mini_app_id\": \"0477118884622944\",\n \"mobile\": \"+91XXXXXXXXXX\",\n \"name\": \"Competition Zone\",\n \"status\": \"ACTIVE\",\n \"launch_url\": \"https://dev-bot.convegenius.ai/competition-zone\"\n },\n {\n \"mini_app_id\": \"0468692244515033\",\n \"mobile\": \"+919821932305\",\n \"name\": \"Skills Corner\",\n \"status\": \"ACTIVE\",\n \"launch_url\": \"https://dev-bot.convegenius.ai/skills-corner\"\n },\n {\n \"mini_app_id\": \"0468268545296050\",\n \"mobile\": \"+91XXXXXXXXXX\",\n \"name\": \"Engage\",\n \"status\": \"ACTIVE\",\n \"launch_url\": \"https://dev-bot.convegenius.ai/engage\"\n },\n {\n \"mini_app_id\": \"0439573431418350\",\n \"mobile\": \"+91XXXXXXXXXX\",\n \"name\": \"Test Web App 1\",\n \"status\": \"ACTIVE\",\n \"launch_url\": \"https://test-bot.convegenius.ai/mini-app.html\"\n },\n {\n \"mini_app_id\": \"0482820345123432\",\n \"mobile\": \"+91XXXXXXXXXX\",\n \"name\": \"Test Web App 2\",\n \"status\": \"ACTIVE\",\n \"launch_url\": \"https://dev-bot.convegenius.ai/mini-app.html\"\n },\n {\n \"mini_app_id\": \"0454731027665011\",\n \"mobile\": \"+91XXXXXXXXXX\",\n \"name\": \"Test Native App 1\",\n \"status\": \"INACTIVE\",\n \"launch_url\": \"https://dev-bot.convegenius.ai/skills-corner\"\n },\n {\n \"mini_app_id\": \"0485487948936347\",\n \"mobile\": \"+91XXXXXXXXXX\",\n \"name\": \"Digital Class\",\n \"status\": \"ACTIVE\",\n \"launch_url\": \"https://dev-bot.convegenius.ai/digital-class\"\n },\n {\n \"mini_app_id\": \"0409459869699200\",\n \"mobile\": \"+91XXXXXXXXXX\",\n \"name\": \"Test Web App 3\",\n \"status\": \"ACTIVE\",\n \"launch_url\": \"https://dev-bot.convegenius.ai/digital-class\"\n },\n {\n \"mini_app_id\": \"0426507426931753\",\n \"mobile\": \"+91XXXXXXXXXX\",\n \"name\": \"Test\",\n \"status\": \"ACTIVE\",\n \"launch_url\": \"https://youtube.com\"\n },\n {\n \"mini_app_id\": \"0490021544289554\",\n \"mobile\": \"+918604832528\",\n \"name\": \"big ideas\",\n \"status\": \"ACTIVE\",\n \"launch_url\": \"https://www.google.com\"\n },\n {\n \"mini_app_id\": \"0471402748953261\",\n \"mobile\": \"+91XXXXXXXXXX\",\n \"name\": \"Test Web\",\n \"status\": \"ACTIVE\",\n \"launch_url\": null\n },\n {\n \"mini_app_id\": \"0461480763157295\",\n \"mobile\": \"+91XXXXXXXXXX\",\n \"name\": \"Flight Tickets\",\n \"status\": \"ACTIVE\",\n \"launch_url\": null\n },\n {\n \"mini_app_id\": \"0499889140114840\",\n \"mobile\": \"+91XXXXXXXXXX\",\n \"name\": \"Test Web App\",\n \"status\": \"ACTIVE\",\n \"launch_url\": null\n },\n {\n \"mini_app_id\": \"0404103800953957\",\n \"mobile\": \"+91XXXXXXXXXX\",\n \"name\": \"Test Web\",\n \"status\": \"INACTIVE\",\n \"launch_url\": \"https://test-bot.convegenius.ai/mini-app.html\"\n },\n {\n \"mini_app_id\": \"0479959428655864\",\n \"mobile\": \"+919555747419\",\n \"name\": \"Test Mini-App (rename)\",\n \"status\": \"INACTIVE\",\n \"launch_url\": null\n },\n {\n \"mini_app_id\": \"0435232424080759\",\n \"mobile\": \"+919821932318\",\n \"name\": \"Test Web\",\n \"status\": \"ACTIVE\",\n \"launch_url\": null\n },\n {\n \"mini_app_id\": \"0451457325202103\",\n \"mobile\": \"+919821932316\",\n \"name\": \"Test Web\",\n \"status\": \"ACTIVE\",\n \"launch_url\": null\n },\n {\n \"mini_app_id\": \"0418909948363840\",\n \"mobile\": \"+91XXXXXXXXXX\",\n \"name\": \"A Test Mini App\",\n \"status\": \"ACTIVE\",\n \"launch_url\": \"https://dev-bot.convegenius.ai/random-quiz\"\n },\n {\n \"mini_app_id\": \"0491864141162357\",\n \"mobile\": \"+91XXXXXXXXXX\",\n \"name\": \"A Test Mini App 1\",\n \"status\": \"ACTIVE\",\n \"launch_url\": \"https://dev-bot.convegenius.ai/random-quiz\"\n },\n {\n \"mini_app_id\": \"0427969573292586\",\n \"mobile\": \"+91XXXXXXXXXX\",\n \"name\": \"Make Mini App Testing\",\n \"status\": \"ACTIVE\",\n \"launch_url\": null\n },\n {\n \"mini_app_id\": \"0430025449566158\",\n \"mobile\": \"+91XXXXXXXXXX\",\n \"name\": \"Hi my name is Test App\",\n \"status\": \"ACTIVE\",\n \"launch_url\": \"https://test-bot.convegenius.ai/mini-app.html\"\n },\n {\n \"mini_app_id\": \"0469869566575465\",\n \"mobile\": \"+91XXXXXXXXXX\",\n \"name\": \"Hi my name is Test App\",\n \"status\": \"ACTIVE\",\n \"launch_url\": \"https://test-bot.convegenius.ai/mini-app.html\"\n },\n {\n \"mini_app_id\": \"0418964517483900\",\n \"mobile\": \"+91XXXXXXXXXX\",\n \"name\": \"Hi my name is Test App\",\n \"status\": \"ACTIVE\",\n \"launch_url\": \"https://test-bot.convegenius.ai/mini-app.html\"\n },\n {\n \"mini_app_id\": \"0454974636479845\",\n \"mobile\": \"+91XXXXXXXXXX\",\n \"name\": \"Hi my name is Test App\",\n \"status\": \"ACTIVE\",\n \"launch_url\": \"https://test-bot.convegenius.ai/mini-app.html\"\n },\n {\n \"mini_app_id\": \"0450294756127770\",\n \"mobile\": \"+91XXXXXXXXXX\",\n \"name\": \"Hi my name is Test App\",\n \"status\": \"ACTIVE\",\n \"launch_url\": \"https://test-bot.convegenius.ai/mini-app.html\"\n },\n {\n \"mini_app_id\": \"0450294756127770\",\n \"email\": \"abc@gmail.com\",\n \"name\": \"Hi my name is Test App\",\n \"status\": \"ACTIVE\",\n \"launch_url\": \"https://test-bot.convegenius.ai/mini-app.html\"\n }\n ]\n}"}],"_postman_id":"9e3c21c1-5855-42fb-a592-1d40344564aa"},{"name":"Get-Configuration","id":"07d5f82d-10f6-4605-b810-93d5245ce77e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{API-Key}}"},"isInherited":false},"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{URL}}/mini-apps/{{Mini-App-ID}}/configuration","description":"Retrieves the configuration of the mini-app such as name, category, description, mini-app icon, launch URL, and more.
\n","urlObject":{"path":["mini-apps","{{Mini-App-ID}}","configuration"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[{"id":"3c0f3d1a-d868-462d-85d4-29b798adc9a1","name":"Get-Configuration","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{URL}}/mini-apps/{{Mini-App-ID}}/configuration"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"name\": \"Test Web App 3\",\n \"type\": \"WEB\",\n \"photo\": \"https://dev-kluster-public-cdn.cgslate.com/configuration/0409459869699200/photo/K59I90xD14Qcvrp56RUxc\",\n \"category\": \"Others\",\n \"launch_url\": \"https://dev-bot.convegenius.ai/digital-class\",\n \"description\": \"Test Web App 3\",\n \"mini_app_uuid\": \"0409459869699200\",\n \"language_supported\": [\n \"EN\"\n ],\n \"permissions_required\": [\n \"FILE_PICKER\",\n \"LOCATION\",\n \"CAMERA\",\n \"MICROPHONE\"\n ],\n \"customer_support_email\": \"testit@snfkad.ai\",\n \"customer_support_phone\": \"+911111111111\"\n}"}],"_postman_id":"07d5f82d-10f6-4605-b810-93d5245ce77e"},{"name":"Update-Configuration","id":"2bfe1512-a667-4c0d-9a55-efd1ca6c935b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{API-Key}}"},"isInherited":false},"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"Updates the configuration of the mini-app, such as name, description, category, launch URL, support details and more.
\nRequest Parameters
\n","urlObject":{"path":["mini-apps","{{Mini-App-ID}}","configuration"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[{"id":"f3142bec-4535-4e0e-ab35-48a56c1807af","name":"Update-Configuration","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"Updates the icon of the Mini-app on the SwiftChat platform.
\nThe supported file formats are PNG and JPEG.
\nThe maximum size limit: 50 KB
\n","urlObject":{"path":["mini-apps","{{Mini-App-ID}}","configuration","photo"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[{"id":"ea4d835a-b36b-4559-9131-2a89655a36e2","name":"Update-Photo","originalRequest":{"method":"PUT","header":[],"body":{"mode":"formdata","formdata":[{"key":"type","value":"image/png","type":"text"},{"key":"file","type":"file","src":"/Users/Shared/photo.png"}]},"url":"{{URL}}/mini-apps/{{Mini-App-ID}}/configuration/photo"},"status":"OK","code":200,"_postman_previewlanguage":"plain","header":null,"cookie":[],"responseTime":null,"body":"OK"}],"_postman_id":"eb0a2f97-e786-496b-a52c-1b58ab823f41"},{"name":"Get-Shareable-Link","id":"0e4a6513-b3c8-4b12-8ab1-bb216a6bf61e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{API-Key}}"},"isInherited":false},"method":"GET","header":[],"url":"{{URL}}/mini-apps/{{Mini-App-ID}}/shareable-link","description":"Retrieves the shareable link of the mini-app, which you can use for marketing and distribution purposes.
\n","urlObject":{"path":["mini-apps","{{Mini-App-ID}}","shareable-link"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[{"id":"b9350e26-fd2d-4303-ae08-af0ef5054d99","name":"Get-Shareable-Link","originalRequest":{"method":"GET","header":[],"url":"{{URL}}/mini-apps/{{Mini-App-ID}}/shareable-link"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"shareable_link\": \"https://cgweb.page/\"\n}"}],"_postman_id":"0e4a6513-b3c8-4b12-8ab1-bb216a6bf61e"},{"name":"Put-Labels","id":"7a43a639-5739-4266-ab7f-605601ad37d7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{API-Key}}"},"isInherited":false},"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"data\": [\n \"Test Label\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{URL}}/mini-apps/{{Mini-App-ID}}/labels","description":"Updates the labels for the mini-app for searchability on SwiftChat platform.
\nRequest Parameters
\n","urlObject":{"path":["mini-apps","{{Mini-App-ID}}","labels"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[{"id":"466b5710-83d2-4154-b45a-17c1cfbffd57","name":"Put-Labels","originalRequest":{"method":"PUT","header":[{"key":"package-name","value":"ai.convegenius.app.debug","disabled":true}],"body":{"mode":"raw","raw":"{\n \"data\": [\n \"Test Label\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{URL}}/mini-apps/{{Mini-App-ID}}/lables"},"status":"OK","code":200,"_postman_previewlanguage":"plain","header":null,"cookie":[],"responseTime":null,"body":"OK"}],"_postman_id":"7a43a639-5739-4266-ab7f-605601ad37d7"},{"name":"Get-Lables","id":"ed47af8b-1e21-401e-9084-9c9f67ae3eb0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{API-Key}}"},"isInherited":false},"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{URL}}/mini-apps/{{Mini-App-ID}}/lables","description":"Retrieves the labels that are tagged to the mini-app for searchability in SwiftChat.
\n","urlObject":{"path":["mini-apps","{{Mini-App-ID}}","lables"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[{"id":"fdaa93a3-df52-4dd4-a593-34ab1cb5fdd9","name":"Get-Lables","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{URL}}/mini-apps/{{Mini-App-ID}}/lables"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n \"Test Label\"\n ]\n}"}],"_postman_id":"ed47af8b-1e21-401e-9084-9c9f67ae3eb0"},{"name":"Get-Mini-App-Access-Token","id":"acab75b9-9aeb-476e-bfde-4482b32ff679","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{kluster-api-api-key}}"}],"body":{"mode":"raw","raw":"{\n \"grant_token\": \"07494215-9788-45b1-b37d-0c4e65982f01\"\n}"},"url":"{{URL}}/mini-apps/{{Mini-App-ID}}/sso/get-access-token","description":"Retrieves the access_token which can be used to get the user's details on user's consent.
\nNote: The access_token is valid for 30 minutes only.
\nRequest Parameters
\n","urlObject":{"path":["mini-apps","{{Mini-App-ID}}","sso","get-access-token"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[{"id":"5e797610-fd6c-4eab-85ad-e4ce0b0e36fd","name":"Get-Mini-App-Access-Token","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{kluster-api-api-key}}"}],"body":{"mode":"raw","raw":"{\n \"grant_token\": \"07494215-9788-45b1-b37d-0c4e65982f01\"\n}","options":{"raw":{"language":"json"}}},"url":"{{URL}}/mini-apps/{{Mini-App-ID}}/sso/get-access-token"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"access_token\": \"01494215-9788-45b1-b37d-0c4e65982f34\",\n \"expires_at\": \"1702344233\"\n}"}],"_postman_id":"acab75b9-9aeb-476e-bfde-4482b32ff679"},{"name":"Get-User-Details","id":"9fb2ceb6-165b-48ec-a8b7-b5684966ff9b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{kluster-api-api-key}}"}],"body":{"mode":"raw","raw":"{\n \"access_token\": \"07494215-9788-45b1-b37d-0c4e65982f01\"\n}"},"url":"{{URL}}/mini-apps/{{Mini-App-ID}}/sso/get-user-details","description":"Gets the user profile details from platform for SSO in the Mini-app by user's concent.
\nThe technical flow of the SSO is given in the flowchat:
\n![\"Mini-app%20SSO%20Technical%20Flow\"](\"https://feed-video.s3.ap-south-1.amazonaws.com/API_mini-app_flowchart/Mini-app_SSO_flow.png\")
\n\nMini-app SDK Functions
\nThe following functions are available in the Mini-app when you include the Mini-app Extension SDK.
\nThe Mini-app Extension SDK source: https://cdn.convegenius.ai/public/mini_app_extension/mini-app-sdk-v1.js
\nSample Code
\n<script type=\"text/javascript\" src=\"https://cdn.convegenius.ai/public/mini_app_extension/mini-app-sdk-v1.js\">\n</script>\n\nEnables you to create and manage mini-apps.
\nUse this API to:
\n- \n
Retrieve all the available mini-apps associated with your merchant account.
\n \nCreate and verify a mini-app.
\n \nRetrieve or update the mini-app configuration.
\n \nUpdate the mini-app icon on the SwiftChat platform.
\n \nRetrieve or update labels for searchability of the mini-apps on SwiftChat.
\n \nRetrieve the shareable link of the mini-app for marketing and distribution purposes.
\n \nAccess user's SwiftChat profile details for SSO using SDK.
\n \n
The technical flow of the SSO is given in the flowchat:
\n\n\nMini-app SDK Functions
\nThe following functions are available in the Mini-app when you include the Mini-app Extension SDK.
\nThe Mini-app Extension SDK source: https://cdn.convegenius.ai/public/mini_app_extension/mini-app-sdk-v1.js
\nSample Code
\n<script type=\"text/javascript\" src=\"https://cdn.convegenius.ai/public/mini_app_extension/mini-app-sdk-v1.js\">\n</script>\n\nRetrieves the available list of countries and their codes in which you can make your bot or mini-app searchable.
\n","urlObject":{"path":["regions","countries"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[{"id":"29963984-656f-4ab6-a97d-ffd5ed52dc45","name":"Get-Countries","originalRequest":{"method":"GET","header":[],"url":"{{URL}}/regions/countries"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sat, 24 Dec 2022 13:46:34 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"72"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"ETag","value":"W/\"48-bXILRpoq/eBvQx2VOSRUKwI5xNw\""},{"key":"Vary","value":"Accept-Encoding"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"code\": \"IN\",\n \"name\": \"India\"\n },\n {\n \"code\": \"SG\",\n \"name\": \"Singapore\"\n }\n ]\n}"}],"_postman_id":"98b5aeb4-ae47-4c69-823a-2285fbb59851"},{"name":"Get-States","id":"1bd1d780-00bd-4d05-8c17-0ca24551ebbb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{API-Key}}"},"isInherited":false},"method":"GET","header":[],"url":"{{URL}}/regions/states?country_code=IN","description":"Retrieves the available list of states in a country and their codes in which you can make your bot or mini-app searchable.
\nRequest Parameters
\n","urlObject":{"path":["regions","states"],"host":["{{URL}}"],"query":[{"key":"country_code","value":"IN"}],"variable":[]}},"response":[{"id":"71a6fa8a-b67e-47e4-aa22-a77b5213a59d","name":"Get-States","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{URL}}/regions/states?country_code=IN","host":["{{URL}}"],"path":["regions","states"],"query":[{"key":"country_code","value":"IN"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sat, 24 Dec 2022 13:46:45 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"ETag","value":"W/\"4f9-KyGZC8ON/GoL5RoSrtfSPJ1bVYg\""},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"code\": \"AN\",\n \"name\": \"Andaman and Nicobar Islands\"\n },\n {\n \"code\": \"AP\",\n \"name\": \"Andhra Pradesh\"\n },\n {\n \"code\": \"AR\",\n \"name\": \"Arunachal Pradesh\"\n },\n {\n \"code\": \"AS\",\n \"name\": \"Assam\"\n },\n {\n \"code\": \"BR\",\n \"name\": \"Bihar\"\n },\n {\n \"code\": \"CH\",\n \"name\": \"Chandigarh\"\n },\n {\n \"code\": \"CT\",\n \"name\": \"Chhattisgarh\"\n },\n {\n \"code\": \"DN\",\n \"name\": \"Dadra and Nagar Haveli\"\n },\n {\n \"code\": \"DD\",\n \"name\": \"Daman and Diu\"\n },\n {\n \"code\": \"DL\",\n \"name\": \"Delhi\"\n },\n {\n \"code\": \"GA\",\n \"name\": \"Goa\"\n },\n {\n \"code\": \"GJ\",\n \"name\": \"Gujarat\"\n },\n {\n \"code\": \"HR\",\n \"name\": \"Haryana\"\n },\n {\n \"code\": \"HP\",\n \"name\": \"Himachal Pradesh\"\n },\n {\n \"code\": \"JK\",\n \"name\": \"Jammu and Kashmir\"\n },\n {\n \"code\": \"JH\",\n \"name\": \"Jharkhand\"\n },\n {\n \"code\": \"KA\",\n \"name\": \"Karnataka\"\n },\n {\n \"code\": \"KL\",\n \"name\": \"Kerala\"\n },\n {\n \"code\": \"LA\",\n \"name\": \"Ladakh\"\n },\n {\n \"code\": \"LD\",\n \"name\": \"Lakshadweep\"\n },\n {\n \"code\": \"MP\",\n \"name\": \"Madhya Pradesh\"\n },\n {\n \"code\": \"MH\",\n \"name\": \"Maharashtra\"\n },\n {\n \"code\": \"MN\",\n \"name\": \"Manipur\"\n },\n {\n \"code\": \"ML\",\n \"name\": \"Meghalaya\"\n },\n {\n \"code\": \"MZ\",\n \"name\": \"Mizoram\"\n },\n {\n \"code\": \"NL\",\n \"name\": \"Nagaland\"\n },\n {\n \"code\": \"OR\",\n \"name\": \"Odisha\"\n },\n {\n \"code\": \"PY\",\n \"name\": \"Puducherry\"\n },\n {\n \"code\": \"PB\",\n \"name\": \"Punjab\"\n },\n {\n \"code\": \"RJ\",\n \"name\": \"Rajasthan\"\n },\n {\n \"code\": \"SK\",\n \"name\": \"Sikkim\"\n },\n {\n \"code\": \"TN\",\n \"name\": \"Tamil Nadu\"\n },\n {\n \"code\": \"TG\",\n \"name\": \"Telangana\"\n },\n {\n \"code\": \"TR\",\n \"name\": \"Tripura\"\n },\n {\n \"code\": \"UP\",\n \"name\": \"Uttar Pradesh\"\n },\n {\n \"code\": \"UT\",\n \"name\": \"Uttarakhand\"\n },\n {\n \"code\": \"WB\",\n \"name\": \"West Bengal\"\n }\n ]\n}"}],"_postman_id":"1bd1d780-00bd-4d05-8c17-0ca24551ebbb"},{"name":"Get-Cities","id":"90299b41-7fe4-4476-bf80-c62044043184","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{API-Key}}"},"isInherited":false},"method":"GET","header":[],"url":"{{URL}}/regions/cities?country_code=IN&state_code=UP","description":"Retrieves the available list of cities in a state of a selected country and their codes in which you can make your bot or mini-app searchable.
\nRequest Parameters
\n","urlObject":{"path":["regions","cities"],"host":["{{URL}}"],"query":[{"key":"country_code","value":"IN"},{"key":"state_code","value":"UP"}],"variable":[]}},"response":[{"id":"14804c9d-89fa-4b5a-9da5-7b4bc8c880ba","name":"Get-Cities","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{URL}}/regions/cities?country_code=IN&state_code=UP","host":["{{URL}}"],"path":["regions","cities"],"query":[{"key":"country_code","value":"IN"},{"key":"state_code","value":"UP"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sat, 24 Dec 2022 13:46:56 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"ETag","value":"W/\"1678-I3TY0G3WtG0Xdy/X5EGkP0xuc14\""},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n \"Achhnera\",\n \"Afzalgarh\",\n \"Agra\",\n \"Āgra\",\n \"Ahraura\",\n \"Ajodhya\",\n \"Akbarpur\",\n \"Alīganj\",\n \"Alīgarh\",\n \"Allahābād\",\n \"Allāhganj\",\n \"Amānpur\",\n \"Ambahta\",\n \"Ambedkar Nagar\",\n \"Amethi\",\n \"Amethī\",\n \"Amroha\",\n \"Anandnagar\",\n \"Antu\",\n \"Anūpshahr\",\n \"Aonla\",\n \"Atarra\",\n \"Atraulī\",\n \"Atraulia\",\n \"Auraiya\",\n \"Aurās\",\n \"Azamgarh\",\n \"Āzamgarh\",\n \"Baberu\",\n \"Babīna\",\n \"Babrāla\",\n \"Babugarh\",\n \"Bachhraon\",\n \"Bachhrāwān\",\n \"Baghpat\",\n \"Bāghpat\",\n \"Bāh\",\n \"Baheri\",\n \"Bahjoi\",\n \"Bahraich\",\n \"Bahraigh\",\n \"Bahsūma\",\n \"Bahua\",\n \"Bājna\",\n \"Bakewar\",\n \"Baldev\",\n \"Ballia\",\n \"Balrampur\",\n \"Balrāmpur\",\n \"Banat\",\n \"Banbasa\",\n \"Bānda\",\n \"Bāngarmau\",\n \"Bānsdīh\",\n \"Bānsgāon\",\n \"Bānsi\",\n \"Bāra Banki\",\n \"Barāgaon\",\n \"Baraut\",\n \"Bareilly\",\n \"Barkhera Kalān\",\n \"Barsāna\",\n \"Basti\",\n \"Bastī\",\n \"Behat\",\n \"Bela\",\n \"Benīganj\",\n \"Beswān\",\n \"Bewar\",\n \"Bhadohi\",\n \"Bhagwantnagar\",\n \"Bharthana\",\n \"Bharwāri\",\n \"Bhinga\",\n \"Bhongaon\",\n \"Bidhūna\",\n \"Bīghāpur Khurd\",\n \"Bijnor\",\n \"Bīkāpur\",\n \"Bilāri\",\n \"Bilariāganj\",\n \"Bīlāspur\",\n \"Bilgrām\",\n \"Bilhaur\",\n \"Bilsanda\",\n \"Bilsi\",\n \"Bilthra\",\n \"Bindki\",\n \"Bīsalpur\",\n \"Bisauli\",\n \"Bisenda Buzurg\",\n \"Bishunpur Urf Mahārājganj\",\n \"Biswān\",\n \"Bithūr\",\n \"Budaun\",\n \"Budhāna\",\n \"Bulandshahr\",\n \"Captainganj\",\n \"Chail\",\n \"Chakia\",\n \"Chandauli\",\n \"Chandauli District\",\n \"Chāndpur\",\n \"Chanduasi\",\n \"Charkhāri\",\n \"Charthāwal\",\n \"Chhaprauli\",\n \"Chharra\",\n \"Chhāta\",\n \"Chhibrāmau\",\n \"Chhutmalpur\",\n \"Chillupār\",\n \"Chirgaon\",\n \"Chitrakoot\",\n \"Chopan\",\n \"Chunār\",\n \"Colonelganj\",\n \"Dādri\",\n \"Dalmau\",\n \"Dankaur\",\n \"Dāsna\",\n \"Dātāganj\",\n \"Daurāla\",\n \"Dayāl Bāgh\",\n \"Deoband\",\n \"Deoraniān\",\n \"Deoria\",\n \"Dewā\",\n \"Dhāmpur\",\n \"Dhanaura\",\n \"Dhaurahra\",\n \"Dibai\",\n \"Dohrighāt\",\n \"Dostpur\",\n \"Dūdhi\",\n \"Etah\",\n \"Etāwah\",\n \"Faizābād\",\n \"Farah\",\n \"Farīdnagar\",\n \"Farīdpur\",\n \"Farrukhābād\",\n \"Fatehābād\",\n \"Fatehganj West\",\n \"Fatehgarh\",\n \"Fatehpur\",\n \"Fatehpur Chaurāsi\",\n \"Fatehpur Sīkri\",\n \"Firozabad\",\n \"Fīrozābād\",\n \"Fyzābād\",\n \"Gajraula\",\n \"Gangoh\",\n \"Ganj Dundwāra\",\n \"Ganj Murādābād\",\n \"Garautha\",\n \"Garhi Pūkhta\",\n \"Garhmuktesar\",\n \"Gautam Buddha Nagar\",\n \"Gawān\",\n \"Ghātampur\",\n \"Ghāziābād\",\n \"Ghazīpur\",\n \"Ghāzīpur\",\n \"Ghiror\",\n \"Ghorāwal\",\n \"Ghosī\",\n \"Gohānd\",\n \"Gokul\",\n \"Gola Bāzār\",\n \"Gola Gokarannāth\",\n \"Gonda\",\n \"Gondā City\",\n \"Gopāmau\",\n \"Gorakhpur\",\n \"Goshāinganj\",\n \"Goshāīnganj\",\n \"Govardhan\",\n \"Greater Noida\",\n \"Gulāothi\",\n \"Gunnaur\",\n \"Gursahāiganj\",\n \"Gursarāi\",\n \"Gyānpur\",\n \"Haldaur\",\n \"Hamīrpur\",\n \"Handiā\",\n \"Hāpur\",\n \"Haraiya\",\n \"Hardoi\",\n \"Hardoī\",\n \"Harduāganj\",\n \"Hasanpur\",\n \"Hastināpur\",\n \"Hātā\",\n \"Hāthras\",\n \"Iglās\",\n \"Ikauna\",\n \"Indergarh\",\n \"Islāmnagar\",\n \"Itaunja\",\n \"Itimādpur\",\n \"Jagdīshpur\",\n \"Jagnair\",\n \"Jahānābād\",\n \"Jahāngīrābād\",\n \"Jahāngīrpur\",\n \"Jainpur\",\n \"Jais\",\n \"Jalālābad\",\n \"Jalālābād\",\n \"Jalālī\",\n \"Jalālpur\",\n \"Jālaun\",\n \"Jalesar\",\n \"Jānsath\",\n \"Jarwal\",\n \"Jasrāna\",\n \"Jaswantnagar\",\n \"Jaunpur\",\n \"Jewar\",\n \"Jhālu\",\n \"Jhānsi\",\n \"Jhīnjhak\",\n \"Jhinjhāna\",\n \"Jhūsi\",\n \"Jyotiba Phule Nagar\",\n \"Kabrāi\",\n \"Kachhwa\",\n \"Kadaura\",\n \"Kādīpur\",\n \"Kaimganj\",\n \"Kairāna\",\n \"Kākori\",\n \"Kakrāla\",\n \"Kālīnagar\",\n \"Kālpi\",\n \"Kamalganj\",\n \"Kampil\",\n \"Kāndhla\",\n \"Kannauj\",\n \"Kanpur\",\n \"Kānpur\",\n \"Kanpur Dehat\",\n \"Kānt\",\n \"Kānth\",\n \"Karārī\",\n \"Karhal\",\n \"Kāsganj\",\n \"Katra\",\n \"Kaushambi District\",\n \"Kemrī\",\n \"Khada\",\n \"Khāga\",\n \"Khair\",\n \"Khairābād\",\n \"Khalīlābād\",\n \"Khānpur\",\n \"Kharela\",\n \"Khargupur\",\n \"Kharkhauda\",\n \"Khatauli\",\n \"Khekra\",\n \"Kheri\",\n \"Khudāganj\",\n \"Khurja\",\n \"Khūtār\",\n \"Kirākat\",\n \"Kiraoli\",\n \"Kīratpur\",\n \"Kishanpur\",\n \"Kishni\",\n \"Kithor\",\n \"Konch\",\n \"Kopāganj\",\n \"Kosi\",\n \"Kota\",\n \"Kotra\",\n \"Kulpahār\",\n \"Kunda\",\n \"Kundarkhi\",\n \"Kurāra\",\n \"Kushinagar\",\n \"Lāharpur\",\n \"Lakhīmpur\",\n \"Lakhnā\",\n \"Lālganj\",\n \"Lalitpur\",\n \"Lar\",\n \"Lāwar Khās\",\n \"Loni\",\n \"Lucknow\",\n \"Lucknow District\",\n \"Machhlīshahr\",\n \"Mādhoganj\",\n \"Mādhogarh\",\n \"Maghar\",\n \"Mahāban\",\n \"Mahārāganj\",\n \"Maharajganj\",\n \"Mahārājganj\",\n \"Mahmudābād\",\n \"Mahoba\",\n \"Mahobā\",\n \"Maholi\",\n \"Mahroni\",\n \"Mailāni\",\n \"Mainpuri\",\n \"Malīhābād\",\n \"Mandāwar\",\n \"Maniar\",\n \"Mānikpur\",\n \"Manjhanpur\",\n \"Mankāpur\",\n \"Mārahra\",\n \"Mariāhu\",\n \"Mataundh\",\n \"Mathura\",\n \"Mau\",\n \"Mau Aimma\",\n \"Maudaha\",\n \"Maurānwān\",\n \"Mawāna\",\n \"Meerut\",\n \"Mehnagar\",\n \"Mehndāwal\",\n \"Milak\",\n \"Mīrānpur\",\n \"Mīrānpur Katra\",\n \"Mīrganj\",\n \"Mirzāpur\",\n \"Misrikh\",\n \"Mohān\",\n \"Mohanpur\",\n \"Morādābād\",\n \"Moth\",\n \"Mubārakpur\",\n \"Mughal Sarāi\",\n \"Muhammadābād\",\n \"Murādnagar\",\n \"Mursān\",\n \"Musāfir-Khāna\",\n \"Muzaffarnagar\",\n \"Nadīgaon\",\n \"Nagīna\",\n \"Nagrām\",\n \"Najībābād\",\n \"Nakūr\",\n \"Nanauta\",\n \"Nandgaon\",\n \"Nānpāra\",\n \"Narauli\",\n \"Naraura\",\n \"Nautanwa\",\n \"Nawābganj\",\n \"Nichlaul\",\n \"Nihtaur\",\n \"Niwāri\",\n \"Nizāmābād\",\n \"Noida\",\n \"Nūrpur\",\n \"Obra\",\n \"Orai\",\n \"Oran\",\n \"Pachperwa\",\n \"Padrauna\",\n \"Pahāsu\",\n \"Pāli\",\n \"Paliā Kalān\",\n \"Pārīchha\",\n \"Parīchhatgarh\",\n \"Parshādepur\",\n \"Patiāli\",\n \"Patti\",\n \"Pawāyan\",\n \"Phalauda\",\n \"Phaphūnd\",\n \"Pharihā\",\n \"Phulpur\",\n \"Phūlpur\",\n \"Pihānī\",\n \"Pīlibhīt\",\n \"Pīlībhīt\",\n \"Pilkhua\",\n \"Pināhat\",\n \"Pipraich\",\n \"Pratāpgarh\",\n \"Pukhrāyān\",\n \"Pūranpur\",\n \"Purwā\",\n \"Rabūpura\",\n \"Rādhākund\",\n \"Rāe Bareli\",\n \"Raebareli\",\n \"Rājāpur\",\n \"Rāmkola\",\n \"Rāmnagar\",\n \"Rāmpur\",\n \"Rāmpura\",\n \"Rānīpur\",\n \"Rasrā\",\n \"Rasūlābād\",\n \"Rāth\",\n \"Rāya\",\n \"Renukūt\",\n \"Reoti\",\n \"Richha\",\n \"Robertsganj\",\n \"Rūdarpur\",\n \"Rura\",\n \"Sadābād\",\n \"Sādāt\",\n \"Safīpur\",\n \"Sahāranpur\",\n \"Sahaspur\",\n \"Sahaswān\",\n \"Sahāwar\",\n \"Saidpur\",\n \"Sakīt\",\n \"Salon\",\n \"Sambhal\",\n \"Samthar\",\n \"Sāndi\",\n \"Sandīla\",\n \"Sant Kabir Nagar\",\n \"Sant Ravi Das Nagar\",\n \"Sarāi Ākil\",\n \"Sarai Ekdil\",\n \"Sarāi Mīr\",\n \"Sarauli\",\n \"Sardhana\",\n \"Sarīla\",\n \"Sāsni\",\n \"Satrikh\",\n \"Saurikh\",\n \"Sector\",\n \"Seohāra\",\n \"Shāhābād\",\n \"Shāhganj\",\n \"Shāhi\",\n \"Shāhjahānpur\",\n \"Shāhjānpur\",\n \"Shāhpur\",\n \"Shāmli\",\n \"Shamsābād\",\n \"Shankargarh\",\n \"Shergarh\",\n \"Sherkot\",\n \"Shikārpūr\",\n \"Shikohābād\",\n \"Shīshgarh\",\n \"Shrawasti\",\n \"Siddharthnagar\",\n \"Sidhaulī\",\n \"Sidhpura\",\n \"Sikandarābād\",\n \"Sikandarpur\",\n \"Sikandra\",\n \"Sikandra Rao\",\n \"Sirāthu\",\n \"Sirsā\",\n \"Sirsāganj\",\n \"Sirsi\",\n \"Sisauli\",\n \"Siswā Bāzār\",\n \"Sītāpur\",\n \"Sonbhadra\",\n \"Soron\",\n \"Suār\",\n \"Sultānpur\",\n \"Suriānwān\",\n \"Tājpur\",\n \"Tālbahat\",\n \"Tālgrām\",\n \"Tānda\",\n \"Tāndā\",\n \"Thakurdwara\",\n \"Thāna Bhawan\",\n \"Tikaitnagar\",\n \"Tīkri\",\n \"Tilhar\",\n \"Tindwāri\",\n \"Titron\",\n \"Tori-Fatehpur\",\n \"Tulsīpur\",\n \"Tūndla\",\n \"Ugu\",\n \"Ujhāni\",\n \"Ūn\",\n \"Unnāo\",\n \"Usehat\",\n \"Utraula\",\n \"Varanasi\",\n \"Vārānasi\",\n \"Vrindāvan\",\n \"Wazīrganj\",\n \"Zafarābād\",\n \"Zaidpur\",\n \"Zamānia\"\n ]\n}"}],"_postman_id":"90299b41-7fe4-4476-bf80-c62044043184"},{"name":"Get-Bot-Availability-Regions","id":"5b8fbbe7-a31b-495f-a977-21cd157852a1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{API-Key}}"},"isInherited":false},"method":"GET","header":[],"url":"{{URL}}/bots/{{Bot-ID}}/availability/regions","description":"Retrieves the list of countries, states, and cities that a bot is available and operational.
\n","urlObject":{"path":["bots","{{Bot-ID}}","availability","regions"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[{"id":"6019eabb-bf14-4ee1-a681-4577e76984e8","name":"Get-Region-Availability-Mapping","originalRequest":{"method":"GET","header":[],"url":"{{URL}}/bots/{{Bot-ID}}/availability/regions"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 26 Dec 2022 07:35:50 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"195"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"ETag","value":"W/\"c3-6JjAorxwGcqdMBEcjdTIcdM2G8Q\""},{"key":"Vary","value":"Accept-Encoding"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"country_code\": \"IN\",\n \"states\": [\n \"AP\"\n ],\n \"cities\": [\n {\n \"state_code\": \"AP\",\n \"cities\": [\n \"Attili\",\n \"Avanigadda\"\n ]\n }\n ]\n },\n {\n \"country_code\": \"SG\",\n \"states\": [],\n \"cities\": []\n }\n ]\n}"}],"_postman_id":"5b8fbbe7-a31b-495f-a977-21cd157852a1"},{"name":"Put-Bot-Availability-Regions","id":"4dc94920-3eeb-4a30-8a50-dd49fadb0281","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{API-Key}}"},"isInherited":false},"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"data\": [\n {\n \"country_code\": \"IN\",\n \"states\": [\n \"AP\",\n \"GJ\"\n ],\n \"cities\": [\n {\n \"state_code\": \"AP\",\n \"cities\": [\n \"Attili\",\n \"Avanigadda\"\n ]\n },\n {\n \"state_code\": \"GJ\",\n \"cities\": []\n }\n ]\n },\n {\n \"country_code\": \"SG\",\n \"states\": [],\n \"cities\": []\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{URL}}/bots/{{Bot-ID}}/availability/regions","description":"Updates the list of countries, states, and cities in which the bot will be operational.
\nNote__: You must provide the list of new countries in which the bot will be operational along with the existing countries in which the bot is already operational.
\nRequest Parameters
\nAvailable Country Codes
\n","urlObject":{"path":["bots","{{Bot-ID}}","availability","regions"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[{"id":"46baa748-fd7e-4209-adba-e2181557ecf2","name":"Put-Region-Availability-Mapping","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"data\": [\n {\n \"country_code\": \"IN\",\n \"states\": [\n \"AP\",\n \"GJ\"\n ],\n \"cities\": [\n {\n \"state_code\": \"AP\",\n \"cities\": [\n \"Attili\",\n \"Avanigadda\"\n ]\n },\n {\n \"state_code\": \"GJ\",\n \"cities\": []\n }\n ]\n },\n {\n \"country_code\": \"SG\",\n \"states\": [],\n \"cities\": []\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{URL}}/bots/{{Bot-ID}}/availability/regions"},"status":"OK","code":200,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Mon, 26 Dec 2022 07:36:18 GMT"},{"key":"Content-Type","value":"text/plain; charset=utf-8"},{"key":"Content-Length","value":"2"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"ETag","value":"W/\"2-nOO9QiTIwXgNtWtBJezz8kv3SLc\""},{"key":"Vary","value":"Accept-Encoding"}],"cookie":[],"responseTime":null,"body":"OK"}],"_postman_id":"4dc94920-3eeb-4a30-8a50-dd49fadb0281"},{"name":"Get-Mini-App-Availability-Regions","id":"d88c0d90-3851-4548-b5e2-6bfd317b7722","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{API-Key}}"},"isInherited":false},"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{URL}}/mini-apps/{{Mini-App-ID}}/availability/regions","description":"Retrieves the list of countries that a mini-app is available and operational.
\n","urlObject":{"path":["mini-apps","{{Mini-App-ID}}","availability","regions"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[{"id":"f5bbfb9c-8eb4-4d21-a6bb-cf507039ff7e","name":"Get-Mini-App-Availability-Regions","originalRequest":{"method":"GET","header":[{"key":"package-name","value":"ai.convegenius.app.debug","disabled":true}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{URL}}/mini-apps/{{Mini-App-ID}}/availability/regions"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"country_code\": \"IN\",\n \"states\": [\n \"MH\",\n \"UP\"\n ],\n \"cities\": [\n {\n \"state_code\": \"MH\",\n \"cities\": [\n \"Mumbai\"\n ]\n },\n {\n \"state_code\": \"UP\",\n \"cities\": [\n \"Noida\"\n ]\n }\n ]\n }\n ]\n}"}],"_postman_id":"d88c0d90-3851-4548-b5e2-6bfd317b7722"},{"name":"Put-Mini-App-Availability-Regions","id":"55ff2ffb-1cf7-4fce-847b-bbd64b5d745b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{API-Key}}"},"isInherited":false},"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"data\": [\n {\n \"country_code\": \"IN\",\n \"states\": [\n \"MH\",\n \"UP\"\n ],\n \"cities\": [\n {\n \"state_code\": \"MH\",\n \"cities\": [\n \"Mumbai\"\n ]\n },\n {\n \"state_code\": \"UP\",\n \"cities\": [\n \"Noida\"\n ]\n }\n ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{URL}}/mini-apps/{{Mini-App-ID}}/availability/regions","description":"Updates the list of regions in which the mini-app will be operational.
\nNote__: You must provide the list of new regions in which the mini-app will be operational along with the existing regions in which the mini-app is already operational.
\nRequest Parameters
\n","urlObject":{"path":["mini-apps","{{Mini-App-ID}}","availability","regions"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[{"id":"50cd83a5-10c2-46d5-9976-7f61a9531498","name":"Put-Mini-App-Availability-Regions","originalRequest":{"method":"PUT","header":[{"key":"package-name","value":"ai.convegenius.app.debug","disabled":true}],"body":{"mode":"raw","raw":"{\n \"data\": [\n {\n \"country_code\": \"IN\",\n \"states\": [\n \"MH\",\n \"UP\"\n ],\n \"cities\": [\n {\n \"state_code\": \"MH\",\n \"cities\": [\n \"Mumbai\"\n ]\n },\n {\n \"state_code\": \"UP\",\n \"cities\": [\n \"Noida\"\n ]\n }\n ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{URL}}/mini-apps/{{Mini-App-ID}}/availability/regions"},"status":"OK","code":200,"_postman_previewlanguage":"plain","header":null,"cookie":[],"responseTime":null,"body":"OK"}],"_postman_id":"55ff2ffb-1cf7-4fce-847b-bbd64b5d745b"}],"id":"255ca807-8ee9-44e5-a8b6-5c9c72e71b62","description":"Enables you to define the list of countries, states, or cities in which your bot or mini-app will be operational and searchable.
\nWhen you choose a region for your bot or mini-app, it will be searchable from Discover section, to all the users from that location (if the user provides the location in their profile).
\nFor example, if you want your bot to be searchable in a city, you must provide the country, state, and then city for which you want to make it searchable. If you are providing only the state, the bot is searchable in all the cities of that state.
\nNote: If you don't choose a location, the bot is searchable to all the users from the country in which you registered your bot using a mobile number, i.e, +91 for India and +65 for Singapore.
\nThe current available operational countries are:
\nUse this API to:
\n- \n
Retrieve the list of countries along with the codes.
\n \nRetrieve the list of states and cities to configure the bot or mini-app availability.
\n \nManage the regions in which your bot or mini-app will be searchable.
\n \nRetrieve the list of regions that the bot or mini-app is searchable.
\n \n
Uploads media files into your repository to send them as needed to the users through bots.
\nThe maximum size of a media file allowed is 64 MB.
\nDeletes the media file from the repository when it is no more required or updated with a new media file.
\n","urlObject":{"path":["bots","{{Bot-ID}}","media","{{Media-ID}}"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[{"id":"1065e380-18ed-4b2c-acf0-a0db0b01d38f","name":"Delete-Media","originalRequest":{"method":"DELETE","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{URL}}/bots/{{Bot-ID}}/media/{{Media-ID}}"},"status":"OK","code":200,"_postman_previewlanguage":"plain","header":null,"cookie":[],"responseTime":null,"body":"OK"}],"_postman_id":"f601aaf2-5bf0-43af-b35b-a0502309118f"},{"name":"Get-Media-URL","event":[{"listen":"test","script":{"id":"d690317a-a156-4326-a248-8882c4914ca7","exec":[""],"type":"text/javascript"}}],"id":"64776f49-6b92-4ee5-bb95-45ee399a6542","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{API-Key}}"},"isInherited":false},"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{URL}}/bots/{{Bot-ID}}/media/{{Media-ID}}","description":"Retrieves the URL of the media file that a bot or a user user used to communicate with each other. The link retrieved by this request is valid for 15 minutes.
\n","urlObject":{"path":["bots","{{Bot-ID}}","media","{{Media-ID}}"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[{"id":"569f66cb-3fb2-4137-8e08-a575de120f45","name":"Get-Media-URL","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{URL}}/bots/{{Bot-ID}}/media/{{Media-ID}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"url\": \"https://kluster-bucket.s3.ap-south-1.amazonaws.com/media/0295758414350769/WLnB4QQVC05vILF_BkKa2?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=ASIA3VDVNPERUIJXEX7N%2F20220427%2Fap-south-1%2Fs3%2Faws4_request&X-Amz-Date=20220427T091239Z&X-Amz-Expires=900&X-Amz-Security-Token=IQoJb3JpZ2luX2VjEP3%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaCmFwLXNvdXRoLTEiRzBFAiBWe5C6A4LwRccpE4r8a195m%2FX5gzEEQUCnbq66ObR6IwIhAJ6nRDr0m41LmAulBkq2UhobDCkY7ZDlMOnKCQQycLNbKt8ECLb%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEQBBoMODAxMjU3NjUwNDY3IgzdrXkPbJ7ihTUila0qswRy%2FWfmVvioF246Gl9osBEP1Q%2F8leT1YLE%2FwTYaR962Fe%2B06Ltg2S1XSlbyMRqhP9kPi4DjwRxIUgWyMIt9ZUi%2BCfTqM33DAtpMh%2BKa3dLFlf4dryLwVCGhci7KdduwtKp7QIfeZmdl08VMJGB66ZsLGxZFMuV2xEVelK3G703KkJ6C4I0ulAwzMjh7DmKV12SzA8PqqHrlSBWbuOFLuUAWnlJWfEOepW27Oj4NS04Fb01jRf3sxR5SIiIX5p7QSZrwmo12AYwHlao9IqDszT9acKpcOXzbllMeNLZClzWx%2Bj5rjZTwEskHxN5qi9FFIu8z%2FeFomFWUimtq5LC%2B818FEQafh1h5I%2B4JgqeIFz17ZMZ4pMqFfoNI55PNNm4KZ1zM%2B5OMoYi2rTtEdTTygZhSAdOInzbLF2095M3NLpoaOtTAxP8BLr0g4YNHAQ6vH5RZSn6ldj1PjCANkslNlWdH7NVycOsgsDlQtwnxcRAKWs%2FTHFlbJIyQoxaDhLBnKY8Tricdl7HsXv%2Fkq6LmRtTFlt50R2JoE0B%2BOIruY2ThVw7dJlMsXEr7I1xo6V8gOTS7SLWkC4EN1w7wr%2BOlO1TK3fbRtcO8HllFJZDF%2Bl086qBN%2Fyr4SuwoBUIiTF6U5TvtDYAgyLeTqlvBg9%2FeJrtVeZZaVMX1w%2FZfn557XUZBIx%2BLXa4fPM62gfPG%2BC3GMbYBwq1VzLxz0PWqkh0VfCG8fNjO2BnB0Jng5t8W8Bv0kJWuDjCWm6OTBjqpAUJCiqzthu9%2FG5dCGlJEmt2yDzLZKz3uxQ%2F8xrKFH14E3g4CPpGBDimOWQBt421%2FIRyFO7ByWzlb3aHNgPp8CLMtm%2FEd0t%2Bj1K8EGPwn2mDIfcqSMyPgNuI%2FRhFwNpubwWMC3znGitbnvgl%2BP3zUkk2Ro2GH4L2jDD4Lsm7pZKFtgDNVcvfKUhGM9P5eBzrmmZ65293NLF%2FU6MQYcs9J5AmxjvbLLx%2Bxbcc%3D&X-Amz-Signature=eaa1e96f1c9ec38b9752d484d37bb1651fc683781cc902718a5ef3d0d9ad70da&X-Amz-SignedHeaders=host\"\n}"}],"_postman_id":"64776f49-6b92-4ee5-bb95-45ee399a6542"}],"id":"d6fdf3fa-f10c-40ce-8f4a-842f5809df29","description":"Enables you to manage media files that you use to communicate with users though bots.
\nUse this API to:
\n- \n
- Upload media files to your repository. \n
- Delete the available media files from your repository. \n
- Retrieve the URL of the media. \n
Following are the supported media file formats:
\nNote: The maximum size limit is 64MB for all the media files.
\n","_postman_id":"d6fdf3fa-f10c-40ce-8f4a-842f5809df29"},{"name":"Message","item":[{"name":"Send-Text-Message","event":[{"listen":"test","script":{"id":"9b240a91-4804-42f1-8640-410e39b6e534","exec":[""],"type":"text/javascript"}}],"id":"2d512569-f4d1-4f43-a2c9-d33dbf8676cf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{API-Key}}"},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"to\": \"{{Recepient-Mobile}}\",\n \"type\": \"text\",\n \"text\": {\n \"body\": \"Sends the text message to the user.
\nRequest Parameters
\nText Object
\n","urlObject":{"path":["bots","{{Bot-ID}}","messages"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[{"id":"c21390b6-0610-4ba9-ac2c-7353b986bb13","name":"Send-Text-Message","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"to\": \"{{Recepient-Mobile}}\",\n \"type\": \"text\",\n \"text\": {\n \"body\": \"Hello\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{URL}}/bots/{{Bot-ID}}/messages"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"id\": \"ba69108d-fed6-4573-be11-383a81a074bb\"\n}"}],"_postman_id":"2d512569-f4d1-4f43-a2c9-d33dbf8676cf"},{"name":"Send-Document-Message-By-Media-ID","event":[{"listen":"test","script":{"id":"b698ac91-98bf-47b9-b18e-a08c80b41425","exec":[""],"type":"text/javascript"}}],"id":"64af0cc4-192c-4565-9cad-f979a43573b2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{API-Key}}"},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"to\": \"{{Recepient-Mobile}}\",\n \"type\": \"document\",\n \"document\": {\n \"id\": \"Sends the document to the user by the media ID of the document. The supported document types are PDF and DOCX.
\nRequest Parameters
\nDocument Object
\n","urlObject":{"path":["bots","{{Bot-ID}}","messages"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[{"id":"64662863-034f-4710-b728-907210952469","name":"Send-Document-Message-By-Media-ID","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"to\": \"{{Recepient-Mobile}}\",\n \"type\": \"document\",\n \"document\": {\n \"id\": \"GmanyYP6tB4pUxZILXe57\",\n \"name\": \"test.pdf\",\n \"body\": \"Test\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{URL}}/bots/{{Bot-ID}}/messages"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"id\": \"6262514b-ef48-4d30-bb61-07bd80670e1b\"\n}"}],"_postman_id":"64af0cc4-192c-4565-9cad-f979a43573b2"},{"name":"Send-Document-Message-By-Media-URL","event":[{"listen":"test","script":{"id":"dcbc4a22-3c9a-4acc-a5fd-764be1fa10df","exec":[""],"type":"text/javascript"}}],"id":"418f5f68-3fdf-4830-9b5a-a93d1896eb8c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{API-Key}}"},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"to\": \"{{Recepient-Mobile}}\",\n \"type\": \"document\",\n \"document\": {\n \"url\": \"Sends the document to the user by document URL. The supported document types are PDF and DOCX.
\nRequest Parameters
\nDocument Object
\n","urlObject":{"path":["bots","{{Bot-ID}}","messages"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[{"id":"d0facef2-8b90-4e4e-b78e-c157ed5f4969","name":"Send-Document-Message-By-Media-URL","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"to\": \"{{Recepient-Mobile}}\",\n \"type\": \"document\",\n \"document\": {\n \"url\": \"https://bot-resources.cgslate.com/bot/MH/resources/1Qlk94xD8c8YKujavZRnzFybv6nK2MRWKK0wA0rj8OFQ/Answer%20Key%20-%20Class%205%20-%20Science%20-%20Week%2025%20-%208-1-2022.pdf\",\n \"name\": \"Answer Key - Class 5 - Science - Week 25 - 8/1/2022\",\n \"body\": \"Answer Key - Class 5 - Science - Week 25 - 8/1/2022\",\n \"read_only\": true\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{URL}}/bots/{{Bot-ID}}/messages"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"id\": \"03a45f1c-e454-43e4-aeab-d9f8564336aa\"\n}"}],"_postman_id":"418f5f68-3fdf-4830-9b5a-a93d1896eb8c"},{"name":"Send-Image-Message-By-Media-ID","event":[{"listen":"test","script":{"id":"3745f306-4005-4d71-b590-0fe84ee2e0ff","exec":[""],"type":"text/javascript"}}],"id":"612c1eab-1668-46fe-986d-066ab882970f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{API-Key}}"},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"to\": \"{{Recepient-Mobile}}\",\n \"type\": \"image\",\n \"image\": {\n \"id\": \"Sends the image to the user by the media ID of the image. The supported image types are JPEG, PNG, and GIF.
\nRequest Parameters
\nImage Object
\n","urlObject":{"path":["bots","{{Bot-ID}}","messages"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[{"id":"b30b93d5-07b5-422c-aaed-638a77bea8d7","name":"Send-Image-Message-By-Media-ID","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"to\": \"{{Recepient-Mobile}}\",\n \"type\": \"image\",\n \"image\": {\n \"id\": \"EFAO1IONOVsctiJGvLqdl\",\n \"body\": \"Test\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{URL}}/bots/{{Bot-ID}}/messages"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"id\": \"3a77b8c6-e7ce-4ced-92a1-2d557a37ba38\"\n}"}],"_postman_id":"612c1eab-1668-46fe-986d-066ab882970f"},{"name":"Send-Image-Message-By-Media-URL","event":[{"listen":"test","script":{"id":"699abaa5-e565-4e7f-8737-515748f21c24","exec":[""],"type":"text/javascript"}}],"id":"4460e8c1-f089-448f-9d99-80064ecaf51b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{API-Key}}"},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"to\": \"{{Recepient-Mobile}}\",\n \"type\": \"image\",\n \"image\": {\n \"url\": \"Sends the image to the user by the media URL of the image. The supported image types are JPEG, PNG and GIF.
\nRequest Parameters
\nImage Object
\n","urlObject":{"path":["bots","{{Bot-ID}}","messages"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[{"id":"91fd1caa-fcea-4375-afa5-c5df80da3406","name":"Send-Image-Message-By-Media-URL","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"to\": \"{{Recepient-Mobile}}\",\n \"type\": \"image\",\n \"image\": {\n \"url\": \"https://test-slate-data.s3.ap-southeast-1.amazonaws.com/testing_media/sample_image_1.jpeg\",\n \"body\": \"Test\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{URL}}/bots/{{Bot-ID}}/messages"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"id\": \"c7d38219-3667-4f2f-bdf2-9428f17dd602\"\n}"}],"_postman_id":"4460e8c1-f089-448f-9d99-80064ecaf51b"},{"name":"Send-Video-Message-By-Media-ID","event":[{"listen":"test","script":{"id":"cd5f84df-aa81-47fa-ab80-55785dd4646b","exec":[""],"type":"text/javascript"}}],"id":"9a4b1f28-eb69-4fd2-96c7-e5b2a415f339","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{API-Key}}"},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"to\": \"{{Recepient-Mobile}}\",\n \"type\": \"video\",\n \"video\": {\n \"id\": \"![https://test-slate-data.s3.ap-southeast-1.amazonaws.com/testing_media/sample_image_1.jpeg](\"https://test-slate-data.s3.ap-southeast-1.amazonaws.com/testing_media/sample_image_1.jpeg\"){kind=link}
Sends the video to the user by the media ID of the video. The supported video types are MP4 and 3GP.
\nRequest Parameters
\nVideo Object
\n","urlObject":{"path":["bots","{{Bot-ID}}","messages"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[{"id":"29bd5f14-ffaf-414b-94ff-967d7ed2bd00","name":"Send-Video-Message-By-Media-ID","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"to\": \"{{Recepient-Mobile}}\",\n \"type\": \"video\",\n \"video\": {\n \"id\": \"CLcatUcN6PHg4HK9ydXpw\",\n \"title\": \"Test\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{URL}}/bots/{{Bot-ID}}/messages"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"id\": \"a912a4fa-9833-4ba6-86a0-ed8557bb5bc9\"\n}"}],"_postman_id":"9a4b1f28-eb69-4fd2-96c7-e5b2a415f339"},{"name":"Send-Video-Message-By-Media-URL","event":[{"listen":"test","script":{"id":"9ec13701-7ac6-409b-862e-f90b0800a4e4","exec":[""],"type":"text/javascript"}}],"id":"5ff886da-f954-426f-a939-95d040aaee08","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{API-Key}}"},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"to\": \"{{Recepient-Mobile}}\",\n \"type\": \"video\",\n \"video\": {\n \"url\": \"Sends the video to the user by the media URL of the video. The supported video types are MP4 and 3GP.
\nRequest Parameters
\nVideo Object
\n","urlObject":{"path":["bots","{{Bot-ID}}","messages"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[{"id":"2e7efcb6-1dc9-43c6-bd59-7f5f206a435c","name":"Send-Video-Message-By-Media-URL","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"to\": \"{{Recepient-Mobile}}\",\n \"type\": \"video\",\n \"video\": {\n \"url\": \"https://test-slate-data.s3.ap-southeast-1.amazonaws.com/testing_media/sample_video_1.mp4\",\n \"title\": \"Test\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{URL}}/bots/{{Bot-ID}}/messages"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"id\": \"b0e448d2-abf1-48bf-b536-2794d3c6ad25\"\n}"}],"_postman_id":"5ff886da-f954-426f-a939-95d040aaee08"},{"name":"Send-Video-Stream-Message","id":"80582cc1-d184-4921-9e67-a3c2568d7ef7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{API-Key}}"},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"to\": \"{{Recepient-Mobile}}\",\n \"type\": \"video_stream\",\n \"video_stream\": {\n \"url\": \"Sends the video message which transmits the video data over the internet in real-time or near-real-time to the user by the URL of the video.
\nRequest Parameters
\nVideo Object
\n","urlObject":{"path":["bots","{{Bot-ID}}","messages"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[{"id":"39cf26c6-b7c4-4d47-a033-a4d7c1838564","name":"Send-Video-Stream-Messge","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"to\": \"{{Recepient-Mobile}}\",\n \"type\": \"video_stream\",\n \"video_stream\": {\n \"url\": \"https://cdn.kutuki.in/hls/MakeThumbprintFlower540p.m3u8\",\n \"protocol\": \"hls\",\n \"thumbnail\": \"https://cdn.kutuki.in/Thumbnails+and+Covers/Thumbnails/makethumbprintflower.png\",\n \"title\": \"Test\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{URL}}/bots/{{Bot-ID}}/messages"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"id\": \"a912a4fa-9833-4ba6-86a0-ed8557bb5bc9\"\n}"}],"_postman_id":"80582cc1-d184-4921-9e67-a3c2568d7ef7"},{"name":"Send-Audio-Message-By-Media-ID","event":[{"listen":"test","script":{"id":"cd5f84df-aa81-47fa-ab80-55785dd4646b","exec":[""],"type":"text/javascript"}}],"id":"c3baf297-aa23-4b7a-9de7-dabf48ce93c6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{API-Key}}"},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"to\": \"{{Recepient-Mobile}}\",\n \"type\": \"audio\",\n \"audio\": {\n \"id\": \"![https://cdn.example.in/Thumbnails+and+Covers/Thumbnails/makethumbprintflower.png](\"https://cdn.example.in/Thumbnails+and+Covers/Thumbnails/makethumbprintflower.png\"){kind=link}
Sends an audio message to the user by the media ID of the audio. The supported audio types are MP3 and OGG.
\nRequest Parameters
\nAudio Object
\n","urlObject":{"path":["bots","{{Bot-ID}}","messages"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[{"id":"3a2afa1b-21d3-4856-9706-7a9e943042af","name":"Send-Audio-Message-By-Media-ID","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"to\": \"{{Recepient-Mobile}}\",\n \"type\": \"audio\",\n \"audio\": {\n \"id\": \"CLcatUcN6PHg4HK9ydXpw\",\n \"title\": \"Test\",\n \"body\": \"Test Caption\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{URL}}/bots/{{Bot-ID}}/messages"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"id\": \"a912a4fa-9833-4ba6-86a0-ed8557bb5bc9\"\n}"}],"_postman_id":"c3baf297-aa23-4b7a-9de7-dabf48ce93c6"},{"name":"Send-Audio-Message-By-Media-URL","event":[{"listen":"test","script":{"id":"9ec13701-7ac6-409b-862e-f90b0800a4e4","exec":[""],"type":"text/javascript"}}],"id":"f8f833ad-c040-42ed-9229-0efa581bc012","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{API-Key}}"},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"to\": \"{{Recepient-Mobile}}\",\n \"type\": \"audio\",\n \"audio\": {\n \"url\": \"Sends the audio to the user by the media URL of the audio. The supported audio types are MP3 and OGG.
\nRequest Parameters
\nAudio Object
\n","urlObject":{"path":["bots","{{Bot-ID}}","messages"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[{"id":"869d9c75-1e31-44da-ad1f-b044b0eada75","name":"Send-Audio-Message-By-Media-URL","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"to\": \"{{Recepient-Mobile}}\",\n \"type\": \"audio\",\n \"audio\": {\n \"url\": \"https://test-slate-data.s3.ap-southeast-1.amazonaws.com/testing_media/sample_mp3_1.mp3\",\n \"title\": \"Test\",\n \"body\": \"Test Caption\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{URL}}/bots/{{Bot-ID}}/messages"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"id\": \"b0e448d2-abf1-48bf-b536-2794d3c6ad25\"\n}"}],"_postman_id":"f8f833ad-c040-42ed-9229-0efa581bc012"},{"name":"Send-Button-Message","event":[{"listen":"test","script":{"id":"2ad65d95-55b5-47d0-b857-ecd17ebc261f","exec":[""],"type":"text/javascript"}}],"id":"4f731314-8e13-4b82-80c5-a841d67a230e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{API-Key}}"},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"to\": \"{{Recepient-Mobile}}\",\n \"type\": \"button\",\n \"button\": {\n \"body\": {\n \"type\": \"text\",\n \"text\": {\n \"body\": \"Sends the message as a button to the user. The button can be a text object or an image object.
\nRequest Parameters
\nButton Object
\nButton Body Object
\nText Message Object
\nImage Message Object
\nButtons
\n","urlObject":{"path":["bots","{{Bot-ID}}","messages"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[{"id":"bfeb7253-36e7-4b81-bbe4-16cb4656d8e9","name":"Send-Button-Message","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"to\": \"{{Recepient-Mobile}}\",\n \"type\": \"button\",\n \"button\": {\n \"body\": {\n \"type\": \"text\",\n \"text\": {\n \"body\": \"Hello, click on the button to filter the {2} class maths videos.\"\n }\n },\n \"buttons\": [\n {\n \"type\": \"solid\",\n \"body\": \"Mathematics, Class 1\",\n \"reply\": \"Mathematics, Class 1\"\n },\n {\n \"type\": \"solid\",\n \"body\": \"Mathematics quiz, Class 1\",\n \"reply\": \"Mathematics quiz, Class 1\"\n },\n {\n \"icon\": \"registration\",\n \"type\": \"dotted\",\n \"body\": \"Add another student\",\n \"reply\": \"Add another student\"\n }\n ],\n \"allow_custom_response\": false,\n \"ttl\": 30\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{URL}}/bots/{{Bot-ID}}/messages"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"id\": \"d46b22e0-3655-46cd-8763-08ea311d8755\"\n}"}],"_postman_id":"4f731314-8e13-4b82-80c5-a841d67a230e"},{"name":"Send-Multi-Select-Button-Message","event":[{"listen":"test","script":{"id":"9a9e6e9c-220e-497a-84ea-fb5a3983142e","exec":[""],"type":"text/javascript"}}],"id":"25ed790b-86d7-4ab6-914a-d087f77d1c73","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{API-Key}}"},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"to\": \"{{Recepient-Mobile}}\",\n \"type\": \"button\",\n \"multi_select_button\": {\n \"body\": {\n \"type\": \"text\",\n \"text\": {\n \"body\": \"Sends the message as a multiple buttons to the user, from which the user can select one or more. The button can be a text object or an image object.
\nRequest Parameters
\nMulti Select Button Object
\nButton Body Object
\nText Message Object
\nImage Message Object
\nButtons
\n","urlObject":{"path":["bots","{{Bot-ID}}","messages"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[{"id":"8851d6e5-3f08-44fa-9a06-9f98cb5525b2","name":"Send-Multi-Select-Button-Message","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"to\": \"{{Recepient-Mobile}}\",\n \"type\": \"multi_select_button\",\n \"multi_select_button\": {\n \"body\": {\n \"type\": \"text\",\n \"text\": {\n \"body\": \"Hello\"\n }\n },\n \"buttons\": [\n {\n \"type\": \"solid\",\n \"body\": \"Class 1\",\n \"reply\": \"Class 1\"\n },\n {\n \"type\": \"solid\",\n \"body\": \"Mathematics\",\n \"reply\": \"Mathematics\"\n },\n {\n \"icon\": \"registration\",\n \"type\": \"dotted\",\n \"body\": \"Add another student\",\n \"reply\": \"Add another student\"\n }\n ],\n \"allow_custom_response\": false,\n \"ttl\": 30\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{URL}}/bots/{{Bot-ID}}/messages"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"id\": \"635d2eb7-03da-4633-8eae-ed904d74403b\"\n}"}],"_postman_id":"25ed790b-86d7-4ab6-914a-d087f77d1c73"},{"name":"Send-Card-Message","event":[{"listen":"test","script":{"id":"0f8e3310-16c0-4036-8ac0-c27575e74233","exec":[""],"type":"text/javascript"}}],"id":"d2a1869d-8ed6-4123-b069-be2a4f1c09b0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{API-Key}}"},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"to\": \"{{Recepient-Mobile}}\",\n \"type\": \"card\",\n \"card\": [\n {\n \"header\": {\n \"type\": \"image\",\n \"image\": {\n \"id\": \"Sends card messages to the user, which can be sent in an array of up to 10 cards.
\nRequest Parameters
\nCard Object
\nHeader Object
\nImage Object
\nText Object
\nVideo Stream Object
\nCard Body Object
\nActions Object
\nWebsite Object
\nActions Object Additional Functions
\nThe following functions are available in the WebView when you include the Bot Extension SDK.
\nThe Bot Extension SDK source: https://cdn.convegenius.ai/public/bot_extension/sdk-v1.js
\nSample Code
\n<script type=\"text/javascript\" src=\"https://cdn.convegenius.ai/public/bot_extension/sdk-v1.js\"></script>\n<script type=\"text/javascript\">\n function getPayload() {\n console.log(\"Calling getPayload\");\n BotExtension.getPayload((data) => {\n console.log(\"Received \", data);\n alert(\"Received : \" + data.value);\n });\n }\n function callClose() {\n console.log(\"Calling close\");\n BotExtension.close();\n }\n</script>\n\nSends article messages to the user, which can be sent in an array of up to 10 articles.
\nRequest Parameters
\nArticle Object
\nHeader Object
\nImage Object
\nText Object
\nActions Object
\nWebsite Object
\nActions Object Additional Functions
\nThe following functions are available in the WebView when you include the Bot Extension SDK.
\nThe Bot Extension SDK source: https://cdn.convegenius.ai/public/bot_extension/sdk-v1.js
\nSample Code
\n <script type=\"text/javascript\" src=\"https://cdn.convegenius.ai/public/bot_extension/sdk-v1.js\"></script>\n<script type=\"text/javascript\">\n function getPayload() {\n console.log(\"Calling getPayload\");\n BotExtension.getPayload((data) => {\n console.log(\"Received \", data);\n alert(\"Received : \" + data.value);\n });\n }\n function callClose() {\n console.log(\"Calling close\");\n BotExtension.close();\n }\n</script>\n\nSends rich input messages to the user, which can be used to receive and collect the users' response.
\nRequest Parameters
\nRich Input Object
\nConfig Object for Date
\nMin Object
\nMax Object
\nConfig Object for Facial Recognition
\n","urlObject":{"path":["bots","{{Bot-ID}}","messages"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[{"id":"77d4801f-8788-4a8d-a3f4-d14d64f1c259","name":"Send-Rich-Input-Message","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"to\": \"{{Recepient-Mobile}}\",\n \"type\": \"rich_input\",\n \"rich_input\": {\n \"body\": \"Please enter your birth date.\",\n \"button_text\": \"Select date\",\n \"type\": \"date\",\n \"config\": {\n \"min\": {\n \"day\": 12,\n \"month\": 7,\n \"year\": 1996\n },\n \"max\": {\n \"day\": 12,\n \"month\": 7,\n \"year\": 2022\n }\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{URL}}/bots/{{Bot-ID}}/messages"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"id\": \"dbc2f978-d38b-48ff-8866-22ec64e19a6f\"\n}"},{"id":"ff1ebb9e-8bb3-498a-bb82-667915638b00","name":"Send-Rich-Input-Message","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"to\": \"{{Recepient-Mobile}}\",\n \"type\": \"rich_input\",\n \"rich_input\": {\n \"body\": \"Please allow facial recognition.\",\n \"button_text\": \"facial recognition.\",\n \"type\": \"facial_recognition\",\n \"config\": {\n \"image_count\": 5,\n \"multi_face_captue\": true,\n \"location_required\": true\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{URL}}/bots/{{Bot-ID}}/messages"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"id\": \"dbc2f978-d38b-48ff-8866-22ec64e19a6f\"\n}"}],"_postman_id":"c5569fa1-e07b-44cb-9b09-6de92be0b434"},{"name":"Send-Rich-Input-Form-Message","id":"3af19efd-cb4c-4380-be56-28537111e6b7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{API-Key}}"},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"to\": \"{{Recepient-Mobile}}\",\n \"type\": \"rich_input\",\n \"rich_input\": {\n \"body\": \"Sends rich input form messages to the user, which can be used to receive and collect the user's response for multiple data points in a single form.
\n\n
Request Parameters
\n\n
Rich Input Object
\n\n
Config Object (Each Field in Form)
\n\n
Conditional Fields (Based on Type)
\nIf type = text
\n\n
If type = dropdown
\nOption Object
\n\n
If type = date
\n\n
Overall Limits Summary
\n","urlObject":{"path":["bots","{{Bot-ID}}","messages"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[{"id":"2f4f7a98-9a91-4cdd-bd51-067d2b23fd85","name":"Send-Rich-Input-Form-Message","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"to\": \"{{Recepient-Mobile}}\",\n \"type\": \"rich_input\",\n \"rich_input\": {\n \"body\": \"Sends a message which is initiated by the bot with an approved predefined template.
\nRequest Parameters
\nMessage Object
\nTemplate Object
\n","urlObject":{"path":["bots","{{Bot-ID}}","template","messages"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"d54857ba-85de-452b-9170-9978172ddf20","name":"Send-Template-Message","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"merchant_uuid\": \"Sends the message as an action button along with a body to the user.
\nThe action message contains 2 parts:
1. Message body: It can contain text or an image object.
2. Actions: It contains an array of action buttons at a maximum of 5.
An action button can contain only a website. When the user click on the button, the weblink will open in a separate page.
\nRequest Parameters
\nAction Object
\nAction Message Body Object
\nText Message Object
\nImage Message Object
\nActions Object
\nWebsite Object
\nActions Object Additional Functions
\nThe following functions are available in the WebView when you include the Bot Extension SDK.
\nThe Bot Extension SDK source: https://cdn.convegenius.ai/public/bot_extension/sdk-v1.js
\nSample Code
\n<script type=\"text/javascript\" src=\"https://cdn.convegenius.ai/public/bot_extension/sdk-v1.js\"></script>\n<script type=\"text/javascript\">\n function getPayload() {\n console.log(\"Calling getPayload\");\n BotExtension.getPayload((data) => {\n console.log(\"Received \", data);\n alert(\"Received : \" + data.value);\n });\n }\n function callClose() {\n console.log(\"Calling close\");\n BotExtension.close();\n }\n</script>\n\nSends the location for the given coordinates as a message to the user.
\nRequest Parameters
\nLocation Object
\n","urlObject":{"path":["bots","{{Bot-ID}}","messages"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[{"id":"1e8b8c07-b518-4380-9c0d-0533539c6bd2","name":"Send-Location-Message","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"to\": \"{{Recepient-Mobile}}\",\n \"type\": \"location\",\n \"location\": {\n \"longitude\": \"77.37696017698852\",\n \"latitude\": \"28.62295346279411\",\n \"name\": \"ConveGenius\",\n \"address\": \"B- 52, B Block, Sector 63, Noida, Uttar Pradesh 201301\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{URL}}/bots/{{Bot-ID}}/messages"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"id\": \"d46b22e0-3655-46cd-8763-08ea311d8755\"\n}"}],"_postman_id":"330c6f7a-db95-42f7-a898-a595ed77c89b"},{"name":"Send-Scorecard-Message","id":"736a86ab-2d06-45b7-bd6d-dfaf83e95f1d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{API-Key}}"},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"to\": \"{{Recepient-Mobile}}\",\n \"type\": \"scorecard\",\n \"scorecard\": {\n \"theme\": \"Sends the message as a scorecard to the user. The scorecard shows the performance of a user in a quiz or test.
\nRequest Parameters
\nScorecard Object
\n","urlObject":{"path":["bots","{{Bot-ID}}","messages"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[{"id":"fa70be90-18ff-410b-a10c-30aac901e9cf","name":"Send-Scorecard-Message","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"to\": \"{{Recepient-Mobile}}\",\n \"type\": \"scorecard\",\n \"scorecard\": {\n \"theme\": \"theme1\",\n \"background\": \"orange\",\n \"performance\": \"high\",\n \"share_message\": \"Hey! I just got an All India Rank of 250 in the Weekly Quiz. Click the link below to take the quiz.\",\n \"text1\": \"Weekly Quiz\",\n \"text2\": \"Wow! You did an awesome job.\",\n \"text3\": \"Score - 90%\",\n \"text4\": \"All India Rank\",\n \"score\": \"250\",\n \"animation\": \"confetti\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{URL}}/bots/{{Bot-ID}}/messages"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 26 Dec 2022 06:16:56 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"45"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"ETag","value":"W/\"2d-+xnR4VfSpV185oiEeLstgXLeSU0\""},{"key":"Vary","value":"Accept-Encoding"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"d46b22e0-3655-46cd-8763-08ea311d8755\"\n}"}],"_postman_id":"736a86ab-2d06-45b7-bd6d-dfaf83e95f1d"}],"id":"987a7057-0b03-4d03-8d8f-c0296793c6b9","description":"Enables you to interact with the users though messages.
\nInfo: If your bot sends a message when the user is inactive in the bot chat screen, the user will receive the bot's message as a notification.
\nThe supported message types are:
\n- \n
text
\n \ndocument
\n \nimage
\n \nvideo
\n \naudio
\n \nbutton
\n \ncard
\n \nmulti-select buttons
\n \narticle
\n \nrich input
\n \naction
\n \nlocation
\n \nscorecard
\n \n
Use SwiftChat Message API to:
\n- \n
Initiate a conversation with users, using pre-approved templates, if the 24 hrs is completed after a conversation is initiated either by user or by bot.
\n \nSend text, image, audio, video, location and document messages to users.
\n \nSend interactive messages using buttons, action messages and cards.
\n \n
Following are the supported media file formats:
\nNote: The maximum size limit is 64MB for all the media files.
\n","_postman_id":"987a7057-0b03-4d03-8d8f-c0296793c6b9"},{"name":"Template","item":[{"name":"Create-Text-Template","id":"f69522d1-93f6-40be-b832-a536fb2f6c86","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{API-Key}}"},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"test_template\",\n \"template\": {\n \"type\": \"text\",\n \"text\": {\n \"body\": \"Creates a template for the text message that is used when the bot is starting the conversation.
\nRequest Parameters
\nTemplate Object
\nText Object
\n","urlObject":{"path":["merchants","{{Merchant-ID}}","templates"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[{"id":"65b18eee-926d-4ed5-9f33-626d2ceef308","name":"Create-Text-Template","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"otp_text_template\",\n \"template\": {\n \"type\": \"text\",\n \"text\": {\n \"body\": \"Hello {1}, your OTP is {2}.\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{URL}}/merchants/{{Merchant-ID}}/templates"},"status":"Created","code":201,"_postman_previewlanguage":"plain","header":null,"cookie":[],"responseTime":null,"body":"Created"}],"_postman_id":"f69522d1-93f6-40be-b832-a536fb2f6c86"},{"name":"Create-Document-Template","id":"b1b7efc2-408d-4307-b7e6-d2efb507e88a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{API-Key}}"},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"test_template_2\",\n \"template\": {\n \"type\": \"document\",\n \"document\": {\n \"id\": \"Creates a template for the document type message that is used when the bot is starting the conversation.
\nRequest Parameters
\nTemplate Object
\nDocument Object
\n","urlObject":{"path":["merchants","{{Merchant-ID}}","templates"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[{"id":"7a2bac8b-b814-45c7-be3e-2c99c8afe7ac","name":"Create-Document-Template","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"monthly_brochure\",\n \"template\": {\n \"type\": \"document\",\n \"document\": {\n \"id\": \"{1}\",\n \"name\": \"This is a name for a {2} template\",\n \"body\": \"Click on this {2} month brochure to understand the monthly progress.\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{URL}}/merchants/{{Merchant-ID}}/templates"},"status":"Created","code":201,"_postman_previewlanguage":"plain","header":null,"cookie":[],"responseTime":null,"body":"Created"}],"_postman_id":"b1b7efc2-408d-4307-b7e6-d2efb507e88a"},{"name":"Create-Image-Template","id":"2f4d15ab-5969-43f5-bd6a-91457f4b238c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{API-Key}}"},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"test_template_3\",\n \"template\": {\n \"type\": \"image\",\n \"image\": {\n \"id\": \"Creates a template for the image type message that is used when the bot is starting the conversation.
\nRequest Parameters
\nTemplate Object
\nImage Object
\n","urlObject":{"path":["merchants","{{Merchant-ID}}","templates"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[{"id":"365115b9-d135-4a6a-bd50-17716ecfca43","name":"Create-Image-Template","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"monthly_brochure\",\n \"template\": {\n \"type\": \"image\",\n \"image\": {\n \"id\": \"{1}\",\n \"body\": \"Hello, click on the image to understand the leaning plan for {2} month.\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{URL}}/merchants/{{Merchant-ID}}/templates"},"status":"Created","code":201,"_postman_previewlanguage":"plain","header":null,"cookie":[],"responseTime":null,"body":"Created"}],"_postman_id":"2f4d15ab-5969-43f5-bd6a-91457f4b238c"},{"name":"Create-Video-Template","id":"92eab09f-b24c-4d62-ac12-f53a9e07f5c0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{API-Key}}"},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"test_template_4\",\n \"template\": {\n \"type\": \"video\",\n \"video\": {\n \"id\": \"Creates a template for the video type message that is used when the bot is starting the conversation.
\nRequest Parameters
\nTemplate Object
\nVideo Object
\n","urlObject":{"path":["merchants","{{Merchant-ID}}","templates"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[{"id":"994394b2-8e72-464e-b816-7830821aebd8","name":"Create-Video-Template","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"learning_plan_overview\",\n \"template\": {\n \"type\": \"video\",\n \"video\": {\n \"id\": \"{1}\",\n \"title\": \"Hello, click on the video for learning plan overview for {2} month.\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{URL}}/merchants/{{Merchant-ID}}/templates"},"status":"Created","code":201,"_postman_previewlanguage":"plain","header":null,"cookie":[],"responseTime":null,"body":"Created"}],"_postman_id":"92eab09f-b24c-4d62-ac12-f53a9e07f5c0"},{"name":"Create-Button-Template","id":"66b149a9-8ede-43bb-8b9d-69b52a8f5ab2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{API-Key}}"},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"test_template_5\",\n \"template\": {\n \"type\": \"button\",\n \"button\": {\n \"body\": {\n \"type\": \"image\",\n \"image\": {\n \"id\": \"Creates a template for the button type message that is used when the bot is starting the conversation.
\nRequest Parameters
\nTemplate Object
\nButton Object
\nBody Object
\nText Object
\nImage Object
\nArray of Buttons
\n","urlObject":{"path":["merchants","{{Merchant-ID}}","templates"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[{"id":"754ab4ef-5587-433b-ae16-e77fb36e7c54","name":"Create-Button-Template","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"maths_for_first_class\",\n \"template\": {\n \"type\": \"button\",\n \"button\": {\n \"body\": {\n \"type\": \"image\",\n \"image\": {\n \"id\": \"{1}\",\n \"body\": \"Hello, click on the button to filter the {2} class maths videos.\"\n }\n },\n \"buttons\": [\n {\n \"type\": \"solid\",\n \"body\": \"Mathematics, Class 1\",\n \"reply\": \"Mathematics, Class 1\"\n },\n {\n \"type\": \"solid\",\n \"body\": \"Mathematics quiz, Class 1\",\n \"reply\": \"Mathematics quiz, Class 1\"\n },\n {\n \"icon\": \"registration\",\n \"type\": \"dotted\",\n \"body\": \"Add another student\",\n \"reply\": \"Add another student\"\n }\n ],\n \"allow_custom_response\": false\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{URL}}/merchants/{{Merchant-ID}}/templates"},"status":"Created","code":201,"_postman_previewlanguage":"plain","header":null,"cookie":[],"responseTime":null,"body":"Created"}],"_postman_id":"66b149a9-8ede-43bb-8b9d-69b52a8f5ab2"},{"name":"Get-Templates","id":"74db3fde-7863-4315-8941-d8a690ddcae2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{API-Key}}"},"isInherited":false},"method":"GET","header":[],"url":"{{URL}}/merchants/{{Merchant-ID}}/templates","description":"Retrieves all the available predefined templates which can be used when the bot is starting the conversation.
\n","urlObject":{"path":["merchants","{{Merchant-ID}}","templates"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[{"id":"3447eb59-e9dd-427d-855f-81a44c9ca5ce","name":"Get-Templates","originalRequest":{"method":"GET","header":[],"url":"{{URL}}/merchants/{{Merchant-ID}}/templates"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n [\n {\n \"name\": \"test_template_1\",\n \"type\": \"text\",\n \"status\": \"REJECTED\",\n \"created_at\": \"2022-04-12T08:27:03.593Z\",\n \"status_reason\": \"Use case unclear.\"\n },\n {\n \"name\": \"test_template_2\",\n \"type\": \"video\",\n \"status\": \"ACTIVE\",\n \"created_at\": \"2022-04-12T08:27:03.593Z\",\n \"status_reason\": null\n },\n {\n \"name\": \"test_template_3\",\n \"type\": \"text\",\n \"status\": \"PENDING_REVIEW\",\n \"created_at\": \"2022-04-12T08:27:03.593Z\",\n \"status_reason\": null\n },\n {\n \"name\": \"test_template_4\",\n \"type\": \"text\",\n \"status\": \"PENDING_REVIEW\",\n \"created_at\": \"2022-04-12T08:27:03.593Z\",\n \"status_reason\": null\n }\n ]\n ]\n}"}],"_postman_id":"74db3fde-7863-4315-8941-d8a690ddcae2"},{"name":"Get-Template","id":"9ae36c27-de8f-49e8-8f52-8fa2f9f148ed","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{API-Key}}"},"isInherited":false},"method":"GET","header":[],"url":"{{URL}}/merchants/{{Merchant-ID}}/templates/{{Template-Name}}","description":"Retrieves the available predefined template by the template name, which can be used when the bot is starting the conversation.
\n","urlObject":{"path":["merchants","{{Merchant-ID}}","templates","{{Template-Name}}"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[{"id":"ff13fec8-d940-48c2-b459-4f1edeb98008","name":"Get-Template","originalRequest":{"method":"GET","header":[],"url":"{{URL}}/merchants/{{Merchant-ID}}/templates/{{Template-Name}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"template\": {\n \"type\": \"text\",\n \"text\": {\n \"body\": \"Hello {1}, your OTP is {2}.\"\n }\n },\n \"status\": \"ACTIVE\",\n \"status_reason\": null,\n \"created_at\": \"2022-04-11T12:19:34.342Z\"\n}"}],"_postman_id":"9ae36c27-de8f-49e8-8f52-8fa2f9f148ed"},{"name":"Delete-Template","id":"05a42f98-28a4-47d2-ac4b-8483fb5c0bda","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{API-Key}}"},"isInherited":false},"method":"DELETE","header":[],"url":"{{URL}}/merchants/{{Merchant-ID}}/templates/{{Template-Name}}","description":"Deletes a template by its name, which is no longer required to use when the bot is initiating the conversation.
\n","urlObject":{"path":["merchants","{{Merchant-ID}}","templates","{{Template-Name}}"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[{"id":"45e74d45-c863-4c7d-b814-480488759cf4","name":"Delete-Template","originalRequest":{"method":"DELETE","header":[],"url":"{{URL}}/merchants/{{Merchant-ID}}/templates/{{Template-Name}}"},"status":"OK","code":200,"_postman_previewlanguage":"plain","header":null,"cookie":[],"responseTime":null,"body":"OK"}],"_postman_id":"05a42f98-28a4-47d2-ac4b-8483fb5c0bda"}],"id":"2c9c74b2-b8ad-4142-94b0-95a277f266c5","description":"Use Templates to create pre-defined and parameterized text, media or button messages. You can use only the approved template messages when the bot is initiating a conversation. The bot can initiate the conversation using template messages only after 24 hrs of chat window.
\n24-hour chat window is the duration that starts when the user or bot initiates a conversation.
\nUse this API to create and manage text, document, button, and media templates. You can also use the parameters to create personalized experience for the users.
\n","_postman_id":"2c9c74b2-b8ad-4142-94b0-95a277f266c5"},{"name":"Billing","item":[{"name":"Get-Conversations","id":"c9b37d39-a147-4a7d-b7a6-608318e8e4a1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{API-Key}}"},"isInherited":false},"method":"GET","header":[],"url":"{{URL}}/billing/bots/{{Bot-ID}}/conversations?start_date=Retrieves the number of business (bot) or user initiated conversations between a bot and users for a provided date range.
\nFor example, if a user or a bot start the conversation at 5:30 AM UTC, the conversation ends at 5:29 AM UTC on the next day.
\nThe date and time are tracked based on UTC. The date format is YYYY-MM-DD.
\n","urlObject":{"path":["billing","bots","{{Bot-ID}}","conversations"],"host":["{{URL}}"],"query":[{"key":"start_date","value":"Enables you to retrieve the number of conversations between a bot and users for billing and report tracking purposes.
\nThere are 2 types of conversations:
\n- \n
- User initiated \n
- Business (bot) initiated \n
The conversation can be initiated by a user or a bot with a template. A conversation is a chat (i.e, it can be multiple messages) between a user and a bot for a 24-hour window.
\n","_postman_id":"11cfd67c-a503-41ef-9570-7ee5313a0aa4"}],"event":[{"listen":"prerequest","script":{"id":"5f4df5b1-c08f-4fb2-a69d-a4611e181284","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"6d85cdb5-c02d-45bf-aa8f-ed064dc09fbb","type":"text/javascript","exec":[""]}}],"variable":[{"id":"4ac207d9-62d3-40bc-91f2-f24665c45b4d","key":"TEMPLATE-URL","value":""}]}