Definição dos campos do objeto principal [talk]:
| Campo | Nullable | Descrição |
|---|---|---|
| id int | NÃO | Identificador interno do atendimento; |
| customer_id int | NÃO | Identificador interno do cliente; |
| agent_id int | SIM | Identificador interno do agente; |
| queue_id int | SIM | Identificador interno da fila de atendimento; |
| channel_id int | NÃO | Identificador interno do canal; |
| priority_id int | NÃO | Identificador interno da prioridade; |
| finished_at datetime | SIM | Data/hora da finalização do atendimento; |
| was_success bool | NÃO | Flag para identificar se o atendimento foi encerrado por uma tabulação positiva ou não; |
| created_at datetime | NÃO | Data/hora do início do atendimento; |
| has_schedule bool | NÃO | Flag para identificar se o atendimento está em agendamento ou não; |
| is_critical bool | NÃO | Flag para identificar se o atendimento está classificado como crítico ou não; |
| score int | SIM | Nota da pesquisa de satisfação enviado após a finalização do atendimento; |
| rating_survey_id int | SIM | ID interno da pesquisa de satisfação enviada para o cliente após a finalização do atendimento; |
| started_at datetime | SIM | Data/hora que o atendimento foi encaminhado para a fila de espera; |
| is_simulation bool | NÃO | APENAS PARA USO INTERNO |
| simulation_bot_id int | SIM | APENAS PARA USO INTERNO |
| latitude string | SIM | Latitude da instalação do serviço contratado pelo cliente; OBS: Esta informação está disponível apenas para contas que possuem integrações com ERP's que disponibilizam a localização do cliente; |
| longitude string | SIM | Longitude da instalação do serviço contratado pelo cliente; OBS: Esta informação está disponível apenas para contas que possuem integrações com ERP's que disponibilizam a localização do cliente; |
| initial_sender_channel int | NÃO | ID interno do canal que iniciou o atendimento; |
| is_waiting bool | NÃO | Flag para identificar se o atendimento está em espera ou não; |
| was_expired bool | NÃO | Flag para identificar se o atendimento foi encerrado por tempo de espera expirado ou não; |
| delivered_at datetime | SIM | Data/hora que o atendimento foi distribuído para um agente humano; |
| last_waiting_message_at datetime | SIM | Data/hora da última mensagem de espera enviada para o cliente; |
| is_shopping bool | NÃO | Flag para identificar se o atendimento foi iniciado pelo HubStore ou não; |
| is_ads bool | NÃO | Flag para identificar se o atendimento possui alguma mensagem recebidas através de um link de anúncio da Meta; |
| last_webchat_request_at datetime | SIM | APENAS PARA USO INTERNO |
| scaled_to int | SIM | Identificador interno do agente para o qual o atendimento foi escalonado; |
| client_ip string | SIM | IP do cliente; OBS: Esta informação está disponível apenas para atendimento através do canal Webchat; |
| client_user_agent string | SIM | User agent do browser do cliente; OBS: Esta informação está disponível apenas para atendimento através do canal Webchat; |
| survey_id int | SIM | Identificador interno de pesquisa que gerou o atendimento; |
| talk_category_id int | SIM | Identificador interno da categoria do atendimento; |
| talk_service_id int | SIM | Identificador interno do catálogo de serviço do atendimento; |
| initiation_type enum {c, m, n, r} | NÃO | Flag para identificar a origem da abertura do atendimento: * c (comment): Comentário em um story da empresa no Instagram ou Facebook; * m (mention): Menção em um story do cliente do Instagram ou Facebook; * n (normal): Normal; * r (reaction): Reação em um story da empresa no Instagram ou Facebook; |
| delivered_to int | SIM | Identificador interno do agente para o qual o atendimento foi distribuído; |
| external_protocol string | SIM | Número do protocolo externo do atendimento; OBS: Esta informação está disponível apenas para as contas que fazem atualização desse campo através da API; |
| tracking_number string | NÃO | Número do protocolo do atendimento; |
| url_viewer string | NÃO | URL do visualizador de atendimento que pode ser incorporado em outro sistema utilizando um iframe. OBS: Para o funcionamento do visualizador de atendimento, o host do site de origem precisa ser informado para a PipeRun para que possa ser adicionado à lista de permissões da conta; |
| talk_histories list <Object talkHistory> | SIM | Histórico de mensagens do atendimento; |
| customer <Object customer> | NÃO | Dados do cliente; |
| talk_events list <Object talkEvent> | SIM | Lista de tabulações do atendimento; |
| bot_variables list <Object botVariable> | SIM | Lista das variáveis capturadas pelo Bot que efetuou o pré-atendimento; |
| bot <Object Bot> | SIM | Dados do Bot que efetuou o pré-atendimento; |
| service_catalog <Object serviceCatalog> | SIM | Dados do serviço; |
Exemplo de payload:
{
"id": 114603,
"customer_id": 144527,
"agent_id": 2,
"queue_id": 17,
"channel_id": 1,
"priority_id": 2,
"finished_at": "2025-09-08 11:01:19",
"was_success": false,
"created_at": "2025-09-08T14:01:17.000000Z",
"has_schedule": false,
"is_critical": false,
"score": null,
"rating_survey_id": null,
"started_at": null,
"is_simulation": false,
"simulation_bot_id": null,
"latitude": null,
"longitude": null,
"initial_sender_channel": "1",
"is_waiting": false,
"was_expired": false,
"delivered_at": null,
"last_waiting_message_at": null,
"is_shopping": false,
"is_ads": false,
"last_webchat_request_at": null,
"scaled_to": null,
"client_ip": null,
"client_user_agent": null,
"survey_id": null,
"talk_category_id": null,
"talk_service_id": null,
"initiation_type": "n",
"delivered_to": null,
"external_protocol": null,
"tracking_number": "20250908114603",
"url_viewer": "https://crmpiperun.cxm.pipe.run/viewer/cFl5YXAyYnVnRkNjM2Y1L0d0QTczdz09",
"talk_histories": [
{
"id": 2077775,
"talk_id": 114603,
"user_id": 2,
"queue_id": null,
"channel_id": 1,
"message": "Teste Jonas",
"has_attachment": false,
"attachment_url": null,
"attachment_type_id": null,
"sent_at": "2025-09-08 11:01:17",
"delivered_at": null,
"read_at": null,
"created_at": "2025-09-08T14:01:17.000000Z",
"was_read": false,
"has_highlight": false,
"from": "51999998888",
"type": "in",
"to": "1",
"external_id": "wamid.HBgMNTU1MTk1OTg4OTg4FQIAEhggNEI5RDhFRDQ2MEFFMkE2MUJDQ0JCREI4OUQ3NDNDN0MA",
"left_at": null,
"has_error": false,
"campaign_id": null,
"was_blocked": false,
"is_template": false,
"response_from": null,
"fare": "0",
"error_reason": null,
"template_id": null,
"original_message": null,
"subject": "",
"exceeded_allowance": false,
"is_intervention": false,
"is_forwarded": false,
"is_frequently_forwarded": false,
"is_ads": false,
"send_after": null,
"is_reverted_template": false,
"reaction": null,
"customer_reaction": null,
"status": 0,
"is_hidden": false,
"file_name": "",
"attachment_type": [],
"user": {
"id": 2,
"branch_id": 1,
"name": "PipeBot",
"login": "bot",
"email": "",
"level_id": 4,
"language_id": 1,
"can_external_access": false,
"email_verified_at": "2023-08-09T13:40:14.000000Z",
"created_at": null,
"is_active": true,
"is_bot": true,
"whatsapp_number": null,
"can_api_access": false,
"preferences": {
"notification_channels": "all",
"notification_options": "same",
"notification_sound_default": {
"id": "1",
"description": "Default",
"filename": "Default.mp3"
},
"map_mode": "satellite",
"map_service": "google_maps",
"enter_key_settings": "new_line",
"activate_shortcuts": "off",
"customized_notifications": [
{
"id": "1",
"description": "Default",
"channel_id": "2",
"filename": "Default.mp3"
},
{
"id": "1",
"description": "Default",
"channel_id": "1",
"filename": "Default.mp3"
}
]
},
"can_export_report": true,
"user_id": 1,
"force_change_password": false,
"support_external_id": null,
"last_login_mode": null,
"show_bot_academy_advice": true,
"last_login_method": "local"
},
"channel": {
"id": 1,
"description": "WhatsApp",
"icon_class": "fab fa-whatsapp",
"priority": 1,
"primary_color": "#4caf50",
"secondary_color": "#9dd5a8",
"is_active": true,
"incoming_type": "w",
"enable_emoji": true,
"enable_audio": true,
"enable_attachment": true,
"allow_campaign": true,
"provider_id": 7,
"unitary_price": "0",
"template_price": "0",
"outgoing_type": "s",
"allow_bot": true,
"additional_price": "0",
"messages_allowance": 0
}
},
{
"id": 2077776,
"talk_id": 114603,
"user_id": 2,
"queue_id": 17,
"channel_id": 1,
"message": "Fila inicial definida como [PipeRun -> Ambos -> Atendimento BOT] pela configuração do Bot.",
"has_attachment": false,
"attachment_url": null,
"attachment_type_id": null,
"sent_at": "2025-09-08 11:01:17",
"delivered_at": null,
"read_at": null,
"created_at": "2025-09-08T14:01:17.000000Z",
"was_read": false,
"has_highlight": false,
"from": null,
"type": "system",
"to": null,
"external_id": null,
"left_at": null,
"has_error": false,
"campaign_id": null,
"was_blocked": false,
"is_template": false,
"response_from": null,
"fare": "0",
"error_reason": null,
"template_id": null,
"original_message": null,
"subject": null,
"exceeded_allowance": false,
"is_intervention": false,
"is_forwarded": false,
"is_frequently_forwarded": false,
"is_ads": false,
"send_after": null,
"is_reverted_template": false,
"reaction": null,
"customer_reaction": null,
"status": 0,
"is_hidden": false,
"file_name": "",
"attachment_type": [],
"user": {
"id": 2,
"branch_id": 1,
"name": "PipeBot",
"login": "bot",
"email": "",
"level_id": 4,
"language_id": 1,
"can_external_access": false,
"email_verified_at": "2023-08-09T13:40:14.000000Z",
"created_at": null,
"is_active": true,
"is_bot": true,
"whatsapp_number": null,
"can_api_access": false,
"preferences": {
"notification_channels": "all",
"notification_options": "same",
"notification_sound_default": {
"id": "1",
"description": "Default",
"filename": "Default.mp3"
},
"map_mode": "satellite",
"map_service": "google_maps",
"enter_key_settings": "new_line",
"activate_shortcuts": "off",
"customized_notifications": [
{
"id": "1",
"description": "Default",
"channel_id": "2",
"filename": "Default.mp3"
},
{
"id": "1",
"description": "Default",
"channel_id": "1",
"filename": "Default.mp3"
},
{
"id": "1",
"description": "Default",
"channel_id": "6",
"filename": "Default.mp3"
},
{
"id": "1",
"description": "Default",
"channel_id": "3",
"filename": "Default.mp3"
},
{
"id": "1",
"description": "Default",
"channel_id": "5",
"filename": "Default.mp3"
},
{
"id": "1",
"description": "Default",
"channel_id": "11",
"filename": "Default.mp3"
},
{
"id": "1",
"description": "Default",
"channel_id": "4",
"filename": "Default.mp3"
},
{
"id": "1",
"description": "Default",
"channel_id": "8",
"filename": "Default.mp3"
}
]
},
"can_export_report": true,
"user_id": 1,
"force_change_password": false,
"support_external_id": null,
"last_login_mode": null,
"show_bot_academy_advice": true,
"last_login_method": "local"
},
"channel": {
"id": 1,
"description": "WhatsApp",
"icon_class": "fab fa-whatsapp",
"priority": 1,
"primary_color": "#4caf50",
"secondary_color": "#9dd5a8",
"is_active": true,
"incoming_type": "w",
"enable_emoji": true,
"enable_audio": true,
"enable_attachment": true,
"allow_campaign": true,
"provider_id": 7,
"unitary_price": "0",
"template_price": "0",
"outgoing_type": "s",
"allow_bot": true,
"additional_price": "0",
"messages_allowance": 0
}
},
{
"id": 2077777,
"talk_id": 114603,
"user_id": 2,
"queue_id": 17,
"channel_id": 1,
"message": "📣 Atenção! Nosso número de atendimento mudou. Agora você pode nos contatar pelo WhatsApp no link: 📲 https://bitly.run/WhatsPipeRun",
"has_attachment": false,
"attachment_url": null,
"attachment_type_id": null,
"sent_at": "2025-09-08 11: 01: 18",
"delivered_at": null,
"read_at": "2025-09-08 11: 01: 20",
"created_at": "2025-09-08T14: 01: 18.000000Z",
"was_read": true,
"has_highlight": false,
"from": null,
"type": "out",
"to": "555195988988",
"external_id": "wamid.HBgMNTU1MTk1OTg4OTg4FQIAERgSQThDMUUxOTg0RUEzODg2QTY1AA==",
"left_at": "2025-09-08 11: 01: 18",
"has_error": false,
"campaign_id": null,
"was_blocked": false,
"is_template": false,
"response_from": null,
"fare": "0",
"error_reason": null,
"template_id": null,
"original_message": null,
"subject": null,
"exceeded_allowance": false,
"is_intervention": false,
"is_forwarded": false,
"is_frequently_forwarded": false,
"is_ads": false,
"send_after": null,
"is_reverted_template": false,
"reaction": null,
"customer_reaction": null,
"status": 3,
"is_hidden": false,
"file_name": "",
"attachment_type": [],
"user": {
"id": 2,
"branch_id": 1,
"name": "PipeBot",
"login": "bot",
"email": "",
"level_id": 4,
"language_id": 1,
"can_external_access": false,
"email_verified_at": "2023-08-09T13: 40: 14.000000Z",
"created_at": null,
"is_active": true,
"is_bot": true,
"whatsapp_number": null,
"can_api_access": false,
"preferences": {
"notification_channels": "all",
"notification_options": "same",
"notification_sound_default": {
"id": "1",
"description": "Default",
"filename": "Default.mp3"
},
"map_mode": "satellite",
"map_service": "google_maps",
"enter_key_settings": "new_line",
"activate_shortcuts": "off",
"customized_notifications": [
{
"id": "1",
"description": "Default",
"channel_id": "2",
"filename": "Default.mp3"
},
{
"id": "1",
"description": "Default",
"channel_id": "1",
"filename": "Default.mp3"
},
{
"id": "1",
"description": "Default",
"channel_id": "6",
"filename": "Default.mp3"
},
{
"id": "1",
"description": "Default",
"channel_id": "3",
"filename": "Default.mp3"
},
{
"id": "1",
"description": "Default",
"channel_id": "5",
"filename": "Default.mp3"
},
{
"id": "1",
"description": "Default",
"channel_id": "11",
"filename": "Default.mp3"
},
{
"id": "1",
"description": "Default",
"channel_id": "4",
"filename": "Default.mp3"
},
{
"id": "1",
"description": "Default",
"channel_id": "8",
"filename": "Default.mp3"
}
]
},
"can_export_report": true,
"user_id": 1,
"force_change_password": false,
"support_external_id": null,
"last_login_mode": null,
"show_bot_academy_advice": true,
"last_login_method": "local"
},
"channel": {
"id": 1,
"description": "WhatsApp",
"icon_class": "fab fa-whatsapp",
"priority": 1,
"primary_color": "#4caf50",
"secondary_color": "#9dd5a8",
"is_active": true,
"incoming_type": "w",
"enable_emoji": true,
"enable_audio": true,
"enable_attachment": true,
"allow_campaign": true,
"provider_id": 7,
"unitary_price": "0",
"template_price": "0",
"outgoing_type": "s",
"allow_bot": true,
"additional_price": "0",
"messages_allowance": 0
}
}
],
"customer": {
"id": 144527,
"name": "JONAS",
"external_id": "95238935",
"document_number": "",
"wildcard_01": "",
"wildcard_02": "",
"wildcard_03": "",
"wildcard_04": "",
"wildcard_05": "",
"wildcard_06": "",
"wildcard_07": "",
"wildcard_08": "",
"wildcard_09": "",
"wildcard_10": "",
"created_at": "2023-09-21T12: 28: 45.000000Z",
"main_sms": 44290,
"main_whatsapp": 44290,
"main_email": 25396,
"agent_id": null,
"queue_id": null,
"customer_group_id": null,
"profile_picture_url": null,
"is_priority": false,
"last_base_api": null,
"customer_organization_id": 15662,
"crmv_user_id": 65886,
"crmv_person_id": 9523893,
"is_active": true,
"cxm_user_id": null,
"profile_info": {
"name": "Jonas Schen",
"username": "j.schen",
"profile_pic": "https: //scontent-gru1-2.cdninstagram.com/v/t51.2885-19/136402463_253976186149719_5865312005602673050_n.jpg?stp=dst-jpg_s206x206_tt6&_nc_cat=100&ccb=1-7&_nc_sid=bf7eb4&_nc_eui2=AeHYN5VZiIc-sNtHGCgs4254feyGsovGEtd97Iayi8YS108vxDsrXCu3TL9YLx0Gt0ajlYNuFFeStw7XimoOCt8c&_nc_ohc=ZvuS5PnxbuIQ7kNvwEFvYu8&_nc_oc=Adkmlu7T1RN2lcleakngSeC_fbAhYLw5m6KANJ33KMsM1KnrjaOstylyzRgEtOt1fcc&_nc_zt=24&_nc_ht=scontent-gru1-2.cdninstagram.com&edm=ALmAK4EEAAAA&oh=00_AfSiRcadzk9IDd3dKCgN1WnE9_6TvlAdGfsDeZrsdNBMrw&oe=687F1E0E",
"is_verified_user": false,
"follower_count": 219,
"is_user_follow_business": true,
"is_business_follow_user": false,
"id": "8215422678527800"
},
"custom_fields": {
"Empresa": "Piperun",
"Web Whatsapp - Pessoa": "(51) 99999-8888",
"Nacionalidade": "Brasileira"
},
"telephones": [
{
"id": 70994,
"customer_id": 144527,
"area_code": "51",
"number": "999887766",
"type": "m",
"level_id": "N",
"has_sms": false,
"has_whatsapp": false,
"has_whatsapp_api": false,
"wa_is_business": false,
"wa_is_enterprise": false,
"wa_contact_name": null,
"wa_pushname": null,
"wa_verified_level": null,
"wa_verified_name": null,
"wa_profile_picture": null,
"session_expires_at": null,
"insert_origin": "MAILING",
"inserted_by": 127,
"country_code": "55",
"country_iso2": "br",
"full_number": "51999887766",
"full_number_cc": "+55 51999887766"
}
],
"emails": [
{
"id": 49543,
"customer_id": 144527,
"email": "[email protected]",
"level_id": "N",
"insert_origin": "AUTO",
"inserted_by": 2,
"unsubscribed_at": null
}
]
},
"talk_events": [
{
"id": 80991,
"talk_id": 114603,
"event_id": 87,
"queue_id": 17,
"is_success": false,
"created_at": "2025-09-08T14:01:19.000000Z",
"agent_id": 2,
"channel_id": 1,
"reaction_type": "f",
"reaction_type_description": "Finalizar",
"event": {
"id": 87,
"description": "Finalizado pelo BOT",
"external_id": 12
}
}
],
"bot_variables": [
{
"var_name": "@botCustomerContext_id",
"value": "40109"
},
{
"var_name": "@bot_score",
"value": "90"
}
],
"bot": {
"id": 105,
"description": "Informativo - TROCA DE CANAL - 2025"
},
"service_catalog": {
"id": 71,
"description": "Teste ativo com id",
"external_id": "111"
}
}