{ "info": { "_postman_id": "11a4323f-5187-4628-aa3d-03f406ddc3ca", "name": "Video Interaction API", "description": "This is the API to integrate 8x8 Video Interaction product.\n\nContact Support:\n Name: 8x8 Inc\n Email: cpaas-support@8x8.com", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "createdAt": "2026-07-28T00:28:43.000Z", "updatedAt": "2026-07-28T00:28:43.000Z", "lastUpdatedBy": "35240", "uid": "35240-11a4323f-5187-4628-aa3d-03f406ddc3ca" }, "item": [ { "name": "api", "item": [ { "name": "v1", "item": [ { "name": "tokens", "item": [ { "name": "Token creation", "id": "44021b6a-a862-4a0f-912b-bddd0bfd16ed", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "body": { "mode": "raw", "raw": "{\n \"create_room\": \"\",\n \"phone_number\": \"\",\n \"call_reference\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/tokens", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "tokens" ] }, "description": "This API endpoint allows the creation of a bearer token. The API endpoint can also be used to create a new room, once a room is created, participants can join it, creating a conference. Once a room is created, the validity period is 15 minutes. More example on this API usages can be found [here](/connect/docs/token-example-creation).\n### Authentication:\n- 8x8 Video Interaction API utilizes an 8x8 API Key for authentication.\n\t- You can create a API key directly from the Connect Portal. The process to create an API key is documented [here](/connect/docs/authentication) and a direct link to the API Keys page can be found [here](https://connect.8x8.com/messaging/api-keys).\n\t- You need to include the following header in your requests: Authorization: Bearer {API key}\n- NB: (replace the {API key} placeholder with your API key from Connect)" }, "response": [ { "id": "61a27218-4907-4725-aea3-0089e86f2eab", "name": "Here is an example of successful response: ", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "body": { "mode": "raw", "raw": "{\n \"create_room\": \"\",\n \"phone_number\": \"\",\n \"call_reference\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/tokens", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "tokens" ] } }, "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 \"auth_token\": \"[...]E5B87qPWXyNNDHBx_LftaHarc\"\n }\n }\n }\n}", "createdAt": "2026-07-28T00:28:44.000Z", "updatedAt": "2026-07-28T00:28:44.000Z", "uid": "35240-61a27218-4907-4725-aea3-0089e86f2eab" } ], "createdAt": "2026-07-28T00:28:44.000Z", "updatedAt": "2026-07-28T00:28:44.000Z", "uid": "35240-44021b6a-a862-4a0f-912b-bddd0bfd16ed" } ], "id": "4e22c8cf-acf9-4e1c-b8d0-49aeaf1d878a", "createdAt": "2026-07-28T00:28:44.000Z", "updatedAt": "2026-07-28T00:28:44.000Z", "uid": "35240-4e22c8cf-acf9-4e1c-b8d0-49aeaf1d878a" }, { "name": "call-logs", "item": [ { "name": "Call Logs", "id": "04085ee9-50d5-429e-89e1-61272bb584d4", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) ", "key": "x-token", "value": "{YourAuthToken}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/call-logs?from= yyyy-mm-dd&to= yyyy-mm-dd&q=&cursor=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "call-logs" ], "query": [ { "key": "from", "value": " yyyy-mm-dd" }, { "key": "to", "value": " yyyy-mm-dd" }, { "key": "q", "value": "" }, { "key": "cursor", "value": "" } ] }, "description": "This API endpoint allows to retrieve information related to past calls. You need to use the Token API first to create an Authorization Token. You can to list the calls during a time period or with a specific Call_Reference or Phone_Number. \n\nExample 1: \n```\ncurl -X POST https://video-agent.8x8.com//api/v1/call-logs \\\n-H \"Content-Type: application/json\" \\\n-H x-token: YourAuthToken' \\\n```\n\nExample 2:\n```\ncurl -X POST\nhttps://video-agent.8x8.com/api/v1/call-logs?from=yyyy-mm-dd&to=yyyy-mm-dd&q=12345&cursor=5757 \\\n-H \"Content-Type: application/json\" \\\n-H x-token: YourAuthToken' \\\n```\n" }, "response": [ { "id": "af3146f9-a120-4e73-a453-0666e92cf574", "name": "New Response", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) ", "key": "x-token", "value": "{YourAuthToken}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/call-logs?from= yyyy-mm-dd&to= yyyy-mm-dd&q=&cursor=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "call-logs" ], "query": [ { "key": "from", "value": " yyyy-mm-dd" }, { "key": "to", "value": " yyyy-mm-dd" }, { "key": "q", "value": "" }, { "key": "cursor", "value": "" } ] } }, "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 \"prevCursor\": \"5775\",\n \"list\": [\n {\n \"CallId\": \"5774\",\n \"UserB_MSISDN\": \"639215074178\",\n \"CreatedAt\": \"2019-02-05T07:19:28.850Z\",\n \"FinishedAt\": \"2019-02-05T07:24:50.170Z\",\n \"Duration\": 25,\n \"Status\": \"E\",\n \"CountryISO2alpha\": \"PH\",\n \"Reference\": \"ffdsfsfsf\"\n },\n {\n \"CallId\": \"5756\",\n \"UserB_MSISDN\": \"null,\",\n \"CreatedAt\": \"2019-02-04T04:00:26.250Z\",\n \"Duration\": 0,\n \"Status\": \"C\",\n \"CountryISO2alpha\": \"\u201cSG\u201d\",\n \"Reference\": \"mdopyomn\"\n }\n ]\n }\n }\n }\n}", "createdAt": "2026-07-28T00:28:44.000Z", "updatedAt": "2026-07-28T00:28:44.000Z", "uid": "35240-af3146f9-a120-4e73-a453-0666e92cf574" } ], "createdAt": "2026-07-28T00:28:44.000Z", "updatedAt": "2026-07-28T00:28:44.000Z", "uid": "35240-04085ee9-50d5-429e-89e1-61272bb584d4" } ], "id": "e992a304-9b26-4b1d-9bd8-d7d696ae9467", "createdAt": "2026-07-28T00:28:44.000Z", "updatedAt": "2026-07-28T00:28:44.000Z", "uid": "35240-e992a304-9b26-4b1d-9bd8-d7d696ae9467" }, { "name": "calls", "item": [ { "name": "{id}", "item": [ { "name": "Detail call", "id": "f607295f-cec5-4158-ab32-d25bb9069d97", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) ", "key": "x-token", "value": "{YourAuthToken}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/calls/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "calls", ":id" ], "variable": [ { "id": "fcebb128-e03d-49e8-bd50-45d9b8bf9622", "key": "id", "value": "CallID", "description": "(Required) " } ] }, "description": "This API endpoint enables information retrieval related to a specific past call. You need to use the Token API first to create an Authorization Token. You can retrieve all information related to a specific call using the CallId. " }, "response": [ { "id": "f6661d5c-9052-4ce8-963e-798489041ae8", "name": "New Response", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) ", "key": "x-token", "value": "{YourAuthToken}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/calls/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "calls", ":id" ], "variable": [ { "key": "id" } ] } }, "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 \"CreatedAt\": \"2019-01-05T07:27:25.190Z\",\n \"FinishedAt\": \"2019-01-05T07:28:36.060Z\",\n \"Duration\": 25,\n \"Status\": \"C\",\n \"AgentRating\": \"5\",\n \"GuestRating\": \"5\",\n \"Location\": {\n \"lat\": 10.3179594,\n \"long\": 123.907218\n },\n \"Conversation\": [\n {\n \"origin\": \"agent\",\n \"timestamp\": 1552018590459,\n \"data\": \"Hi There\"\n },\n {\n \"origin\": \"guest\",\n \"timestamp\": 1552018598185,\n \"data\": \"Hello\"\n },\n {\n \"origin\": \"guest\",\n \"timestamp\": 1552018609975,\n \"data\": \"/s3/uploads/snapshots/2019/2/8/1552458607812-snapshot.png\"\n },\n {\n \"origin\": \"guest\",\n \"timestamp\": 1552018620433,\n \"data\": \"/s3/uploads/snapshots/2019/2/8/1552085618003-snapshot.png\"\n }\n ]\n }\n }\n }\n}", "createdAt": "2026-07-28T00:28:44.000Z", "updatedAt": "2026-07-28T00:28:44.000Z", "uid": "35240-f6661d5c-9052-4ce8-963e-798489041ae8" } ], "createdAt": "2026-07-28T00:28:44.000Z", "updatedAt": "2026-07-28T00:28:44.000Z", "uid": "35240-f607295f-cec5-4158-ab32-d25bb9069d97" } ], "id": "baa48a98-f375-4543-9d2f-ae428bd12b95", "createdAt": "2026-07-28T00:28:44.000Z", "updatedAt": "2026-07-28T00:28:44.000Z", "uid": "35240-baa48a98-f375-4543-9d2f-ae428bd12b95" } ], "id": "52544055-098c-483b-8e36-e71d5a36c3ad", "createdAt": "2026-07-28T00:28:44.000Z", "updatedAt": "2026-07-28T00:28:44.000Z", "uid": "35240-52544055-098c-483b-8e36-e71d5a36c3ad" } ], "id": "44af0314-6174-4d76-a043-4bc71d45ec43", "createdAt": "2026-07-28T00:28:44.000Z", "updatedAt": "2026-07-28T00:28:44.000Z", "uid": "35240-44af0314-6174-4d76-a043-4bc71d45ec43" } ], "id": "f20a3b61-478e-45b0-ba0f-9a4000838fdc", "createdAt": "2026-07-28T00:28:44.000Z", "updatedAt": "2026-07-28T00:28:44.000Z", "uid": "35240-f20a3b61-478e-45b0-ba0f-9a4000838fdc" }, { "name": "{link}", "item": [ { "name": "Retrieve Image", "id": "942b1d52-df0a-4915-b235-5190fc7bb293", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) ", "key": "x-token", "value": "{YourAuthToken}" }, { "key": "Accept", "value": "*/*" } ], "url": { "raw": "{{baseUrl}}/:link", "host": [ "{{baseUrl}}" ], "path": [ ":link" ], "variable": [ { "id": "693eb226-d245-4ddb-99e7-f5c89c63aa75", "key": "link", "value": "/s3/uploads/snapshots/2019/3/8/1552018607812/snapshot.png", "description": "(Required) " } ] }, "description": "This operation allows you to download an image from a conversation. " }, "response": [ { "id": "3e36613f-5740-4360-975d-2ca81d0a3d2c", "name": "New Response", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) ", "key": "x-token", "value": "{YourAuthToken}" }, { "key": "Accept", "value": "*/*" } ], "url": { "raw": "{{baseUrl}}/:link", "host": [ "{{baseUrl}}" ], "path": [ ":link" ], "variable": [ { "key": "link" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "*/*" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-07-28T00:28:44.000Z", "updatedAt": "2026-07-28T00:28:44.000Z", "uid": "35240-3e36613f-5740-4360-975d-2ca81d0a3d2c" } ], "createdAt": "2026-07-28T00:28:44.000Z", "updatedAt": "2026-07-28T00:28:44.000Z", "uid": "35240-942b1d52-df0a-4915-b235-5190fc7bb293" } ], "id": "0d74bd47-4269-4d1f-8f3e-6703fdaf46c4", "createdAt": "2026-07-28T00:28:44.000Z", "updatedAt": "2026-07-28T00:28:44.000Z", "uid": "35240-0d74bd47-4269-4d1f-8f3e-6703fdaf46c4" } ], "variable": [ { "key": "baseUrl", "value": "https://video-agent.8x8.com/" } ] }