--- agentTools: projectIndex: https://piperun-atendimentos.readme.io/llms.txt --- # Listar histórico de um atendimento # OpenAPI definition ```json { "openapi": "3.1.0", "info": { "title": "Versão 1.0", "version": "1.0" }, "servers": [ { "url": "https://{subdominio}.cxm.pipe.run", "variables": { "subdominio": { "default": "subdominio" } } } ], "components": { "securitySchemes": { "sec0": { "type": "apiKey", "in": "header", "name": "Authorization", "x-bearer-format": "bearer" } } }, "security": [ { "sec0": [] } ], "paths": { "/api/talk_histories": { "get": { "summary": "Listar histórico de um atendimento", "description": "", "operationId": "listar-historico-de-um-atendimento", "parameters": [ { "name": "talk_id", "in": "query", "description": "ID do atendimento", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "agent_id", "in": "query", "description": "ID do agente que abriu o histórico", "schema": { "type": "integer", "format": "int32" } }, { "name": "type", "in": "query", "description": "Tipo de retorno. Valores permitidos: a=>Todas as mensagens | u=>Somente mensagens não lidas", "required": true, "schema": { "type": "string", "enum": [ "a", "u" ] } }, { "name": "only_view", "in": "query", "description": "Define se irá marcar as mensagens como lidas. Valores permitidos: 0=>NÃO | 1=>SIM", "schema": { "type": "string", "enum": [ "0", "1" ] } }, { "name": "per_page", "in": "query", "description": "Quantidade de resultados por página. Se este parâmetro não for enviado, todas as mensagens serão retornadas.", "schema": { "type": "integer", "format": "int32" } }, { "name": "page", "in": "query", "description": "Número da página que irá retornar", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "Accept", "in": "header", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Content-Type", "in": "header", "required": true, "schema": { "type": "string", "default": "application/json" } } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"id\": 10091,\n \"agent_id\": 22,\n \"customer_id\": 604,\n \"channel_id\": 1,\n \"queue_id\": 3,\n \"priority_id\": 2,\n \"has_schedule\": false,\n \"is_waiting\": false,\n \"finished_at\": null,\n \"created_at\": \"2022-09-09T19:42:13.000000Z\",\n \"talk_histories\": {\n \"current_page\": 1,\n \"data\": [\n {\n \"id\": 228637,\n \"talk_id\": 10091,\n \"channel_id\": 1,\n \"queue_id\": 3,\n \"user_id\": 22,\n \"message\": \"\",\n \"subject\": null,\n \"response_from\": null,\n \"type\": \"out\",\n \"has_attachment\": true,\n \"attachment_type_id\": 3,\n \"attachment_url\": \"https://5hub.5hub.com.br/storage/talks/10091/out/2022/09/22/152037/20220922142237742611_44.png\",\n \"sent_at\": \"2022-09-22 14:22:37\",\n \"is_intervention\": false,\n \"from\": null,\n \"has_highlight\": false,\n \"has_error\": false,\n \"was_blocked\": false,\n \"read_at\": \"2022-09-22 15:55:18\",\n \"delivered_at\": \"2022-09-22 15:20:56\",\n \"left_at\": \"2022-09-22 15:20:42\",\n \"is_template\": false,\n \"template_id\": null,\n \"original_message\": null,\n \"status\": 3,\n \"is_hidden\": false,\n \"file_name\": \"20220922152037742611_22.png\",\n \"channel\": {\n \"id\": 1,\n \"description\": \"WhatsApp\",\n \"icon_class\": \"fab fa-whatsapp\",\n \"primary_color\": \"#4caf50\",\n \"secondary_color\": \"#9dd5a8\",\n \"enable_emoji\": true,\n \"enable_audio\": true,\n \"enable_attachment\": true\n },\n \"user\": {\n \"id\": 22,\n \"name\": \"Maria Silveira\"\n },\n \"template_whatsapp\": null\n },\n {\n \"id\": 228226,\n \"talk_id\": 10091,\n \"channel_id\": 1,\n \"queue_id\": 3,\n \"user_id\": 22,\n \"message\": \"Boa tarde Marcia\",\n \"subject\": null,\n \"response_from\": null,\n \"type\": \"in\",\n \"has_attachment\": false,\n \"attachment_type_id\": null,\n \"attachment_url\": \"\",\n \"sent_at\": \"2022-09-21 14:25:34\",\n \"is_intervention\": false,\n \"from\": \"11991369049\",\n \"has_highlight\": false,\n \"has_error\": false,\n \"was_blocked\": false,\n \"read_at\": \"2022-09-21 14:25:35\",\n \"delivered_at\": null,\n \"left_at\": null,\n \"is_template\": false,\n \"template_id\": null,\n \"original_message\": null,\n \"status\": 3,\n \"is_hidden\": false,\n \"file_name\": \"\",\n \"channel\": {\n \"id\": 1,\n \"description\": \"WhatsApp\",\n \"icon_class\": \"fab fa-whatsapp\",\n \"primary_color\": \"#4caf50\",\n \"secondary_color\": \"#9dd5a8\",\n \"enable_emoji\": true,\n \"enable_audio\": true,\n \"enable_attachment\": true\n },\n \"user\": {\n \"id\": 22,\n \"name\": \"Maria Silveira\"\n },\n \"template_whatsapp\": null\n },\n {\n \"id\": 223686,\n \"talk_id\": 10091,\n \"channel_id\": 1,\n \"queue_id\": 3,\n \"user_id\": 22,\n \"message\": \"Boa tarde, é Marcia, podemos falar sobre sua solicitação?\",\n \"subject\": null,\n \"response_from\": null,\n \"type\": \"out\",\n \"has_attachment\": false,\n \"attachment_type_id\": null,\n \"attachment_url\": \"\",\n \"sent_at\": \"2022-09-09 16:42:13\",\n \"is_intervention\": false,\n \"from\": null,\n \"has_highlight\": false,\n \"has_error\": false,\n \"was_blocked\": false,\n \"read_at\": \"2022-09-09 20:18:56\",\n \"delivered_at\": \"2022-09-09 16:42:28\",\n \"left_at\": \"2022-09-09 16:42:18\",\n \"is_template\": true,\n \"template_id\": 43,\n \"original_message\": \"@saudacao_tempo, é @agente->nome, podemos falar sobre sua solicitação?\",\n \"status\": 3,\n \"is_hidden\": false,\n \"file_name\": \"\",\n \"channel\": {\n \"id\": 1,\n \"description\": \"WhatsApp\",\n \"icon_class\": \"fab fa-whatsapp\",\n \"primary_color\": \"#4caf50\",\n \"secondary_color\": \"#9dd5a8\",\n \"enable_emoji\": true,\n \"enable_audio\": true,\n \"enable_attachment\": true\n },\n \"user\": {\n \"id\": 22,\n \"name\": \"Maria Silveira\"\n },\n \"template_whatsapp\": {\n \"id\": 43,\n \"header\": null,\n \"footer\": null,\n \"buttons\": null\n }\n }\n ],\n \"first_page_url\": \"https://5hub.5hub.com.br/api/talk_histories?page=1\",\n \"from\": 1,\n \"last_page\": 1,\n \"last_page_url\": \"https://5hub.5hub.com.br/api/talk_histories?page=1\",\n \"links\": [\n {\n \"url\": null,\n \"label\": \"« Anterior\",\n \"active\": false\n },\n {\n \"url\": \"https://5hub.5hub.com.br/api/talk_histories?page=1\",\n \"label\": \"1\",\n \"active\": true\n },\n {\n \"url\": null,\n \"label\": \"Próximo »\",\n \"active\": false\n }\n ],\n \"next_page_url\": null,\n \"path\": \"https://5hub.5hub.com.br/api/talk_histories\",\n \"per_page\": \"15\",\n \"prev_page_url\": null,\n \"to\": 14,\n \"total\": 14\n },\n \"can_transcription\": false,\n \"tracking_number\": \"2022090910091\",\n \"url_viewer\": \"https://5hub.5hub.com.br/viewer/OTI4a0Y0bFNwsW4f0SHJncTdXZnhyUT09\",\n \"talk_priority\": {\n \"id\": 2,\n \"description\": \"Média\"\n },\n \"agent\": {\n \"id\": 22,\n \"user_id\": 22,\n \"status_id\": 1,\n \"name\": \"Marcia Santos\",\n \"is_active\": true,\n \"can_attach\": true,\n \"can_noqueues\": false,\n \"can_edit_customers\": true,\n \"can_transfer\": true,\n \"can_send_audio\": true,\n \"can_send_emoji\": true,\n \"can_add_blacklist\": true,\n \"updated_at\": \"2022-09-23T18:26:49.000000Z\",\n \"talk_id\": null,\n \"last_talk_at\": \"2022-09-19 14:51:10\",\n \"nickname\": \"@marcia\",\n \"is_bot\": false,\n \"work_shift_id\": 3,\n \"photo_url\": null,\n \"sign_of_life_at\": \"2022-09-23 15:25:57\",\n \"external_id\": null,\n \"can_start_talk\": true,\n \"screen_lock_on_pause\": true,\n \"agent_access_log_id\": 15604,\n \"session_id\": \"vhmnHULPX8PT5MBEvNQ1hXM5Fzcy7tdqk7LebaSm\",\n \"softphone_username\": null,\n \"softphone_password\": null,\n \"can_make_call\": false,\n \"backup_agent_id\": null,\n \"last_logout_at\": \"2022-09-23 15:26:49\",\n \"last_login_at\": \"2022-09-23T16:59:56.000000Z\",\n \"user\": {\n \"id\": 22,\n \"name\": \"Maria Silveira\"\n }\n },\n \"customer\": {\n \"id\": 604,\n \"name\": \"FLAVIO SILVA\",\n \"document_number\": \"\",\n \"external_id\": null,\n \"profile_picture_url\": null,\n \"main_whatsapp\": {\n \"id\": 85,\n \"customer_id\": 604,\n \"area_code\": \"11\",\n \"number\": \"987654321\",\n \"wa_verified_level\": 0,\n \"is_blocked\": false,\n \"full_number\": \"11987654321\"\n },\n \"main_sms\": null,\n \"main_email\": null,\n \"wildcard_01\": null,\n \"wildcard_02\": null,\n \"wildcard_03\": null,\n \"wildcard_04\": null,\n \"wildcard_05\": null,\n \"wildcard_06\": null,\n \"wildcard_07\": null,\n \"wildcard_08\": null,\n \"wildcard_09\": null,\n \"wildcard_10\": null,\n \"is_priority\": false\n },\n \"channel\": {\n \"id\": 1,\n \"description\": \"WhatsApp\",\n \"icon_class\": \"fab fa-whatsapp\",\n \"primary_color\": \"#4caf50\",\n \"secondary_color\": \"#9dd5a8\",\n \"enable_emoji\": true,\n \"enable_audio\": true,\n \"enable_attachment\": true\n },\n \"queue\": {\n \"id\": 3,\n \"description\": \"Fila unica\",\n \"card_id\": 2,\n \"full_description\": \"Piperun -> Suporte -> Fila unica\",\n \"card\": {\n \"id\": 2,\n \"description\": \"Suporte\",\n \"product_id\": 3,\n \"full_description\": \"Piperun -> Suporte\",\n \"product\": {\n \"id\": 3,\n \"description\": \"Piperun\"\n }\n }\n }\n}" } }, "schema": { "type": "object", "properties": { "id": { "type": "integer", "example": 10091, "default": 0 }, "agent_id": { "type": "integer", "example": 22, "default": 0 }, "customer_id": { "type": "integer", "example": 604, "default": 0 }, "channel_id": { "type": "integer", "example": 1, "default": 0 }, "queue_id": { "type": "integer", "example": 3, "default": 0 }, "priority_id": { "type": "integer", "example": 2, "default": 0 }, "has_schedule": { "type": "boolean", "example": false, "default": true }, "is_waiting": { "type": "boolean", "example": false, "default": true }, "finished_at": {}, "created_at": { "type": "string", "example": "2022-09-09T19:42:13.000000Z" }, "talk_histories": { "type": "object", "properties": { "current_page": { "type": "integer", "example": 1, "default": 0 }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "example": 228637, "default": 0 }, "talk_id": { "type": "integer", "example": 10091, "default": 0 }, "channel_id": { "type": "integer", "example": 1, "default": 0 }, "queue_id": { "type": "integer", "example": 3, "default": 0 }, "user_id": { "type": "integer", "example": 22, "default": 0 }, "message": { "type": "string", "example": "" }, "subject": {}, "response_from": {}, "type": { "type": "string", "example": "out" }, "has_attachment": { "type": "boolean", "example": true, "default": true }, "attachment_type_id": { "type": "integer", "example": 3, "default": 0 }, "attachment_url": { "type": "string", "example": "https://5hub.5hub.com.br/storage/talks/10091/out/2022/09/22/152037/20220922142237742611_44.png" }, "sent_at": { "type": "string", "example": "2022-09-22 14:22:37" }, "is_intervention": { "type": "boolean", "example": false, "default": true }, "from": {}, "has_highlight": { "type": "boolean", "example": false, "default": true }, "has_error": { "type": "boolean", "example": false, "default": true }, "was_blocked": { "type": "boolean", "example": false, "default": true }, "read_at": { "type": "string", "example": "2022-09-22 15:55:18" }, "delivered_at": { "type": "string", "example": "2022-09-22 15:20:56" }, "left_at": { "type": "string", "example": "2022-09-22 15:20:42" }, "is_template": { "type": "boolean", "example": false, "default": true }, "template_id": {}, "original_message": {}, "status": { "type": "integer", "example": 3, "default": 0 }, "is_hidden": { "type": "boolean", "example": false, "default": true }, "file_name": { "type": "string", "example": "20220922152037742611_22.png" }, "channel": { "type": "object", "properties": { "id": { "type": "integer", "example": 1, "default": 0 }, "description": { "type": "string", "example": "WhatsApp" }, "icon_class": { "type": "string", "example": "fab fa-whatsapp" }, "primary_color": { "type": "string", "example": "#4caf50" }, "secondary_color": { "type": "string", "example": "#9dd5a8" }, "enable_emoji": { "type": "boolean", "example": true, "default": true }, "enable_audio": { "type": "boolean", "example": true, "default": true }, "enable_attachment": { "type": "boolean", "example": true, "default": true } } }, "user": { "type": "object", "properties": { "id": { "type": "integer", "example": 22, "default": 0 }, "name": { "type": "string", "example": "Maria Silveira" } } }, "template_whatsapp": {} } } }, "first_page_url": { "type": "string", "example": "https://5hub.5hub.com.br/api/talk_histories?page=1" }, "from": { "type": "integer", "example": 1, "default": 0 }, "last_page": { "type": "integer", "example": 1, "default": 0 }, "last_page_url": { "type": "string", "example": "https://5hub.5hub.com.br/api/talk_histories?page=1" }, "links": { "type": "array", "items": { "type": "object", "properties": { "url": {}, "label": { "type": "string", "example": "« Anterior" }, "active": { "type": "boolean", "example": false, "default": true } } } }, "next_page_url": {}, "path": { "type": "string", "example": "https://5hub.5hub.com.br/api/talk_histories" }, "per_page": { "type": "string", "example": "15" }, "prev_page_url": {}, "to": { "type": "integer", "example": 14, "default": 0 }, "total": { "type": "integer", "example": 14, "default": 0 } } }, "can_transcription": { "type": "boolean", "example": false, "default": true }, "tracking_number": { "type": "string", "example": "2022090910091" }, "url_viewer": { "type": "string", "example": "https://5hub.5hub.com.br/viewer/OTI4a0Y0bFNwsW4f0SHJncTdXZnhyUT09" }, "talk_priority": { "type": "object", "properties": { "id": { "type": "integer", "example": 2, "default": 0 }, "description": { "type": "string", "example": "Média" } } }, "agent": { "type": "object", "properties": { "id": { "type": "integer", "example": 22, "default": 0 }, "user_id": { "type": "integer", "example": 22, "default": 0 }, "status_id": { "type": "integer", "example": 1, "default": 0 }, "name": { "type": "string", "example": "Marcia Santos" }, "is_active": { "type": "boolean", "example": true, "default": true }, "can_attach": { "type": "boolean", "example": true, "default": true }, "can_noqueues": { "type": "boolean", "example": false, "default": true }, "can_edit_customers": { "type": "boolean", "example": true, "default": true }, "can_transfer": { "type": "boolean", "example": true, "default": true }, "can_send_audio": { "type": "boolean", "example": true, "default": true }, "can_send_emoji": { "type": "boolean", "example": true, "default": true }, "can_add_blacklist": { "type": "boolean", "example": true, "default": true }, "updated_at": { "type": "string", "example": "2022-09-23T18:26:49.000000Z" }, "talk_id": {}, "last_talk_at": { "type": "string", "example": "2022-09-19 14:51:10" }, "nickname": { "type": "string", "example": "@marcia" }, "is_bot": { "type": "boolean", "example": false, "default": true }, "work_shift_id": { "type": "integer", "example": 3, "default": 0 }, "photo_url": {}, "sign_of_life_at": { "type": "string", "example": "2022-09-23 15:25:57" }, "external_id": {}, "can_start_talk": { "type": "boolean", "example": true, "default": true }, "screen_lock_on_pause": { "type": "boolean", "example": true, "default": true }, "agent_access_log_id": { "type": "integer", "example": 15604, "default": 0 }, "session_id": { "type": "string", "example": "vhmnHULPX8PT5MBEvNQ1hXM5Fzcy7tdqk7LebaSm" }, "softphone_username": {}, "softphone_password": {}, "can_make_call": { "type": "boolean", "example": false, "default": true }, "backup_agent_id": {}, "last_logout_at": { "type": "string", "example": "2022-09-23 15:26:49" }, "last_login_at": { "type": "string", "example": "2022-09-23T16:59:56.000000Z" }, "user": { "type": "object", "properties": { "id": { "type": "integer", "example": 22, "default": 0 }, "name": { "type": "string", "example": "Maria Silveira" } } } } }, "customer": { "type": "object", "properties": { "id": { "type": "integer", "example": 604, "default": 0 }, "name": { "type": "string", "example": "FLAVIO SILVA" }, "document_number": { "type": "string", "example": "" }, "external_id": {}, "profile_picture_url": {}, "main_whatsapp": { "type": "object", "properties": { "id": { "type": "integer", "example": 85, "default": 0 }, "customer_id": { "type": "integer", "example": 604, "default": 0 }, "area_code": { "type": "string", "example": "11" }, "number": { "type": "string", "example": "987654321" }, "wa_verified_level": { "type": "integer", "example": 0, "default": 0 }, "is_blocked": { "type": "boolean", "example": false, "default": true }, "full_number": { "type": "string", "example": "11987654321" } } }, "main_sms": {}, "main_email": {}, "wildcard_01": {}, "wildcard_02": {}, "wildcard_03": {}, "wildcard_04": {}, "wildcard_05": {}, "wildcard_06": {}, "wildcard_07": {}, "wildcard_08": {}, "wildcard_09": {}, "wildcard_10": {}, "is_priority": { "type": "boolean", "example": false, "default": true } } }, "channel": { "type": "object", "properties": { "id": { "type": "integer", "example": 1, "default": 0 }, "description": { "type": "string", "example": "WhatsApp" }, "icon_class": { "type": "string", "example": "fab fa-whatsapp" }, "primary_color": { "type": "string", "example": "#4caf50" }, "secondary_color": { "type": "string", "example": "#9dd5a8" }, "enable_emoji": { "type": "boolean", "example": true, "default": true }, "enable_audio": { "type": "boolean", "example": true, "default": true }, "enable_attachment": { "type": "boolean", "example": true, "default": true } } }, "queue": { "type": "object", "properties": { "id": { "type": "integer", "example": 3, "default": 0 }, "description": { "type": "string", "example": "Fila unica" }, "card_id": { "type": "integer", "example": 2, "default": 0 }, "full_description": { "type": "string", "example": "Piperun -> Suporte -> Fila unica" }, "card": { "type": "object", "properties": { "id": { "type": "integer", "example": 2, "default": 0 }, "description": { "type": "string", "example": "Suporte" }, "product_id": { "type": "integer", "example": 3, "default": 0 }, "full_description": { "type": "string", "example": "Piperun -> Suporte" }, "product": { "type": "object", "properties": { "id": { "type": "integer", "example": 3, "default": 0 }, "description": { "type": "string", "example": "Piperun" } } } } } } } } } } } }, "401": { "description": "401", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"error\": \"Invalid token.\"\n}" } }, "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Invalid token." } } } } } }, "422": { "description": "422", "content": { "application/json": { "examples": { "Inconsistência nos dados enviados": { "value": "{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"talk_id\": [\n \"O campo ID do atendimento é obrigatório.\"\n ]\n }\n}" } }, "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "The given data was invalid." }, "errors": { "type": "object", "properties": { "talk_id": { "type": "array", "items": { "type": "string", "example": "O campo ID do atendimento é obrigatório." } } } } } } } } } }, "deprecated": false, "x-readme": { "code-samples": [ { "language": "curl", "code": "curl --request GET \\\n --url 'https://{subdominio}.cxm.pipe.run/api/talk_histories?talk_id=10091&agent_id=1&type=a&only_view=1&per_page=5&page=1&=22715&=a' \\\n --header 'Accept: application/json' \\\n --header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiIxNCIsImp0aSI6IjRjMWVjMmU1ODI2YzM0ZmQyMWEzMGIwODc2OWNjMmVjYzY2YzYxMGI2ZmNhNGI5YTg5MzgwNjc0ZDMzZDIxOThmMmEyNzNmNjMwMGRjMGQ4IiwiaWF0IjoxNjcyNjcwMzYwLjI1NDI5MywibmJmIjoxNjcyNjcwMzYwLjI1NDI5NywiZXhwIjoxNjcyNzU2NzYwLjE2OTY5Mywic3ViIjoiMjAiLCJzY29wZXMiOltdfQ.ZysAwtZxl2tBKO9ofDM5TXmYaVBcQhHA691i2sfcCerEhXXBh0Dmv3mWDg5HIyru5gz2Two1JLorx_SK8kLNInwsb7O8_MRU-BBYeZFX5mGc1WXAV0FJLfmR3WOk0pQcw1RrgXuhcus1moTigYvwkZfrHP-NaJqAhGiPp7aCnvJ8623JSEoq_NIc8HRJSMMAV2e7rwycBJsiSIIhNh3KzSy-r24zgVgk1s4T7k4kbHanZ8DdKVZxzit6c9yRS_1AFwlodPPPYTJkGgLzpIY48kuFmF7h9oRiiWxD6sg2i5aJvpjCLLh97dAj7hk88_T1m0ILKSDQ3lVt2xJZyYRrEy-UrgfTWV1IjKTjSxV62417eZJWnLWwuMYL6ThRuoupzSNJJbL9WHUcI8Gog-BxNemKuBSJbIHvxMcw1CGEu5rPjlzRfKJswEZwt58N_20iFrvZrTJmLztdUtjrQx_9i-msS-bmImweD8ITv7wNp9VifF29hOxUTTwSntTXoCfhd0bNottD6B5VDGwyCnBJrhNcvQ0cxjrgMllUQYw6O5LD2SgTrhs0uzJvfuTiF8nWn5AXWQEdEEX_lqHloybb8WhKpKXKn4iv7c9x-6QG8iIHQg-SFQO8cRKQQKj8XFjGFxmdpO8Iclr-QmNwGIZq04dbeAE_LaVk842zfz_xmsg' \\\n --header 'Content-Type: application/json'", "name": "200 - OK" } ], "samples-languages": [ "curl" ] } } } }, "x-readme": { "headers": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "explorer-enabled": true, "proxy-enabled": true }, "x-readme-fauxas": true, "_id": "639b9eee56a9f8002b83200b:63a9f74ac2898605828bcb66" } ```