< Voltar para as definições do objeto principal [talk].
Definição dos campos do objeto "talkHistory":
| Campos | Nullable | Descrição |
|---|---|---|
| id int | NÃO | Identificador interno do cliente; |
| talk_id int | NÃO | Identificador interno do atendimento; |
| user_id int | NÃO | Identificador interno do usuário que enviou a mensagem; |
| queue_id int | SIM | Identificador interno da fila onde o atendimento estava no momento do envio/recebimento da mensagem; |
| channel_id int | NÃO | Identificador interno do canal pelo qual a mensagem foi enviada/recebida; |
| message string | SIM | Corpo da mensagem; |
| has_attachment bool | NÃO | Flag para identificar se a mensagem possui anexo ou não; |
| attachment_url string | SIM | URL do anexo; |
| attachment_type_id enum {AUDIO, FILE, IMAGE, VIDEO, LOCATION, CONTACT, MENU, CATALOG, CATALOG_REPLY, CATALOG_ORDER, ADS, WEBCHAT_NOTIFICATION, PROPOSAL_ORDER, PIX_CODE, INVOICE} | SIM | Flag para identificar o tipo de anexo: * 1: Áudio; * 2: Arquivo; * 3: Imagem; * 4: Vídeo; * 5: Localização; * 6: Contato; * 7: Menu; * 8: Catálogo; * 9: Resposta de catálogo; * 10: Pedido de catálogo; * 11: Anúncio; * 12: Notificação do Webchat * 13: Pedido de proposta; * 14: Código PIX; * 15: Fatura; |
| sent_at datetime | NÃO | Data/hora do envio da mensagem; |
| delivered_at datetime | SIM | Data/hora que a mensagem foi entregue para o cliente; |
| read_at datetime | SIM | Data/hora que a mensagem foi lida pelo cliente ou agente; |
| created_at datetime | NÃO | Data/hora que a mensagem foi criada; |
| was_read bool | NÃO | Flag para identificar se a mensagem foi lida ou não; |
| has_highlight bool | NÃO | Flag para identificar se a mensagem possui uma palavra em destaque ou não; |
| from string | NÃO | Remente da mensagem; |
| type enum {IN, OUT, SYSTEM} | NÃO | Flag para identificar o tipo da mensagem: * IN: Mensagem recebida; * OUT: Mensagem enviada; * SYSTEM: Mensagem de sistema; |
| to string | NÃO | Destinatário da mensagem; |
| external_id string | SIM | Identificador externo da mensagem na Meta ou broker; |
| left_at datetime | SIM | Data/hora que a mensagem saiu da fila de envio do sistema; |
| has_error bool | NÃO | Flag para identificar se houve erro no envio da mensagem ou não; |
| campaign_id int | SIM | Identificador interno da campanha responsável pelo envio da mensagem; |
| was_blocked bool | NÃO | Flag para identificar se o envio da mensagem foi bloqueado ou não; |
| is_template bool | NÃO | Flag para identificar se a mensagem é um template; |
| response_from int | SIM | Identificador interno da mensagem que foi respondida; |
| fare float | SIM | CAMPO DEPRECIADO |
| error_reason string | SIM | Descrição do motivo do erro ou bloqueio no envio da mensagem; |
| template_id int | SIM | Identificador interno do template utilizado no envio da mensagem; |
| original_message string | SIM | Corpo da mensagem, sem tratamento de variáveis; |
| subject string | SIM | Assunto do e-mail; OBS: Esta informação está disponível apenas mensagens enviadas pelo canal E-mail; |
| exceeded_allowance bool | NÃO | CAMPO DEPRECIADO |
| is_intervention bool | NÃO | Flag para identificar se a mensagem foi enviada através de intervenção do supervisor ou não; |
| is_forwarded bool | NÃO | Flag para identificar se a mensagem recebida foi encaminhada pelo cliente ou não; |
| is_frequently_forwarded bool | NÃO | Flag para identificar se a mensagem recebida está sendo encaminhada com frequência por vários usuários do WhatsApp; |
| is_ads bool | NÃO | Flag para identificar se a mensagem foi enviada pelo cliente através de um link de anúncio da Meta; |
| is_reverted_template bool | NÃO | Flag para identificar se a mensagem era um HSM e foi revertido em mensagem comum pelo sistema; |
| reaction string | SIM | Emoji enviado como reação da mensagem; OBS: Esta informação está disponível apenas mensagens enviadas pelo canal WhatsApp; |
| customer_reaction string | SIM | Emoji recebido como reação da mensagem; OBS: Esta informação está disponível apenas mensagens enviadas pelo canal WhatsApp; |
| status enum {0, 1, 2, 3, 4, 5} | NÃO | Flag para identificar o status do envio da mensagem: * 0: Não enviada; * 1: Enviada; * 2: Entregue; * 3: Lida; * 4: Bloqueada; * 5: Erro no envio; |
| is_hidden bool | NÃO | Flag para identificar se o agente atual tem permissão para visualizar o conteúdo da mensagem; |
| file_name string | SIM | Nome do arquivo em anexo; |
| attachment_type <Object attachmentType> | SIM | Dados do tipo de anexo; |
| user <Object user> | NÃO | Dados do usuário |
| channel <Object channel> | NÃO | Dados do canal |
Exemplo de payload
{
"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
}
}