{ "openapi": "3.0.3", "info": { "title": "Convert Omnichannel", "version": "1.0.0", "contact": {} }, "servers": [ { "url": "https://{serverUrl}.convert.app.br" } ], "paths": { "/api/v1/livechat/rooms": { "get": { "tags": [ "Livechat - Salas" ], "summary": "Buscar lista de salas", "description": "livechat/rooms", "operationId": "livechatRooms", "parameters": [ { "name": "open", "in": "query", "schema": { "type": "string", "example": "false" } }, { "name": "withTagsColor", "in": "query", "schema": { "type": "string", "example": "true" } }, { "name": "sort", "in": "query", "schema": { "type": "string", "example": "{%22closedAt%22:-1}" } }, { "name": "withAgentsNames", "in": "query", "schema": { "type": "string", "example": "true" } }, { "name": "withVisitorDestinyChannel", "in": "query", "schema": { "type": "string", "example": "true" } }, { "name": "withVisitorPhone", "in": "query", "schema": { "type": "string", "example": "true" } }, { "name": "count", "in": "query", "schema": { "type": "string", "example": "25" } }, { "name": "roomIds", "in": "query", "schema": { "type": "string", "example": "NY8Gwaa6DtuZxvWMo" } }, { "name": "fields", "in": "query", "schema": { "type": "string", "example": "{\"departmentId\":1,\"departmentMain\":1}" } }, { "name": "token", "in": "query", "schema": { "type": "string", "example": "WHATS-5554992229295" } }, { "name": "x-requested-with", "in": "header", "schema": { "type": "string", "example": "{{x_requested_with}}" } }, { "name": "x-user-id", "in": "header", "schema": { "type": "string", "example": "{{x_user_id}}" } }, { "name": "x-auth-token", "in": "header", "schema": { "type": "string", "example": "{{x_auth_token}}" } } ], "responses": { "200": { "description": "" } } } }, "/api/v1/livechat/room": { "get": { "tags": [ "Livechat - Salas" ], "summary": "Buscar sala de atendimento", "operationId": "livechatRoom", "parameters": [ { "name": "token", "in": "query", "schema": { "type": "string", "example": "WHATS-5551998812844" } }, { "name": "rid", "in": "query", "schema": { "type": "string", "example": "RHrbWpixxeWmRmDLo" } }, { "name": "agentId", "in": "query", "schema": { "type": "string", "example": "arthur@convertcompany.com.br" } }, { "name": "x-requested-with", "in": "header", "schema": { "type": "string", "example": "{{x_requested_with}}" } }, { "name": "x-user-id", "in": "header", "schema": { "type": "string", "example": "{{x_user_id}}" } }, { "name": "x-auth-token", "in": "header", "schema": { "type": "string", "example": "{{x_auth_token}}" } } ], "responses": { "200": { "description": "" } } } }, "/api/v1/livechat/rooms/export": { "get": { "tags": [ "Livechat - Salas" ], "summary": "Exportar sala de atendimento", "description": "livechat/rooms/export", "operationId": "livechatRoomsExport", "parameters": [ { "name": "count", "in": "query", "schema": { "type": "string", "example": "6000" } }, { "name": "x-requested-with", "in": "header", "schema": { "type": "string", "example": "XMLHttpRequest" } }, { "name": "x-user-id", "in": "header", "schema": { "type": "string", "example": "MFKujjHvsvff5eFAs" } }, { "name": "x-auth-token", "in": "header", "schema": { "type": "string", "example": "ECCg8TugVL0T4Cc7hg1jiUUFrmM7CK2BbGV7yV6kNU_" } } ], "responses": { "200": { "description": "" } } } }, "/api/v1/livechat/room.create": { "post": { "tags": [ "Livechat - Salas" ], "summary": "Criar sala de atendimento", "description": "## POST > api/v1/livechat/room.create\n\n#### Descrição:\n\nO propósito dessa API é a criação de uma nova sala de atendimento.\n\n#### Request body (Schema):\n\n- 'platform' - String (obrigatório). Plataforma de atendimento, ex.: 'WHATS'.\n \n- 'channel' - String (obrigatório). Canal de destino, ex.: '555430468153'.\n \n- 'channelDescription' - String (obrigatório). Descrição do canal de destino, ex.: 'Convert 8153 (555430468153)'.\n \n- 'message' - String (obrigatório). Mensagem enviada pelo visitante, ex.: 'Bom dia!'.\n \n- 'visitor' - Objeto (obrigatório). Dados do visitante:\n - 'token' - String (obrigatório). Token do visitante, ex.: 'WHATS-5551998812844'.\n \n - 'name' - String (obrigatório). Nome do visitante, ex.: 'Arthur Dahmer (5551998812844)'.\n \n - 'phone' - String (obrigatório). Telefone do visitante, ex.: '5551998812844'.\n \n- 'room' - Objeto (obrigatório). Dados da sala:\n - 'tags' - Array (opcional). Tags da sala de atendimento, ex.: \\[\"Comercial\", \"Site\"\\].\n \n - 'topic' - String (opcional). Tópico, ex.: 'Primeiro Contato'.\n \n - 'livechatData' - Objeto (obrigatório). Campos personalizados da sala de atendimento, aqui também é possível adicionar mais campos personalizados da sala:\n - 'tipo_mensagem' - String (obrigatório). Tipo de atendimento, ex.: 'recaptiva'.\n \n\n#### Response body (Schema):\n\n- visitor - Objeto. Dados do visitante criado/atualizado.\n \n- room - Objeto. Dados da sala criada.\n \n- newRoom - Bool. Informativo se foi criada uma nova sala.\n \n- success - Bool. Status da requisição.", "operationId": "livechatRoomCreate", "parameters": [ { "name": "x-requested-with", "in": "header", "schema": { "type": "string", "example": "{{x_requested_with}}" } }, { "name": "x-user-id", "in": "header", "schema": { "type": "string", "example": "{{x_user_id}}" } }, { "name": "x-auth-token", "in": "header", "schema": { "type": "string", "example": "{{x_auth_token}}" } } ], "requestBody": { "content": { "application/json": { "examples": { "livechat/room.create": { "value": "{\r\n \"platform\": \"WHATS\",\r\n \"channel\": \"555430468151\",\r\n \"channelDescription\": \"555430468151\",\r\n \"department\": \"NkN4wr6wW2mEqPhSR\", // Entrada (54) 3046-8151\r\n \"message\": \"Bom dia Mundo!\",\r\n \"visitor\": {\r\n \"token\": \"WHATS-5551998812844\",\r\n \"name\": \"Arthur Dahmer (5551998812844)\",\r\n \"phone\": \"5551998812844\"\r\n },\r\n \"room\": {\r\n \"tags\": [\"Criação de Sala\", \"Teste\"],\r\n \"topic\": \"Teste Criação de Sala\",\r\n \"livechatData\": {\r\n \"tipo_mensagem\": \"ativa\",\r\n \"teste_room\": \"Teste Criação de Sala\"\r\n }\r\n }\r\n}" } } } } }, "responses": { "200": { "description": "" } } } }, "/api/v1/livechat/room.survey": { "post": { "tags": [ "Livechat - Salas" ], "summary": "Atualizar NPS da sala", "description": "> api/v1/livechat/room.survey \n \n\n#### **Requer Autenticação?**\n\nNão\n\n#### **Descrição:**\n\nO objetivo desta API é registrar/atualizar o NPS de uma sala.\n\n#### **Parâmetros:**\n\n- **rid** \\[String\\] - obrigatório, ID da sala.\n- **token** \\[String\\] - obrigatório, token do convidado/visitante da sala (ex.: 'WHATS-5554988776655'). No objeto da sala essa informação pode ser obtida em 'v.token'.\n \n- data \\[Object\\] - obrigatório, composto obrigatóriamente por um array de objetos com as chaves 'name' \\[String\\] e 'value' \\[String\\].", "operationId": "livechatRoomSurvey", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "example": "satisfaction" }, "value": { "type": "string", "example": "5" } } }, "example": [ { "name": "satisfaction", "value": "5" }, { "name": "additionalFeedback", "value": "Ótimo!" }, { "name": "sent", "value": "1" } ] }, "rid": { "type": "string", "example": "Ha4BYxfjdgWt723eM" }, "token": { "type": "string", "example": "WHATS-5551998812844" } } }, "examples": { "livechat/room.survey": { "value": { "data": [ { "name": "satisfaction", "value": "5" }, { "name": "additionalFeedback", "value": "Ótimo!" }, { "name": "sent", "value": "1" } ], "rid": "Ha4BYxfjdgWt723eM", "token": "WHATS-5551998812844" } } } } } }, "responses": { "200": { "description": "" } } } }, "/api/v1/livechat/room.tabulacao": { "post": { "tags": [ "Livechat - Salas" ], "summary": "Atualizar classificação da sala", "description": "livechat/room.tabulacao", "operationId": "livechatRoomTabulacao", "parameters": [ { "name": "x-requested-with", "in": "header", "schema": { "type": "string", "example": "XMLHttpRequest" } }, { "name": "x-user-id", "in": "header", "schema": { "type": "string", "example": "admin.convert" } }, { "name": "x-auth-token", "in": "header", "schema": { "type": "string", "example": "Oq0kjQdxc-NeHQ6QSqlefPxph6iVqy9r9gdBWnYGphb" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "rid": { "type": "string", "example": "AaPraPyp9M7w37ZbX" }, "statusTabulacao": { "type": "string", "example": "Status Tabulacao Teste 4" }, "tabulacao": { "type": "string", "example": "Tabulacao Teste 2" } } }, "examples": { "livechat/room.tabulacao": { "value": { "rid": "AaPraPyp9M7w37ZbX", "statusTabulacao": "Status Tabulacao Teste 4", "tabulacao": "Tabulacao Teste 2" } } } } } }, "responses": { "200": { "description": "" } } } }, "/api/v1/livechat/room.tag": { "post": { "tags": [ "Livechat - Salas" ], "summary": "Atualizar tags da sala", "description": "livechat/room.tag", "operationId": "livechatRoomTag", "parameters": [ { "name": "x-requested-with", "in": "header", "schema": { "type": "string", "example": "XMLHttpRequest" } }, { "name": "x-user-id", "in": "header", "schema": { "type": "string", "example": "admin.convert" } }, { "name": "x-auth-token", "in": "header", "schema": { "type": "string", "example": "Oq0kjQdxc-NeHQ6QSqlefPxph6iVqy9r9gdBWnYGphb" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "rid": { "type": "string", "example": "AaPraPyp9M7w37ZbX" }, "tag": { "type": "string", "example": "Tag1" } } }, "examples": { "livechat/room.tag": { "value": { "rid": "AaPraPyp9M7w37ZbX", "tag": "Tag1" } } } } } }, "responses": { "200": { "description": "" } } } }, "/api/v1/livechat/room.forward": { "post": { "tags": [ "Livechat - Salas" ], "summary": "Transferir atendimento", "description": "### **Requer Autenticação?**\n\nSim\n\n### **Descrição**\n\nO objetivo desta API é buscar todas as configurações públicas da plataforma.\n\n### **Parâmetros**\n\n- `offset` - opcional \\[String\\]. Quantia de dados que serão pulados/ignorados antes de retornar o resultado.\n- `count` - opcional \\[String\\]. Quantia limite de dados retornados, o padrão é 50. É possível deixar ilimitado a quantia de dados de retorno ao informar o valor 0 (zero).\n- `sort` - opcional \\[JSON\\]. Ordenação dos dados de retorno. Ex.: { \"_id\": -1 } .\n- `fields` - opcional \\[JSON\\]. Campos que serão inseridos nos dados de retorno de cada Setting.\n- `query` - opcional \\[JSON\\]. Utilizado para inserir uma query específica junto do restante da pesquisa. Ex.: {\"_id\": { \"$in\": \\[\"Livechat_ConvertOmniChannelNpsScore\"\\] } }.\n \n\n### Resposta\n\nPor padrão, são retornados apenas os seguintes campos das Settings: __id_, _value_, _enterprise_, _invalidValue_ e _modules_.", "operationId": "livechatRoomForward", "parameters": [ { "name": "x-requested-with", "in": "header", "schema": { "type": "string", "example": "{{x_requested_with}}" } }, { "name": "x-user-id", "in": "header", "schema": { "type": "string", "example": "{{x_user_id}}" } }, { "name": "x-auth-token", "in": "header", "schema": { "type": "string", "example": "{{x_auth_token}}" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "departmentId": { "type": "string", "example": "" }, "roomId": { "type": "string", "example": "GemPWJuAnqkZCaz6y" }, "userId": { "type": "string", "example": "rvKGNR82yQSuQopfg" } } }, "examples": { "livechat/room.forward": { "value": { "departmentId": "", "roomId": "GemPWJuAnqkZCaz6y", "userId": "rvKGNR82yQSuQopfg" } } } } } }, "responses": { "200": { "description": "" } } } }, "/api/v1/livechat/rooms/servedNumbers": { "post": { "tags": [ "Livechat - Salas" ], "summary": "Buscar atendimentos por contato", "description": "livechat/rooms/servedNumbers", "operationId": "livechatRoomsServednumbers", "parameters": [ { "name": "x-requested-with", "in": "header", "schema": { "type": "string", "example": "XMLHttpRequest" } }, { "name": "x-user-id", "in": "header", "schema": { "type": "string", "example": "MFKujjHvsvff5eFAs" } }, { "name": "x-auth-token", "in": "header", "schema": { "type": "string", "example": "ECCg8TugVL0T4Cc7hg1jiUUFrmM7CK2BbGV7yV6kNU_" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "tokens": { "type": "array", "items": { "type": "string", "example": "WHATS-555499345104" }, "example": [ "WHATS-555499345104", "WHATS-5551998812844" ] } } }, "examples": { "livechat/rooms/servedNumbers": { "value": { "tokens": [ "WHATS-555499345104", "WHATS-5551998812844" ] } } } } } }, "responses": { "200": { "description": "" } } } }, "/api/v1/livechat/users/{type}": { "get": { "tags": [ "api/v1", "livechat/" ], "summary": "livechat/users/:type", "description": "### **Requer Autenticação?**\n\n### **Descrição**\n\n### **Parâmetros**\n\n### Resposta", "operationId": "livechatUsersType", "parameters": [ { "name": "x-requested-with", "in": "header", "schema": { "type": "string", "example": "{{x_requested_with}}" } }, { "name": "x-user-id", "in": "header", "schema": { "type": "string", "example": "{{x_user_id}}" } }, { "name": "x-auth-token", "in": "header", "schema": { "type": "string", "example": "{{x_auth_token}}" } } ], "responses": { "200": { "description": "" } } }, "parameters": [ { "name": "type", "in": "path", "required": true, "schema": { "type": "string", "example": "agent" } } ] }, "/api/v1/livechat/users/{type}/{_id}": { "get": { "tags": [ "api/v1", "livechat/" ], "summary": "livechat/users/:type/:_id", "description": "### **Requer Autenticação?**\n\n### **Descrição**\n\n### **Parâmetros**\n\n_id - pode ser o id do usuário ou seu username.\n\n### Resposta", "operationId": "livechatUsersTypeId", "parameters": [ { "name": "x-requested-with", "in": "header", "schema": { "type": "string", "example": "{{x_requested_with}}" } }, { "name": "x-user-id", "in": "header", "schema": { "type": "string", "example": "{{x_user_id}}" } }, { "name": "x-auth-token", "in": "header", "schema": { "type": "string", "example": "{{x_auth_token}}" } } ], "responses": { "200": { "description": "" } } }, "parameters": [ { "name": "type", "in": "path", "required": true, "schema": { "type": "string", "example": "agent" } }, { "name": "_id", "in": "path", "required": true, "schema": { "type": "string", "example": "airton@convertcompany.com.br" } } ] }, "/api/v1/livechat/agents/{agentId}/departments": { "get": { "tags": [ "api/v1", "livechat/" ], "summary": "livechat/agents/:agentId/departments", "description": "### **Requer Autenticação?**\n\n### **Descrição**\n\n### **Parâmetros**\n\n### Resposta", "operationId": "livechatAgentsAgentidDepartments", "parameters": [ { "name": "enabledDepartmentsOnly", "in": "query", "schema": { "type": "string", "example": "true" } }, { "name": "x-requested-with", "in": "header", "schema": { "type": "string", "example": "{{x_requested_with}}" } }, { "name": "x-user-id", "in": "header", "schema": { "type": "string", "example": "{{x_user_id}}" } }, { "name": "x-auth-token", "in": "header", "schema": { "type": "string", "example": "{{x_auth_token}}" } } ], "responses": { "200": { "description": "" } } }, "parameters": [ { "name": "agentId", "in": "path", "required": true, "schema": { "type": "string", "example": "tuDCW3LAhTy9iA5Qk" } } ] }, "/api/v1/livechat/agents/{agentId}/departmentsWithNames": { "get": { "tags": [ "api/v1", "livechat/" ], "summary": "livechat/agents/:agentId/departmentsWithNames", "description": "### **Requer Autenticação?**\n\n### **Descrição**\n\n### **Parâmetros**\n\n### Resposta", "operationId": "livechatAgentsAgentidDepartmentswithnames", "parameters": [ { "name": "enabledDepartmentsOnly", "in": "query", "schema": { "type": "string", "example": "true" } }, { "name": "x-requested-with", "in": "header", "schema": { "type": "string", "example": "{{x_requested_with}}" } }, { "name": "x-user-id", "in": "header", "schema": { "type": "string", "example": "{{x_user_id}}" } }, { "name": "x-auth-token", "in": "header", "schema": { "type": "string", "example": "{{x_auth_token}}" } } ], "responses": { "200": { "description": "" } } }, "parameters": [ { "name": "agentId", "in": "path", "required": true, "schema": { "type": "string", "example": "tuDCW3LAhTy9iA5Qk" } } ] }, "/api/v1/livechat/agent.transfer.rooms": { "post": { "tags": [ "api/v1", "livechat/" ], "summary": "livechat/agent.transfer.rooms", "description": "### **Requer Autenticação?**\n\n### **Descrição**\n\n### **Parâmetros**\n\n### Resposta", "operationId": "livechatAgentTransferRooms", "parameters": [ { "name": "x-requested-with", "in": "header", "schema": { "type": "string", "example": "{{x_requested_with}}" } }, { "name": "x-user-id", "in": "header", "schema": { "type": "string", "example": "{{x_user_id}}" } }, { "name": "x-auth-token", "in": "header", "schema": { "type": "string", "example": "{{x_auth_token}}" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "destinationAgentId": { "type": "string", "example": "arthur@convertcompany.com.br" }, "originAgentId": { "type": "string", "example": "airton@convertcompany.com.br" } } }, "examples": { "livechat/agent.transfer.rooms": { "value": { "destinationAgentId": "arthur@convertcompany.com.br", "originAgentId": "airton@convertcompany.com.br" } } } } } }, "responses": { "200": { "description": "" } } } }, "/api/v1/livechat/department": { "get": { "tags": [ "Livechat - Departamentos" ], "summary": "Buscar departamentos", "description": "livechat/department", "operationId": "livechatDepartment", "parameters": [ { "name": "count", "in": "query", "schema": { "type": "string", "example": "2" } }, { "name": "x-requested-with", "in": "header", "schema": { "type": "string", "example": "{{x_requested_with}}" } }, { "name": "x-user-id", "in": "header", "schema": { "type": "string", "example": "{{x_user_id}}" } }, { "name": "x-auth-token", "in": "header", "schema": { "type": "string", "example": "{{x_auth_token}}" } } ], "responses": { "200": { "description": "" } } }, "post": { "tags": [ "Livechat - Departamentos" ], "summary": "Cadastrar um novo departamento", "description": "livechat/department", "operationId": "livechatDepartment1", "parameters": [ { "name": "x-requested-with", "in": "header", "schema": { "type": "string", "example": "XMLHttpRequest" } }, { "name": "x-user-id", "in": "header", "schema": { "type": "string", "example": "MFKujjHvsvff5eFAs" } }, { "name": "x-auth-token", "in": "header", "schema": { "type": "string", "example": "ECCg8TugVL0T4Cc7hg1jiUUFrmM7CK2BbGV7yV6kNU_" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "agents": { "type": "array", "items": {}, "example": [] }, "department": { "type": "object", "properties": { "color": { "type": "string", "example": "#0077ff" }, "description": { "type": "string", "example": "Teste 1" }, "email": { "type": "string", "example": "teste@teste.com" }, "enabled": { "type": "boolean", "example": true }, "name": { "type": "string", "example": "Teste 1" }, "showOnOfflineForm": { "type": "boolean", "example": true }, "showOnRegistration": { "type": "boolean", "example": true } } } } }, "examples": { "livechat/department": { "value": { "agents": [], "department": { "color": "#0077ff", "description": "Teste 1", "email": "teste@teste.com", "enabled": true, "name": "Teste 1", "showOnOfflineForm": true, "showOnRegistration": true } } } } } } }, "responses": { "200": { "description": "" } } } }, "/api/v1/livechat/department/{departmentId}": { "get": { "tags": [ "Livechat - Departamentos" ], "summary": "Buscar departamento por id", "description": "livechat/department/:_id", "operationId": "livechatDepartmentId", "parameters": [ { "name": "x-requested-with", "in": "header", "schema": { "type": "string", "example": "{{x_requested_with}}" } }, { "name": "x-user-id", "in": "header", "schema": { "type": "string", "example": "{{x_user_id}}" } }, { "name": "x-auth-token", "in": "header", "schema": { "type": "string", "example": "{{x_auth_token}}" } } ], "responses": { "200": { "description": "" } } }, "parameters": [ { "name": "departmentId", "in": "path", "required": true, "schema": { "type": "string", "example": "oyohkTYw6AyQzx86F" } } ] }, "/api/v1/livechat/visitors.search": { "get": { "tags": [ "Livechat - Contatos" ], "summary": "Buscar contatos", "description": "### **Requer Autenticação?**\n\n### **Descrição**\n\n### **Parâmetros**\n\n### Resposta", "operationId": "livechatVisitorsSearch", "parameters": [ { "name": "term", "in": "query", "schema": { "type": "string", "example": "teste" } }, { "name": "offset", "in": "query", "schema": { "type": "string", "example": "" } }, { "name": "count", "in": "query", "schema": { "type": "string", "example": "0" } }, { "name": "sort", "in": "query", "schema": { "type": "string", "example": "" } }, { "name": "x-requested-with", "in": "header", "schema": { "type": "string", "example": "{{x_requested_with}}" } }, { "name": "x-user-id", "in": "header", "schema": { "type": "string", "example": "{{x_user_id}}" } }, { "name": "x-auth-token", "in": "header", "schema": { "type": "string", "example": "{{x_auth_token}}" } } ], "responses": { "200": { "description": "" } } } }, "/api/v1/livechat/visitors.info": { "get": { "tags": [ "Livechat - Contatos" ], "summary": "Buscar informações do contato", "description": "### **Requer Autenticação?**\n\n### **Descrição**\n\n### **Parâmetros**\n\n### Resposta", "operationId": "livechatVisitorsInfo", "parameters": [ { "name": "visitorId", "in": "query", "schema": { "type": "string", "example": "w7JD8Ek4xm3mk2rkn" } }, { "name": "x-requested-with", "in": "header", "schema": { "type": "string", "example": "{{x_requested_with}}" } }, { "name": "x-user-id", "in": "header", "schema": { "type": "string", "example": "{{x_user_id}}" } }, { "name": "x-auth-token", "in": "header", "schema": { "type": "string", "example": "{{x_auth_token}}" } } ], "responses": { "200": { "description": "" } } } }, "/api/v1/livechat/visitor/{token}": { "get": { "tags": [ "Livechat - Contatos" ], "summary": "Buscar informações do contato (token)", "description": "### **Requer Autenticação?**\n\n### **Descrição**\n\n### **Parâmetros**\n\n### Resposta", "operationId": "livechatVisitorToken", "parameters": [ { "name": "x-requested-with", "in": "header", "schema": { "type": "string", "example": "{{x_requested_with}}" } }, { "name": "x-user-id", "in": "header", "schema": { "type": "string", "example": "{{x_user_id}}" } }, { "name": "x-auth-token", "in": "header", "schema": { "type": "string", "example": "{{x_auth_token}}" } } ], "responses": { "200": { "description": "" } } }, "delete": { "tags": [ "Livechat - Contatos" ], "summary": "Deletar contato", "description": "### **Requer Autenticação?**\n\n### **Descrição**\n\n### **Parâmetros**\n\n### Resposta", "operationId": "livechatVisitorToken1", "parameters": [ { "name": "x-requested-with", "in": "header", "schema": { "type": "string", "example": "{{x_requested_with}}" } }, { "name": "x-user-id", "in": "header", "schema": { "type": "string", "example": "{{x_user_id}}" } }, { "name": "x-auth-token", "in": "header", "schema": { "type": "string", "example": "{{x_auth_token}}" } } ], "responses": { "200": { "description": "" } } }, "parameters": [ { "name": "token", "in": "path", "required": true, "schema": { "type": "string", "example": "WHATS-5554987654321" } } ] }, "/api/v1/livechat/visitor": { "post": { "tags": [ "Livechat - Contatos" ], "summary": "Cadastrar um contato", "description": "### **Requer Autenticação?**\n\n### **Descrição**\n\n### **Parâmetros**\n\n### Resposta", "operationId": "livechatVisitor", "parameters": [ { "name": "x-requested-with", "in": "header", "schema": { "type": "string", "example": "{{x_requested_with}}" } }, { "name": "x-user-id", "in": "header", "schema": { "type": "string", "example": "{{x_user_id}}" } }, { "name": "x-auth-token", "in": "header", "schema": { "type": "string", "example": "{{x_auth_token}}" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "visitor": { "type": "object", "properties": { "token": { "type": "string", "example": "WHATS-5551998812844" } } } } }, "examples": { "livechat/visitor": { "value": { "visitor": { "token": "WHATS-5551998812844" } } } } } } }, "responses": { "200": { "description": "" } } } }, "/api/v1/livechat/channelsSelect": { "get": { "tags": [ "api/v1", "livechat/" ], "summary": "livechat/channelsSelect", "description": "livechat/channelsSelect", "operationId": "livechatChannelsselect", "parameters": [ { "name": "onlyWhats", "in": "query", "schema": { "type": "string", "example": "true" } }, { "name": "x-requested-with", "in": "header", "schema": { "type": "string", "example": "{{x_requested_with}}" } }, { "name": "x-user-id", "in": "header", "schema": { "type": "string", "example": "{{x_user_id}}" } }, { "name": "x-auth-token", "in": "header", "schema": { "type": "string", "example": "{{x_auth_token}}" } } ], "responses": { "200": { "description": "" } } } }, "/api/v1/livechat/channels": { "get": { "tags": [ "api/v1", "livechat/" ], "summary": "livechat/channels", "description": "livechat/channels", "operationId": "livechatChannels", "parameters": [ { "name": "count", "in": "query", "schema": { "type": "string", "example": "0" } }, { "name": "x-requested-with", "in": "header", "schema": { "type": "string", "example": "{{x_requested_with}}" } }, { "name": "x-user-id", "in": "header", "schema": { "type": "string", "example": "{{x_user_id}}" } }, { "name": "x-auth-token", "in": "header", "schema": { "type": "string", "example": "{{x_auth_token}}" } } ], "responses": { "200": { "description": "" } } } }, "/api/v1/livechat/channels/{_id}": { "get": { "tags": [ "api/v1", "livechat/" ], "summary": "livechat/channels/:_id", "description": "livechat/channels/:_id", "operationId": "livechatChannelsId", "parameters": [ { "name": "x-requested-with", "in": "header", "schema": { "type": "string", "example": "{{x_requested_with}}" } }, { "name": "x-user-id", "in": "header", "schema": { "type": "string", "example": "{{x_user_id}}" } }, { "name": "x-auth-token", "in": "header", "schema": { "type": "string", "example": "{{x_auth_token}}" } } ], "responses": { "200": { "description": "" } } }, "parameters": [ { "name": "_id", "in": "path", "required": true, "schema": { "type": "string", "example": "bMQKwPgLXRwYENdns" } } ] }, "/api/v1/livechat/channelByIdentificador/{identificador}": { "get": { "tags": [ "api/v1", "livechat/" ], "summary": "livechat/channelByIdentificador/:identificador", "description": "> api/v1/livechat/channelByIdentificador/:identificador?departmentId= \n \n\n#### **Requer Autenticação?**\n\nSim\n\n#### **Descrição:**\n\nO objetivo desta API é buscar todas as informações de um determinado Canal, trazendo também as informações do seu Fluxo de destino (através do Id do Fluxo presente no Canal).\n\n#### **Parâmetros:**\n\n- **identificador** - obrigatório, campo identificador do Canal, normalmente o número da linha (ex.: 5554988776655).\n- **departmentId** - opcional, ID de um departamento presente nos Fluxos Avançados do Canal em questão. Caso esse parâmetro seja informado, compreende-se que se está buscando um Fluxo Avançado. Obtido através da consulta do ID do Fluxo associado a esse ID de departamento e não ao ID de Fluxo padrão do Canal. Dessa forma, caso a pesquisa dessa novo ID de Fluxo seja realizada com sucesso, no objeto de retorno é retornado o objeto do Fluxo identificado como 'fluxoAvancadoObj', ao invés de 'fluxoObj', que seria o retorno padrão. Caso esse ID de departamento informado não esteja nos Fluxos Avançados do Canal, seja inválido ou o ID de Fluxo associado a ele seja inválido, a obtenção de dados continua, o utilizando o ID de Fluxo padrão do Canal.", "operationId": "livechatChannelbyidentificadorIdentificador", "parameters": [ { "name": "departmentId", "in": "query", "schema": { "type": "string", "example": "Prge4wZMmsAqdKZ3N" } }, { "name": "x-requested-with", "in": "header", "schema": { "type": "string", "example": "{{x_requested_with}}" } }, { "name": "x-user-id", "in": "header", "schema": { "type": "string", "example": "{{x_user_id}}" } }, { "name": "x-auth-token", "in": "header", "schema": { "type": "string", "example": "{{x_auth_token}}" } } ], "responses": { "200": { "description": "" } } }, "parameters": [ { "name": "identificador", "in": "path", "required": true, "schema": { "type": "string", "example": "555430468151" } } ] }, "/api/v1/livechat/omni-integrations/saldo": { "get": { "tags": [ "api/v1", "livechat/" ], "summary": "livechat/omni-integrations/saldo", "description": "livechat/omni-integrations/saldo", "operationId": "livechatOmniIntegrationsSaldo", "parameters": [ { "name": "x-requested-with", "in": "header", "schema": { "type": "string", "example": "XMLHttpRequest" } }, { "name": "x-user-id", "in": "header", "schema": { "type": "string", "example": "MFKujjHvsvff5eFAs" } }, { "name": "x-auth-token", "in": "header", "schema": { "type": "string", "example": "ECCg8TugVL0T4Cc7hg1jiUUFrmM7CK2BbGV7yV6kNU_" } } ], "responses": { "200": { "description": "" } } } }, "/api/v1/livechat/analytics/dashboards/kpis": { "get": { "tags": [ "api/v1", "livechat/" ], "summary": "livechat/analytics/dashboards/kpis", "description": "livechat/analytics/dashboards/kpis", "operationId": "livechatAnalyticsDashboardsKpis", "parameters": [ { "name": "x-requested-with", "in": "header", "schema": { "type": "string", "example": "XMLHttpRequest" } }, { "name": "x-user-id", "in": "header", "schema": { "type": "string", "example": "admin.convert" } }, { "name": "x-auth-token", "in": "header", "schema": { "type": "string", "example": "-00yc2vHWdq_XGVWbH_NO4NZZ1PR4fWdSU0b6_5myL1" } } ], "responses": { "200": { "description": "" } } } }, "/api/v1/livechat/templatesFiltered": { "get": { "tags": [ "api/v1", "livechat/" ], "summary": "livechat/templatesFiltered", "description": "### **Requer Autenticação?**\n\n### **Descrição**\n\n### **Parâmetros**\n\n_id - pode ser o id do usuário ou seu username.\n\n### Resposta", "operationId": "livechatTemplatesfiltered", "parameters": [ { "name": "text", "in": "query", "schema": { "type": "string", "example": "teste" } }, { "name": "onlyAvailable", "in": "query", "schema": { "type": "string", "example": "true" } }, { "name": "x-requested-with", "in": "header", "schema": { "type": "string", "example": "{{x_requested_with}}" } }, { "name": "x-user-id", "in": "header", "schema": { "type": "string", "example": "{{x_user_id}}" } }, { "name": "x-auth-token", "in": "header", "schema": { "type": "string", "example": "{{x_auth_token}}" } } ], "responses": { "200": { "description": "" } } } }, "/api/v1/livechat/templates/fetch": { "post": { "tags": [ "api/v1", "livechat/" ], "summary": "livechat/templates/fetch", "description": "livechat/templates/fetch", "operationId": "livechatTemplatesFetch", "parameters": [ { "name": "x-requested-with", "in": "header", "schema": { "type": "string", "example": "{{x_requested_with}}" } }, { "name": "x-user-id", "in": "header", "schema": { "type": "string", "example": "{{x_user_id}}" } }, { "name": "x-auth-token", "in": "header", "schema": { "type": "string", "example": "{{x_auth_token}}" } } ], "responses": { "200": { "description": "" } } } }, "/api/v1/livechat/templates/send": { "post": { "tags": [ "api/v1", "livechat/" ], "summary": "livechat/templates/send", "description": "### \\[POST\\] api/v1/livechat/templates/send\n\n### ✅ Requer Autenticação\n\n### 📝 Descrição\n\nO propósito dessa API é o envio de um Template.\n\n### ➡️ Request Body\n\n- `id_broker` (string): ID do template no Broker.\n \n- `username` (string): Usuário do número de destino (WHATS + número).\n \n- `numero` (string): Número do canal de origem (portador do template).\n \n- `department` (string): ID do departamento.\n \n- `agentSelected` (string): ID do agente (opcional). Esse parâmetro é opcional somente se 'create_room' for igual a false.\n \n- `vars` (array): Variáveis do template (opcional).\n \n- `midia` (object): Dados da mídia do template (opcional).\n \n- `fields` (array): Campos adicionais que serão inseridos a sala ou ao visitante (opcional).\n \n- `campanha` (string): Título da Campanha, será adicionado como tópico (opcional).\n \n- `previewMsg` (string): Mensagem principal do template (opcional). Caso não seja informado, a própria API se encarrega de preenche-lo.\n \n- `nomeContato` (array): Nome do contato de destino, para atualização na central de contatos (opcional).\n \n- `create_room` (boolean): Define se será criada uma sala (opcional), seu valor padrão é true.\n \n- `hide_room` (boolean): Define se será criada a sala como oculta (opcional), seu valor padrão é false.\n \n\n### ⬅️ Response\n\n- `success` (boolean): Status da requisição.\n \n- `status` (number): Código do status da requisição.\n \n- `message` (string): Mensagem de retorno.\n \n- `aditionalInfo` (string): Informações adicionais da requisição.\n \n- `codAtendimento` (number): Código do atendimento em que foi enviado o template.", "operationId": "livechatTemplatesSend", "parameters": [ { "name": "x-requested-with", "in": "header", "schema": { "type": "string", "example": "{{x_requested_with}}" } }, { "name": "x-user-id", "in": "header", "schema": { "type": "string", "example": "{{x_user_id}}" } }, { "name": "x-auth-token", "in": "header", "schema": { "type": "string", "example": "{{x_auth_token}}" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "create_room": { "type": "boolean", "example": false }, "department": { "type": "string", "example": "dWkxryyiDg5sZPFmp" }, "id_broker": { "type": "string", "example": "a87c89bc-4ac3-45f8-b57e-e4850facc68d" }, "numero": { "type": "string", "example": "555430468151" }, "previewMsg": { "type": "string", "example": "Podemos conversar agora?" }, "username": { "type": "string", "example": "WHATS-5551998812844" } } }, "examples": { "livechat/templates/send": { "value": { "create_room": false, "department": "dWkxryyiDg5sZPFmp", "id_broker": "a87c89bc-4ac3-45f8-b57e-e4850facc68d", "numero": "555430468151", "previewMsg": "Podemos conversar agora?", "username": "WHATS-5551998812844" } } } } } }, "responses": { "200": { "description": "" } } } }, "/api/v1/livechat/templates/send.status": { "post": { "tags": [ "api/v1", "livechat/" ], "summary": "livechat/templates/send.status", "description": "### \\[POST\\] /api/v1/livechat/templates/send.status\n\n### ✅ Requer Autenticação\n\n### 📝 Descrição\n\nO propósito dessa API é verificar o status de envio de Templates.\n\n### ➡️ Request Body\n\n- `channel` {string|array}: Canal ou canais de origem do template.\n \n- `destination` {string} (opcional): Número do contato de destino do template. Podendo ser omitido, retornando todos os templates sem levar em consideração o número de destino.\n \n- `date` {string}: Data do envio dos templates (no formato 'YYYY-MM-DD').\n \n\n### ⬅️ Response Body\n\n- `status` {number}: Código do status da requisição.\n \n- `templates` {array}: Templates obtidos.\n \n- `count` {number}: Contagem dos templates obtidos.\n \n- `message` {string}: Mensagem de erro, caso algum ocorra.\n \n- `success` {boolean}: Status da requisição.", "operationId": "livechatTemplatesSendStatus", "parameters": [ { "name": "x-requested-with", "in": "header", "schema": { "type": "string", "example": "{{x_requested_with}}" } }, { "name": "x-user-id", "in": "header", "schema": { "type": "string", "example": "{{x_user_id}}" } }, { "name": "x-auth-token", "in": "header", "schema": { "type": "string", "example": "{{x_auth_token}}" } } ], "requestBody": { "content": { "application/json": { "examples": { "livechat/templates/send.status": { "value": "{\r\n \"channel\": \"555430468151\", // [ \"555430468151\", \"555430468153\"]\r\n \"destination\": \"555198812844\", // opcional\r\n \"date\": \"2024-06-12\"\r\n}" } } } } }, "responses": { "200": { "description": "" } } } }, "/api/v1/livechat/tags.delete": { "post": { "tags": [ "api/v1", "livechat/" ], "summary": "livechat/tags.delete", "description": "### \\[POST\\] /api/v1/livechat/tags.delete\n\n### ✅ Requer Autenticação\n\n### 📝 Descrição\n\nO propósito dessa API é realizar a remoção de uma ou mais tags.\n\n### ➡️ Request Body\n\n- `tagsId` {array}: Array de IDs das Tags.\n \n\n### ⬅️ Response Body\n\n- `count` {number}: Contagem de tags removidas.\n \n- `success` {boolean}: Status da requisição.", "operationId": "livechatTagsDelete", "parameters": [ { "name": "x-requested-with", "in": "header", "schema": { "type": "string", "example": "{{x_requested_with}}" } }, { "name": "x-user-id", "in": "header", "schema": { "type": "string", "example": "{{x_user_id}}" } }, { "name": "x-auth-token", "in": "header", "schema": { "type": "string", "example": "{{x_auth_token}}" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "tagsId": { "type": "array", "items": { "type": "string", "example": "Yu9W5gdKb3dNzXZrq" }, "example": [ "Yu9W5gdKb3dNzXZrq", "ZBFtJjXrimDRtkbSn" ] } } }, "examples": { "livechat/tags.delete": { "value": { "tagsId": [ "Yu9W5gdKb3dNzXZrq", "ZBFtJjXrimDRtkbSn" ] } } } } } }, "responses": { "200": { "description": "" } } } }, "/api/v1/livechat/visitors.delete": { "post": { "tags": [ "api/v1", "livechat/" ], "summary": "livechat/visitors.delete", "description": "### \\[POST\\] /api/v1/livechat/visitors.delete\n\n### ✅ Requer Autenticação\n\n### 📝 Descrição\n\nO propósito dessa API é realizar a remoção de um ou mais Contatos (visitors).\n\n### ➡️ Request Body\n\n- `tagsId` {array}: Array de IDs das Tags.\n \n\n### ⬅️ Response Body\n\n- `count` {number}: Contagem de tags removidas.\n \n- `success` {boolean}: Status da requisição.", "operationId": "livechatVisitorsDelete", "parameters": [ { "name": "x-requested-with", "in": "header", "schema": { "type": "string", "example": "{{x_requested_with}}" } }, { "name": "x-user-id", "in": "header", "schema": { "type": "string", "example": "{{x_user_id}}" } }, { "name": "x-auth-token", "in": "header", "schema": { "type": "string", "example": "{{x_auth_token}}" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "visitorsId": { "type": "array", "items": { "type": "string", "example": "Yu9W5gdKb3dNzXZrq" }, "example": [ "Yu9W5gdKb3dNzXZrq", "ZBFtJjXrimDRtkbSn" ] } } }, "examples": { "livechat/visitors.delete": { "value": { "visitorsId": [ "Yu9W5gdKb3dNzXZrq", "ZBFtJjXrimDRtkbSn" ] } } } } } }, "responses": { "200": { "description": "" } } } }, "/api/v1/livechat/flows": { "get": { "tags": [ "api/v1", "livechat/" ], "summary": "livechat/flows", "description": "livechat/flows", "operationId": "livechatFlows", "parameters": [ { "name": "x-requested-with", "in": "header", "schema": { "type": "string", "example": "XMLHttpRequest" } }, { "name": "x-user-id", "in": "header", "schema": { "type": "string", "example": "MFKujjHvsvff5eFAs" } }, { "name": "x-auth-token", "in": "header", "schema": { "type": "string", "example": "ECCg8TugVL0T4Cc7hg1jiUUFrmM7CK2BbGV7yV6kNU_" } } ], "responses": { "200": { "description": "" } } } }, "/api/v1/livechat/flows/{_id}": { "get": { "tags": [ "api/v1", "livechat/" ], "summary": "livechat/flows/:_id", "description": "livechat/flows/:_id", "operationId": "livechatFlowsId", "parameters": [ { "name": "x-requested-with", "in": "header", "schema": { "type": "string", "example": "XMLHttpRequest" } }, { "name": "x-user-id", "in": "header", "schema": { "type": "string", "example": "MFKujjHvsvff5eFAs" } }, { "name": "x-auth-token", "in": "header", "schema": { "type": "string", "example": "ECCg8TugVL0T4Cc7hg1jiUUFrmM7CK2BbGV7yV6kNU_" } } ], "responses": { "200": { "description": "" } } }, "parameters": [ { "name": "_id", "in": "path", "required": true, "schema": { "type": "string", "example": "2LiomCBuSppwm5Ngy" } } ] }, "/api/v1/livechat/custom-fields": { "get": { "tags": [ "api/v1", "livechat/" ], "summary": "livechat/custom-fields", "description": "livechat/custom-fields", "operationId": "livechatCustomFields", "parameters": [ { "name": "x-requested-with", "in": "header", "schema": { "type": "string", "example": "{{x_requested_with}}" } }, { "name": "x-user-id", "in": "header", "schema": { "type": "string", "example": "{{x_user_id}}" } }, { "name": "x-auth-token", "in": "header", "schema": { "type": "string", "example": "{{x_auth_token}}" } } ], "responses": { "200": { "description": "" } } } }, "/api/v1/livechat/custom.field": { "post": { "tags": [ "api/v1", "livechat/" ], "summary": "livechat/custom.field", "description": "livechat/custom.field", "operationId": "livechatCustomField", "parameters": [ { "name": "x-requested-with", "in": "header", "schema": { "type": "string", "example": "{{x_requested_with}}" } }, { "name": "x-user-id", "in": "header", "schema": { "type": "string", "example": "{{x_user_id}}" } }, { "name": "x-auth-token", "in": "header", "schema": { "type": "string", "example": "{{x_auth_token}}" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "key": { "type": "string", "example": "tipo_mensagem" }, "overwrite": { "type": "boolean", "example": true }, "token": { "type": "string", "example": "WHATS-5551998812844" }, "value": { "type": "string", "example": "PORQUE ISSO ACONTECE COMIGO DNV" } } }, "examples": { "livechat/custom.field": { "value": { "key": "tipo_mensagem", "overwrite": true, "token": "WHATS-5551998812844", "value": "PORQUE ISSO ACONTECE COMIGO DNV" } } } } } }, "responses": { "200": { "description": "" } } } }, "/api/v1/livechat/custom.fields": { "post": { "tags": [ "api/v1", "livechat/" ], "summary": "livechat/custom.fields", "description": "livechat/custom.fields", "operationId": "livechatCustomFields1", "parameters": [ { "name": "x-requested-with", "in": "header", "schema": { "type": "string", "example": "{{x_requested_with}}" } }, { "name": "x-user-id", "in": "header", "schema": { "type": "string", "example": "{{x_user_id}}" } }, { "name": "x-auth-token", "in": "header", "schema": { "type": "string", "example": "{{x_auth_token}}" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "customFields": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "example": "teste_visitor" }, "overwrite": { "type": "boolean", "example": true }, "value": { "type": "string", "example": "TESTE DE VISITOR" } } }, "example": [ { "key": "teste_visitor", "overwrite": true, "value": "TESTE DE VISITOR" }, { "key": "texto_integracao", "overwrite": true, "value": "Uma grande texto de integracao" } ] }, "rid": { "type": "string", "example": "32iZCjkyvjsGFSipJ" }, "token": { "type": "string", "example": "WHATS-5551998812844" } } }, "examples": { "livechat/custom.fields": { "value": { "customFields": [ { "key": "teste_visitor", "overwrite": true, "value": "TESTE DE VISITOR" }, { "key": "texto_integracao", "overwrite": true, "value": "Uma grande texto de integracao" } ], "rid": "32iZCjkyvjsGFSipJ", "token": "WHATS-5551998812844" } } } } } }, "responses": { "200": { "description": "" } } } }, "/api/v1/livechat/timegroups/test/{_id}": { "get": { "tags": [ "api/v1", "livechat/" ], "summary": "livechat/timegroups/test", "description": "### **Requer Autenticação?**\n\nSim\n\n### **Descrição**\n\nO objetivo desta API é testar se uma data se encaixa em um determinado Grupo de Horário.\n\n### **Parâmetros**\n\n- `_id` (URL Param) - obrigatório \\[String\\]. ID do Grupo de Horário testado.\n- `date` (Query Param) - opcional \\[String\\]. Data para comparação. O padrão é a data e horário atual. Fuso 'America/Sao_Paulo'.\n \n\n### Resposta", "operationId": "livechatTimegroupsTest", "parameters": [ { "name": "date", "in": "query", "schema": { "type": "string" } }, { "name": "x-requested-with", "in": "header", "schema": { "type": "string", "example": "{{x_requested_with}}" } }, { "name": "x-user-id", "in": "header", "schema": { "type": "string", "example": "{{x_user_id}}" } }, { "name": "x-auth-token", "in": "header", "schema": { "type": "string", "example": "{{x_auth_token}}" } } ], "responses": { "200": { "description": "" } } }, "parameters": [ { "name": "_id", "in": "path", "required": true, "schema": { "type": "string", "example": "FMPNkg6vyv2PkXi5x" } } ] }, "/api/v1/livechat/message": { "post": { "tags": [ "api/v1", "livechat/" ], "summary": "livechat/message", "description": "### \\[POST\\] api/v1/livechat/message\n\n### ✅ Requer Autenticação\n\n### 📝 Descrição\n\nInserir uma nova mensagem na sala de bate-papo. \nEssa API insere mensagens na sala apenas como visitante, não funciona para inserir como usuário/agente.\n\n### ➡️ Request Body\n\n- `_id` {string} (opcional): Id da mensagem.\n \n- `token` {string}: Token do visitante.\n \n- `rid` {string}: ID da sala.\n \n- `msg` {string}: Mensagem a ser enviada.\n \n- `agent` {object} (opcional): Informações do agente que enviou a mensagem.\n \n - `agent.agentId` {string}: ID do agente.\n \n - `agent.username` {string}: Nome de usuário do agente.\n \n\n### ⬅️ Response Body\n\n- `response` {object}: Objeto de resposta da requisição.\n \n- `response.success` {boolean}: Status da requisição.\n \n- `response.message` {object}: Dados da mensagem criada.", "operationId": "livechatMessage", "parameters": [ { "name": "x-requested-with", "in": "header", "schema": { "type": "string", "example": "{{x_requested_with}}" } }, { "name": "x-user-id", "in": "header", "schema": { "type": "string", "example": "{{x_user_id}}" } }, { "name": "x-auth-token", "in": "header", "schema": { "type": "string", "example": "{{x_auth_token}}" } } ], "requestBody": { "content": { "application/json": { "examples": { "livechat/message": { "value": "{\r\n \"token\": \"WHATS-5551998812844\",\r\n \"rid\": \"ZWh4CedDv4sf6kKBM\",\r\n \"msg\": \"Opa\"/*,\r\n \"agent\": {\r\n \"agentId\": \"NQ7cWyJ58MeiRm3es\",\r\n \"username\": \"dev.convert\"\r\n }*/\r\n}" } } } } }, "responses": { "200": { "description": "" } } } }, "/api/v1/livechat/message.update": { "post": { "tags": [ "api/v1", "livechat/" ], "summary": "livechat/message.update", "description": "livechat/message.update", "operationId": "livechatMessageUpdate", "parameters": [ { "name": "x-requested-with", "in": "header", "schema": { "type": "string", "example": "{{x_requested_with}}" } }, { "name": "x-user-id", "in": "header", "schema": { "type": "string", "example": "{{x_user_id}}" } }, { "name": "x-auth-token", "in": "header", "schema": { "type": "string", "example": "{{x_auth_token}}" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "messageId": { "type": "string", "example": "dCngMm9bn76iTSiD9" }, "transcript": { "type": "string", "example": "Transcrição da mensagem" } } }, "examples": { "livechat/message.update": { "value": { "messageId": "dCngMm9bn76iTSiD9", "transcript": "Transcrição da mensagem" } } } } } }, "responses": { "200": { "description": "" } } } }, "/api/v1/livechat/message.status": { "post": { "tags": [ "api/v1", "livechat/" ], "summary": "livechat/message.status", "description": "livechat/message.status", "operationId": "livechatMessageStatus", "parameters": [ { "name": "x-requested-with", "in": "header", "schema": { "type": "string", "example": "{{x_requested_with}}" } }, { "name": "x-user-id", "in": "header", "schema": { "type": "string", "example": "{{x_user_id}}" } }, { "name": "x-auth-token", "in": "header", "schema": { "type": "string", "example": "{{x_auth_token}}" } } ], "requestBody": { "content": { "application/json": { "examples": { "livechat/message.status": { "value": "{\r\n \"messageId\": \"mXurtbA8dnWLjPohr\",\r\n \"currentStatus\": \"sent\", // 'sent', 'delivered', 'read', 'error'\r\n \"ts\": \"2024-06-10T16:26:16.000Z\" // new Date().toISOString()\r\n //\"errorMsg\": \"Falha na conexão com o broker!\"\r\n}" } } } } }, "responses": { "200": { "description": "" } } } }, "/api/v1/livechat/favoritas": { "get": { "tags": [ "api/v1", "livechat/" ], "summary": "livechat/favoritas", "description": "livechat/favoritas", "operationId": "livechatFavoritas", "parameters": [ { "name": "onlyMyDepartments", "in": "query", "schema": { "type": "string", "example": "true" } }, { "name": "x-requested-with", "in": "header", "schema": { "type": "string", "example": "{{x_requested_with}}" } }, { "name": "x-user-id", "in": "header", "schema": { "type": "string", "example": "{{x_user_id}}" } }, { "name": "x-auth-token", "in": "header", "schema": { "type": "string", "example": "{{x_auth_token}}" } } ], "responses": { "200": { "description": "" } } } }, "/api/v1/rooms.info": { "get": { "tags": [ "api/v1" ], "summary": "rooms.info", "description": "rooms.info", "operationId": "roomsInfo", "parameters": [ { "name": "roomId", "in": "query", "schema": { "type": "string", "example": "TEAoEP8Gp9isr5ySQ" } }, { "name": "x-requested-with", "in": "header", "schema": { "type": "string", "example": "XMLHttpRequest" } }, { "name": "x-user-id", "in": "header", "schema": { "type": "string", "example": "MFKujjHvsvff5eFAs" } }, { "name": "x-auth-token", "in": "header", "schema": { "type": "string", "example": "ECCg8TugVL0T4Cc7hg1jiUUFrmM7CK2BbGV7yV6kNU_" } } ], "responses": { "200": { "description": "" } } } }, "/api/v1/rooms.audit": { "get": { "tags": [ "api/v1" ], "summary": "rooms.audit", "description": "rooms.audit", "operationId": "roomsAudit", "parameters": [ { "name": "from", "in": "query", "schema": { "type": "string", "example": "2023-01-01T00:00" } }, { "name": "to", "in": "query", "schema": { "type": "string", "example": "2023-12-31%2023:59" } }, { "name": "rid", "in": "query", "schema": { "type": "string", "example": "MFKujjHvsvff5eFAsfXTaqxHYkvtXCJQ8Z" } }, { "name": "x-requested-with", "in": "header", "schema": { "type": "string", "example": "XMLHttpRequest" } }, { "name": "x-user-id", "in": "header", "schema": { "type": "string", "example": "MFKujjHvsvff5eFAs" } }, { "name": "x-auth-token", "in": "header", "schema": { "type": "string", "example": "ECCg8TugVL0T4Cc7hg1jiUUFrmM7CK2BbGV7yV6kNU_" } } ], "responses": { "200": { "description": "" } } } }, "/api/v1/rooms.export": { "get": { "tags": [ "api/v1" ], "summary": "rooms.export", "description": "rooms.export", "operationId": "roomsExport", "parameters": [ { "name": "rid", "in": "query", "schema": { "type": "string", "example": "hD3dzq9F9vaCRjAoH" } }, { "name": "x-requested-with", "in": "header", "schema": { "type": "string", "example": "XMLHttpRequest" } }, { "name": "x-user-id", "in": "header", "schema": { "type": "string", "example": "tnhHBEmeKjPrTxyX3" } }, { "name": "x-auth-token", "in": "header", "schema": { "type": "string", "example": "AfSZITE_hrc-CnWOnuJexZfdKr9sQ0tk467_J51-9t3" } } ], "responses": { "200": { "description": "" } } } }, "/api/v1/rooms.exportByEmail": { "post": { "tags": [ "api/v1" ], "summary": "rooms.exportByEmail", "description": "rooms.exportByEmail", "operationId": "roomsExportbyemail", "parameters": [ { "name": "x-requested-with", "in": "header", "schema": { "type": "string", "example": "XMLHttpRequest" } }, { "name": "x-user-id", "in": "header", "schema": { "type": "string", "example": "MFKujjHvsvff5eFAs" } }, { "name": "x-auth-token", "in": "header", "schema": { "type": "string", "example": "ECCg8TugVL0T4Cc7hg1jiUUFrmM7CK2BbGV7yV6kNU_" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "rid": { "type": "string", "example": "DSAJ64RBreukZqTQ5" }, "type": { "type": "string", "example": "file" } } }, "examples": { "rooms.exportByEmail": { "value": { "rid": "DSAJ64RBreukZqTQ5", "type": "file" } } } } } }, "responses": { "200": { "description": "" } } } }, "/api/v1/chat.sendMessage": { "post": { "tags": [ "api/v1" ], "summary": "chat.sendMessage", "description": "chat.sendMessage", "operationId": "chatSendmessage", "parameters": [ { "name": "x-requested-with", "in": "header", "schema": { "type": "string", "example": "{{x_requested_with}}" } }, { "name": "x-user-id", "in": "header", "schema": { "type": "string", "example": "{{x_user_id}}" } }, { "name": "x-auth-token", "in": "header", "schema": { "type": "string", "example": "{{x_auth_token}}" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "object", "properties": { "msg": { "type": "string", "example": "Yo!" }, "rid": { "type": "string", "example": "ZWh4CedDv4sf6kKBM" } } } } }, "examples": { "chat.sendMessage": { "value": { "message": { "msg": "Yo!", "rid": "ZWh4CedDv4sf6kKBM" } } } } } } }, "responses": { "200": { "description": "" } } } }, "/api/v1/chat.sendSystemMessage": { "post": { "tags": [ "api/v1" ], "summary": "chat.sendSystemMessage", "description": "### \\[POST\\] /api/v1/chat.sendSystemMessage\n\n### ✅ Requer Autenticação\n\n### 📝 Descrição\n\nO propósito dessa API é envia uma mensagem do sistema para uma sala (direct, livechat, channel).\n\n- Envia para qualquer tipo de sala, porém ela precisa existir (conforme o 'rid' informado).\n \n- Salas do tipo 'livechat' precisar estar abertas.\n \n\n### ➡️ Request Body\n\n- `rid` {string}: ID da sala.\n \n- `message` {object}: Dados da mensagem.\n \n - `message.msg` {string}: Conteúdo de texto da mensagem.\n \n - `message.t` {string}: Tipo da mensagem, precisa ser um tipo válido. Ex.: 'livechat_internal_notice'.\n \n- `user` {string} (opcional): Usuário remetente da mensagem, pode ser seu id, username ou email. Caso não seja informado, é utilizado o id do usuário informado nos Headers da requisição.\n \n\n### ⬅️ Response Body\n\n- `success` {boolean}: Status da requisição.\n \n- `message` {string}: Dados da mensagem enviada.", "operationId": "chatSendsystemmessage", "parameters": [ { "name": "x-requested-with", "in": "header", "schema": { "type": "string", "example": "{{x_requested_with}}" } }, { "name": "x-user-id", "in": "header", "schema": { "type": "string", "example": "{{x_user_id}}" } }, { "name": "x-auth-token", "in": "header", "schema": { "type": "string", "example": "{{x_auth_token}}" } } ], "requestBody": { "content": { "application/json": { "examples": { "chat.sendSystemMessage": { "value": "{\r\n \"rid\": \"qaoAHxeFhdEi9eSPw\",\r\n \"message\": {\r\n \"msg\": \"*Oportunidades do Cliente (Piperun)*\\n• 🥶 125915839 - Telefone (ver mais)\\n• 🔥 125915839 - Telefone (ver mais)\\n_Faça o vinculo corretamente_\",\r\n \"t\": \"livechat_internal_notice\" // livechat_internal_notice\r\n }/*,\r\n \"user\": \"dev.convert\" // NQ7cWyJ58MeiRm3es / dev.convert / devconvert@convertcompany.com.br\r\n */\r\n}" } } } } }, "responses": { "200": { "description": "" } } } }, "/api/v1/settings.public": { "get": { "tags": [ "api/v1" ], "summary": "settings.public", "description": "### **Requer Autenticação?**\n\nSim\n\n### **Descrição**\n\nO objetivo desta API é buscar todas as configurações públicas da plataforma.\n\n### **Parâmetros**\n\n- `offset` - opcional \\[String\\]. Quantia de dados que serão pulados/ignorados antes de retornar o resultado.\n- `count` - opcional \\[String\\]. Quantia limite de dados retornados, o padrão é 50. É possível deixar ilimitado a quantia de dados de retorno ao informar o valor 0 (zero).\n- `sort` - opcional \\[JSON\\]. Ordenação dos dados de retorno. Ex.: { \"_id\": -1 } .\n- `fields` - opcional \\[JSON\\]. Campos que serão inseridos nos dados de retorno de cada Setting.\n- `query` - opcional \\[JSON\\]. Utilizado para inserir uma query específica junto do restante da pesquisa. Ex.: {\"_id\": { \"$in\": \\[\"Livechat_ConvertOmniChannelNpsScore\"\\] } }.\n \n\n### Resposta\n\nPor padrão, são retornados apenas os seguintes campos das Settings: __id_, _value_, _enterprise_, _invalidValue_ e _modules_.", "operationId": "settingsPublic", "parameters": [ { "name": "offset", "in": "query", "schema": { "type": "string", "example": "" } }, { "name": "count", "in": "query", "schema": { "type": "string", "example": "0" } }, { "name": "sort", "in": "query", "schema": { "type": "string", "example": "{ \"_id\": -1 }" } }, { "name": "fields", "in": "query", "schema": { "type": "string", "example": "{ \"packageValue\": 1 }" } }, { "name": "query", "in": "query", "schema": { "type": "string", "example": "{\"_id\": { \"$in\": [\"Livechat_ConvertOmniChannelNpsScore\"] } }" } }, { "name": "x-requested-with", "in": "header", "schema": { "type": "string", "example": "{{x_requested_with}}" } }, { "name": "x-user-id", "in": "header", "schema": { "type": "string", "example": "{{x_user_id}}" } }, { "name": "x-auth-token", "in": "header", "schema": { "type": "string", "example": "{{x_auth_token}}" } } ], "responses": { "200": { "description": "" } } } }, "/api/v1/users.info": { "get": { "tags": [ "api/v1" ], "summary": "users.info", "description": "### **Requer Autenticação?**\n\nSim\n\n### **Descrição**\n\nO objetivo desta API é buscar todas as configurações públicas da plataforma.\n\n### **Parâmetros**\n\n- `offset` - opcional \\[String\\]. Quantia de dados que serão pulados/ignorados antes de retornar o resultado.\n- `count` - opcional \\[String\\]. Quantia limite de dados retornados, o padrão é 50. É possível deixar ilimitado a quantia de dados de retorno ao informar o valor 0 (zero).\n- `sort` - opcional \\[JSON\\]. Ordenação dos dados de retorno. Ex.: { \"_id\": -1 } .\n- `fields` - opcional \\[JSON\\]. Campos que serão inseridos nos dados de retorno de cada Setting.\n- `query` - opcional \\[JSON\\]. Utilizado para inserir uma query específica junto do restante da pesquisa. Ex.: {\"_id\": { \"$in\": \\[\"Livechat_ConvertOmniChannelNpsScore\"\\] } }.\n \n\n### Resposta\n\nPor padrão, são retornados apenas os seguintes campos das Settings: __id_, _value_, _enterprise_, _invalidValue_ e _modules_.", "operationId": "usersInfo", "parameters": [ { "name": "userId", "in": "query", "schema": { "type": "string", "example": "4f29EankbCHbfaCxK" } }, { "name": "username", "in": "query", "schema": { "type": "string", "example": "admin.converts" } }, { "name": "userEmail", "in": "query", "schema": { "type": "string", "example": "arthur@convertcompany.com.br" } }, { "name": "x-requested-with", "in": "header", "schema": { "type": "string", "example": "{{x_requested_with}}" } }, { "name": "x-user-id", "in": "header", "schema": { "type": "string", "example": "{{x_user_id}}" } }, { "name": "x-auth-token", "in": "header", "schema": { "type": "string", "example": "{{x_auth_token}}" } } ], "responses": { "200": { "description": "" } } } }, "/api/v1/users.getStatus": { "get": { "tags": [ "api/v1" ], "summary": "users.getStatus", "description": "### **Requer Autenticação?**\n\nSim\n\n### **Descrição**\n\nO objetivo desta API é buscar todas as configurações públicas da plataforma.\n\n### **Parâmetros**\n\n- `offset` - opcional \\[String\\]. Quantia de dados que serão pulados/ignorados antes de retornar o resultado.\n- `count` - opcional \\[String\\]. Quantia limite de dados retornados, o padrão é 50. É possível deixar ilimitado a quantia de dados de retorno ao informar o valor 0 (zero).\n- `sort` - opcional \\[JSON\\]. Ordenação dos dados de retorno. Ex.: { \"_id\": -1 } .\n- `fields` - opcional \\[JSON\\]. Campos que serão inseridos nos dados de retorno de cada Setting.\n- `query` - opcional \\[JSON\\]. Utilizado para inserir uma query específica junto do restante da pesquisa. Ex.: {\"_id\": { \"$in\": \\[\"Livechat_ConvertOmniChannelNpsScore\"\\] } }.\n \n\n### Resposta\n\nPor padrão, são retornados apenas os seguintes campos das Settings: __id_, _value_, _enterprise_, _invalidValue_ e _modules_.", "operationId": "usersGetstatus", "parameters": [ { "name": "user", "in": "query", "schema": { "type": "string", "example": "admin.convert" } }, { "name": "x-requested-with", "in": "header", "schema": { "type": "string", "example": "{{x_requested_with}}" } }, { "name": "x-user-id", "in": "header", "schema": { "type": "string", "example": "{{x_user_id}}" } }, { "name": "x-auth-token", "in": "header", "schema": { "type": "string", "example": "{{x_auth_token}}" } } ], "responses": { "200": { "description": "" } } } } }, "tags": [ { "name": "api/v1" }, { "name": "livechat/" } ] }