{"info":{"_postman_id":"0b9e625d-8ae5-4c67-84a0-0c481b65f9be","name":"Apex Visibility Chat","description":"<html><head></head><body><p>Welcome to the Apex Visibility Live Chat documentation. Please make sure you read all sections carefully to ensure a seamless integration experience. Do not hesitate to contact our support if you have any questions.</p>\n<h1 id=\"using-this-documentation\">Using this documentation</h1>\n<p>You can use the left hand side menu to navigate to the API requests you wish to view. When viewing the request you wish to analyze make sure to use the right hand column to view various examples from the drop down menus to view some example requests and responses.</p>\n<h1 id=\"websocket-topics\">WebSocket topics</h1>\n<p>There are two topics available for subscription.</p>\n<ol>\n<li>/new-message/:accountTopic</li>\n</ol>\n<p>This topic streams all new messages received while connected and subscribed. These are in the same format as the list messages API.</p>\n<ol>\n<li>/new-chat/:accountTopic</li>\n</ol>\n<p>This topic streams all new chats that are initiated while connected and subscribed. These are in the same format as the list chats API.</p>\n</body></html>","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Using this documentation","slug":"using-this-documentation"},{"content":"WebSocket topics","slug":"websocket-topics"}],"owner":"2281947","collectionId":"0b9e625d-8ae5-4c67-84a0-0c481b65f9be","publishedId":"T1Dv6ZPd","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"673AB7"},"publishDate":"2020-07-31T01:57:06.000Z"},"item":[{"name":"Authentication","item":[{"name":"Login","id":"7b751120-47f4-4f1a-9644-786e46524242","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"username\": \"steve@example.net\",\n    \"password\": \"xxxxxx\"\n}","options":{"raw":{"language":"json"}}},"url":"https://chat-api.apexvisibility.co/api/login","description":"<p>This method is used to authenticate, an access token will be issued if successful.</p>\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"your-bearer-token"}]},"isInherited":true,"source":{"_postman_id":"0b9e625d-8ae5-4c67-84a0-0c481b65f9be","id":"0b9e625d-8ae5-4c67-84a0-0c481b65f9be","name":"Apex Visibility Chat","type":"collection"}},"urlObject":{"path":["api","login"],"host":["https://chat-api.apexvisibility.co"],"query":[],"variable":[]}},"response":[{"id":"31c6ef1d-8b4e-4622-adf4-9c1d0abd3754","name":"successful operation","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n    \"username\": \"steve@example.net\",\n    \"password\": \"xxxxxx\"\n}"},"url":"https://chat-api.apexvisibility.co/api/login"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"username\": \"joe@example.net\",\n \"roles\": [\n  \"Ut enim cupidatat\",\n  \"in eu in veniam\"\n ],\n \"token_type\": \"Bearer\",\n \"access_token\": \"xxxxxx\",\n \"expires_in\": 3600,\n \"refresh_token\": \"yyyyyy\"\n}"}],"_postman_id":"7b751120-47f4-4f1a-9644-786e46524242"}],"id":"d3ba5132-dfb4-4c79-ba34-cd1e20d6608c","description":"<p>All requests to the API require authentication tokens in order to be authorized. The API makes use of JWT tokens which must be included as bearer tokens in the Authorization header. You may issue tokens using the Login API request with your credentials.</p>\n","_postman_id":"d3ba5132-dfb4-4c79-ba34-cd1e20d6608c","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"your-bearer-token"}]},"isInherited":true,"source":{"_postman_id":"0b9e625d-8ae5-4c67-84a0-0c481b65f9be","id":"0b9e625d-8ae5-4c67-84a0-0c481b65f9be","name":"Apex Visibility Chat","type":"collection"}}},{"name":"Account","item":[{"name":"List Accessible Accounts","id":"632ff7fc-a6c3-4cec-9da4-70fa7faeb7ff","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://chat-api.apexvisibility.co/api/account","description":"<p>Users may have access to multiple accounts, this method provides a list of accounts which they have access to</p>\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"your-bearer-token"}]},"isInherited":true,"source":{"_postman_id":"0b9e625d-8ae5-4c67-84a0-0c481b65f9be","id":"0b9e625d-8ae5-4c67-84a0-0c481b65f9be","name":"Apex Visibility Chat","type":"collection"}},"urlObject":{"path":["api","account"],"host":["https://chat-api.apexvisibility.co"],"query":[],"variable":[]}},"response":[{"id":"311f714b-2a01-47e5-a473-c3e303fdb867","name":"successful operation","originalRequest":{"method":"GET","header":[],"url":"https://chat-api.apexvisibility.co/api/account"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"*/*"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"632ff7fc-a6c3-4cec-9da4-70fa7faeb7ff"},{"name":"Read Account","id":"1ad1d1c9-85d1-4c7f-8aad-498da72f0861","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://chat-api.apexvisibility.co/api/account/:accountId","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"your-bearer-token"}]},"isInherited":true,"source":{"_postman_id":"0b9e625d-8ae5-4c67-84a0-0c481b65f9be","id":"0b9e625d-8ae5-4c67-84a0-0c481b65f9be","name":"Apex Visibility Chat","type":"collection"}},"urlObject":{"path":["api","account",":accountId"],"host":["https://chat-api.apexvisibility.co"],"query":[],"variable":[{"description":{"content":"<p>(Required) </p>\n","type":"text/plain"},"type":"any","value":"96061419","key":"accountId"}]}},"response":[{"id":"415ec470-2f2f-4c52-a69f-73988deaff28","name":"successful operation","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://chat-api.apexvisibility.co/api/account/:accountId","host":["https://chat-api.apexvisibility.co"],"path":["api","account",":accountId"],"variable":[{"key":"accountId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"*/*"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"1ad1d1c9-85d1-4c7f-8aad-498da72f0861"},{"name":"Get WebSocket Token","id":"ad62ee3a-89b3-48e5-805c-f771a053f283","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://chat-api.apexvisibility.co/api/account/:accountId/token","description":"<p>This API call is provided to retrieve a JWT token which can be used for connecting to the WebSocket streaming service.</p>\n<p>Once this token is received you can use this to connect to the Centrifugo streaming service as per the example below.</p>\n<p>There are several Centrifugo client libraries available for download here: <a href=\"https://centrifugal.github.io/centrifugo/libraries/client/\">https://centrifugal.github.io/centrifugo/libraries/client/</a></p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>http\n        .get('/account/' + account.id + '/token')\n        .then(response =&gt; {\n          socket = new Centrifuge(\n            'https://streams.apexvisibility.co/connection/sockjs',\n            {\n              sockjs: SockJS,\n              sockjsTransports: [\n                'xdr-streaming',\n                'xhr-streaming',\n                'eventsource',\n                'iframe-eventsource',\n                'iframe-htmlfile',\n                'xdr-polling',\n                'xhr-polling',\n                'iframe-xhr-polling',\n                'jsonp-polling',\n              ],\n            }\n          );\n\n          socket.setToken(response.data);\n\n          // account.topic is available from Read Account API call\n          socket.subscribe('/new-message/' + account.topic, data =&gt; {\n            // data contains the message event\n          });\n\n          socket.connect();\n        })\n</code></pre>","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"your-bearer-token"}]},"isInherited":true,"source":{"_postman_id":"0b9e625d-8ae5-4c67-84a0-0c481b65f9be","id":"0b9e625d-8ae5-4c67-84a0-0c481b65f9be","name":"Apex Visibility Chat","type":"collection"}},"urlObject":{"path":["api","account",":accountId","token"],"host":["https://chat-api.apexvisibility.co"],"query":[],"variable":[{"description":{"content":"<p>(Required) </p>\n","type":"text/plain"},"type":"any","value":"96061419","key":"accountId"}]}},"response":[{"id":"e1ca38e3-899b-490f-b527-1b32eb875e35","name":"successful operation","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://chat-api.apexvisibility.co/api/account/:accountId","host":["https://chat-api.apexvisibility.co"],"path":["api","account",":accountId"],"variable":[{"key":"accountId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"*/*"}],"cookie":[],"responseTime":null,"body":"{{vault:json-web-token}}"}],"_postman_id":"ad62ee3a-89b3-48e5-805c-f771a053f283"}],"id":"09208ca2-7b1e-4ed8-8f17-e6bbaca536b2","description":"<p>In some instances customers may have different accounts for different divisions or business units, because of this most requests require an account ID parameter.</p>\n","_postman_id":"09208ca2-7b1e-4ed8-8f17-e6bbaca536b2","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"your-bearer-token"}]},"isInherited":true,"source":{"_postman_id":"0b9e625d-8ae5-4c67-84a0-0c481b65f9be","id":"0b9e625d-8ae5-4c67-84a0-0c481b65f9be","name":"Apex Visibility Chat","type":"collection"}}},{"name":"Chat","item":[{"name":"Message","item":[{"name":"List Messages","id":"fecc6941-0748-4af4-b183-3859028bd39c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://chat-api.apexvisibility.co/api/chat/:accountId/message/:chatId?lastReceivedId=96061419&offset=0&max=10&sort=id&order=asc","description":"<p>This API can be used for retrieving chat messages. It is recommended for the client to keep track of the ID of the latest received message and pass this back in the 'lastReceivedID' parameter in order to avoid retrieval of duplicate messages.</p>\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"your-bearer-token"}]},"isInherited":true,"source":{"_postman_id":"0b9e625d-8ae5-4c67-84a0-0c481b65f9be","id":"0b9e625d-8ae5-4c67-84a0-0c481b65f9be","name":"Apex Visibility Chat","type":"collection"}},"urlObject":{"path":["api","chat",":accountId","message",":chatId"],"host":["https://chat-api.apexvisibility.co"],"query":[{"key":"lastReceivedId","value":"96061419"},{"description":{"content":"<p>start offset</p>\n","type":"text/plain"},"key":"offset","value":"0"},{"description":{"content":"<p>max results</p>\n","type":"text/plain"},"key":"max","value":"10"},{"description":{"content":"<p>sort by field</p>\n","type":"text/plain"},"key":"sort","value":"id"},{"description":{"content":"<p>ordering</p>\n","type":"text/plain"},"key":"order","value":"asc"}],"variable":[{"description":{"content":"<p>(Required) </p>\n","type":"text/plain"},"type":"any","value":"96061419","key":"accountId"},{"description":{"content":"<p>(Required) </p>\n","type":"text/plain"},"type":"any","value":"96061419","key":"chatId"}]}},"response":[{"id":"684e75b3-2b13-4a81-945c-2afd17ca8239","name":"successful operation","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://chat-api.apexvisibility.co/api/chat/:accountId/message/:chatId?lastReceivedId=<integer>&offset=0&max=10&sort=id&order=asc","host":["https://chat-api.apexvisibility.co"],"path":["api","chat",":accountId","message",":chatId"],"query":[{"key":"lastReceivedId","value":"<integer>"},{"key":"offset","value":"0"},{"key":"max","value":"10"},{"key":"sort","value":"id"},{"key":"order","value":"asc"}],"variable":[{"key":"accountId"},{"key":"chatId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n  \"id\": 123,\n  \"dateCreated\": \"2020-06-22T19:24:51Z\",\n  \"message\": \"Hi there, could you assist me please?\",\n  \"attachment\": {\n   \"id\": 123,\n   \"base64\": \"R0lGODlhAQABAAAAACH5BAEKAAEALAAAAAABAAEAAAICTAEAOw==\",\n   \"filename\": \"my-image.gif\",\n   \"mimeType\": \"image/gif\",\n   \"url\": \"https://cdn.com/image.png\",\n   \"size\": 102342\n  },\n  \"sender\": {\n   \"id\": 123,\n   \"username\": \"steve@example.net\",\n   \"firstName\": \"Steven\",\n   \"lastName\": \"Jablinski\"\n  },\n  \"chat\": {\n   \"id\": 123,\n   \"dateCreated\": \"2020-06-22T19:24:51Z\",\n   \"startedBy\": {\n    \"id\": 123,\n    \"username\": \"steve@example.net\",\n    \"firstName\": \"Steven\",\n    \"lastName\": \"Jablinski\"\n   },\n   \"name\": \"Steve\",\n   \"complete\": false,\n   \"lockedBy\": {\n    \"id\": 123,\n    \"username\": \"steve@example.net\",\n    \"firstName\": \"Steven\",\n    \"lastName\": \"Jablinski\"\n   },\n   \"tags\": [\n    \"deserunt dolore aliqua magna\",\n    \"ex aliquip\"\n   ]\n  },\n  \"account\": {\n   \"id\": 123,\n   \"name\": \"Demo Account\"\n  }\n },\n {\n  \"id\": 123,\n  \"dateCreated\": \"2020-06-22T19:24:51Z\",\n  \"message\": \"Hi there, could you assist me please?\",\n  \"attachment\": {\n   \"id\": 123,\n   \"base64\": \"R0lGODlhAQABAAAAACH5BAEKAAEALAAAAAABAAEAAAICTAEAOw==\",\n   \"filename\": \"my-image.gif\",\n   \"mimeType\": \"image/gif\",\n   \"url\": \"https://cdn.com/image.png\",\n   \"size\": 102342\n  },\n  \"sender\": {\n   \"id\": 123,\n   \"username\": \"steve@example.net\",\n   \"firstName\": \"Steven\",\n   \"lastName\": \"Jablinski\"\n  },\n  \"chat\": {\n   \"id\": 123,\n   \"dateCreated\": \"2020-06-22T19:24:51Z\",\n   \"startedBy\": {\n    \"id\": 123,\n    \"username\": \"steve@example.net\",\n    \"firstName\": \"Steven\",\n    \"lastName\": \"Jablinski\"\n   },\n   \"name\": \"Steve\",\n   \"complete\": false,\n   \"lockedBy\": {\n    \"id\": 123,\n    \"username\": \"steve@example.net\",\n    \"firstName\": \"Steven\",\n    \"lastName\": \"Jablinski\"\n   },\n   \"tags\": [\n    \"Excepteur ut quis\",\n    \"ex officia Lorem\"\n   ]\n  },\n  \"account\": {\n   \"id\": 123,\n   \"name\": \"Demo Account\"\n  }\n }\n]"}],"_postman_id":"fecc6941-0748-4af4-b183-3859028bd39c"},{"name":"Add Message","id":"1cb34685-359c-48aa-93a7-17f1d75fa86b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"id\": 123,\n    \"dateCreated\": \"2020-06-22T19:24:51Z\",\n    \"message\": \"Hi there, could you assist me please?\",\n    \"attachment\": {\n        \"id\": 123,\n        \"base64\": \"R0lGODlhAQABAAAAACH5BAEKAAEALAAAAAABAAEAAAICTAEAOw==\",\n        \"filename\": \"my-image.gif\",\n        \"mimeType\": \"image/gif\",\n        \"url\": \"https://cdn.com/image.png\",\n        \"size\": 102342\n    },\n    \"sender\": {\n        \"id\": 123,\n        \"username\": \"steve@example.net\",\n        \"firstName\": \"Steven\",\n        \"lastName\": \"Jablinski\"\n    },\n    \"chat\": {\n        \"id\": 123,\n        \"dateCreated\": \"2020-06-22T19:24:51Z\",\n        \"startedBy\": {\n            \"id\": 123,\n            \"username\": \"steve@example.net\",\n            \"firstName\": \"Steven\",\n            \"lastName\": \"Jablinski\"\n        },\n        \"name\": \"Steve\",\n        \"complete\": false,\n        \"lockedBy\": {\n            \"id\": 123,\n            \"username\": \"steve@example.net\",\n            \"firstName\": \"Steven\",\n            \"lastName\": \"Jablinski\"\n        },\n        \"tags\": [\n            \"et adipisicing occaecat\",\n            \"aliquip\"\n        ]\n    },\n    \"account\": {\n        \"id\": 123,\n        \"name\": \"Demo Account\"\n    }\n}","options":{"raw":{"language":"json"}}},"url":"https://chat-api.apexvisibility.co/api/chat/:accountId/message/:chatId","description":"<p>This API can be used to send a message to a chat. Only the 'message' property is required and other parameters are not used.</p>\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"your-bearer-token"}]},"isInherited":true,"source":{"_postman_id":"0b9e625d-8ae5-4c67-84a0-0c481b65f9be","id":"0b9e625d-8ae5-4c67-84a0-0c481b65f9be","name":"Apex Visibility Chat","type":"collection"}},"urlObject":{"path":["api","chat",":accountId","message",":chatId"],"host":["https://chat-api.apexvisibility.co"],"query":[],"variable":[{"description":{"content":"<p>(Required) </p>\n","type":"text/plain"},"type":"any","value":"96061419","key":"accountId"},{"description":{"content":"<p>(Required) </p>\n","type":"text/plain"},"type":"any","value":"96061419","key":"chatId"}]}},"response":[{"id":"4ef0938d-ff30-4834-9ae7-ee7270c57c48","name":"successful operation","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n    \"id\": 123,\n    \"dateCreated\": \"2020-06-22T19:24:51Z\",\n    \"message\": \"Hi there, could you assist me please?\",\n    \"attachment\": {\n        \"id\": 123,\n        \"base64\": \"R0lGODlhAQABAAAAACH5BAEKAAEALAAAAAABAAEAAAICTAEAOw==\",\n        \"filename\": \"my-image.gif\",\n        \"mimeType\": \"image/gif\",\n        \"url\": \"https://cdn.com/image.png\",\n        \"size\": 102342\n    },\n    \"sender\": {\n        \"id\": 123,\n        \"username\": \"steve@example.net\",\n        \"firstName\": \"Steven\",\n        \"lastName\": \"Jablinski\"\n    },\n    \"chat\": {\n        \"id\": 123,\n        \"dateCreated\": \"2020-06-22T19:24:51Z\",\n        \"startedBy\": {\n            \"id\": 123,\n            \"username\": \"steve@example.net\",\n            \"firstName\": \"Steven\",\n            \"lastName\": \"Jablinski\"\n        },\n        \"name\": \"Steve\",\n        \"complete\": false,\n        \"lockedBy\": {\n            \"id\": 123,\n            \"username\": \"steve@example.net\",\n            \"firstName\": \"Steven\",\n            \"lastName\": \"Jablinski\"\n        },\n        \"tags\": [\n            \"et adipisicing occaecat\",\n            \"aliquip\"\n        ]\n    },\n    \"account\": {\n        \"id\": 123,\n        \"name\": \"Demo Account\"\n    }\n}"},"url":{"raw":"https://chat-api.apexvisibility.co/api/chat/:accountId/message/:chatId","host":["https://chat-api.apexvisibility.co"],"path":["api","chat",":accountId","message",":chatId"],"variable":[{"key":"accountId"},{"key":"chatId"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"1cb34685-359c-48aa-93a7-17f1d75fa86b"}],"id":"5c4c5345-b475-457a-a658-cd02277a7345","_postman_id":"5c4c5345-b475-457a-a658-cd02277a7345","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"your-bearer-token"}]},"isInherited":true,"source":{"_postman_id":"0b9e625d-8ae5-4c67-84a0-0c481b65f9be","id":"0b9e625d-8ae5-4c67-84a0-0c481b65f9be","name":"Apex Visibility Chat","type":"collection"}}},{"name":"Tag","item":[{"name":"Add tags to chat","id":"812354bb-5665-44d7-8442-9cdff989461c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"tags\": [\n        \"nostrud sint labore\",\n        \"anim\"\n    ]\n}","options":{"raw":{"language":"json"}}},"url":"https://chat-api.apexvisibility.co/api/chat/:accountId/tag/:chatId","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"your-bearer-token"}]},"isInherited":true,"source":{"_postman_id":"0b9e625d-8ae5-4c67-84a0-0c481b65f9be","id":"0b9e625d-8ae5-4c67-84a0-0c481b65f9be","name":"Apex Visibility Chat","type":"collection"}},"urlObject":{"path":["api","chat",":accountId","tag",":chatId"],"host":["https://chat-api.apexvisibility.co"],"query":[],"variable":[{"description":{"content":"<p>(Required) </p>\n","type":"text/plain"},"type":"any","value":"96061419","key":"accountId"},{"description":{"content":"<p>(Required) </p>\n","type":"text/plain"},"type":"any","value":"96061419","key":"chatId"}]}},"response":[{"id":"520b8c28-73b8-464b-9198-414c6e7a556e","name":"successful operation","originalRequest":{"method":"PUT","header":[],"url":{"raw":"https://chat-api.apexvisibility.co/api/chat/:accountId/tag/:chatId","host":["https://chat-api.apexvisibility.co"],"path":["api","chat",":accountId","tag",":chatId"],"variable":[{"key":"accountId"},{"key":"chatId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 123,\n \"dateCreated\": \"2020-06-22T19:24:51Z\",\n \"startedBy\": {\n  \"id\": 123,\n  \"username\": \"steve@example.net\",\n  \"firstName\": \"Steven\",\n  \"lastName\": \"Jablinski\"\n },\n \"name\": \"Steve\",\n \"complete\": false,\n \"lockedBy\": {\n  \"id\": 123,\n  \"username\": \"steve@example.net\",\n  \"firstName\": \"Steven\",\n  \"lastName\": \"Jablinski\"\n },\n \"tags\": [\n  \"sit ullamco\",\n  \"ea consequat dolore proident reprehenderit\"\n ]\n}"}],"_postman_id":"812354bb-5665-44d7-8442-9cdff989461c"},{"name":"Remove tags from chat","id":"5c738fbd-c977-4069-b6bb-7da285eedb97","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"tags\": [\n        \"elit dolore nostrud Ut Duis\",\n        \"ex veniam officia in occaecat\"\n    ]\n}"},"url":"https://chat-api.apexvisibility.co/api/chat/:accountId/tag/:chatId","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"your-bearer-token"}]},"isInherited":true,"source":{"_postman_id":"0b9e625d-8ae5-4c67-84a0-0c481b65f9be","id":"0b9e625d-8ae5-4c67-84a0-0c481b65f9be","name":"Apex Visibility Chat","type":"collection"}},"urlObject":{"path":["api","chat",":accountId","tag",":chatId"],"host":["https://chat-api.apexvisibility.co"],"query":[],"variable":[{"description":{"content":"<p>(Required) </p>\n","type":"text/plain"},"type":"any","value":"96061419","key":"accountId"},{"description":{"content":"<p>(Required) </p>\n","type":"text/plain"},"type":"any","value":"96061419","key":"chatId"}]}},"response":[{"id":"7cd74aca-4725-4300-bafd-911af511e5a1","name":"successful operation","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://chat-api.apexvisibility.co/api/chat/:accountId/tag/:chatId","host":["https://chat-api.apexvisibility.co"],"path":["api","chat",":accountId","tag",":chatId"],"variable":[{"key":"accountId"},{"key":"chatId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 123,\n \"dateCreated\": \"2020-06-22T19:24:51Z\",\n \"startedBy\": {\n  \"id\": 123,\n  \"username\": \"steve@example.net\",\n  \"firstName\": \"Steven\",\n  \"lastName\": \"Jablinski\"\n },\n \"name\": \"Steve\",\n \"complete\": false,\n \"lockedBy\": {\n  \"id\": 123,\n  \"username\": \"steve@example.net\",\n  \"firstName\": \"Steven\",\n  \"lastName\": \"Jablinski\"\n },\n \"tags\": [\n  \"sit ullamco\",\n  \"ea consequat dolore proident reprehenderit\"\n ]\n}"}],"_postman_id":"5c738fbd-c977-4069-b6bb-7da285eedb97"}],"id":"f5522c3a-3a87-4c86-9222-9d43d09cffe0","_postman_id":"f5522c3a-3a87-4c86-9222-9d43d09cffe0","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"your-bearer-token"}]},"isInherited":true,"source":{"_postman_id":"0b9e625d-8ae5-4c67-84a0-0c481b65f9be","id":"0b9e625d-8ae5-4c67-84a0-0c481b65f9be","name":"Apex Visibility Chat","type":"collection"}}},{"name":"List Chats","id":"d6bc1032-9fa8-4ebf-bfef-bf1b6185a5a9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://chat-api.apexvisibility.co/api/chat/:accountId?includeLocked=true&includeClosed=true&tags=ipsum do veniam&offset=0&max=10&sort=id&order=asc","description":"<p>This API can be used to retrieve chats. A chat is effectively a thread which contains all messages between agents and a user.</p>\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"your-bearer-token"}]},"isInherited":true,"source":{"_postman_id":"0b9e625d-8ae5-4c67-84a0-0c481b65f9be","id":"0b9e625d-8ae5-4c67-84a0-0c481b65f9be","name":"Apex Visibility Chat","type":"collection"}},"urlObject":{"path":["api","chat",":accountId"],"host":["https://chat-api.apexvisibility.co"],"query":[{"key":"includeLocked","value":"true"},{"key":"includeClosed","value":"true"},{"key":"tags","value":"ipsum do veniam"},{"description":{"content":"<p>start offset</p>\n","type":"text/plain"},"key":"offset","value":"0"},{"description":{"content":"<p>max results</p>\n","type":"text/plain"},"key":"max","value":"10"},{"description":{"content":"<p>sort by field</p>\n","type":"text/plain"},"key":"sort","value":"id"},{"description":{"content":"<p>ordering</p>\n","type":"text/plain"},"key":"order","value":"asc"}],"variable":[{"description":{"content":"<p>(Required) </p>\n","type":"text/plain"},"type":"any","value":"96061419","key":"accountId"}]}},"response":[{"id":"58b3cd8f-5e1f-44b2-89e9-e0b111a4e52b","name":"successful operation","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://chat-api.apexvisibility.co/api/chat/:accountId?includeLocked=<boolean>&includeClosed=<boolean>&tags=<string>&offset=0&max=10&sort=id&order=asc","host":["https://chat-api.apexvisibility.co"],"path":["api","chat",":accountId"],"query":[{"key":"includeLocked","value":"<boolean>"},{"key":"includeClosed","value":"<boolean>"},{"key":"tags","value":"<string>"},{"key":"offset","value":"0"},{"key":"max","value":"10"},{"key":"sort","value":"id"},{"key":"order","value":"asc"}],"variable":[{"key":"accountId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n  \"id\": 123,\n  \"dateCreated\": \"2020-06-22T19:24:51Z\",\n  \"startedBy\": {\n   \"id\": 123,\n   \"username\": \"steve@example.net\",\n   \"firstName\": \"Steven\",\n   \"lastName\": \"Jablinski\"\n  },\n  \"name\": \"Steve\",\n  \"complete\": false,\n  \"lockedBy\": {\n   \"id\": 123,\n   \"username\": \"steve@example.net\",\n   \"firstName\": \"Steven\",\n   \"lastName\": \"Jablinski\"\n  },\n  \"tags\": [\n   \"consequat nostrud laborum\",\n   \"consectetur nostrud dolore commodo ipsum\"\n  ]\n },\n {\n  \"id\": 123,\n  \"dateCreated\": \"2020-06-22T19:24:51Z\",\n  \"startedBy\": {\n   \"id\": 123,\n   \"username\": \"steve@example.net\",\n   \"firstName\": \"Steven\",\n   \"lastName\": \"Jablinski\"\n  },\n  \"name\": \"Steve\",\n  \"complete\": false,\n  \"lockedBy\": {\n   \"id\": 123,\n   \"username\": \"steve@example.net\",\n   \"firstName\": \"Steven\",\n   \"lastName\": \"Jablinski\"\n  },\n  \"tags\": [\n   \"minim do aute Ut veniam\",\n   \"nisi\"\n  ]\n }\n]"}],"_postman_id":"d6bc1032-9fa8-4ebf-bfef-bf1b6185a5a9"},{"name":"Read Chat","id":"65b4e7cf-f9c6-485c-88d7-cef5cec82660","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://chat-api.apexvisibility.co/api/chat/:accountId/:chatId?offset=0&max=10&sort=id&order=asc","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"your-bearer-token"}]},"isInherited":true,"source":{"_postman_id":"0b9e625d-8ae5-4c67-84a0-0c481b65f9be","id":"0b9e625d-8ae5-4c67-84a0-0c481b65f9be","name":"Apex Visibility Chat","type":"collection"}},"urlObject":{"path":["api","chat",":accountId",":chatId"],"host":["https://chat-api.apexvisibility.co"],"query":[{"description":{"content":"<p>start offset</p>\n","type":"text/plain"},"key":"offset","value":"0"},{"description":{"content":"<p>max results</p>\n","type":"text/plain"},"key":"max","value":"10"},{"description":{"content":"<p>sort by field</p>\n","type":"text/plain"},"key":"sort","value":"id"},{"description":{"content":"<p>ordering</p>\n","type":"text/plain"},"key":"order","value":"asc"}],"variable":[{"description":{"content":"<p>(Required) </p>\n","type":"text/plain"},"type":"any","value":"96061419","key":"accountId"},{"description":{"content":"<p>(Required) </p>\n","type":"text/plain"},"type":"any","value":"96061419","key":"chatId"}]}},"response":[{"id":"b243a2d4-c5d4-41be-b3a7-8663c105d730","name":"successful operation","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://chat-api.apexvisibility.co/api/chat/:accountId/:chatId?offset=0&max=10&sort=id&order=asc","host":["https://chat-api.apexvisibility.co"],"path":["api","chat",":accountId",":chatId"],"query":[{"key":"offset","value":"0"},{"key":"max","value":"10"},{"key":"sort","value":"id"},{"key":"order","value":"asc"}],"variable":[{"key":"accountId"},{"key":"chatId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 123,\n \"dateCreated\": \"2020-06-22T19:24:51Z\",\n \"startedBy\": {\n  \"id\": 123,\n  \"username\": \"steve@example.net\",\n  \"firstName\": \"Steven\",\n  \"lastName\": \"Jablinski\"\n },\n \"name\": \"Steve\",\n \"complete\": false,\n \"lockedBy\": {\n  \"id\": 123,\n  \"username\": \"steve@example.net\",\n  \"firstName\": \"Steven\",\n  \"lastName\": \"Jablinski\"\n },\n \"tags\": [\n  \"sit ullamco\",\n  \"ea consequat dolore proident reprehenderit\"\n ]\n}"}],"_postman_id":"65b4e7cf-f9c6-485c-88d7-cef5cec82660"},{"name":"Complete Chat","id":"2937040d-26ce-4ac1-a101-6027cf42f767","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"url":"https://chat-api.apexvisibility.co/api/chat/:accountId/complete/:chatId","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"your-bearer-token"}]},"isInherited":true,"source":{"_postman_id":"0b9e625d-8ae5-4c67-84a0-0c481b65f9be","id":"0b9e625d-8ae5-4c67-84a0-0c481b65f9be","name":"Apex Visibility Chat","type":"collection"}},"urlObject":{"path":["api","chat",":accountId","complete",":chatId"],"host":["https://chat-api.apexvisibility.co"],"query":[],"variable":[{"description":{"content":"<p>(Required) </p>\n","type":"text/plain"},"type":"any","value":"96061419","key":"accountId"},{"description":{"content":"<p>(Required) </p>\n","type":"text/plain"},"type":"any","value":"96061419","key":"chatId"}]}},"response":[{"id":"b817f7f6-7cfa-4a22-80f0-9d0554902e28","name":"successful operation","originalRequest":{"method":"PUT","header":[],"url":{"raw":"https://chat-api.apexvisibility.co/api/chat/:accountId/complete/:chatId","host":["https://chat-api.apexvisibility.co"],"path":["api","chat",":accountId","complete",":chatId"],"variable":[{"key":"accountId"},{"key":"chatId"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"2937040d-26ce-4ac1-a101-6027cf42f767"}],"id":"e8d644a0-318d-492b-8b4e-d0372c4081d8","_postman_id":"e8d644a0-318d-492b-8b4e-d0372c4081d8","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"your-bearer-token"}]},"isInherited":true,"source":{"_postman_id":"0b9e625d-8ae5-4c67-84a0-0c481b65f9be","id":"0b9e625d-8ae5-4c67-84a0-0c481b65f9be","name":"Apex Visibility Chat","type":"collection"}}},{"name":"Media","item":[{"name":"List Media","id":"490a536d-42c8-4af8-b11e-5c59a63fbe25","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://chat-api.apexvisibility.co/api/media/:accountId?offset=0&max=10&sort=id&order=asc","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"your-bearer-token"}]},"isInherited":true,"source":{"_postman_id":"0b9e625d-8ae5-4c67-84a0-0c481b65f9be","id":"0b9e625d-8ae5-4c67-84a0-0c481b65f9be","name":"Apex Visibility Chat","type":"collection"}},"urlObject":{"path":["api","media",":accountId"],"host":["https://chat-api.apexvisibility.co"],"query":[{"description":{"content":"<p>start offset</p>\n","type":"text/plain"},"key":"offset","value":"0"},{"description":{"content":"<p>max results</p>\n","type":"text/plain"},"key":"max","value":"10"},{"description":{"content":"<p>sort by field</p>\n","type":"text/plain"},"key":"sort","value":"id"},{"description":{"content":"<p>ordering</p>\n","type":"text/plain"},"key":"order","value":"asc"}],"variable":[{"description":{"content":"<p>(Required) </p>\n","type":"text/plain"},"type":"any","value":"96061419","key":"accountId"}]}},"response":[{"id":"6e37f7c9-efff-4ae7-92cd-b2cddbd99636","name":"successful operation","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://chat-api.apexvisibility.co/api/media/:accountId?offset=0&max=10&sort=id&order=asc","host":["https://chat-api.apexvisibility.co"],"path":["api","media",":accountId"],"query":[{"key":"offset","value":"0"},{"key":"max","value":"10"},{"key":"sort","value":"id"},{"key":"order","value":"asc"}],"variable":[{"key":"accountId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n  \"id\": 123,\n  \"base64\": \"R0lGODlhAQABAAAAACH5BAEKAAEALAAAAAABAAEAAAICTAEAOw==\",\n  \"filename\": \"my-image.gif\",\n  \"mimeType\": \"image/gif\",\n  \"url\": \"https://cdn.com/image.png\",\n  \"size\": 102342\n },\n {\n  \"id\": 123,\n  \"base64\": \"R0lGODlhAQABAAAAACH5BAEKAAEALAAAAAABAAEAAAICTAEAOw==\",\n  \"filename\": \"my-image.gif\",\n  \"mimeType\": \"image/gif\",\n  \"url\": \"https://cdn.com/image.png\",\n  \"size\": 102342\n }\n]"}],"_postman_id":"490a536d-42c8-4af8-b11e-5c59a63fbe25"},{"name":"Upload Media","id":"6d78fe5e-1cec-49d6-ac61-162b745b6c96","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"id\": 123,\n    \"base64\": \"R0lGODlhAQABAAAAACH5BAEKAAEALAAAAAABAAEAAAICTAEAOw==\",\n    \"filename\": \"my-image.gif\",\n    \"mimeType\": \"image/gif\",\n    \"url\": \"https://cdn.com/image.png\",\n    \"size\": 102342\n}","options":{"raw":{"language":"json"}}},"url":"https://chat-api.apexvisibility.co/api/media/:accountId","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"your-bearer-token"}]},"isInherited":true,"source":{"_postman_id":"0b9e625d-8ae5-4c67-84a0-0c481b65f9be","id":"0b9e625d-8ae5-4c67-84a0-0c481b65f9be","name":"Apex Visibility Chat","type":"collection"}},"urlObject":{"path":["api","media",":accountId"],"host":["https://chat-api.apexvisibility.co"],"query":[],"variable":[{"description":{"content":"<p>(Required) </p>\n","type":"text/plain"},"type":"any","value":"96061419","key":"accountId"}]}},"response":[{"id":"708c8a08-a79a-4a4d-9bc9-d74f2b427730","name":"successful operation","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n    \"id\": 123,\n    \"base64\": \"R0lGODlhAQABAAAAACH5BAEKAAEALAAAAAABAAEAAAICTAEAOw==\",\n    \"filename\": \"my-image.gif\",\n    \"mimeType\": \"image/gif\",\n    \"url\": \"https://cdn.com/image.png\",\n    \"size\": 102342\n}"},"url":{"raw":"https://chat-api.apexvisibility.co/api/media/:accountId","host":["https://chat-api.apexvisibility.co"],"path":["api","media",":accountId"],"variable":[{"key":"accountId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 123,\n \"base64\": \"R0lGODlhAQABAAAAACH5BAEKAAEALAAAAAABAAEAAAICTAEAOw==\",\n \"filename\": \"my-image.gif\",\n \"mimeType\": \"image/gif\",\n \"url\": \"https://cdn.com/image.png\",\n \"size\": 102342\n}"}],"_postman_id":"6d78fe5e-1cec-49d6-ac61-162b745b6c96"},{"name":"Delete Media","id":"24279f11-5c35-46ab-8859-0ff0407a082f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://chat-api.apexvisibility.co/api/media/:accountId/:mediaId","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"your-bearer-token"}]},"isInherited":true,"source":{"_postman_id":"0b9e625d-8ae5-4c67-84a0-0c481b65f9be","id":"0b9e625d-8ae5-4c67-84a0-0c481b65f9be","name":"Apex Visibility Chat","type":"collection"}},"urlObject":{"path":["api","media",":accountId",":mediaId"],"host":["https://chat-api.apexvisibility.co"],"query":[],"variable":[{"description":{"content":"<p>(Required) </p>\n","type":"text/plain"},"type":"any","value":"96061419","key":"accountId"},{"description":{"content":"<p>(Required) </p>\n","type":"text/plain"},"type":"any","value":"96061419","key":"mediaId"}]}},"response":[{"id":"86dbe471-a3a9-4dd2-8a0e-44b498207383","name":"successful operation","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://chat-api.apexvisibility.co/api/media/:accountId/:mediaId","host":["https://chat-api.apexvisibility.co"],"path":["api","media",":accountId",":mediaId"],"variable":[{"key":"accountId"},{"key":"mediaId"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"24279f11-5c35-46ab-8859-0ff0407a082f"}],"id":"93c0c4ac-07e5-4daf-8184-94e52ca9e3b1","_postman_id":"93c0c4ac-07e5-4daf-8184-94e52ca9e3b1","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"your-bearer-token"}]},"isInherited":true,"source":{"_postman_id":"0b9e625d-8ae5-4c67-84a0-0c481b65f9be","id":"0b9e625d-8ae5-4c67-84a0-0c481b65f9be","name":"Apex Visibility Chat","type":"collection"}}}],"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"your-bearer-token"}]}},"event":[{"listen":"prerequest","script":{"id":"5d109ca5-b198-4c03-8ccb-46d59558e1e4","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"88899eff-09ca-453c-9c02-1b831c0a07a2","type":"text/javascript","exec":[""]}}],"variable":[{"id":"e4439a80-9740-4421-90a2-24c080892b24","key":"baseUrl","value":"https://chat-api.apexvisibility.co"},{"id":"eb62c84a-b9e3-4756-99cf-3c80ce6b19dd","key":"bearerToken","value":"your-bearer-token"}]}