{"info":{"_postman_id":"376454b4-ccc4-4fb5-8b88-5a3a3392e6d1","name":"Vartalap","description":"

Vartalap is an open source personal chat application. It is design to provide the level of transparency in the personal messaging application with your data.

This is a API documentation of the Vartalap.

For Authorization always set the following headers

accesskey= # Authentication token as response of login api\nuser= # Authenticated username\n

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"20439391","collectionId":"376454b4-ccc4-4fb5-8b88-5a3a3392e6d1","publishedId":"Uyr5neME","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2022-04-16T11:58:56.000Z"},"item":[{"name":"v1.0","item":[{"name":"Auth","item":[{"name":"Login WIth Mock Authentication","event":[{"listen":"test","script":{"id":"e2dcf2d7-8271-4f56-8a5f-7f100d1521f3","exec":["const result = pm.response.json()\r","pm.environment.set('accesskey', result.accesskey);"],"type":"text/javascript"}}],"id":"a3737989-64c6-4158-9933-493190913b7f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"username\": \"{{username}}\",\r\n \"authToken\": \"o\",\r\n \"notificationToken\": \"fcm token\",\r\n \"deviceId\": \"default\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/v1.0/login","description":"

Mock authentication endpoint.

Development user only.

Authenticate with Firebase such as Phone Auth

Authentication endpoints

\n","_postman_id":"d2d46fb2-b6b2-4935-a4f2-b6c01535e827","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"accesskey"},{"key":"value","value":"{{accesskey}}"}]},"isInherited":true,"source":{"_postman_id":"376454b4-ccc4-4fb5-8b88-5a3a3392e6d1","id":"376454b4-ccc4-4fb5-8b88-5a3a3392e6d1","name":"Vartalap","type":"collection"}}},{"name":"Profile","item":[{"name":"Get Profile","id":"8f5b2170-326c-48a9-94ce-93ea0c5c89c2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{baseUrl}}/v1.0/profile/","description":"

Get User profile

User Profile Endpoints

\n","_postman_id":"1e3efc0c-09c7-4ac1-b38d-4d66a01a1222","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"accesskey"},{"key":"value","value":"{{accesskey}}"}]},"isInherited":true,"source":{"_postman_id":"376454b4-ccc4-4fb5-8b88-5a3a3392e6d1","id":"376454b4-ccc4-4fb5-8b88-5a3a3392e6d1","name":"Vartalap","type":"collection"}}},{"name":"Gateway","item":[{"name":"Send Message","id":"c3051346-6868-4be7-aa8b-f1ed22398a34","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"[\r\n \"{\\\"_v\\\":2,\\\"id\\\":\\\"string\\\",\\\"head\\\":{\\\"type\\\":\\\"chat|group|channel|bot|notification\\\",\\\"to\\\":\\\"username|group_id|channel_id|bot_id\\\",\\\"from\\\":\\\"username\\\",\\\"chatid\\\":\\\"chatid\\\",\\\"contentType\\\":\\\"json|text|video|audio|location|form\\\",\\\"action\\\":\\\"message|ack|subscribe|unsubscribe|join|leave|create|add-member|remove-member\\\"},\\\"meta\\\":{\\\"hash\\\":\\\"md5:hash\\\",\\\"content_hash\\\":\\\"md5:hash\\\",\\\"generate_ts\\\":123455667890},\\\"body\\\":{\\\"text\\\":\\\"Hello this a text message\\\"}}\",\r\n \"{\\\"_v\\\":2,\\\"id\\\":\\\"string\\\",\\\"head\\\":{\\\"type\\\":\\\"chat|group|channel|bot|notification\\\",\\\"to\\\":\\\"username|group_id|channel_id|bot_id\\\",\\\"from\\\":\\\"username\\\",\\\"chatid\\\":\\\"chatid\\\",\\\"contentType\\\":\\\"json|text|video|audio|location|form\\\",\\\"action\\\":\\\"message|ack|subscribe|unsubscribe|join|leave|create|add-member|remove-member\\\"},\\\"meta\\\":{\\\"hash\\\":\\\"md5:hash\\\",\\\"content_hash\\\":\\\"md5:hash\\\",\\\"generate_ts\\\":123455667890},\\\"body\\\":{\\\"text\\\":\\\"Hello this a text message\\\"}}\"\r\n]","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/v1.0/messages","description":"

Http endpoint to send messages

Web socket and HTTP Gateway

As postman doesn't yet support adding web socket request in normal collection.

Endpoint: wss://{{hostname}}/wss

\n","_postman_id":"e0914662-2f33-48d1-8269-37822418260e","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"accesskey"},{"key":"value","value":"{{accesskey}}"}]},"isInherited":true,"source":{"_postman_id":"376454b4-ccc4-4fb5-8b88-5a3a3392e6d1","id":"376454b4-ccc4-4fb5-8b88-5a3a3392e6d1","name":"Vartalap","type":"collection"}}},{"name":"Group","item":[{"name":"Get All Groups","id":"3c027912-2a62-40cc-b75e-0819155e586a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{baseUrl}}/v1.0/groups/","description":"

Get All the groups user have access to

Get group chat information including name, display pic, members

Create new group chat

Add members to existing group chat

Remove other members only valid if you have admin permission or Leave group chat.

Endpoints for performing group related actions

\n","_postman_id":"7275ea1d-d105-41b5-bc3d-5493b638d5bd","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"accesskey"},{"key":"value","value":"{{accesskey}}"}]},"isInherited":true,"source":{"_postman_id":"376454b4-ccc4-4fb5-8b88-5a3a3392e6d1","id":"376454b4-ccc4-4fb5-8b88-5a3a3392e6d1","name":"Vartalap","type":"collection"}}},{"name":"Assets","item":[{"name":"Generate Presigned URL for upload","id":"91d13e89-224a-4903-baaa-75308e8ea49b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{baseUrl}}/v1.0/assets/upload/presigned_url?ext=.png&category=chat","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"accesskey"},{"key":"value","value":"{{accesskey}}"}]},"isInherited":true,"source":{"_postman_id":"376454b4-ccc4-4fb5-8b88-5a3a3392e6d1","id":"376454b4-ccc4-4fb5-8b88-5a3a3392e6d1","name":"Vartalap","type":"collection"}},"urlObject":{"path":["v1.0","assets","upload","presigned_url"],"host":["{{baseUrl}}"],"query":[{"key":"ext","value":".png"},{"key":"category","value":"chat"}],"variable":[]}},"response":[],"_postman_id":"91d13e89-224a-4903-baaa-75308e8ea49b"},{"name":"Get Presigned Url to download assets","id":"299e34d8-4605-45df-b57a-11aac91b6fe4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{baseUrl}}/v1.0/assets/download/:assetId/presigned_url","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"accesskey"},{"key":"value","value":"{{accesskey}}"}]},"isInherited":true,"source":{"_postman_id":"376454b4-ccc4-4fb5-8b88-5a3a3392e6d1","id":"376454b4-ccc4-4fb5-8b88-5a3a3392e6d1","name":"Vartalap","type":"collection"}},"urlObject":{"path":["v1.0","assets","download",":assetId","presigned_url"],"host":["{{baseUrl}}"],"query":[],"variable":[{"type":"any","value":null,"key":"assetId"}]}},"response":[],"_postman_id":"299e34d8-4605-45df-b57a-11aac91b6fe4"},{"name":"Update Asset Status","id":"3435f8ee-4333-4fbb-8a02-7ae88f079a51","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"status\": true\r\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/v1.0/assets/:assetId/status","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"accesskey"},{"key":"value","value":"{{accesskey}}"}]},"isInherited":true,"source":{"_postman_id":"376454b4-ccc4-4fb5-8b88-5a3a3392e6d1","id":"376454b4-ccc4-4fb5-8b88-5a3a3392e6d1","name":"Vartalap","type":"collection"}},"urlObject":{"path":["v1.0","assets",":assetId","status"],"host":["{{baseUrl}}"],"query":[],"variable":[{"type":"any","value":"e3dbe14f-c8da-4436-b912-da059098c6a5","key":"assetId"}]}},"response":[],"_postman_id":"3435f8ee-4333-4fbb-8a02-7ae88f079a51"}],"id":"9d21dd59-795e-4ef7-8b92-0ff9b1c7384d","description":"

File service endpoint to upload and download files

\n","_postman_id":"9d21dd59-795e-4ef7-8b92-0ff9b1c7384d","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"accesskey"},{"key":"value","value":"{{accesskey}}"}]},"isInherited":true,"source":{"_postman_id":"376454b4-ccc4-4fb5-8b88-5a3a3392e6d1","id":"376454b4-ccc4-4fb5-8b88-5a3a3392e6d1","name":"Vartalap","type":"collection"}}},{"name":"Contact Book","item":[{"name":"Sync Contact","id":"0bb67168-9813-4ca8-b31e-8eee0149a164","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"users\": [\r\n \"username_1\",\r\n \"username_2\"\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/v1.0/contactbook/sync","description":"

Sync contact book, to fetch list of users using this service

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"accesskey"},{"key":"value","value":"{{accesskey}}"}]},"isInherited":true,"source":{"_postman_id":"376454b4-ccc4-4fb5-8b88-5a3a3392e6d1","id":"376454b4-ccc4-4fb5-8b88-5a3a3392e6d1","name":"Vartalap","type":"collection"}},"urlObject":{"path":["v1.0","contactbook","sync"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"0bb67168-9813-4ca8-b31e-8eee0149a164"}],"id":"39d37299-0db3-479a-9268-829ad0d4cbed","_postman_id":"39d37299-0db3-479a-9268-829ad0d4cbed","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"accesskey"},{"key":"value","value":"{{accesskey}}"}]},"isInherited":true,"source":{"_postman_id":"376454b4-ccc4-4fb5-8b88-5a3a3392e6d1","id":"376454b4-ccc4-4fb5-8b88-5a3a3392e6d1","name":"Vartalap","type":"collection"}}}],"id":"89091d5f-bf1b-47a5-9f49-ca737fa721d2","_postman_id":"89091d5f-bf1b-47a5-9f49-ca737fa721d2","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"accesskey"},{"key":"value","value":"{{accesskey}}"}]},"isInherited":true,"source":{"_postman_id":"376454b4-ccc4-4fb5-8b88-5a3a3392e6d1","id":"376454b4-ccc4-4fb5-8b88-5a3a3392e6d1","name":"Vartalap","type":"collection"}}}],"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"accesskey"},{"key":"value","value":"{{accesskey}}"}]}},"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["var username = pm.environment.get(\"username\");","if(username) {"," pm.request.addHeader({"," key: 'user',"," value: username"," });","}"],"id":"f0c34219-dd13-4342-9452-db23fd282f5d"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"e83a1029-a383-44fb-b070-5f54300d2382"}}],"variable":[{"key":"firebase_auth_token","value":" "}]}