{ "info": { "_postman_id": "9d0d3d8a-4ade-4969-b0f6-ec7e51cc4987", "name": "Chapi - Chat API", "description": "8x8 Work Chat API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "createdAt": "2026-07-28T00:27:01.000Z", "updatedAt": "2026-07-28T00:27:02.000Z", "lastUpdatedBy": "35240", "uid": "35240-9d0d3d8a-4ade-4969-b0f6-ec7e51cc4987" }, "item": [ { "name": "api", "item": [ { "name": "chat", "item": [ { "name": "v1", "item": [ { "name": "messages", "item": [ { "name": "Send a message to a public chat room.", "id": "68e7c70a-aa86-4782-be6e-584edfd14f21", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "body": { "mode": "raw", "raw": "{\n \"messageRaw\": \"\",\n \"room\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/chat/v1/messages/", "host": [ "{{baseUrl}}" ], "path": [ "api", "chat", "v1", "messages", "" ] }, "description": "This will send a message to a room. If the room does not exist Chapi will create the room, then send the message to it. This endpoint is unable to send messages if the room is private." }, "response": [ { "id": "13e391dd-aa26-4791-a5d9-84e1137c5710", "name": "OK", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"messageRaw\": \"\",\n \"room\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/chat/v1/messages/", "host": [ "{{baseUrl}}" ], "path": [ "api", "chat", "v1", "messages", "" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"examples\": {\n \"response\": {\n \"value\": {\n \"parsed\": \"Hello World!\"\n }\n }\n }\n}", "createdAt": "2026-07-28T00:27:02.000Z", "updatedAt": "2026-07-28T00:27:02.000Z", "uid": "35240-13e391dd-aa26-4791-a5d9-84e1137c5710" }, { "id": "1ff8a229-9789-449a-9156-9c20895939b1", "name": "Created", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"messageRaw\": \"\",\n \"room\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/chat/v1/messages/", "host": [ "{{baseUrl}}" ], "path": [ "api", "chat", "v1", "messages", "" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T00:27:02.000Z", "updatedAt": "2026-07-28T00:27:02.000Z", "uid": "35240-1ff8a229-9789-449a-9156-9c20895939b1" }, { "id": "a2b0b461-602a-4aae-bed2-a73070f7c76b", "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"messageRaw\": \"\",\n \"room\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/chat/v1/messages/", "host": [ "{{baseUrl}}" ], "path": [ "api", "chat", "v1", "messages", "" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T00:27:02.000Z", "updatedAt": "2026-07-28T00:27:02.000Z", "uid": "35240-a2b0b461-602a-4aae-bed2-a73070f7c76b" }, { "id": "228421d6-583a-4167-83a9-14efbd1098a7", "name": "Forbidden", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"messageRaw\": \"\",\n \"room\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/chat/v1/messages/", "host": [ "{{baseUrl}}" ], "path": [ "api", "chat", "v1", "messages", "" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T00:27:02.000Z", "updatedAt": "2026-07-28T00:27:02.000Z", "uid": "35240-228421d6-583a-4167-83a9-14efbd1098a7" }, { "id": "3302057c-3d8c-434c-a2bb-90bdf6b5e78a", "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"messageRaw\": \"\",\n \"room\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/chat/v1/messages/", "host": [ "{{baseUrl}}" ], "path": [ "api", "chat", "v1", "messages", "" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T00:27:02.000Z", "updatedAt": "2026-07-28T00:27:02.000Z", "uid": "35240-3302057c-3d8c-434c-a2bb-90bdf6b5e78a" } ], "createdAt": "2026-07-28T00:27:02.000Z", "updatedAt": "2026-07-28T00:27:02.000Z", "uid": "35240-68e7c70a-aa86-4782-be6e-584edfd14f21" }, { "name": "Fetches messages for a room. Defaults to `CHAPI sandbox` room.", "id": "71d1abae-ecdf-4b1a-b684-bb60c25cea06", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "*/*" } ], "url": { "raw": "{{baseUrl}}/api/chat/v1/messages?pageSize=30&room=&ts=0", "host": [ "{{baseUrl}}" ], "path": [ "api", "chat", "v1", "messages" ], "query": [ { "description": "pageSize", "key": "pageSize", "value": "30" }, { "description": "room", "key": "room", "value": "" }, { "description": "ts", "key": "ts", "value": "0" } ] }, "description": "Fetches a list of messages from the room." }, "response": [ { "id": "9638faa5-e512-409f-bcfa-6dc54eb61d57", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "*/*" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/chat/v1/messages?pageSize=30&room=&ts=0", "host": [ "{{baseUrl}}" ], "path": [ "api", "chat", "v1", "messages" ], "query": [ { "description": "pageSize", "key": "pageSize", "value": "30" }, { "description": "room", "key": "room", "value": "" }, { "description": "ts", "key": "ts", "value": "0" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"examples\": {\n \"response\": {\n \"value\": {\n \"authorUser\": {\n \"avatarUrl\": \"https://roombot.s3.us-west-1.amazonaws.com/chapi.png\",\n \"email\": \"developer@8x8.com\",\n \"name\": \"Chapi\"\n },\n \"messageParsed\": \"Hello world\",\n \"timestamp\": 1594918006814947\n }\n }\n }\n}", "createdAt": "2026-07-28T00:27:02.000Z", "updatedAt": "2026-07-28T00:27:02.000Z", "uid": "35240-9638faa5-e512-409f-bcfa-6dc54eb61d57" }, { "id": "fcbdb27c-2855-481e-a146-fce82faf7104", "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/chat/v1/messages?pageSize=30&room=&ts=0", "host": [ "{{baseUrl}}" ], "path": [ "api", "chat", "v1", "messages" ], "query": [ { "description": "pageSize", "key": "pageSize", "value": "30" }, { "description": "room", "key": "room", "value": "" }, { "description": "ts", "key": "ts", "value": "0" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T00:27:02.000Z", "updatedAt": "2026-07-28T00:27:02.000Z", "uid": "35240-fcbdb27c-2855-481e-a146-fce82faf7104" }, { "id": "04e729d2-98be-4f12-b605-415db47daba5", "name": "Forbidden", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/chat/v1/messages?pageSize=30&room=&ts=0", "host": [ "{{baseUrl}}" ], "path": [ "api", "chat", "v1", "messages" ], "query": [ { "description": "pageSize", "key": "pageSize", "value": "30" }, { "description": "room", "key": "room", "value": "" }, { "description": "ts", "key": "ts", "value": "0" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T00:27:02.000Z", "updatedAt": "2026-07-28T00:27:02.000Z", "uid": "35240-04e729d2-98be-4f12-b605-415db47daba5" }, { "id": "0ef8b62e-8486-49f0-bf30-b9922c95dbc4", "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/chat/v1/messages?pageSize=30&room=&ts=0", "host": [ "{{baseUrl}}" ], "path": [ "api", "chat", "v1", "messages" ], "query": [ { "description": "pageSize", "key": "pageSize", "value": "30" }, { "description": "room", "key": "room", "value": "" }, { "description": "ts", "key": "ts", "value": "0" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T00:27:02.000Z", "updatedAt": "2026-07-28T00:27:02.000Z", "uid": "35240-0ef8b62e-8486-49f0-bf30-b9922c95dbc4" } ], "createdAt": "2026-07-28T00:27:02.000Z", "updatedAt": "2026-07-28T00:27:02.000Z", "uid": "35240-71d1abae-ecdf-4b1a-b684-bb60c25cea06" } ], "id": "5402efe6-ec1a-4da8-9791-1034560c94b0", "createdAt": "2026-07-28T00:27:02.000Z", "updatedAt": "2026-07-28T00:27:02.000Z", "uid": "35240-5402efe6-ec1a-4da8-9791-1034560c94b0" } ], "id": "957aac32-d749-46cd-afd9-15cdd3ff5816", "createdAt": "2026-07-28T00:27:02.000Z", "updatedAt": "2026-07-28T00:27:02.000Z", "uid": "35240-957aac32-d749-46cd-afd9-15cdd3ff5816" } ], "id": "4493c47b-d243-4847-85af-f42ff07a401b", "createdAt": "2026-07-28T00:27:02.000Z", "updatedAt": "2026-07-28T00:27:02.000Z", "uid": "35240-4493c47b-d243-4847-85af-f42ff07a401b" } ], "id": "3ed1dfb3-6425-4f83-b1fe-78bcfbdae236", "createdAt": "2026-07-28T00:27:02.000Z", "updatedAt": "2026-07-28T00:27:02.000Z", "uid": "35240-3ed1dfb3-6425-4f83-b1fe-78bcfbdae236" } ], "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "variable": [ { "key": "baseUrl", "value": "//api.8x8.com/chat" } ] }