{"openapi":"3.1.0","info":{"title":"API FluxaChat","version":"1.0"},"servers":[{"url":"https://app.fluxachat.com.br"}],"paths":{"/api/v1/accounts/{account_id}":{"get":{"tags":["Account"],"operationId":"get-account-details","summary":"Obtenha detalhes da conta","description":"Obtenha os detalhes da conta corrente","security":[{"userApiKey":[]}],"parameters":[{"$ref":"#/components/parameters/account_id"}],"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/account_show_response"}}}},"401":{"description":"Não autorizado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}},"404":{"description":"Conta não encontrada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}}}},"patch":{"tags":["Account"],"operationId":"update-account","summary":"Atualizar conta","description":"Atualizar detalhes, configurações e atributos personalizados da conta","security":[{"userApiKey":[]}],"parameters":[{"$ref":"#/components/parameters/account_id"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/account_update_payload"}},"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/account_update_payload"}}}},"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/account_detail"}}}},"401":{"description":"Não autorizado (requer função de administrador)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}},"404":{"description":"Conta não encontrada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}},"422":{"description":"Erro de validação","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}}}}},"/api/v1/accounts/{account_id}/custom_attribute_definitions":{"get":{"tags":["Custom Attributes"],"operationId":"get-account-custom-attribute","summary":"Listar todos os atributos personalizados em uma conta","parameters":[{"name":"attribute_model","in":"query","schema":{"type":"string","enum":["0","1"]},"description":"atributo_conversa(0)/atributo_contato(1)","required":true}],"description":"Obtenha detalhes de atributos personalizados em uma conta","security":[{"userApiKey":[]}],"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"array","description":"Lista de todos os atributos personalizados","items":{"$ref":"#/components/schemas/custom_attribute"}}}}},"403":{"description":"Acesso negado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}}}},"post":{"tags":["Custom Attributes"],"operationId":"add-new-custom-attribute-to-account","summary":"Adicione um novo atributo personalizado","description":"Adicione um novo atributo personalizado à conta","security":[{"userApiKey":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/custom_attribute_create_update_payload"}}}},"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/custom_attribute"}}}},"403":{"description":"Acesso negado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}}}}},"/api/v1/accounts/{account_id}/custom_attribute_definitions/{id}":{"get":{"tags":["Custom Attributes"],"operationId":"get-details-of-a-single-custom-attribute","summary":"Obtenha detalhes de um atributo personalizado","security":[{"userApiKey":[]}],"description":"Obtenha os detalhes de um atributo personalizado na conta","parameters":[{"$ref":"#/components/parameters/account_id"},{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"O ID do atributo personalizado a ser atualizado."}],"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/custom_attribute"}}}},"401":{"description":"Não autorizado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}},"404":{"description":"O ID do atributo fornecido não existe na conta","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}}}},"patch":{"tags":["Custom Attributes"],"operationId":"update-custom-attribute-in-account","summary":"Atualizar atributo personalizado na conta","description":"Atualizar um atributo personalizado na conta","security":[{"userApiKey":[]}],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"O ID do atributo personalizado a ser atualizado."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/custom_attribute_create_update_payload"}}}},"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/custom_attribute"}}}},"403":{"description":"Acesso negado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}},"404":{"description":"Agente não encontrado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}}}},"delete":{"tags":["Custom Attributes"],"operationId":"delete-custom-attribute-from-account","summary":"Remover um atributo personalizado da conta","description":"Remover um atributo personalizado da conta","security":[{"userApiKey":[]}],"parameters":[{"$ref":"#/components/parameters/account_id"},{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"O ID do atributo personalizado a ser excluído"}],"responses":{"200":{"description":"Sucesso"},"403":{"description":"Acesso negado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}},"404":{"description":"Atributo personalizado não encontrado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}}}}},"/api/v1/accounts/{account_id}/contacts":{"get":{"tags":["Contacts"],"operationId":"contactList","description":"Listando todos os contatos resolvidos com paginação (Tamanho da página = 15). Contatos resolvidos são aqueles que possuem valor para identificador, e-mail ou número de telefone","summary":"Listar contatos","security":[{"userApiKey":[]}],"parameters":[{"$ref":"#/components/parameters/account_id"},{"$ref":"#/components/parameters/contact_sort_param"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/contacts_list_response"}}}},"400":{"description":"Erro de solicitação incorreta","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}}}},"post":{"tags":["Contacts"],"operationId":"contactCreate","description":"Crie um novo contato","summary":"Criar contato","security":[{"userApiKey":[]}],"parameters":[{"$ref":"#/components/parameters/account_id"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/contact_create_payload"}}}},"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/extended_contact"}}}},"400":{"description":"Erro de solicitação incorreta","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}}}}},"/api/v1/accounts/{account_id}/contacts/{id}":{"get":{"tags":["Contacts"],"operationId":"contactDetails","summary":"Mostrar contato","security":[{"userApiKey":[]}],"description":"Obtenha um contato pertencente à conta usando ID","responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/contact_show_response"}}}},"403":{"description":"Acesso negado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}},"404":{"description":"Contato não encontrado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}}}},"put":{"tags":["Contacts"],"operationId":"contactUpdate","summary":"Atualizar contato","security":[{"userApiKey":[]}],"description":"Atualizar um contato pertencente à conta usando ID","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/contact_update_payload"}}}},"responses":{"204":{"description":"Sucesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/contact_base"}}}},"403":{"description":"Acesso negado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}},"404":{"description":"Contato não encontrado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}}}},"delete":{"tags":["Contacts"],"operationId":"contactDelete","summary":"Excluir contato","security":[{"userApiKey":[]}],"description":"Exclua um contato pertencente à conta usando ID","responses":{"200":{"description":"Sucesso"},"401":{"description":"Não autorizado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}},"404":{"description":"Contato não encontrado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}}}}},"/api/v1/accounts/{account_id}/contacts/{id}/conversations":{"get":{"tags":["Contacts"],"operationId":"contactConversations","summary":"Conversas de contato","description":"Obtenha conversas associadas a esse contato","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"number"},"description":"ID do contato"}],"security":[{"userApiKey":[]}],"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/contact_conversations_response"}}}},"403":{"description":"Acesso negado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}},"404":{"description":"Contato não encontrado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}}}}},"/api/v1/accounts/{account_id}/contacts/{id}/labels":{"get":{"tags":["Contact Labels"],"operationId":"list-all-labels-of-a-contact","summary":"Listar rótulos","description":"Lista todos os marcadores de um contato","security":[{"userApiKey":[]}],"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/contact_labels"}}}},"401":{"description":"Não autorizado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}},"404":{"description":"Contato não encontrado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}}}},"post":{"tags":["Contact Labels"],"operationId":"contact-add-labels","summary":"Adicionar rótulos","description":"Adicione marcadores a um contato. Observe que esta API substituiria a lista existente de rótulos associados à conversa.","security":[{"userApiKey":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["labels"],"properties":{"labels":{"type":"array","description":"Lista de rótulos (strings separadas por vírgula)","items":{"type":"string"},"example":["support","billing"]}}}}}},"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/contact_labels"}}}},"401":{"description":"Não autorizado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}},"404":{"description":"Contato não encontrado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}}}}},"/api/v1/accounts/{account_id}/contacts/search":{"get":{"tags":["Contacts"],"operationId":"contactSearch","description":"Pesquise os contatos resolvidos usando uma chave de pesquisa, atualmente suporta pesquisa por e-mail (tamanho da página = 15). Contatos resolvidos são aqueles que possuem valor para identificador, e-mail ou número de telefone","summary":"Pesquisar contatos","security":[{"userApiKey":[]}],"parameters":[{"$ref":"#/components/parameters/account_id"},{"name":"q","in":"query","schema":{"type":"string"},"description":"Pesquise usando o contato `name`, `identifier`, `email` ou `phone number`"},{"$ref":"#/components/parameters/contact_sort_param"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/contacts_list_response"}}}},"401":{"description":"Erro de autenticação","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}}}}},"/api/v1/accounts/{account_id}/contacts/filter":{"post":{"tags":["Contacts"],"operationId":"contactFilter","description":"Filtre contatos com opções de filtro personalizadas e paginação","summary":"Filtro de contato","security":[{"userApiKey":[]}],"parameters":[{"$ref":"#/components/parameters/account_id"},{"name":"page","in":"query","schema":{"type":"number"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"payload":{"type":"array","items":{"type":"object","properties":{"attribute_key":{"type":"string","description":"nome do atributo do filtro"},"filter_operator":{"type":"string","description":"nome do operador de filtro","enum":["equal_to","not_equal_to","contains","does_not_contain"]},"values":{"type":"array","items":{"type":"string"},"description":"lista dos valores de atributos a serem filtrados"},"query_operator":{"type":"string","description":"nome do operador de consulta","enum":["AND","OR"]}}},"example":[{"attribute_key":"name","filter_operator":"equal_to","values":["en"],"query_operator":"AND"},{"attribute_key":"country_code","filter_operator":"equal_to","values":["us"],"query_operator":null}]}}}}}},"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/contacts_list_response"}}}},"400":{"description":"Erro de solicitação incorreta","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}}}}},"/api/v1/accounts/{account_id}/contacts/{id}/contact_inboxes":{"post":{"tags":["Contacts"],"operationId":"contactInboxCreation","description":"Crie um registro de caixa de entrada de contato para uma caixa de entrada","summary":"Criar caixa de entrada de contato","parameters":[{"$ref":"#/components/parameters/account_id"},{"name":"id","in":"path","schema":{"type":"number"},"description":"ID do contato","required":true}],"security":[{"userApiKey":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["inbox_id"],"properties":{"inbox_id":{"type":"number","description":"O ID da caixa de entrada","example":1},"source_id":{"type":"string","description":"ID de origem da caixa de entrada do contato"}}}}}},"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/contact_inboxes"}}}},"401":{"description":"Erro de autenticação","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}},"422":{"description":"Carga útil incorreta","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}}}}},"/api/v1/accounts/{account_id}/contacts/{id}/contactable_inboxes":{"get":{"tags":["Contacts"],"operationId":"contactableInboxesGet","description":"Obtenha uma lista de caixas de entrada contatáveis","summary":"Obtenha caixas de entrada contatáveis","security":[{"userApiKey":[]}],"parameters":[{"$ref":"#/components/parameters/account_id"},{"name":"id","in":"path","schema":{"type":"number"},"description":"ID do contato","required":true}],"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/contactable_inboxes_response"}}}},"401":{"description":"Erro de autenticação","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}},"422":{"description":"Carga útil incorreta","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}}}}},"/api/v1/accounts/{account_id}/actions/contact_merge":{"post":{"tags":["Contacts"],"operationId":"contactMerge","summary":"Mesclar contatos","security":[{"userApiKey":[]}],"description":"Mesclar dois contatos em um único contato. O contato base permanece e recebe todos\ndados do contato mesclado. Após a mesclagem, o contato mesclado será excluído permanentemente.\n\nEsta ação é irreversível. Todas as conversas, rótulos e atributos personalizados do\no contato mesclado será movido para o contato base.\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["base_contact_id","mergee_contact_id"],"properties":{"base_contact_id":{"type":"integer","description":"ID do contato que permanecerá após a mesclagem e receberá todos os dados","example":1},"mergee_contact_id":{"type":"integer","description":"ID do contato que será mesclado no contato base e excluído","example":2}}}}}},"responses":{"200":{"description":"Contatos mesclados com sucesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/contact_base"}}}},"400":{"description":"Solicitação incorreta – IDs de contato inválidos ou contatos não podem ser mesclados","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}},"401":{"description":"Não autorizado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}},"404":{"description":"Um ou ambos os contatos não encontrados","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}}}}},"/api/v1/accounts/{account_id}/automation_rules":{"get":{"tags":["Automation Rule"],"operationId":"get-account-automation-rule","summary":"Liste todas as regras de automação em uma conta","parameters":[{"$ref":"#/components/parameters/account_id"},{"$ref":"#/components/parameters/page"}],"description":"Obtenha detalhes das regras de automação em uma conta","security":[{"userApiKey":[]}],"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/automation_rule"}}}},"403":{"description":"Acesso negado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}}}},"post":{"tags":["Automation Rule"],"operationId":"add-new-automation-rule-to-account","summary":"Adicione uma nova regra de automação","description":"Adicione uma nova regra de automação à conta","security":[{"userApiKey":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/automation_rule_create_update_payload"}}}},"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/automation_rule"}}}},"403":{"description":"Acesso negado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}}}}},"/api/v1/accounts/{account_id}/automation_rules/{id}":{"get":{"tags":["Automation Rule"],"operationId":"get-details-of-a-single-automation-rule","summary":"Obtenha detalhes de uma regra de automação","description":"Obtenha os detalhes de uma regra de automação na conta","security":[{"userApiKey":[]}],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"O ID da regra de automação a ser atualizada."}],"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/automation_rule"},"example":{"payload":{"id":90,"account_id":1,"name":"add-label-bug-if-message-contains-bug","description":"add-label-bug-if-message-contains-bug","event_name":"message_created","conditions":[{"values":["incoming"],"attribute_key":"message_type","query_operator":"and","filter_operator":"equal_to"},{"values":["bug"],"attribute_key":"content","filter_operator":"contains"}],"actions":[{"action_name":"add_label","action_params":["bugs","support-query"]}],"created_on":1650555440,"active":true}}}}},"401":{"description":"Não autorizado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}},"404":{"description":"O ID de regra fornecido não existe na conta","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}}}},"patch":{"tags":["Automation Rule"],"operationId":"update-automation-rule-in-account","summary":"Atualizar regra de automação na conta","description":"Atualizar uma regra de automação na conta","security":[{"userApiKey":[]}],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"O ID da regra de automação a ser atualizada."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/automation_rule_create_update_payload"}}}},"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/automation_rule"}}}},"403":{"description":"Acesso negado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}},"404":{"description":"Regra não encontrada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}}}},"delete":{"tags":["Automation Rule"],"operationId":"delete-automation-rule-from-account","summary":"Remover uma regra de automação da conta","description":"Remover uma regra de automação da conta","security":[{"userApiKey":[]}],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"O ID da regra de automação a ser excluída"}],"responses":{"200":{"description":"Sucesso"},"403":{"description":"Acesso negado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}},"404":{"description":"regra de automação não encontrada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}}}}},"/api/v1/accounts/{account_id}/conversations/meta":{"get":{"tags":["Conversations"],"operationId":"conversationListMeta","description":"Seja aberto, não atribuído e todas as conversas contam","summary":"Obtenha contagens de conversas","security":[{"userApiKey":[]}],"parameters":[{"name":"status","in":"query","schema":{"type":"string","enum":["all","open","resolved","pending","snoozed"],"default":"open"},"description":"Filtre por status da conversa."},{"name":"q","in":"query","schema":{"type":"string"},"description":"Filtra conversas com mensagens contendo o termo de pesquisa"},{"name":"inbox_id","in":"query","schema":{"type":"integer"}},{"name":"team_id","in":"query","schema":{"type":"integer"}},{"name":"labels","in":"query","schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"type":"object","properties":{"mine_count":{"type":"number"},"unassigned_count":{"type":"number"},"assigned_count":{"type":"number"},"all_count":{"type":"number"}}}}}}}},"400":{"description":"Erro de solicitação incorreta","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}}}}},"/api/v1/accounts/{account_id}/conversations":{"get":{"tags":["Conversations"],"operationId":"conversationList","description":"Liste todas as conversas com paginação","summary":"Lista de conversas","security":[{"userApiKey":[]}],"parameters":[{"name":"assignee_type","in":"query","schema":{"type":"string","enum":["me","unassigned","all","assigned"],"default":"all"},"description":"Filtre conversas por tipo de destinatário."},{"name":"status","in":"query","schema":{"type":"string","enum":["all","open","resolved","pending","snoozed"],"default":"open"},"description":"Filtre por status da conversa."},{"name":"q","in":"query","schema":{"type":"string"},"description":"Filtra conversas com mensagens contendo o termo de pesquisa"},{"name":"inbox_id","in":"query","schema":{"type":"integer"}},{"name":"team_id","in":"query","schema":{"type":"integer"}},{"name":"labels","in":"query","schema":{"type":"array","items":{"type":"string"}}},{"name":"page","in":"query","schema":{"type":"integer","default":1},"description":"paginar pelas conversas"}],"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/conversation_list"}}}},"400":{"description":"Erro de solicitação incorreta","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}}}},"post":{"tags":["Conversations"],"operationId":"newConversation","summary":"Criar nova conversa","description":"Criar uma conversa no FluxaChat requer um ID de origem. \n\n Saiba mais sobre source_id: https://www.FluxaChat.com/hc/user-guide/articles/1677839703-how-to-create-an-api-channel-inbox#send-messages-to-the-api-channel","security":[{"userApiKey":[]},{"agentBotApiKey":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/conversation_create_payload"}}}},"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"number","description":"ID da conversa"},"account_id":{"type":"number","description":"ID da conta"},"inbox_id":{"type":"number","description":"ID da caixa de entrada"}}}}}},"403":{"description":"Acesso negado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}}}}},"/api/v1/accounts/{account_id}/conversations/filter":{"post":{"tags":["Conversations"],"operationId":"conversationFilter","description":"Filtre conversas com opções de filtro e paginação personalizadas","summary":"Filtro de conversas","security":[{"userApiKey":[]}],"parameters":[{"name":"page","in":"query","schema":{"type":"number"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"payload":{"type":"array","items":{"type":"object","properties":{"attribute_key":{"type":"string","description":"nome do atributo do filtro"},"filter_operator":{"type":"string","description":"nome do operador de filtro","enum":["equal_to","not_equal_to","contains","does_not_contain"]},"values":{"type":"array","items":{"type":"string"},"description":"lista dos valores de atributos a serem filtrados"},"query_operator":{"type":"string","description":"nome do operador de consulta","enum":["AND","OR"]}}},"example":[{"attribute_key":"browser_language","filter_operator":"not_equal_to","values":["en"],"query_operator":"AND"},{"attribute_key":"status","filter_operator":"equal_to","values":["pending"],"query_operator":null}]}}}}}},"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/conversation_list"}}}},"400":{"description":"Erro de solicitação incorreta","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}}}}},"/api/v1/accounts/{account_id}/conversations/{conversation_id}":{"get":{"tags":["Conversations"],"operationId":"get-details-of-a-conversation","summary":"Detalhes da conversa","security":[{"userApiKey":[]}],"description":"Obtenha todos os detalhes sobre uma conversa com todas as mensagens da conversa","responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/conversation_show"}}}},"403":{"description":"Acesso negado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}},"404":{"description":"Conversa não encontrada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}}}},"patch":{"tags":["Conversations"],"operationId":"update-conversation","summary":"Atualizar conversa","description":"Atualizar atributos de conversa","security":[{"userApiKey":[]},{"agentBotApiKey":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"priority":{"type":"string","enum":["urgent","high","medium","low","none"],"description":"A prioridade da conversa","example":"high"},"sla_policy_id":{"type":"number","description":"O ID da política de SLA (disponível apenas na edição Enterprise)","example":1}}}}}},"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/conversation"}}}},"401":{"description":"Não autorizado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}},"404":{"description":"Conversa não encontrada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}}}}},"/api/v1/accounts/{account_id}/conversations/{conversation_id}/toggle_status":{"post":{"tags":["Conversations"],"operationId":"toggle-status-of-a-conversation","summary":"Alternar status","description":"Alternar o status de uma conversa. Passe `status` para definir explicitamente o\nestado de conversa. Use `snoozed` junto com `snoozed_until` para adiar um\nconversa até um horário específico. Se `snoozed_until` for omitido, o\na conversa é adiada até a próxima resposta do contato. Independentemente\ndo valor fornecido, as conversas adiadas sempre reabrem no próximo\nresposta do contato.","security":[{"userApiKey":[]},{"agentBotApiKey":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["status"],"properties":{"status":{"type":"string","enum":["open","resolved","pending","snoozed"],"description":"O status da conversa","example":"open"},"snoozed_until":{"type":"number","description":"Quando o status for `snoozed`, agende o horário de reabertura como um carimbo de data/hora Unix em segundos. Se não for fornecido, a conversa será adiada até a próxima resposta do cliente. A conversa sempre reabre quando o cliente responde.","example":1757506877}}}}}},"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"type":"object"},"payload":{"type":"object","properties":{"success":{"type":"boolean"},"current_status":{"type":"string","enum":["open","resolved","pending","snoozed"]},"conversation_id":{"type":"number"}}}}}}}},"401":{"description":"Não autorizado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}},"404":{"description":"Conversa não encontrada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}}}}},"/api/v1/accounts/{account_id}/conversations/{conversation_id}/toggle_priority":{"post":{"tags":["Conversations"],"operationId":"toggle-priority-of-a-conversation","summary":"Alternar prioridade","description":"Alterna a prioridade da conversa","security":[{"userApiKey":[]},{"agentBotApiKey":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["priority"],"properties":{"priority":{"type":"string","enum":["urgent","high","medium","low","none"],"description":"A prioridade da conversa","example":"high"}}}}}},"responses":{"200":{"description":"Sucesso"},"401":{"description":"Não autorizado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}},"404":{"description":"Conversa não encontrada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}}}}},"/api/v1/accounts/{account_id}/conversations/{conversation_id}/toggle_typing_status":{"post":{"tags":["Conversations"],"operationId":"toggle-typing-status-of-a-conversation","summary":"Alternar status de digitação","description":"Alterna o status de digitação de uma conversa.","security":[{"userApiKey":[]},{"agentBotApiKey":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["typing_status"],"properties":{"typing_status":{"type":"string","enum":["on","off"],"description":"Digitando status para definir.","example":"on"},"is_private":{"type":"boolean","description":"Se o evento de digitação é para notas privadas.","example":false}}}}}},"responses":{"200":{"description":"Sucesso"},"401":{"description":"Não autorizado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}},"404":{"description":"Conversa não encontrada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}}}}},"/api/v1/accounts/{account_id}/conversations/{conversation_id}/custom_attributes":{"post":{"tags":["Conversations"],"operationId":"update-custom-attributes-of-a-conversation","summary":"Atualizar atributos personalizados","description":"Atualiza os atributos personalizados de uma conversa","security":[{"userApiKey":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["custom_attributes"],"properties":{"custom_attributes":{"type":"object","description":"Os atributos personalizados a serem definidos para a conversa","example":{"order_id":"12345","previous_conversation":"67890"}}}}}}},"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"custom_attributes":{"type":"object","description":"Os atributos personalizados da conversa"}}}}}},"401":{"description":"Não autorizado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}},"404":{"description":"Conversa não encontrada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}}}}},"/api/v1/accounts/{account_id}/conversations/{conversation_id}/assignments":{"post":{"tags":["Conversation Assignments"],"operationId":"assign-a-conversation","summary":"Atribuir conversa","description":"Atribuir uma conversa a um agente ou equipe","security":[{"userApiKey":[]},{"agentBotApiKey":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"assignee_id":{"type":"number","description":"ID do usuário destinatário","example":1},"team_id":{"type":"number","description":"ID da equipe. Se o assignee_id estiver presente, este parâmetro será ignorado","example":1}}}}}},"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/user"}}}},"401":{"description":"Não autorizado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}},"404":{"description":"Conversa não encontrada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}}}}},"/api/v1/accounts/{account_id}/conversations/{conversation_id}/labels":{"get":{"tags":["Conversations"],"operationId":"list-all-labels-of-a-conversation","summary":"Listar rótulos","security":[{"userApiKey":[]}],"description":"Lista todos os marcadores de uma conversa","responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/conversation_labels"}}}},"401":{"description":"Não autorizado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}},"404":{"description":"Conversa não encontrada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}}}},"post":{"tags":["Conversations"],"operationId":"conversation-add-labels","summary":"Adicionar rótulos","security":[{"userApiKey":[]}],"description":"Adicione marcadores a uma conversa. Observe que esta API substituiria a lista existente de rótulos associados à conversa.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["labels"],"properties":{"labels":{"type":"array","description":"Lista de rótulos (strings separadas por vírgula)","items":{"type":"string"},"example":["support","billing"]}}}}}},"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/conversation_labels"}}}},"401":{"description":"Não autorizado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}},"404":{"description":"Conversa não encontrada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}}}}},"/api/v1/accounts/{account_id}/conversations/{conversation_id}/reporting_events":{"get":{"tags":["Conversations"],"operationId":"get-conversation-reporting-events","summary":"Eventos de relatórios de conversas","security":[{"userApiKey":[]}],"description":"Obtenha relatórios de eventos para uma conversa específica. Este endpoint retorna eventos como tempo de primeira resposta, tempo de resolução e outras métricas da conversa, classificados por horário de criação em ordem crescente.","responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/reporting_event"},"description":"Lista de eventos de relatório para a conversa"}}}},"403":{"description":"Acesso negado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}},"404":{"description":"Conversa não encontrada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}}}}},"/api/v1/accounts/{account_id}/inboxes":{"get":{"tags":["Inboxes"],"operationId":"listAllInboxes","summary":"Listar todas as caixas de entrada","description":"Liste todas as caixas de entrada disponíveis na conta corrente","security":[{"userApiKey":[]}],"parameters":[{"$ref":"#/components/parameters/account_id"}],"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"payload":{"type":"array","description":"Lista de caixas de entrada","items":{"$ref":"#/components/schemas/inbox"}}}}}}},"403":{"description":"Acesso negado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}},"404":{"description":"Caixa de entrada não encontrada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}}}},"post":{"tags":["Inboxes"],"operationId":"inboxCreation","summary":"Crie uma caixa de entrada","description":"Você pode criar mais de uma caixa de entrada de site em cada conta","security":[{"userApiKey":[]}],"parameters":[{"$ref":"#/components/parameters/account_id"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/inbox_create_payload"},"examples":{"web_widget":{"summary":"Caixa de entrada do site","value":{"name":"Support","greeting_enabled":true,"greeting_message":"Hello, how can I help you?","enable_email_collect":true,"enable_auto_assignment":true,"working_hours_enabled":true,"timezone":"America/New_York","allow_messages_after_resolved":true,"channel":{"type":"web_widget","website_url":"https://example.com","welcome_title":"Welcome to our support","welcome_tagline":"We are here to help you","widget_color":"#FF5733","reply_time":"in_a_few_minutes","pre_chat_form_enabled":false,"continuity_via_email":true,"hmac_mandatory":false,"selected_feature_flags":["attachments","emoji_picker","end_conversation"]}}},"api":{"summary":"Canal de API","value":{"name":"API Inbox","greeting_enabled":true,"greeting_message":"Hello, how can I help you?","enable_auto_assignment":true,"working_hours_enabled":true,"timezone":"America/New_York","channel":{"type":"api","webhook_url":"https://example.com/webhook","hmac_mandatory":false,"additional_attributes":{"source":"mobile_app"}}}},"email":{"summary":"Canal de e-mail","value":{"name":"Email Inbox","greeting_enabled":true,"greeting_message":"Hello, how can I help you?","enable_auto_assignment":true,"working_hours_enabled":true,"timezone":"America/New_York","channel":{"type":"email","email":"support@example.com","imap_enabled":false,"smtp_enabled":false}}},"line":{"summary":"canal LINHA","value":{"name":"LINE Inbox","greeting_enabled":true,"greeting_message":"Hello, how can I help you?","enable_auto_assignment":true,"working_hours_enabled":true,"timezone":"America/New_York","channel":{"type":"line","line_channel_id":"1234567890","line_channel_secret":"line-channel-secret","line_channel_token":"line-channel-token"}}},"telegram":{"summary":"Canal de telegrama","value":{"name":"Telegram Inbox","greeting_enabled":true,"greeting_message":"Hello, how can I help you?","enable_auto_assignment":true,"working_hours_enabled":true,"timezone":"America/New_York","channel":{"type":"telegram","bot_token":"123456789:telegram-bot-token"}}},"whatsapp":{"summary":"Canal WhatsApp","value":{"name":"WhatsApp Inbox","greeting_enabled":true,"greeting_message":"Hello, how can I help you?","enable_auto_assignment":true,"working_hours_enabled":true,"timezone":"America/New_York","channel":{"type":"whatsapp","phone_number":"+15551234567","provider":"whatsapp_cloud","provider_config":{"api_key":"your-api-key","phone_number_id":"your-phone-number-id","business_account_id":"your-business-account-id"}}}},"sms":{"summary":"Canal SMS","value":{"name":"SMS Inbox","greeting_enabled":true,"greeting_message":"Hello, how can I help you?","enable_auto_assignment":true,"working_hours_enabled":true,"timezone":"America/New_York","channel":{"type":"sms","phone_number":"+15551234567","provider_config":{"api_key":"your-api-key","api_secret":"your-api-secret","application_id":"your-application-id","account_id":"your-account-id"}}}}}}}},"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/inbox"}}}},"403":{"description":"Acesso negado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}},"404":{"description":"Caixa de entrada não encontrada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}}}}},"/api/v1/accounts/{account_id}/inboxes/{id}":{"get":{"tags":["Inboxes"],"operationId":"GetInbox","summary":"Obtenha uma caixa de entrada","security":[{"userApiKey":[]}],"description":"Obtenha uma caixa de entrada disponível na conta corrente","parameters":[{"$ref":"#/components/parameters/account_id"},{"name":"id","in":"path","schema":{"type":"number"},"description":"ID da caixa de entrada","required":true}],"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/inbox"}}}},"403":{"description":"Acesso negado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}},"404":{"description":"Caixa de entrada não encontrada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}}}},"patch":{"tags":["Inboxes"],"operationId":"updateInbox","summary":"Atualizar caixa de entrada","security":[{"userApiKey":[]}],"description":"Atualizar uma caixa de entrada existente","parameters":[{"$ref":"#/components/parameters/account_id"},{"name":"id","in":"path","schema":{"type":"number"},"description":"ID da caixa de entrada","required":true}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/inbox_update_payload"},"examples":{"web_widget":{"summary":"Configurações da caixa de entrada do site","value":{"name":"Support","greeting_enabled":true,"greeting_message":"Hello, how can I help you?","enable_email_collect":true,"enable_auto_assignment":true,"working_hours_enabled":true,"timezone":"America/New_York","allow_messages_after_resolved":true,"channel":{"website_url":"https://example.com","welcome_title":"Welcome to our support","welcome_tagline":"We are here to help you","widget_color":"#FF5733","reply_time":"in_a_few_minutes","pre_chat_form_enabled":false,"continuity_via_email":true,"hmac_mandatory":false,"selected_feature_flags":["attachments","emoji_picker","end_conversation"]}}},"api":{"summary":"Configurações do canal API","value":{"name":"API Inbox","greeting_enabled":true,"greeting_message":"Hello, how can I help you?","enable_auto_assignment":true,"working_hours_enabled":true,"timezone":"America/New_York","channel":{"webhook_url":"https://example.com/webhook","hmac_mandatory":false,"additional_attributes":{"source":"mobile_app"}}}},"email":{"summary":"Configurações do canal de e-mail","value":{"name":"Email Inbox","greeting_enabled":true,"greeting_message":"Hello, how can I help you?","enable_auto_assignment":true,"working_hours_enabled":true,"timezone":"America/New_York","channel":{"email":"support@example.com","imap_enabled":false,"smtp_enabled":false}}},"line":{"summary":"Configurações do canal LINE","value":{"name":"LINE Inbox","greeting_enabled":true,"greeting_message":"Hello, how can I help you?","enable_auto_assignment":true,"working_hours_enabled":true,"timezone":"America/New_York","channel":{"line_channel_id":"1234567890","line_channel_secret":"line-channel-secret","line_channel_token":"line-channel-token"}}},"telegram":{"summary":"Configurações do canal de telegrama","value":{"name":"Telegram Inbox","greeting_enabled":true,"greeting_message":"Hello, how can I help you?","enable_auto_assignment":true,"working_hours_enabled":true,"timezone":"America/New_York","channel":{"bot_token":"123456789:telegram-bot-token"}}},"whatsapp":{"summary":"Configurações do canal WhatsApp","value":{"name":"WhatsApp Inbox","greeting_enabled":true,"greeting_message":"Hello, how can I help you?","enable_auto_assignment":true,"working_hours_enabled":true,"timezone":"America/New_York","channel":{"phone_number":"+15551234567","provider":"whatsapp_cloud","provider_config":{"api_key":"your-api-key","phone_number_id":"your-phone-number-id","business_account_id":"your-business-account-id"}}}},"sms":{"summary":"Configurações do canal SMS","value":{"name":"SMS Inbox","greeting_enabled":true,"greeting_message":"Hello, how can I help you?","enable_auto_assignment":true,"working_hours_enabled":true,"timezone":"America/New_York","channel":{"phone_number":"+15551234567","provider_config":{"api_key":"your-api-key","api_secret":"your-api-secret","application_id":"your-application-id","account_id":"your-account-id"}}}}}}}},"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/inbox"}}}},"403":{"description":"Acesso negado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}},"404":{"description":"Caixa de entrada não encontrada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}}}}},"/api/v1/accounts/{account_id}/inboxes/{id}/agent_bot":{"get":{"tags":["Inboxes"],"operationId":"getInboxAgentBot","summary":"Mostrar bot do agente da caixa de entrada","description":"Veja se um bot agente está associado à Caixa de entrada","security":[{"userApiKey":[]}],"parameters":[{"$ref":"#/components/parameters/account_id"},{"name":"id","in":"path","schema":{"type":"number"},"description":"ID da caixa de entrada","required":true}],"responses":{"204":{"description":"Sucesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/agent_bot"}}}},"403":{"description":"Acesso negado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}},"404":{"description":"Caixa de entrada não encontrada, bot do agente não encontrado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}}}}},"/api/v1/accounts/{account_id}/inboxes/{id}/set_agent_bot":{"post":{"tags":["Inboxes"],"operationId":"updateAgentBot","summary":"Adicionar ou remover agente bot","security":[{"userApiKey":[]}],"description":"Para adicionar um passe de bot do agente, ID do agente_bot, para remover o bot do agente de uma caixa de entrada, passe null","parameters":[{"$ref":"#/components/parameters/account_id"},{"name":"id","in":"path","schema":{"type":"number"},"description":"ID da caixa de entrada","required":true}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["agent_bot"],"properties":{"agent_bot":{"type":"number","description":"ID do bot do agente","example":1}}}}}},"responses":{"204":{"description":"Sucesso"},"403":{"description":"Acesso negado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}},"404":{"description":"Caixa de entrada não encontrada, bot do agente não encontrado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}}}}},"/api/v1/accounts/{account_id}/inbox_members/{inbox_id}":{"get":{"tags":["Inboxes"],"operationId":"get-inbox-members","summary":"Listar agentes na caixa de entrada","description":"Obtenha detalhes dos agentes em uma caixa de entrada","security":[{"userApiKey":[]}],"parameters":[{"$ref":"#/components/parameters/inbox_id"}],"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"payload":{"type":"array","description":"Lista de todos os agentes ativos","items":{"$ref":"#/components/schemas/agent"}}}}}}},"403":{"description":"Acesso negado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}},"404":{"description":"Caixa de entrada não encontrada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}}}}},"/api/v1/accounts/{account_id}/inbox_members":{"post":{"tags":["Inboxes"],"operationId":"add-new-agent-to-inbox","summary":"Adicionar um novo agente","description":"Adicionar um novo agente à caixa de entrada","security":[{"userApiKey":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["inbox_id","user_ids"],"properties":{"inbox_id":{"type":"integer","description":"O ID da caixa de entrada","example":1},"user_ids":{"type":"array","items":{"type":"integer"},"description":"IDs de usuários a serem adicionados à caixa de entrada","example":[1]}}}}}},"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"payload":{"type":"array","description":"Lista de todos os agentes ativos","items":{"$ref":"#/components/schemas/agent"}}}}}}},"403":{"description":"Acesso negado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}},"404":{"description":"Caixa de entrada não encontrada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}},"422":{"description":"O usuário deve existir","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}}}},"patch":{"tags":["Inboxes"],"operationId":"update-agents-in-inbox","summary":"Atualizar agentes na caixa de entrada","description":"Todos os agentes, exceto aquele passado nos parâmetros, serão removidos","security":[{"userApiKey":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["inbox_id","user_ids"],"properties":{"inbox_id":{"type":"string","description":"O ID da caixa de entrada","example":1},"user_ids":{"type":"array","items":{"type":"integer"},"description":"IDs de usuários a serem adicionados à caixa de entrada","example":[1]}}}}}},"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"payload":{"type":"array","description":"Lista de todos os agentes ativos","items":{"$ref":"#/components/schemas/agent"}}}}}}},"403":{"description":"Acesso negado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}},"404":{"description":"Caixa de entrada não encontrada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}},"422":{"description":"O usuário deve existir","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}}}},"delete":{"tags":["Inboxes"],"operationId":"delete-agent-in-inbox","summary":"Remover um agente da caixa de entrada","description":"Remover um agente da caixa de entrada","security":[{"userApiKey":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["inbox_id","user_ids"],"properties":{"inbox_id":{"type":"string","description":"O ID da caixa de entrada"},"user_ids":{"type":"array","items":{"type":"integer"},"description":"IDs de usuários a serem excluídos da caixa de entrada"}}}}}},"responses":{"200":{"description":"Sucesso"},"403":{"description":"Acesso negado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}},"404":{"description":"Caixa de entrada não encontrada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}},"422":{"description":"O usuário deve existir","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}}}}},"/api/v1/accounts/{account_id}/labels":{"get":{"tags":["Labels"],"operationId":"list-all-labels","summary":"Listar todos os rótulos","security":[{"userApiKey":[]}],"description":"Listar todos os rótulos disponíveis na conta corrente","responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"payload":{"type":"array","description":"Lista de rótulos","items":{"$ref":"#/components/schemas/label"}}}}}}},"401":{"description":"Não autorizado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}}}},"post":{"tags":["Labels"],"operationId":"create-a-label","summary":"Crie um rótulo","security":[{"userApiKey":[]}],"description":"Crie um rótulo na conta","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/label_create_update_payload"}}}},"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/label"}}}},"401":{"description":"Não autorizado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}}}}},"/api/v1/accounts/{account_id}/labels/{id}":{"get":{"tags":["Labels"],"operationId":"get-details-of-a-single-label","summary":"Obtenha uma etiqueta","security":[{"userApiKey":[]}],"description":"Obtenha os detalhes de um rótulo na conta","responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/label"}}}},"401":{"description":"Não autorizado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}},"404":{"description":"O ID do rótulo fornecido não existe na conta","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}}}},"patch":{"tags":["Labels"],"operationId":"update-a-label","summary":"Atualizar um rótulo","security":[{"userApiKey":[]}],"description":"Atualizar os atributos de um rótulo","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/label_create_update_payload"}}}},"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/label"}}}},"401":{"description":"Não autorizado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}}}},"delete":{"tags":["Labels"],"operationId":"delete-a-label","summary":"Excluir um rótulo","security":[{"userApiKey":[]}],"description":"Excluir um marcador da conta","responses":{"200":{"description":"Sucesso"},"401":{"description":"Não autorizado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}},"404":{"description":"O rótulo não existe na conta","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}}}}},"/api/v1/accounts/{account_id}/conversations/{conversation_id}/messages":{"get":{"tags":["Messages"],"operationId":"list-all-messages","summary":"Receber mensagens","security":[{"userApiKey":[]}],"description":"Listar todas as mensagens de uma conversa","parameters":[{"name":"after","in":"query","schema":{"type":"integer"},"description":"Busque mensagens após a mensagem com este ID. Retorna até 100 mensagens em ordem crescente."},{"name":"before","in":"query","schema":{"type":"integer"},"description":"Busque mensagens antes da mensagem com este ID. Retorna até 20 mensagens em ordem crescente."}],"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"type":"object","properties":{"labels":{"type":"array","items":{"type":"string"}},"additional_attributes":{"type":"object"},"contact":{"$ref":"#/components/schemas/contact"},"assignee":{"$ref":"#/components/schemas/agent"},"agent_last_seen_at":{"type":["string","null"],"format":"date-time"},"assignee_last_seen_at":{"type":["string","null"],"format":"date-time"}}},"payload":{"type":"array","description":"Lista de mensagens","items":{"$ref":"#/components/schemas/message"}}}}}}},"401":{"description":"Não autorizado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}},"404":{"description":"Conversa não encontrada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}}}},"post":{"tags":["Messages"],"operationId":"create-a-new-message-in-a-conversation","summary":"Criar nova mensagem","description":"Crie uma nova mensagem na conversa.\n\nUse `application/json` para mensagens de texto e `multipart/form-data` quando o\na mensagem inclui anexos de arquivo.\n\n### Solicitação de anexo multiparte\n\nEnvie arquivos com o campo do formulário `attachments[]`. `curl -F` define o\n`multipart/form-data` tipo de conteúdo e limite automaticamente.\n\n```bash\ncurl -X POST \"https://app.FluxaChat.com/api/v1/accounts/{account_id}/conversations/{conversation_id}/messages\" \\\n  -H \"api_access_token: <your-api-token>\" \\\n  -F \"content=Here is the screenshot\" \\\n  -F \"message_type=outgoing\" \\\n  -F \"private=false\" \\\n  -F \"attachments[]=@/path/to/screenshot.png\"\n```\n\n## Mensagens de modelo do WhatsApp\n\nPara canais do WhatsApp, você pode enviar mensagens modelo estruturadas usando o campo `template_params`. \nOs modelos devem ser pré-aprovados no WhatsApp Business Manager.\n\n### Modelos de exemplo\n\n**Texto com cabeçalho de imagem:**\n```json\n{\n  \"content\": \"Hi your order 121212 is confirmed. Please wait for further updates\",\n  \"template_params\": {\n    \"name\": \"order_confirmation\",\n    \"category\": \"MARKETING\",\n    \"language\": \"en\",\n    \"processed_params\": {\n      \"body\": {\n        \"1\": \"121212\"\n      },\n      \"header\": {\n        \"media_url\": \"https://picsum.photos/200/300\",\n        \"media_type\": \"image\"\n      }\n    }\n  }\n}\n```\n\n**Texto com botão Copiar código:**\n```json\n{\n  \"content\": \"Special offer! Get 30% off your next purchase. Use the code below\",\n  \"template_params\": {\n    \"name\": \"discount_coupon\",\n    \"category\": \"MARKETING\",\n    \"language\": \"en\",\n    \"processed_params\": {\n      \"body\": {\n        \"discount_percentage\": \"30\"\n      },\n      \"buttons\": [{\n        \"type\": \"copy_code\",\n        \"parameter\": \"SAVE20\"\n      }]\n    }\n  }\n}\n```\n","security":[{"userApiKey":[]},{"agentBotApiKey":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/conversation_message_create_payload"}},"multipart/form-data":{"schema":{"type":"object","description":"Carga útil de dados de formulário para criar uma mensagem com anexos de arquivo.","example":{"content":"Here is the screenshot","message_type":"outgoing","private":false,"attachments[]":["screenshot.png"]},"properties":{"content":{"type":"string","description":"O conteúdo da mensagem","example":"Here is the screenshot"},"message_type":{"type":"string","enum":["outgoing","incoming"],"description":"O tipo da mensagem","example":"outgoing"},"private":{"type":"boolean","description":"Sinalizador para identificar se é uma nota privada","example":false},"content_type":{"type":"string","enum":["text","input_email","cards","input_select","form","article"],"description":"Tipo de conteúdo da mensagem","example":"text"},"content_attributes":{"type":"object","description":"Atributos baseados no tipo de conteúdo","example":{}},"attachments[]":{"type":"array","description":"Arquivos para anexar à mensagem","items":{"type":"string","format":"binary"}}}},"encoding":{"attachments[]":{"style":"form","explode":true}},"examples":{"attachment_message":{"summary":"Mensagem com anexo","value":{"content":"Here is the screenshot","message_type":"outgoing","private":false,"attachments[]":["screenshot.png"]}}}}}},"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/generic_id"},{"$ref":"#/components/schemas/message"}]}}}},"403":{"description":"Acesso negado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}},"404":{"description":"Conversa não encontrada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}}}}},"/api/v1/accounts/{account_id}/conversations/{conversation_id}/messages/{message_id}":{"delete":{"tags":["Messages"],"operationId":"delete-a-message","summary":"Excluir uma mensagem","security":[{"userApiKey":[]}],"description":"Exclua uma mensagem e seus anexos da conversa.","responses":{"200":{"description":"Sucesso"},"401":{"description":"Não autorizado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}},"404":{"description":"A mensagem ou conversa não existe na conta","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}}}}},"/api/v1/accounts/{account_id}/integrations/apps":{"get":{"tags":["Integrations"],"operationId":"get-details-of-all-integrations","summary":"Liste todas as integrações","security":[{"userApiKey":[]}],"description":"Obtenha os detalhes de todas as integrações disponíveis para a conta","responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"payload":{"type":"array","description":"Conjunto de aplicativos de integração","items":{"$ref":"#/components/schemas/integrations_app"}}}}}}},"401":{"description":"Não autorizado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}},"404":{"description":"URL não encontrado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}}}}},"/api/v1/accounts/{account_id}/integrations/hooks":{"post":{"tags":["Integrations"],"operationId":"create-an-integration-hook","summary":"Crie um webhook de integração","description":"Crie um webhook de integração","security":[{"userApiKey":[]}],"parameters":[{"$ref":"#/components/parameters/account_id"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/integrations_hook_create_payload"}}}},"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/integrations_hook"}}}},"401":{"description":"Não autorizado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}}}}},"/api/v1/accounts/{account_id}/integrations/hooks/{hook_id}":{"patch":{"tags":["Integrations"],"operationId":"update-an-integrations-hook","summary":"Atualizar um webhook de integração","description":"Atualizar um webhook de integração","security":[{"userApiKey":[]}],"parameters":[{"$ref":"#/components/parameters/account_id"},{"$ref":"#/components/parameters/hook_id"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/integrations_hook_update_payload"}}}},"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/integrations_hook"}}}},"401":{"description":"Não autorizado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}}}},"delete":{"tags":["Integrations"],"operationId":"delete-an-integration-hook","summary":"Excluir um webhook de integração","description":"Excluir um webhook de integração","security":[{"userApiKey":[]}],"parameters":[{"$ref":"#/components/parameters/account_id"},{"$ref":"#/components/parameters/hook_id"}],"responses":{"200":{"description":"Sucesso"},"401":{"description":"Não autorizado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}},"404":{"description":"O gancho não existe na conta","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}}}}},"/api/v1/profile":{"get":{"tags":["Profile"],"operationId":"fetchProfile","summary":"Buscar perfil de usuário","description":"Obtenha os detalhes do perfil do usuário","security":[{"userApiKey":[]}],"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/user"}}}},"401":{"description":"Não autorizado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}}}},"put":{"tags":["Profile"],"operationId":"updateProfile","summary":"Atualizar perfil de usuário","description":"Atualizar os detalhes do perfil do usuário","security":[{"userApiKey":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["profile"],"properties":{"profile":{"type":"object","properties":{"name":{"type":"string"},"email":{"type":"string"},"display_name":{"type":"string"},"message_signature":{"type":"string"},"phone_number":{"type":"string"},"current_password":{"type":"string"},"password":{"type":"string"},"password_confirmation":{"type":"string"},"ui_settings":{"type":"object"}}}}}},"multipart/form-data":{"schema":{"type":"object","required":["profile"],"properties":{"profile":{"type":"object","properties":{"name":{"type":"string"},"email":{"type":"string"},"display_name":{"type":"string"},"message_signature":{"type":"string"},"phone_number":{"type":"string"},"current_password":{"type":"string"},"password":{"type":"string"},"password_confirmation":{"type":"string"},"avatar":{"type":"string","format":"binary"},"ui_settings":{"type":"object"}}}}}}}},"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/user"}}}},"401":{"description":"Não autorizado"}}}},"/api/v1/accounts/{account_id}/teams":{"get":{"tags":["Teams"],"operationId":"list-all-teams","summary":"Listar todas as equipes","security":[{"userApiKey":[]}],"description":"Listar todas as equipes disponíveis na conta corrente","responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"array","description":"Lista de equipes","items":{"$ref":"#/components/schemas/team"}}}}},"401":{"description":"Não autorizado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}}}},"post":{"tags":["Teams"],"operationId":"create-a-team","summary":"Crie uma equipe","security":[{"userApiKey":[]}],"description":"Crie uma equipe na conta","parameters":[{"$ref":"#/components/parameters/account_id"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/team_create_update_payload"}}}},"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/team"}}}},"401":{"description":"Não autorizado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}}}}},"/api/v1/accounts/{account_id}/teams/{team_id}":{"get":{"tags":["Teams"],"operationId":"get-details-of-a-single-team","summary":"Obtenha detalhes de uma equipe","security":[{"userApiKey":[]}],"description":"Obtenha os detalhes de uma equipe na conta","responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/team"}}}},"401":{"description":"Não autorizado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}},"404":{"description":"O ID da equipe fornecido não existe na conta","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}}}},"patch":{"tags":["Teams"],"operationId":"update-a-team","summary":"Atualizar uma equipe","security":[{"userApiKey":[]}],"description":"Atualizar os atributos de uma equipe","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/team_create_update_payload"}}}},"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/team"}}}},"401":{"description":"Não autorizado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}}}},"delete":{"tags":["Teams"],"operationId":"delete-a-team","summary":"Excluir uma equipe","security":[{"userApiKey":[]}],"description":"Excluir uma equipe da conta","responses":{"200":{"description":"Sucesso"},"401":{"description":"Não autorizado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}},"404":{"description":"A equipe não existe na conta","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}}}}},"/api/v1/accounts/{account_id}/teams/{team_id}/team_members":{"get":{"tags":["Teams"],"operationId":"get-team-members","summary":"Listar agentes na equipe","description":"Obtenha detalhes dos agentes em uma equipe","security":[{"userApiKey":[]}],"parameters":[{"$ref":"#/components/parameters/account_id"},{"$ref":"#/components/parameters/team_id"}],"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"array","description":"Lista de todos os agentes da equipe","items":{"$ref":"#/components/schemas/agent"}}}}},"403":{"description":"Acesso negado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}},"404":{"description":"Equipe não encontrada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}}}},"post":{"tags":["Teams"],"operationId":"add-new-agent-to-team","summary":"Adicionar um novo agente","description":"Adicionar um novo agente à equipe","security":[{"userApiKey":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["user_ids"],"properties":{"user_ids":{"type":"array","items":{"type":"integer"},"description":"IDs de usuários a serem adicionados à equipe","example":[1]}}}}}},"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"array","description":"Lista de todos os agentes ativos","items":{"$ref":"#/components/schemas/agent"}}}}},"403":{"description":"Acesso negado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}},"404":{"description":"Equipe não encontrada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}},"422":{"description":"O usuário deve existir","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}}}},"patch":{"tags":["Teams"],"operationId":"update-agents-in-team","summary":"Atualizar agentes na equipe","description":"Todos os agentes, exceto aquele passado nos parâmetros, serão removidos","security":[{"userApiKey":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["user_ids"],"properties":{"user_ids":{"type":"array","items":{"type":"integer"},"description":"IDs de usuários a serem adicionados à equipe","example":[1]}}}}}},"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"array","description":"Lista de todos os agentes da equipe","items":{"$ref":"#/components/schemas/agent"}}}}},"403":{"description":"Acesso negado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}},"404":{"description":"Equipe não encontrada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}},"422":{"description":"O usuário deve existir","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}}}},"delete":{"tags":["Teams"],"operationId":"delete-agent-in-team","summary":"Remover um agente da equipe","description":"Remover um agente da equipe","security":[{"userApiKey":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["user_ids"],"properties":{"user_ids":{"type":"array","items":{"type":"integer"},"description":"IDs de usuários a serem excluídos da equipe"}}}}}},"responses":{"200":{"description":"Sucesso"},"403":{"description":"Acesso negado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}},"404":{"description":"Equipe não encontrada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}},"422":{"description":"O usuário deve existir","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}}}}},"/api/v1/accounts/{account_id}/custom_filters":{"get":{"tags":["Custom Filters"],"operationId":"list-all-filters","summary":"Listar todos os filtros personalizados","description":"Listar todos os filtros personalizados em uma categoria de usuário","security":[{"userApiKey":[]}],"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"array","description":"Lista de filtros personalizados","items":{"$ref":"#/components/schemas/custom_filter"}}}}},"401":{"description":"Não autorizado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}}}},"post":{"tags":["Custom Filters"],"operationId":"create-a-custom-filter","summary":"Crie um filtro personalizado","description":"Crie um filtro personalizado na conta","parameters":[{"$ref":"#/components/parameters/account_id"}],"security":[{"userApiKey":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/custom_filter_create_update_payload"}}}},"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/custom_filter"}}}},"401":{"description":"Não autorizado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}}}}},"/api/v1/accounts/{account_id}/custom_filters/{custom_filter_id}":{"get":{"tags":["Custom Filters"],"operationId":"get-details-of-a-single-custom-filter","summary":"Obtenha detalhes de um filtro personalizado","description":"Obtenha os detalhes de um filtro personalizado na conta","security":[{"userApiKey":[]}],"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/custom_filter"}}}},"401":{"description":"Não autorizado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}},"404":{"description":"O ID da equipe fornecido não existe na conta","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}}}},"patch":{"tags":["Custom Filters"],"operationId":"update-a-custom-filter","summary":"Atualizar um filtro personalizado","security":[{"userApiKey":[]}],"description":"Atualizar os atributos de um filtro personalizado","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/custom_filter_create_update_payload"}}}},"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/custom_filter"}}}},"401":{"description":"Não autorizado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}}}},"delete":{"tags":["Custom Filters"],"operationId":"delete-a-custom-filter","summary":"Excluir um filtro personalizado","security":[{"userApiKey":[]}],"description":"Exclua um filtro personalizado da conta","responses":{"200":{"description":"Sucesso"},"401":{"description":"Não autorizado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}},"404":{"description":"O filtro personalizado não existe na conta","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}}}}},"/api/v1/accounts/{account_id}/webhooks":{"get":{"tags":["Webhooks"],"operationId":"list-all-webhooks","summary":"Listar todos os webhooks","security":[{"userApiKey":[]}],"description":"Listar todos os webhooks da conta","responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"array","description":"Lista de objetos webhook","items":{"$ref":"#/components/schemas/webhook"}}}}},"401":{"description":"Não autorizado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}}}},"post":{"tags":["Webhooks"],"operationId":"create-a-webhook","summary":"Adicionar um webhook","security":[{"userApiKey":[]}],"description":"Adicione uma assinatura de webhook à conta","parameters":[{"$ref":"#/components/parameters/account_id"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/webhook_create_update_payload"}}}},"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/webhook"}}}},"401":{"description":"Não autorizado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}}}}},"/api/v1/accounts/{account_id}/webhooks/{webhook_id}":{"patch":{"tags":["Webhooks"],"operationId":"update-a-webhook","summary":"Atualizar um objeto webhook","security":[{"userApiKey":[]}],"description":"Atualizar um objeto webhook na conta","parameters":[{"$ref":"#/components/parameters/account_id"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/webhook_create_update_payload"}}}},"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/webhook"}}}},"401":{"description":"Não autorizado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}}}},"delete":{"tags":["Webhooks"],"operationId":"delete-a-webhook","summary":"Excluir um webhook","security":[{"userApiKey":[]}],"description":"Excluir um webhook da conta","responses":{"200":{"description":"Sucesso"},"401":{"description":"Não autorizado","content":{"application/json":{"schema":{"type":"object"}}}},"404":{"description":"O webhook não existe na conta","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}}}}},"/api/v1/accounts/{account_id}/reporting_events":{"get":{"tags":["Reports"],"operationId":"get-account-reporting-events","summary":"Eventos de relatórios de conta","security":[{"userApiKey":[]}],"description":"Obtenha eventos de relatórios paginados para a conta. Este endpoint retorna eventos de relatório, como tempo de primeira resposta, tempo de resolução e outras métricas. Somente administradores podem acessar este endpoint. Os resultados são paginados com 25 itens por página.","parameters":[{"$ref":"#/components/parameters/page"},{"in":"query","name":"since","schema":{"type":"string"},"description":"O carimbo de data/hora de onde os eventos devem começar (carimbo de data/hora Unix em segundos)"},{"in":"query","name":"until","schema":{"type":"string"},"description":"O carimbo de data/hora de onde os eventos devem parar (carimbo de data/hora Unix em segundos)"},{"in":"query","name":"inbox_id","schema":{"type":"number"},"description":"Filtrar eventos por ID da caixa de entrada"},{"in":"query","name":"user_id","schema":{"type":"number"},"description":"Filtrar eventos por ID de usuário/agente"},{"in":"query","name":"name","schema":{"type":"string"},"description":"Filtre eventos por nome de evento (por exemplo, first_response, resolução, respond_time)"}],"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reporting_events_list_response"}}}},"403":{"description":"Acesso negado – Somente administradores podem acessar este endpoint","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}}}}},"/api/v2/accounts/{account_id}/reports":{"get":{"tags":["Reports"],"operationId":"list-all-conversation-statistics","summary":"Obtenha relatórios de conta","security":[{"userApiKey":[]}],"description":"Obtenha relatórios de contas para um tipo, métrica e intervalo de datas específicos","responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"array","description":"Lista de estatísticas de conversa com base em data","items":{"type":"object","properties":{"value":{"type":"string"},"timestamp":{"type":"number"}}}}}}},"403":{"description":"Acesso negado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}},"404":{"description":"relatórios não encontrados","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}}}}},"/api/v2/accounts/{account_id}/reports/summary":{"get":{"tags":["Reports"],"operationId":"list-all-conversation-statistics-summary","summary":"Obtenha o resumo dos relatórios da conta","security":[{"userApiKey":[]}],"description":"Obtenha o resumo dos relatórios da conta para um tipo e período específicos","responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/account_summary"}}}},"403":{"description":"Acesso negado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}},"404":{"description":"relatórios não encontrados","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}}}}},"/api/v2/accounts/{account_id}/reports/conversations":{"get":{"tags":["Reports"],"operationId":"get-account-conversation-metrics","summary":"Métricas de conversa da conta","security":[{"userApiKey":[]}],"description":"Obtenha métricas de conversa para a conta","responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object","description":"Métricas de conversa do objeto da conta","properties":{"open":{"type":"number"},"unattended":{"type":"number"},"unassigned":{"type":"number"}}}}}},"403":{"description":"Acesso negado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}},"404":{"description":"relatórios não encontrados","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}}}}},"/api/v2/accounts/{account_id}/reports/conversations/":{"get":{"tags":["Reports"],"operationId":"get-agent-conversation-metrics","summary":"Métricas de conversa do agente","security":[{"userApiKey":[]}],"description":"Obtenha métricas de conversa para o agente","responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"array","description":"Lista de métricas de conversa baseadas em agentes","items":{"$ref":"#/components/schemas/agent_conversation_metrics"}}}}},"403":{"description":"Acesso negado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}},"404":{"description":"relatórios não encontrados","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}}}}},"/api/v2/accounts/{account_id}/summary_reports/channel":{"get":{"tags":["Reports"],"operationId":"get-channel-summary-report","summary":"Obtenha estatísticas de conversas agrupadas por tipo de canal","security":[{"userApiKey":[]}],"description":"Obtenha contagens de conversas agrupadas por tipo de canal e status para um determinado período.\nRetorna estatísticas para cada tipo de canal, incluindo contagens de conversas abertas, resolvidas, pendentes, adiadas e total.\n\n**Observação:** Este endpoint de API está disponível apenas no FluxaChat versão 4.10.0 e superior. O intervalo de datas é limitado a um máximo de 6 meses.\n","responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/channel_summary"}}}},"400":{"description":"O período excede o limite de seis meses","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}},"403":{"description":"Acesso negado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}}}}},"/api/v2/accounts/{account_id}/summary_reports/inbox":{"get":{"tags":["Reports"],"operationId":"get-inbox-summary-report","summary":"Obtenha estatísticas de conversas agrupadas por caixa de entrada","security":[{"userApiKey":[]}],"description":"Obtenha estatísticas de conversas agrupadas por caixa de entrada para um determinado período.\nRetorna métricas para cada caixa de entrada, incluindo contagens de conversas, contagens de resolução,\ntempo médio de primeira resposta, tempo médio de resolução e tempo médio de resposta.\n","responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/inbox_summary"}}}},"403":{"description":"Acesso negado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}}}}},"/api/v2/accounts/{account_id}/summary_reports/agent":{"get":{"tags":["Reports"],"operationId":"get-agent-summary-report","summary":"Obtenha estatísticas de conversa agrupadas por agente","security":[{"userApiKey":[]}],"description":"Obtenha estatísticas de conversas agrupadas por agente para um determinado período.\nRetorna métricas para cada agente, incluindo contagens de conversas, contagens de resolução,\ntempo médio de primeira resposta, tempo médio de resolução e tempo médio de resposta.\n","responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/agent_summary"}}}},"403":{"description":"Acesso negado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}}}}},"/api/v2/accounts/{account_id}/summary_reports/team":{"get":{"tags":["Reports"],"operationId":"get-team-summary-report","summary":"Obtenha estatísticas de conversas agrupadas por equipe","security":[{"userApiKey":[]}],"description":"Obtenha estatísticas de conversas agrupadas por equipe para um determinado período.\nRetorna métricas para cada equipe, incluindo contagens de conversas, contagens de resoluções,\ntempo médio de primeira resposta, tempo médio de resolução e tempo médio de resposta.\n","responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/team_summary"}}}},"403":{"description":"Acesso negado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}}}}},"/api/v2/accounts/{account_id}/reports/first_response_time_distribution":{"get":{"tags":["Reports"],"operationId":"get-first-response-time-distribution","summary":"Obtenha a distribuição do primeiro tempo de resposta por canal","security":[{"userApiKey":[]}],"description":"Obtenha a distribuição dos primeiros tempos de resposta agrupados por tipo de canal.\nRetorna contagens de conversas em intervalos de tempo diferentes (0-1h, 1-4h, 4-8h, 8-24h, 24h+) para cada tipo de canal.\n\n**Observação:** Este endpoint de API está disponível apenas no FluxaChat versão 4.11.0 e superior.\n","responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/first_response_time_distribution"}}}},"403":{"description":"Acesso negado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}}}}},"/api/v2/accounts/{account_id}/reports/inbox_label_matrix":{"get":{"tags":["Reports"],"operationId":"get-inbox-label-matrix","summary":"Obtenha relatório de matriz de rótulo de caixa de entrada","security":[{"userApiKey":[]}],"description":"Obtenha uma matriz mostrando a contagem de conversas para cada combinação de rótulo de caixa de entrada.\nRetorna uma lista de caixas de entrada, rótulos e uma matriz 2D onde cada célula contém a contagem de conversas\nem uma caixa de entrada específica que possui um rótulo específico aplicado.\n\n**Observação:** Este endpoint de API está disponível apenas no FluxaChat versão 4.11.0 e superior.\n","responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/inbox_label_matrix"}}}},"403":{"description":"Acesso negado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}}}}},"/api/v2/accounts/{account_id}/reports/outgoing_messages_count":{"get":{"tags":["Reports"],"operationId":"get-outgoing-messages-count","summary":"Obtenha a contagem de mensagens enviadas agrupadas por entidade","security":[{"userApiKey":[]}],"description":"Obtenha a contagem de mensagens enviadas agrupadas por uma entidade especificada (agente, equipe, caixa de entrada ou rótulo).\nQuando agrupadas por agente, as mensagens enviadas por bots (AgentBot, Captain::Assistant) são excluídas.\n\n**Observação:** Este endpoint de API está disponível apenas no FluxaChat versão 4.11.0 e superior.\n","parameters":[{"in":"query","name":"group_by","required":true,"schema":{"type":"string","enum":["agent","team","inbox","label"]},"description":"A entidade pela qual agrupar as contagens de mensagens de saída."}],"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/outgoing_messages_count"}}}},"403":{"description":"Acesso negado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}}}}},"/platform/api/v1/accounts":{"post":{"tags":["Accounts"],"operationId":"create-an-account","summary":"Crie uma conta","description":"Crie uma conta","security":[{"platformAppApiKey":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/account_create_update_payload"}}}},"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/platform_account"}}}},"401":{"description":"Não autorizado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}}}}},"/platform/api/v1/accounts/{account_id}":{"get":{"tags":["Accounts"],"operationId":"get-details-of-an-account","summary":"Obtenha detalhes de uma conta","description":"Obtenha os detalhes de uma conta","security":[{"platformAppApiKey":[]}],"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/platform_account"}}}},"401":{"description":"Não autorizado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}},"404":{"description":"A conta fornecida não existe","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}}}},"patch":{"tags":["Accounts"],"operationId":"update-an-account","summary":"Atualizar uma conta","description":"Atualizar os atributos de uma conta","security":[{"platformAppApiKey":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/account_create_update_payload"}}}},"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/platform_account"}}}},"401":{"description":"Não autorizado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}}}},"delete":{"tags":["Accounts"],"operationId":"delete-an-account","summary":"Excluir uma conta","description":"Excluir uma conta","security":[{"platformAppApiKey":[]}],"responses":{"200":{"description":"Sucesso"},"401":{"description":"Não autorizado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}},"404":{"description":"A conta não existe","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}}}}},"/platform/api/v1/accounts/{account_id}/account_users":{"get":{"tags":["Account Users"],"operationId":"list-all-account-users","summary":"Listar todos os usuários da conta","description":"Listar todos os usuários da conta","security":[{"platformAppApiKey":[]}],"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/account_user"}}}},"401":{"description":"Não autorizado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}}}},"post":{"tags":["Account Users"],"operationId":"create-an-account-user","summary":"Crie um usuário de conta","description":"Crie um usuário de conta","security":[{"platformAppApiKey":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/account_user_create_update_payload"}}}},"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"account_id":{"type":"integer","description":"O ID da conta"},"user_id":{"type":"integer","description":"O ID do usuário"},"role":{"type":"string","description":"se o usuário é um administrador ou agente"}}}}}},"401":{"description":"Não autorizado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}}}},"delete":{"tags":["Account Users"],"operationId":"delete-an-account-user","summary":"Excluir um usuário da conta","description":"Excluir um usuário da conta","security":[{"platformAppApiKey":[]}],"responses":{"200":{"description":"Sucesso"},"401":{"description":"Não autorizado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}},"404":{"description":"A conta não existe","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}}}}},"/platform/api/v1/agent_bots":{"get":{"tags":["AgentBots"],"operationId":"list-all-agent-bots","summary":"Listar todos os AgentBots","description":"Liste todos os agentes bots disponíveis","security":[{"platformAppApiKey":[]}],"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"array","description":"Conjunto de bots agentes","items":{"$ref":"#/components/schemas/agent_bot"}}}}},"401":{"description":"Não autorizado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}}}},"post":{"tags":["AgentBots"],"operationId":"create-an-agent-bot","summary":"Crie um agente bot","description":"Crie um bot agente","security":[{"platformAppApiKey":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/platform_agent_bot_create_update_payload"}}}},"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/agent_bot"}}}},"401":{"description":"Não autorizado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}}}}},"/platform/api/v1/agent_bots/{id}":{"get":{"tags":["AgentBots"],"operationId":"get-details-of-a-single-agent-bot","summary":"Obtenha detalhes de um bot de agente","description":"Obtenha os detalhes de um bot agente","security":[{"platformAppApiKey":[]}],"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/agent_bot"}}}},"401":{"description":"Não autorizado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}},"404":{"description":"O ID do bot do agente fornecido não existe","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}}}},"patch":{"tags":["AgentBots"],"operationId":"update-an-agent-bot","summary":"Atualizar um bot de agente","description":"Atualizar os atributos de um bot agente","security":[{"platformAppApiKey":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/platform_agent_bot_create_update_payload"}}}},"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/agent_bot"}}}},"401":{"description":"Não autorizado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}}}},"delete":{"tags":["AgentBots"],"operationId":"delete-an-agent-bot","summary":"Excluir um AgentBot","description":"Excluir um AgentBot","security":[{"platformAppApiKey":[]}],"responses":{"200":{"description":"Sucesso"},"401":{"description":"Não autorizado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}},"404":{"description":"O bot do agente não existe","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}}}}},"/platform/api/v1/users":{"post":{"tags":["Users"],"operationId":"create-a-user","summary":"Crie um usuário","description":"Crie um usuário","security":[{"platformAppApiKey":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/user_create_update_payload"}}}},"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/user"}}}},"401":{"description":"Não autorizado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}}}}},"/platform/api/v1/users/{id}":{"get":{"tags":["Users"],"operationId":"get-details-of-a-user","summary":"Obtenha detalhes do usuário","description":"Obtenha os detalhes de um usuário","security":[{"platformAppApiKey":[]}],"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/user"}}}},"401":{"description":"Não autorizado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}},"404":{"description":"O usuário fornecido não existe","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}}}},"patch":{"tags":["Users"],"operationId":"update-a-user","summary":"Atualizar um usuário","description":"Atualizar os atributos de um usuário","security":[{"platformAppApiKey":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/user_create_update_payload"}}}},"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/user"}}}},"401":{"description":"Não autorizado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}}}},"delete":{"tags":["Users"],"operationId":"delete-a-user","summary":"Excluir um usuário","description":"Excluir um usuário","security":[{"platformAppApiKey":[]}],"responses":{"200":{"description":"Sucesso"},"401":{"description":"Não autorizado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}},"404":{"description":"O usuário não existe","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}}}}},"/platform/api/v1/users/{id}/login":{"get":{"tags":["Users"],"operationId":"get-sso-url-of-a-user","summary":"Obtenha o link SSO do usuário","description":"Obtenha o link sso de um usuário","security":[{"platformAppApiKey":[]}],"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string","description":"URL SSO para autenticar o usuário"}}}}}},"401":{"description":"Não autorizado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}},"404":{"description":"O usuário fornecido não existe","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}}}}},"/public/api/v1/inboxes/{inbox_identifier}/contacts":{"post":{"tags":["Contacts API"],"operationId":"create-a-contact","summary":"Crie um contato","description":"Crie um contato","security":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/public_contact_create_update_payload"}}}},"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/public_contact"}}}},"401":{"description":"Não autorizado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}}}}},"/public/api/v1/inboxes/{inbox_identifier}/contacts/{contact_identifier}":{"get":{"tags":["Contacts API"],"operationId":"get-details-of-a-contact","summary":"Obtenha um contato","description":"Obtenha os detalhes de um contato","security":[],"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/public_contact"}}}},"401":{"description":"Não autorizado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}},"404":{"description":"O contato fornecido não existe","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}}}},"patch":{"tags":["Contacts API"],"operationId":"update-a-contact","summary":"Atualizar um contato","description":"Atualizar os atributos de um contato","security":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/public_contact_create_update_payload"}}}},"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/public_contact_record"}}}},"401":{"description":"Não autorizado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}}}}},"/public/api/v1/inboxes/{inbox_identifier}/contacts/{contact_identifier}/conversations":{"post":{"tags":["Conversations API"],"operationId":"create-a-conversation","summary":"Crie uma conversa","description":"Crie uma conversa","security":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/public_conversation_create_payload"}}}},"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/public_conversation"}}}},"401":{"description":"Não autorizado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}}}},"get":{"tags":["Conversations API"],"operationId":"list-all-contact-conversations","summary":"Listar todas as conversas","description":"Listar todas as conversas do contato","security":[],"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"array","description":"Lista de conversas","items":{"$ref":"#/components/schemas/public_conversation"}}}}},"401":{"description":"Não autorizado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}}}}},"/public/api/v1/inboxes/{inbox_identifier}/contacts/{contact_identifier}/conversations/{conversation_id}":{"get":{"tags":["Conversations API"],"operationId":"get-single-conversation","summary":"Obtenha uma única conversa","description":"Recupera os detalhes de uma conversa específica","security":[],"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/public_conversation"}}}},"401":{"description":"Não autorizado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}},"404":{"description":"Conversa não encontrada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}}}}},"/public/api/v1/inboxes/{inbox_identifier}/contacts/{contact_identifier}/conversations/{conversation_id}/toggle_status":{"post":{"tags":["Conversations API"],"operationId":"resolve-conversation","summary":"Resolver uma conversa","description":"Marca uma conversa como resolvida","security":[],"responses":{"200":{"description":"Conversa resolvida com sucesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/public_conversation"}}}},"401":{"description":"Não autorizado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}},"404":{"description":"Conversa não encontrada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}}}}},"/public/api/v1/inboxes/{inbox_identifier}/contacts/{contact_identifier}/conversations/{conversation_id}/toggle_typing":{"post":{"tags":["Conversations API"],"operationId":"toggle-typing-status","summary":"Alternar status de digitação","description":"Alterna o status de digitação em uma conversa","security":[],"parameters":[{"name":"typing_status","in":"query","required":true,"schema":{"type":"string"},"description":"Status de digitação, 'ligado' ou 'desligado'"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"typing_status":{"type":"string","enum":["on","off"],"description":"O status de digitação a ser definido","example":"on"}}}}}},"responses":{"200":{"description":"Status de digitação alterado com sucesso"},"401":{"description":"Não autorizado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}},"404":{"description":"Conversa não encontrada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}}}}},"/public/api/v1/inboxes/{inbox_identifier}/contacts/{contact_identifier}/conversations/{conversation_id}/update_last_seen":{"post":{"tags":["Conversations API"],"operationId":"update-last-seen","summary":"Atualização vista pela última vez","description":"Atualiza a hora da última visualização do contato em uma conversa","security":[],"responses":{"200":{"description":"Visto pela última vez atualizado com sucesso"},"401":{"description":"Não autorizado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}},"404":{"description":"Conversa não encontrada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}}}}},"/public/api/v1/inboxes/{inbox_identifier}/contacts/{contact_identifier}/conversations/{conversation_id}/messages":{"post":{"tags":["Messages API"],"operationId":"create-a-message","summary":"Crie uma mensagem","description":"Crie uma mensagem","security":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/public_message_create_payload"}}}},"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/public_message"}}}},"401":{"description":"Não autorizado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}}}},"get":{"tags":["Messages API"],"operationId":"list-all-conversation-messages","summary":"Listar todas as mensagens","description":"Listar todas as mensagens na conversa","security":[],"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"array","description":"Lista de mensagens","items":{"$ref":"#/components/schemas/public_message"}}}}},"401":{"description":"Não autorizado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}}}}},"/public/api/v1/inboxes/{inbox_identifier}/contacts/{contact_identifier}/conversations/{conversation_id}/messages/{message_id}":{"patch":{"tags":["Messages API"],"operationId":"update-a-message","summary":"Atualizar uma mensagem","description":"Atualizar uma mensagem","security":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/public_message_update_payload"}}}},"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/public_message"}}}},"401":{"description":"Não autorizado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}}}}},"/api/v1/accounts/{account_id}/agents":{"get":{"tags":["Agents"],"operationId":"list-agents-in-account","summary":"Listar agentes da conta","description":"Lista os agentes vinculados à conta.","security":[{"userApiKey":[]}],"parameters":[{"$ref":"#/components/parameters/account_id"}],"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/agent"}}}}},"403":{"description":"Acesso negado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}}}},"post":{"tags":["Agents"],"operationId":"add-a-new-agent","summary":"Adicionar um novo agente","description":"Adiciona um novo agente à conta.","security":[{"userApiKey":[]}],"parameters":[{"$ref":"#/components/parameters/account_id"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/agent_create_payload"}}}},"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/agent"}}}},"403":{"description":"Acesso negado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}}}}},"/api/v1/accounts/{account_id}/agents/{id}":{"delete":{"tags":["Agents"],"operationId":"remove-an-agent-from-account","summary":"Remover um agente da conta","description":"Remove um agente da conta.","security":[{"userApiKey":[]}],"parameters":[{"$ref":"#/components/parameters/account_id"},{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"O ID do agente que será removido."}],"responses":{"200":{"description":"Sucesso"},"403":{"description":"Acesso negado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}},"404":{"description":"Agente não encontrado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}}}},"patch":{"tags":["Agents"],"operationId":"update-agent-in-account","summary":"Atualizar agente na conta","description":"Atualiza um agente da conta.","security":[{"userApiKey":[]}],"parameters":[{"$ref":"#/components/parameters/account_id"},{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"O ID do agente que será atualizado."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/agent_update_payload"}}}},"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/agent"}}}},"403":{"description":"Acesso negado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}},"404":{"description":"Agente não encontrado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}}}}},"/api/v1/accounts/{account_id}/canned_responses":{"get":{"tags":["Canned Responses"],"operationId":"list-all-canned-responses-in-an-account","summary":"Listar todas as respostas prontas","description":"Lista as respostas prontas da conta.","security":[{"userApiKey":[]}],"parameters":[{"$ref":"#/components/parameters/account_id"}],"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/canned_response"}}}}},"403":{"description":"Acesso negado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}}}},"post":{"tags":["Canned Responses"],"operationId":"add-a-new-canned-response","summary":"Adicionar uma nova resposta pronta","description":"Adiciona uma nova resposta pronta à conta.","security":[{"userApiKey":[]}],"parameters":[{"$ref":"#/components/parameters/account_id"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/canned_response_payload"}}}},"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/canned_response"}}}},"403":{"description":"Acesso negado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}}}}},"/api/v1/accounts/{account_id}/canned_responses/{id}":{"delete":{"tags":["Canned Responses"],"operationId":"remove-a-canned-response-from-account","summary":"Remover uma resposta pronta","description":"Remove uma resposta pronta da conta.","security":[{"userApiKey":[]}],"parameters":[{"$ref":"#/components/parameters/account_id"},{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"O ID da resposta pronta que será removida."}],"responses":{"200":{"description":"Sucesso"},"403":{"description":"Acesso negado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}},"404":{"description":"Resposta pronta não encontrada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}}}},"patch":{"tags":["Canned Responses"],"operationId":"update-canned-response-in-account","summary":"Atualizar resposta pronta na conta","description":"Atualiza uma resposta pronta da conta.","security":[{"userApiKey":[]}],"parameters":[{"$ref":"#/components/parameters/account_id"},{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"O ID da resposta pronta que será atualizada."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/canned_response_payload"}}}},"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/canned_response"}}}},"403":{"description":"Acesso negado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}},"404":{"description":"Resposta pronta não encontrada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bad_request_error"}}}}}}}},"components":{"schemas":{"account_show_response":{"allOf":[{"$ref":"#/components/schemas/account_detail"},{"type":"object","properties":{"latest_chatwoot_version":{"type":["string","null"],"description":"Versão mais recente do FluxaChat disponível","example":"3.0.0"},"subscribed_features":{"type":"array","items":{"type":"string"},"description":"Lista de recursos empresariais assinados (se a edição empresarial estiver habilitada)"}}}]},"bad_request_error":{"title":"dados","type":"object","properties":{"description":{"type":"string"},"errors":{"type":"array","items":{"$ref":"#/components/schemas/request_error"}}}},"account_update_payload":{"type":"object","properties":{"name":{"type":"string","description":"Nome da conta","example":"My Account"},"locale":{"type":"string","description":"A localidade da conta","example":"en"},"domain":{"type":"string","description":"O domínio da conta","example":"example.com"},"support_email":{"type":"string","description":"O e-mail de suporte da conta","example":"support@example.com"},"auto_resolve_after":{"type":["integer","null"],"minimum":10,"maximum":1439856,"description":"Resolver conversas automaticamente após minutos especificados","example":1440},"auto_resolve_message":{"type":["string","null"],"description":"Mensagem a ser enviada durante a resolução automática","example":"This conversation has been automatically resolved due to inactivity"},"auto_resolve_ignore_waiting":{"type":["boolean","null"],"description":"Se deve ignorar conversas em espera para resolução automática","example":false},"industry":{"type":"string","description":"Tipo de indústria","example":"Technology"},"company_size":{"type":"string","description":"Tamanho da empresa","example":"50-100"},"timezone":{"type":"string","description":"Fuso horário da conta","example":"UTC"}}},"account_detail":{"type":"object","properties":{"id":{"type":"number","description":"ID da conta"},"name":{"type":"string","description":"Nome da conta"},"locale":{"type":"string","description":"A localidade da conta"},"domain":{"type":"string","description":"O domínio da conta"},"support_email":{"type":"string","description":"O e-mail de suporte da conta"},"status":{"type":"string","description":"O status da conta"},"created_at":{"type":"string","format":"date-time","description":"A data de criação da conta"},"cache_keys":{"type":"object","description":"Chaves de cache da conta"},"features":{"type":"object","description":"Recursos habilitados para a conta"},"settings":{"type":"object","description":"Configurações da conta","properties":{"auto_resolve_after":{"type":"number","description":"Resolver conversas automaticamente após minutos especificados"},"auto_resolve_message":{"type":"string","description":"Mensagem a ser enviada durante a resolução automática"},"auto_resolve_ignore_waiting":{"type":"boolean","description":"Se deve ignorar conversas em espera para resolução automática"}}},"custom_attributes":{"type":"object","description":"Atributos personalizados da conta","properties":{"plan_name":{"type":["string","null"],"description":"Nome do plano de assinatura"},"subscribed_quantity":{"type":["number","null"],"description":"Quantidade assinada"},"subscription_status":{"type":["string","null"],"description":"Status da assinatura"},"subscription_ends_on":{"type":["string","null"],"format":"date","description":"Data de término da assinatura"},"industry":{"type":"string","description":"Tipo de indústria"},"company_size":{"type":"string","description":"Tamanho da empresa"},"timezone":{"type":"string","description":"Fuso horário da conta"},"logo":{"type":"string","description":"URL do logotipo da conta"},"onboarding_step":{"type":"string","description":"Etapa de integração atual"},"marked_for_deletion_at":{"type":"string","format":"date-time","description":"Quando a conta foi marcada para exclusão"},"marked_for_deletion_reason":{"type":"string","description":"Motivo da exclusão da conta"}}}}},"custom_attribute":{"type":"object","properties":{"id":{"type":"integer","description":"Identificador"},"attribute_display_name":{"type":"string","description":"Nome de exibição do atributo"},"attribute_display_type":{"type":"string","description":"Tipo de exibição do atributo (texto, número, moeda, porcentagem, link, data, lista, caixa de seleção)"},"attribute_description":{"type":"string","description":"Descrição do atributo"},"attribute_key":{"type":"string","description":"Atribuir valor-chave exclusivo"},"regex_pattern":{"type":"string","description":"Padrão Regex"},"regex_cue":{"type":"string","description":"Sugestão Regex"},"attribute_values":{"type":"string","description":"Valores de atributos"},"attribute_model":{"type":"string","description":"Tipo de atributo (conversation_attribute/contact_attribute)"},"default_value":{"type":"string","description":"Atribuir valor padrão"},"created_at":{"type":"string","description":"A data e hora em que o atributo personalizado foi criado"},"updated_at":{"type":"string","description":"A data e hora em que o atributo personalizado foi atualizado"}}},"custom_attribute_create_update_payload":{"type":"object","properties":{"attribute_display_name":{"type":"string","description":"Nome de exibição do atributo","example":"Custom Attribute"},"attribute_display_type":{"type":"integer","description":"Tipo de exibição de atributo (texto- 0, número- 1, moeda- 2, porcentagem- 3, link- 4, data- 5, lista- 6, caixa de seleção- 7)","example":0},"attribute_description":{"type":"string","description":"Descrição do atributo","example":"This is a custom attribute"},"attribute_key":{"type":"string","description":"Atribuir valor-chave exclusivo","example":"custom_attribute"},"attribute_values":{"type":"array","description":"Valores de atributos","items":{"type":"string"},"example":["value1","value2"]},"attribute_model":{"type":"integer","description":"Tipo de atributo (conversation_attribute- 0, contact_attribute- 1)","example":0},"regex_pattern":{"type":"string","description":"Padrão Regex (aplicável apenas para texto tipo). O padrão regex é usado para validar o(s) valor(es) do(s) atributo(s).","example":"^[a-zA-Z0-9]+$"},"regex_cue":{"type":"string","description":"Mensagem de sinalização Regex (aplicável apenas para texto tipo). A mensagem de sinalização é mostrada quando o padrão regex não corresponde.","example":"Please enter a valid value"}}},"contacts_list_response":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/contact_meta"},"payload":{"type":"array","items":{"$ref":"#/components/schemas/contact_list_item"},"description":"Lista de contatos"}}},"contact_create_payload":{"type":"object","required":["inbox_id"],"properties":{"inbox_id":{"type":"number","description":"ID da caixa de entrada à qual o contato pertence","example":1},"name":{"type":"string","description":"nome do contato","example":"Alice"},"email":{"type":"string","description":"e-mail do contato","example":"alice@acme.inc"},"blocked":{"type":"boolean","description":"se o contato está bloqueado ou não","example":false},"phone_number":{"type":"string","description":"telefone do contato","example":"+123456789"},"avatar":{"type":"string","format":"binary","description":"Envie os dados do formulário com o binário da imagem do avatar ou use o avatar_url"},"avatar_url":{"type":"string","description":"O URL para um arquivo jpeg, png para o avatar do contato","example":"https://example.com/avatar.png"},"identifier":{"type":"string","description":"Um identificador exclusivo para o contato no sistema externo","example":"1234567890"},"additional_attributes":{"type":"object","description":"Um objeto onde você pode armazenar atributos adicionais para o contato. Exemplo: {\"type\":\"customer\", \"age\":30}. Esses atributos devem ter definições válidas de atributos personalizados.","example":{"type":"customer","age":30}},"custom_attributes":{"type":"object","description":"Um objeto onde você pode armazenar atributos personalizados para o contato. Exemplo: {\"type\":\"customer\", \"age\":30}. Esse atributo deve ter uma definição válida de atributo personalizado.","example":{}}}},"extended_contact":{"allOf":[{"$ref":"#/components/schemas/contact"},{"type":"object","properties":{"id":{"type":"number","description":"ID do usuário"},"availability_status":{"type":"string","enum":["online","offline"],"description":"Status de disponibilidade do usuário"}}}]},"contact_show_response":{"type":"object","properties":{"payload":{"$ref":"#/components/schemas/contact_list_item"}}},"contact_update_payload":{"type":"object","properties":{"name":{"type":"string","description":"nome do contato","example":"Alice"},"email":{"type":"string","description":"e-mail do contato","example":"alice@acme.inc"},"blocked":{"type":"boolean","description":"se o contato está bloqueado ou não","example":false},"phone_number":{"type":"string","description":"telefone do contato","example":"+123456789"},"avatar":{"type":"string","format":"binary","description":"Envie os dados do formulário com o binário da imagem do avatar ou use o avatar_url"},"avatar_url":{"type":"string","description":"O URL para um arquivo jpeg, png para o avatar do contato","example":"https://example.com/avatar.png"},"identifier":{"type":"string","description":"Um identificador exclusivo para o contato no sistema externo","example":"1234567890"},"additional_attributes":{"type":"object","description":"Um objeto onde você pode armazenar atributos adicionais para o contato. Exemplo: {\"type\":\"customer\", \"age\":30}. Esses atributos devem ter definições válidas de atributos personalizados.","example":{"type":"customer","age":30}},"custom_attributes":{"type":"object","description":"Um objeto onde você pode armazenar atributos personalizados para o contato. Exemplo: {\"type\":\"customer\", \"age\":30}. Esse atributo deve ter uma definição válida de atributo personalizado.","example":{}}}},"contact_base":{"allOf":[{"$ref":"#/components/schemas/generic_id"},{"$ref":"#/components/schemas/contact"}]},"contact_conversations_response":{"type":"object","properties":{"payload":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/conversation"},{"type":"object","properties":{"meta":{"type":"object","properties":{"sender":{"type":"object","properties":{"additional_attributes":{"type":"object","description":"Os atributos adicionais do remetente"},"availability_status":{"type":"string","description":"O status de disponibilidade do remetente"},"email":{"type":["string","null"],"description":"O e-mail do remetente"},"id":{"type":"number","description":"ID do remetente"},"name":{"type":"string","description":"O nome do remetente"},"phone_number":{"type":["string","null"],"description":"O número de telefone do remetente"},"blocked":{"type":"boolean","description":"Se o remetente está bloqueado"},"identifier":{"type":["string","null"],"description":"O identificador do remetente"},"thumbnail":{"type":["string","null"],"description":"URL do avatar do contato"},"custom_attributes":{"type":"object","description":"Os atributos personalizados do remetente"},"last_activity_at":{"type":"number","description":"A última atividade do remetente"},"created_at":{"type":"number","description":"O criado em do remetente"}}},"channel":{"type":"string","description":"Tipo de canal"},"assignee":{"$ref":"#/components/schemas/user"},"hmac_verified":{"type":"boolean","description":"Se o hmac foi verificado"}}}}}]},"description":"Lista de conversas para o contato"}}},"contact_labels":{"type":"object","properties":{"payload":{"type":"array","description":"Lista de rótulos","items":{"type":"string"}}}},"contact_inboxes":{"type":"object","properties":{"source_id":{"type":"string","description":"ID de origem da caixa de entrada do contato"},"inbox":{"$ref":"#/components/schemas/inbox_contact"}}},"contactable_inboxes_response":{"type":"object","properties":{"payload":{"type":"array","items":{"$ref":"#/components/schemas/contact_inbox"},"description":"Lista de caixas de entrada contatáveis para o contato"}}},"automation_rule":{"type":"object","properties":{"payload":{"description":"Carga útil de resposta que contém regras de automação","oneOf":[{"type":"array","description":"Lista de regras de automação (para listar endpoint)","items":{"$ref":"#/components/schemas/automation_rule_item"}},{"type":"object","description":"Regra de automação única (para endpoints de exibição/criação/atualização)","allOf":[{"$ref":"#/components/schemas/automation_rule_item"}]}]}}},"automation_rule_create_update_payload":{"type":"object","properties":{"name":{"type":"string","description":"Nome da regra","example":"Add label on message create event"},"description":{"type":"string","description":"A descrição sobre a automação e ações","example":"Add label support and sales on message create event if incoming message content contains text help"},"event_name":{"type":"string","enum":["conversation_created","conversation_updated","conversation_resolved","message_created"],"example":"message_created","description":"O evento quando você deseja executar as ações de automação"},"active":{"type":"boolean","description":"Habilitar/desabilitar regra de automação"},"actions":{"type":"array","description":"Lista de ações que você deseja executar quando a condição corresponder, por exemplo, adicionar suporte a rótulo se a mensagem contiver ajuda de conteúdo.","items":{"type":"object","example":{"action_name":"add_label","action_params":["support"]}}},"conditions":{"type":"array","description":"Conjunto de condições nas quais o filtro de conversa funcionaria, por exemplo, o conteúdo da mensagem contém ajuda em texto.","items":{"type":"object","example":{"attribute_key":"content","filter_operator":"contains","query_operator":"OR","values":["help"]}}}}},"conversation_list":{"type":"object","properties":{"data":{"type":"object","properties":{"meta":{"type":"object","properties":{"mine_count":{"type":"number"},"unassigned_count":{"type":"number"},"assigned_count":{"type":"number"},"all_count":{"type":"number"}}},"payload":{"type":"array","description":"variedade de conversas","items":{"allOf":[{"$ref":"#/components/schemas/generic_id"},{"$ref":"#/components/schemas/conversation"},{"type":"object","properties":{"meta":{"type":"object","properties":{"sender":{"type":"object","properties":{"additional_attributes":{"type":"object","description":"Os atributos adicionais do remetente"},"availability_status":{"type":"string","description":"O status de disponibilidade do remetente"},"email":{"type":["string","null"],"description":"O e-mail do remetente"},"id":{"type":"number","description":"ID do remetente"},"name":{"type":"string","description":"O nome do remetente"},"phone_number":{"type":["string","null"],"description":"O número de telefone do remetente"},"blocked":{"type":"boolean","description":"Se o remetente está bloqueado"},"identifier":{"type":["string","null"],"description":"O identificador do remetente"},"thumbnail":{"type":["string","null"],"description":"URL do avatar do contato"},"custom_attributes":{"type":"object","description":"Os atributos personalizados do remetente"},"last_activity_at":{"type":"number","description":"A última atividade do remetente"},"created_at":{"type":"number","description":"O criado em do remetente"}}},"channel":{"type":"string","description":"Tipo de canal"},"assignee":{"$ref":"#/components/schemas/user"},"hmac_verified":{"type":"boolean","description":"Se o hmac foi verificado"}}}}}]}}}}}},"conversation_create_payload":{"type":"object","required":["source_id"],"properties":{"source_id":{"type":"string","description":"ID da origem da conversa","example":"1234567890"},"inbox_id":{"type":"integer","description":"Id da caixa de entrada na qual a conversa é criada <br/> Tipos de caixa de entrada permitidos: site, telefone, API, e-mail","example":1},"contact_id":{"type":"integer","description":"ID do contato para o qual a conversa foi criada","example":1},"additional_attributes":{"type":"object","description":"Permite especificar atributos como informações do navegador","example":{"browser":"Chrome","browser_version":"89.0.4389.82","os":"Windows","os_version":"10"}},"custom_attributes":{"type":"object","description":"O objeto para salvar atributos personalizados para conversa, aceita chave e valor de atributos personalizados","example":{"attribute_key":"attribute_value","priority_conversation_number":3}},"status":{"type":"string","enum":["open","resolved","pending"],"description":"Especifique a conversa se ela está pendente, aberta, fechada","example":"open"},"assignee_id":{"type":"integer","description":"ID do agente para atribuir uma conversa a um agente","example":1},"team_id":{"type":"integer","description":"ID da equipe para atribuir uma conversa a uma equipe\\","example":1},"snoozed_until":{"type":"string","format":"date-time","description":"Adiado até a data e hora","example":"2030-07-21T17:32:28Z"},"message":{"type":"object","description":"A mensagem inicial a ser enviada para a conversa","required":["content"],"properties":{"content":{"type":"string","description":"O conteúdo da mensagem","example":"Hello, how can I help you?"},"template_params":{"type":"object","description":"Os parâmetros do modelo para a mensagem no caso do canal Whatsapp","properties":{"name":{"type":"string","description":"Nome do modelo","example":"sample_issue_resolution"},"category":{"type":"string","description":"Categoria do modelo","example":"UTILITY"},"language":{"type":"string","description":"Idioma do modelo","example":"en_US"},"processed_params":{"type":"object","description":"Os valores de parâmetros processados para variáveis de modelo no modelo","example":{"1":"FluxaChat"}}}}}}}},"conversation_show":{"type":"object","allOf":[{"$ref":"#/components/schemas/conversation"},{"type":"object","properties":{"meta":{"type":"object","properties":{"sender":{"type":"object","properties":{"additional_attributes":{"type":"object","description":"Os atributos adicionais do remetente"},"availability_status":{"type":"string","description":"O status de disponibilidade do remetente"},"email":{"type":["string","null"],"description":"O e-mail do remetente"},"id":{"type":"number","description":"ID do remetente"},"name":{"type":"string","description":"O nome do remetente"},"phone_number":{"type":["string","null"],"description":"O número de telefone do remetente"},"blocked":{"type":"boolean","description":"Se o remetente está bloqueado"},"identifier":{"type":["string","null"],"description":"O identificador do remetente"},"thumbnail":{"type":["string","null"],"description":"URL do avatar do contato"},"custom_attributes":{"type":"object","description":"Os atributos personalizados do remetente"},"last_activity_at":{"type":"number","description":"A última atividade do remetente"},"created_at":{"type":"number","description":"O criado em do remetente"}}},"channel":{"type":"string","description":"Tipo de canal"},"assignee":{"$ref":"#/components/schemas/user"},"hmac_verified":{"type":"boolean","description":"Se o hmac foi verificado"}}}}}]},"conversation":{"type":"object","properties":{"id":{"type":"number","description":"ID da conversa"},"messages":{"type":"array","items":{"$ref":"#/components/schemas/message"}},"account_id":{"type":"number","description":"ID da conta"},"uuid":{"type":"string","description":"UUID da conversa"},"additional_attributes":{"type":"object","description":"O objeto que contém atributos adicionais relacionados à conversa"},"agent_last_seen_at":{"type":"number","description":"A última atividade do agente"},"assignee_last_seen_at":{"type":"number","description":"A última atividade do cessionário"},"can_reply":{"type":"boolean","description":"Se a conversa pode ser respondida"},"contact_last_seen_at":{"type":"number","description":"A última atividade do contato"},"custom_attributes":{"type":"object","description":"O objeto para salvar atributos personalizados para conversa, aceita chave e valor de atributos personalizados"},"inbox_id":{"type":"number","description":"ID da caixa de entrada"},"labels":{"type":"array","items":{"type":"string"},"description":"Os rótulos da conversa"},"muted":{"type":"boolean","description":"Se a conversa está silenciada"},"snoozed_until":{"type":["number","null"],"description":"O horário em que a conversa será ativada"},"status":{"type":"string","enum":["open","resolved","pending"],"description":"O status da conversa"},"created_at":{"type":"number","description":"A hora em que a conversa foi criada"},"updated_at":{"type":"number","description":"A hora em que a conversa foi atualizada"},"timestamp":{"type":"number","description":"A hora em que a conversa foi criada"},"first_reply_created_at":{"type":["number","null"],"description":"A hora em que a primeira resposta foi criada"},"unread_count":{"type":"number","description":"O número de mensagens não lidas"},"last_non_activity_message":{"oneOf":[{"$ref":"#/components/schemas/message"},{"type":"null"}],"description":"A última mensagem de não atividade"},"last_activity_at":{"type":"number","description":"A última atividade da conversa"},"priority":{"type":["string","null"],"description":"A prioridade da conversa"},"waiting_since":{"type":["number","null"],"description":"A hora em que a conversa estava esperando"},"sla_policy_id":{"type":["number","null"],"description":"O ID da política de SLA"},"applied_sla":{"type":"object","description":"O SLA aplicado"},"sla_events":{"type":"array","items":{"type":"object","description":"Objetos de evento SLA"}}}},"user":{"type":"object","properties":{"id":{"type":"number"},"access_token":{"type":"string"},"account_id":{"type":"number"},"available_name":{"type":"string"},"avatar_url":{"type":"string"},"confirmed":{"type":"boolean"},"display_name":{"type":["string","null"]},"message_signature":{"type":["string","null"]},"email":{"type":"string"},"hmac_identifier":{"type":"string"},"inviter_id":{"type":["number","null"]},"name":{"type":"string"},"provider":{"type":"string"},"pubsub_token":{"type":"string"},"role":{"type":"string","enum":["agent","administrator"]},"ui_settings":{"type":"object"},"uid":{"type":"string"},"type":{"type":["string","null"]},"custom_attributes":{"type":"object","description":"Disponível para usuários criados por meio de APIs de plataforma e que possuem atributos customizados associados."},"accounts":{"type":"array","items":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"},"status":{"type":"string"},"active_at":{"type":["string","null"],"format":"date-time"},"role":{"type":"string","enum":["administrator","agent"]},"permissions":{"type":"array","items":{"type":"string"}},"availability":{"type":"string"},"availability_status":{"type":"string"},"auto_offline":{"type":"boolean"},"custom_role_id":{"type":["number","null"]},"custom_role":{"type":["object","null"]}}}}}},"conversation_labels":{"type":"object","properties":{"payload":{"type":"array","description":"Lista de rótulos","items":{"type":"string"}}}},"reporting_event":{"type":"object","properties":{"id":{"type":"number","description":"ID do evento de relatório"},"name":{"type":"string","description":"Nome do evento (por exemplo, primeira_resposta, resolução, tempo_de_resposta)"},"value":{"type":"number","format":"double","description":"Valor da métrica em segundos"},"value_in_business_hours":{"type":"number","format":"double","description":"Valor da métrica em segundos, calculado apenas para horário comercial"},"event_start_time":{"type":"string","format":"date-time","description":"O carimbo de data/hora em que o evento começou"},"event_end_time":{"type":"string","format":"date-time","description":"O carimbo de data/hora em que o evento terminou"},"account_id":{"type":"number","description":"ID da conta"},"conversation_id":{"type":["number","null"],"description":"ID da conversa"},"inbox_id":{"type":["number","null"],"description":"ID da caixa de entrada"},"user_id":{"type":["number","null"],"description":"ID do usuário/agente"},"created_at":{"type":"string","format":"date-time","description":"O carimbo de data/hora em que o evento de relatório foi criado"},"updated_at":{"type":"string","format":"date-time","description":"O carimbo de data/hora em que o evento de relatório foi atualizado pela última vez"}}},"inbox":{"type":"object","properties":{"id":{"type":"number","description":"ID da caixa de entrada"},"name":{"type":"string","description":"O nome da caixa de entrada"},"website_url":{"type":"string","description":"URL do site"},"channel_type":{"type":"string","description":"O tipo da caixa de entrada"},"avatar_url":{"type":"string","description":"A imagem do avatar da caixa de entrada"},"widget_color":{"type":"string","description":"Cor do widget usada para personalização do widget"},"website_token":{"type":"string","description":"Token do site"},"enable_auto_assignment":{"type":"boolean","description":"O sinalizador que mostra se a atribuição automática está habilitada ou não"},"web_widget_script":{"type":"string","description":"Script usado para carregar o widget do site"},"welcome_title":{"type":["string","null"],"description":"Título de boas-vindas a ser exibido no widget"},"welcome_tagline":{"type":["string","null"],"description":"Slogan de boas-vindas a ser exibido no widget"},"greeting_enabled":{"type":"boolean","description":"O sinalizador que mostra se a saudação está habilitada"},"greeting_message":{"type":["string","null"],"description":"Uma mensagem de saudação quando o usuário inicia a conversa"},"channel_id":{"type":"number","description":"ID do canal ao qual esta caixa de entrada pertence"},"working_hours_enabled":{"type":"boolean","description":"O sinalizador que mostra se o recurso de horário de trabalho está habilitado"},"enable_email_collect":{"type":"boolean","description":"O sinalizador para permitir a coleta de e-mails de contatos"},"csat_survey_enabled":{"type":"boolean","description":"A sinalização para ativar a pesquisa CSAT"},"auto_assignment_config":{"type":"object","description":"Definições de configuração para atribuição automática"},"out_of_office_message":{"type":["string","null"],"description":"Mensagem para mostrar quando os agentes estão fora do escritório"},"working_hours":{"type":"array","description":"Configuração de horário de funcionamento da caixa de entrada","items":{"type":"object","properties":{"day_of_week":{"type":"number","description":"Dia da semana (0-6, onde 0 é domingo)"},"closed_all_day":{"type":"boolean","description":"Se a caixa de entrada fica fechada o dia inteiro"},"open_hour":{"type":["number","null"],"description":"Hora em que a caixa de entrada abre (0-23)"},"open_minutes":{"type":["number","null"],"description":"Minutos da hora em que a caixa de entrada é aberta (0-59)"},"close_hour":{"type":["number","null"],"description":"Hora em que a caixa de entrada fecha (0-23)"},"close_minutes":{"type":["number","null"],"description":"Minutos da hora em que a caixa de entrada fecha (0-59)"},"open_all_day":{"type":"boolean","description":"Se a caixa de entrada está aberta o dia inteiro"}}}},"timezone":{"type":"string","description":"Configuração de fuso horário para a caixa de entrada"},"callback_webhook_url":{"type":["string","null"],"description":"URL do webhook para retornos de chamada"},"allow_messages_after_resolved":{"type":"boolean","description":"Se permitir mensagens depois que uma conversa for resolvida"},"lock_to_single_conversation":{"type":"boolean","description":"Se deseja bloquear um contato em uma única conversa"},"sender_name_type":{"type":"string","description":"Tipo de nome do remetente a ser exibido (por exemplo, amigável)"},"business_name":{"type":["string","null"],"description":"Nome da empresa associado à caixa de entrada"},"hmac_mandatory":{"type":"boolean","description":"Se a verificação HMAC é obrigatória"},"selected_feature_flags":{"type":["array","null"],"description":"Sinalizadores de recursos selecionados para a caixa de entrada","items":{"type":"string"}},"reply_time":{"type":"string","description":"Tempo de resposta esperado"},"messaging_service_sid":{"type":["string","null"],"description":"SID do serviço de mensagens para provedores de SMS"},"phone_number":{"type":["string","null"],"description":"Número de telefone associado à caixa de entrada"},"medium":{"type":"string","description":"Meio de comunicação (por exemplo, sms, e-mail)"},"provider":{"type":["string","null"],"description":"Provedor do canal"}}},"inbox_create_payload":{"type":"object","properties":{"name":{"type":"string","description":"O nome da caixa de entrada.","example":"Support"},"avatar":{"type":"string","format":"binary","description":"Arquivo de imagem para avatar."},"greeting_enabled":{"type":"boolean","description":"Ative a mensagem de saudação.","example":true},"greeting_message":{"type":"string","description":"Mensagem de saudação a ser enviada quando as mensagens de saudação estiverem habilitadas.","example":"Hello, how can I help you?"},"enable_email_collect":{"type":"boolean","description":"Ative a coleta de e-mail.\n\nDisponível para: `Website`\n","example":true},"csat_survey_enabled":{"type":"boolean","description":"Ative a pesquisa CSAT.","example":true},"csat_config":{"type":"object","description":"Configuração da pesquisa CSAT.","properties":{"display_type":{"type":"string","description":"Estilo de exibição da pesquisa CSAT.","enum":["emoji","star"],"example":"emoji"},"message":{"type":"string","description":"Mensagem mostrada com a pesquisa CSAT.","example":"Please rate your conversation"},"button_text":{"type":"string","description":"Texto mostrado no botão da pesquisa CSAT.","example":"Please rate us"},"language":{"type":"string","description":"Código do idioma da pesquisa CSAT.","example":"en"},"survey_rules":{"type":"object","description":"Regras que decidem quando mostrar a pesquisa CSAT.","properties":{"operator":{"type":"string","example":"contains"},"values":{"type":"array","items":{"type":"string"},"example":["billing"]}}}}},"enable_auto_assignment":{"type":"boolean","description":"Ative a atribuição automática.","example":true},"working_hours_enabled":{"type":"boolean","description":"Ative o horário de trabalho.","example":true},"out_of_office_message":{"type":"string","description":"Mensagem de ausência para enviar fora do horário de trabalho.","example":"We are currently out of office. Please leave a message and we will get back to you."},"timezone":{"type":"string","description":"Fuso horário da caixa de entrada.","example":"America/New_York"},"allow_messages_after_resolved":{"type":"boolean","description":"Permitir mensagens após a conversa ser resolvida.\n\nDisponível para: `Website`\n","example":true},"lock_to_single_conversation":{"type":"boolean","description":"Bloqueie mensagens de contato em uma única conversa ativa.\n\nDisponível para: `API` `LINE` `Telegram` `WhatsApp` `SMS`\n","example":true},"portal_id":{"type":"integer","description":"ID do portal da central de ajuda a ser anexado à caixa de entrada.","example":1},"sender_name_type":{"type":"string","description":"Tipo de nome do remetente para respostas de email de saída.\n\nDisponível para: `Website` `Email`\n","enum":["friendly","professional"],"example":"friendly"},"business_name":{"type":"string","description":"Nome comercial para respostas de e-mail enviadas.\n\nDisponível para: `Website` `Email`\n","example":"My Business"},"channel":{"oneOf":[{"$ref":"#/components/schemas/inbox_create_web_widget_channel_payload"},{"$ref":"#/components/schemas/inbox_create_api_channel_payload"},{"$ref":"#/components/schemas/inbox_create_email_channel_payload"},{"$ref":"#/components/schemas/inbox_create_line_channel_payload"},{"$ref":"#/components/schemas/inbox_create_telegram_channel_payload"},{"$ref":"#/components/schemas/inbox_create_whatsapp_channel_payload"},{"$ref":"#/components/schemas/inbox_create_sms_channel_payload"}],"discriminator":{"propertyName":"type","mapping":{"web_widget":"#/components/schemas/inbox_create_web_widget_channel_payload","api":"#/components/schemas/inbox_create_api_channel_payload","email":"#/components/schemas/inbox_create_email_channel_payload","line":"#/components/schemas/inbox_create_line_channel_payload","telegram":"#/components/schemas/inbox_create_telegram_channel_payload","whatsapp":"#/components/schemas/inbox_create_whatsapp_channel_payload","sms":"#/components/schemas/inbox_create_sms_channel_payload"}}}}},"inbox_update_payload":{"type":"object","properties":{"name":{"type":"string","description":"O nome da caixa de entrada.","example":"Support"},"avatar":{"type":"string","format":"binary","description":"Arquivo de imagem para avatar."},"greeting_enabled":{"type":"boolean","description":"Ative a mensagem de saudação.","example":true},"greeting_message":{"type":"string","description":"Mensagem de saudação a ser enviada quando as mensagens de saudação estiverem habilitadas.","example":"Hello, how can I help you?"},"enable_email_collect":{"type":"boolean","description":"Ative a coleta de e-mail.\n\nDisponível para: `Website`\n","example":true},"csat_survey_enabled":{"type":"boolean","description":"Ative a pesquisa CSAT.","example":true},"csat_config":{"type":"object","description":"Configuração da pesquisa CSAT.","properties":{"display_type":{"type":"string","description":"Estilo de exibição da pesquisa CSAT.","enum":["emoji","star"],"example":"emoji"},"message":{"type":"string","description":"Mensagem mostrada com a pesquisa CSAT.","example":"Please rate your conversation"},"button_text":{"type":"string","description":"Texto mostrado no botão da pesquisa CSAT.","example":"Please rate us"},"language":{"type":"string","description":"Código do idioma da pesquisa CSAT.","example":"en"},"survey_rules":{"type":"object","description":"Regras que decidem quando mostrar a pesquisa CSAT.","properties":{"operator":{"type":"string","example":"contains"},"values":{"type":"array","items":{"type":"string"},"example":["billing"]}}}}},"enable_auto_assignment":{"type":"boolean","description":"Ative a atribuição automática.","example":true},"working_hours_enabled":{"type":"boolean","description":"Ative o horário de trabalho.","example":true},"out_of_office_message":{"type":"string","description":"Mensagem de ausência para enviar fora do horário de trabalho.","example":"We are currently out of office. Please leave a message and we will get back to you."},"timezone":{"type":"string","description":"Fuso horário da caixa de entrada.","example":"America/New_York"},"allow_messages_after_resolved":{"type":"boolean","description":"Permitir mensagens após a conversa ser resolvida.\n\nDisponível para: `Website`\n","example":true},"lock_to_single_conversation":{"type":"boolean","description":"Bloqueie mensagens de contato em uma única conversa ativa.\n\nDisponível para: `API` `LINE` `Telegram` `WhatsApp` `SMS`\n","example":true},"portal_id":{"type":"integer","description":"ID do portal da central de ajuda a ser anexado à caixa de entrada.","example":1},"sender_name_type":{"type":"string","description":"Tipo de nome do remetente para respostas de email de saída.\n\nDisponível para: `Website` `Email`\n","enum":["friendly","professional"],"example":"friendly"},"business_name":{"type":"string","description":"Nome comercial para respostas de e-mail enviadas.\n\nDisponível para: `Website` `Email`\n","example":"My Business"},"channel":{"anyOf":[{"$ref":"#/components/schemas/inbox_update_web_widget_channel_payload"},{"$ref":"#/components/schemas/inbox_update_api_channel_payload"},{"$ref":"#/components/schemas/inbox_update_email_channel_payload"},{"$ref":"#/components/schemas/inbox_update_line_channel_payload"},{"$ref":"#/components/schemas/inbox_update_telegram_channel_payload"},{"$ref":"#/components/schemas/inbox_update_whatsapp_channel_payload"},{"$ref":"#/components/schemas/inbox_update_sms_channel_payload"}]}}},"agent_bot":{"type":"object","properties":{"id":{"type":"number","description":"ID do bot do agente"},"name":{"type":"string","description":"O nome do bot agente"},"description":{"type":"string","description":"A descrição sobre o bot do agente"},"thumbnail":{"type":"string","description":"A miniatura do bot do agente"},"outgoing_url":{"type":"string","description":"O URL do webhook do bot"},"bot_type":{"type":"string","description":"O tipo do bot"},"bot_config":{"type":"object","description":"A configuração do bot"},"account_id":{"type":"number","description":"ID da conta se for um bot específico da conta"},"access_token":{"type":"string","description":"O token de acesso do bot"},"system_bot":{"type":"boolean","description":"Se o bot é um bot de sistema"}}},"agent":{"type":"object","properties":{"id":{"type":"integer"},"account_id":{"type":"integer"},"availability_status":{"type":"string","enum":["online","busy","offline"],"description":"Disponibilidade efetiva do agente."},"auto_offline":{"type":"boolean","description":"Se o agente fica offline automaticamente quando está ausente."},"confirmed":{"type":"boolean","description":"Se o agente confirmou o endereço de email."},"email":{"type":"string","description":"Email do agente."},"available_name":{"type":"string","description":"Nome de exibição do agente."},"name":{"type":"string","description":"Nome do agente."},"role":{"type":"string","enum":["agent","administrator"],"description":"Função do agente."},"thumbnail":{"type":"string","description":"Miniatura do agente."},"custom_role_id":{"type":["integer","null"],"description":"ID da função personalizada do agente."}}},"label":{"type":"object","properties":{"id":{"type":"number","description":"O ID do rótulo"},"title":{"type":"string","description":"O título da etiqueta"},"description":{"type":"string","description":"A descrição do rótulo"},"color":{"type":"string","description":"Código de cor hexadecimal para a etiqueta"},"show_on_sidebar":{"type":"boolean","description":"Se o rótulo deve aparecer na barra lateral"}}},"label_create_update_payload":{"type":"object","properties":{"title":{"type":"string","description":"O título do rótulo","example":"support"},"description":{"type":"string","description":"Uma breve descrição para o rótulo","example":"Conversations that need support follow-up"},"color":{"type":"string","description":"Código de cor hexadecimal para a etiqueta","example":"#1f93ff"},"show_on_sidebar":{"type":"boolean","description":"Se o rótulo deve aparecer na barra lateral","example":true}}},"contact":{"type":"object","properties":{"payload":{"type":"array","items":{"type":"object","properties":{"additional_attributes":{"type":"object","description":"O objeto que contém atributos adicionais relacionados ao contato"},"availability_status":{"type":"string","description":"O status de disponibilidade do contato"},"email":{"type":"string","description":"O endereço de e-mail do contato"},"id":{"type":"integer","description":"O ID do contato"},"name":{"type":"string","description":"O nome do contato"},"phone_number":{"type":"string","description":"O número de telefone do contato"},"blocked":{"type":"boolean","description":"Se o contato está bloqueado"},"identifier":{"type":"string","description":"O identificador do contato"},"thumbnail":{"type":"string","description":"A miniatura do contato"},"custom_attributes":{"type":"object","description":"Os atributos personalizados do contato","example":{"attribute_key":"attribute_value","signed_up_at":"dd/mm/yyyy"}},"last_activity_at":{"type":"integer","description":"A última atividade do contato"},"created_at":{"type":"integer","description":"O criado do contato"},"contact_inboxes":{"type":"array","items":{"$ref":"#/components/schemas/contact_inboxes"}}}}}}},"message":{"type":"object","properties":{"id":{"type":"number","description":"O ID da mensagem"},"content":{"type":"string","description":"O conteúdo do texto da mensagem"},"account_id":{"type":"number","description":"O ID da conta"},"inbox_id":{"type":"number","description":"O ID da caixa de entrada"},"conversation_id":{"type":"number","description":"O ID da conversa"},"message_type":{"type":"integer","enum":[0,1,2,3],"description":"O tipo da mensagem"},"created_at":{"type":"integer","description":"A hora em que a mensagem foi criada"},"updated_at":{"type":["integer","string"],"description":"A hora em que a mensagem foi atualizada"},"private":{"type":"boolean","description":"Os sinalizadores que mostram se a mensagem é privada ou não"},"status":{"type":["string","null"],"enum":["sent","delivered","read","failed",null],"description":"O status da mensagem"},"source_id":{"type":["string","null"],"description":"O ID de origem da mensagem"},"content_type":{"type":["string","null"],"enum":["text","input_text","input_textarea","input_email","input_select","cards","form","article","incoming_email","input_csat","integrations","sticker","voice_call",null],"description":"O tipo da mensagem modelo"},"content_attributes":{"type":"object","description":"Os atributos de conteúdo para cada content_type"},"sender_type":{"type":["string","null"],"enum":["Contact","User","AgentBot","Captain::Assistant",null],"description":"O tipo do remetente"},"sender_id":{"type":["number","null"],"description":"O ID do remetente"},"external_source_ids":{"type":"object","description":"Os IDs de origem externa da mensagem"},"additional_attributes":{"type":"object","description":"Os atributos adicionais da mensagem"},"processed_message_content":{"type":["string","null"],"description":"O conteúdo da mensagem processada"},"sentiment":{"type":["object","null"],"description":"O sentimento da mensagem"},"conversation":{"type":["object","null"],"description":"O objeto de conversa"},"attachment":{"type":["object","null"],"description":"O objeto de arquivo anexado à imagem"},"sender":{"type":"object","description":"Objeto Usuário/Agente/AgentBot"}}},"conversation_message_create_payload":{"type":"object","required":["content"],"properties":{"content":{"type":"string","description":"O conteúdo da mensagem","example":"Hello, how can I help you?"},"message_type":{"type":"string","enum":["outgoing","incoming"],"description":"O tipo da mensagem","example":"outgoing"},"private":{"type":"boolean","description":"Sinalizador para identificar se é uma nota privada","example":false},"content_type":{"type":"string","enum":["text","input_email","cards","input_select","form","article"],"description":"Tipo de conteúdo da mensagem","example":"text"},"content_attributes":{"type":"object","description":"Atributos baseados no tipo de conteúdo","example":{}},"campaign_id":{"type":"integer","description":"O ID da campanha à qual a mensagem pertence","example":1},"template_params":{"type":"object","description":"Parâmetros do modelo do WhatsApp para envio de mensagens estruturadas","required":["name","category","language","processed_params"],"properties":{"name":{"type":"string","description":"Nome do modelo do WhatsApp (deve ser aprovado no WhatsApp Business Manager)","example":"purchase_receipt"},"category":{"type":"string","enum":["UTILITY","MARKETING","SHIPPING_UPDATE","TICKET_UPDATE","ISSUE_RESOLUTION"],"description":"Categoria do modelo","example":"UTILITY"},"language":{"type":"string","description":"Código do idioma do modelo (formato BCP 47)","example":"en_US"},"processed_params":{"type":"object","description":"Parâmetros de modelo processados organizados por tipo de componente","properties":{"body":{"type":"object","description":"Parâmetros de componentes corporais com espaços reservados variáveis","additionalProperties":{"type":"string"},"example":{"1":"Visa","2":"Nike","3":"Bill"}},"header":{"type":"object","description":"Parâmetros do componente de cabeçalho para modelos de mídia","properties":{"media_url":{"type":"string","format":"uri","description":"URL acessível publicamente para cabeçalhos IMAGE, VIDEO ou DOCUMENT","example":"https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf"},"media_type":{"type":"string","enum":["image","video","document"],"description":"Tipo de mídia para o cabeçalho","example":"document"}}},"buttons":{"type":"array","description":"Parâmetros de componente de botão para modelos interativos","items":{"type":"object","properties":{"type":{"type":"string","enum":["url","copy_code"],"description":"Tipo de parâmetro de botão"},"parameter":{"type":"string","description":"Valor do parâmetro dinâmico para o botão","example":"SSFSDFSD"}}}}}}}}}},"generic_id":{"type":"object","properties":{"id":{"type":"number"}}},"integrations_app":{"type":"object","properties":{"id":{"type":"string","description":"O ID da integração"},"name":{"type":"string","description":"O nome da integração"},"description":{"type":"string","description":"A descrição sobre a equipe"},"hook_type":{"type":"string","description":"Se a integração é uma integração de conta ou caixa de entrada"},"enabled":{"type":"boolean","description":"Se a integração está habilitada para a conta"},"allow_multiple_hooks":{"type":"boolean","description":"Se vários ganchos podem ser criados para a integração"},"hooks":{"type":"array","items":{"type":"object"},"description":"Se houver algum gancho criado para esta integração"}}},"integrations_hook_create_payload":{"type":"object","properties":{"app_id":{"type":"integer","description":"O ID do aplicativo para o qual o webhook de integração está sendo criado","example":1},"inbox_id":{"type":"integer","description":"O ID da caixa de entrada, se o gancho for um gancho da caixa de entrada","example":1},"status":{"type":"integer","description":"O status da integração (0 para inativo, 1 para ativo)","example":1},"settings":{"type":"object","description":"As configurações exigidas pela integração","example":{}}}},"integrations_hook":{"type":"object","properties":{"id":{"type":"string","description":"O ID do webhook de integração"},"app_id":{"type":"string","description":"O ID do aplicativo de integração"},"inbox_id":{"type":"string","description":"ID da caixa de entrada se for uma integração da caixa de entrada"},"account_id":{"type":"string","description":"ID da conta da integração"},"status":{"type":"boolean","description":"Se o webhook de integração está habilitado para a conta"},"hook_type":{"type":"boolean","description":"Seja uma conta ou um webhook de integração de caixa de entrada"},"settings":{"type":"object","description":"As configurações associadas para a integração"}}},"integrations_hook_update_payload":{"type":"object","properties":{"status":{"type":"integer","description":"O status da integração (0 para inativo, 1 para ativo)","example":1},"settings":{"type":"object","description":"As configurações exigidas pela integração","example":{}}}},"team":{"type":"object","properties":{"id":{"type":"number","description":"O ID da equipe"},"name":{"type":"string","description":"O nome da equipe"},"description":{"type":["string","null"],"description":"A descrição sobre a equipe"},"allow_auto_assign":{"type":"boolean","description":"Se esta configuração estiver ativada, o sistema atribuirá automaticamente a conversa a um agente da equipe enquanto atribui a conversa a uma equipe"},"account_id":{"type":"number","description":"O ID da conta com a equipe faz parte"},"is_member":{"type":"boolean","description":"Este campo mostra se o usuário atual faz parte da equipe"}}},"team_create_update_payload":{"type":"object","properties":{"name":{"type":"string","description":"O nome da equipe","example":"Support Team"},"description":{"type":"string","description":"A descrição da equipe","example":"This is a team of support agents"},"allow_auto_assign":{"type":"boolean","description":"Se esta configuração estiver ativada, o sistema atribuirá automaticamente a conversa a um agente da equipe enquanto atribui a conversa a uma equipe","example":true}}},"custom_filter":{"type":"object","properties":{"id":{"type":"number","description":"O ID do filtro personalizado"},"name":{"type":"string","description":"O nome do filtro personalizado"},"type":{"type":"string","enum":["conversation","contact","report"],"description":"A descrição sobre o filtro personalizado"},"query":{"type":"object","description":"Uma consulta que precisa ser salva como um filtro personalizado"},"created_at":{"type":"string","format":"date-time","description":"A hora em que o filtro personalizado foi criado"},"updated_at":{"type":"string","format":"date-time","description":"A hora em que o filtro personalizado foi atualizado"}}},"custom_filter_create_update_payload":{"type":"object","properties":{"name":{"type":"string","description":"O nome do filtro personalizado","example":"My Custom Filter"},"type":{"type":"string","enum":["conversation","contact","report"],"description":"A descrição sobre o filtro personalizado","example":"conversation"},"query":{"type":"object","description":"Uma consulta que precisa ser salva como um filtro personalizado","example":{}}}},"webhook":{"type":"object","properties":{"id":{"type":"number","description":"O ID do webhook"},"url":{"type":"string","description":"A URL para a qual os eventos serão enviados"},"name":{"type":"string","description":"O nome do webhook"},"subscriptions":{"type":"array","items":{"type":"string","enum":["conversation_created","conversation_status_changed","conversation_updated","contact_created","contact_updated","message_created","message_updated","webwidget_triggered","conversation_typing_on","conversation_typing_off"]},"description":"A lista de eventos inscritos"},"secret":{"type":"string","nullable":true,"description":"Segredo usado para assinar solicitações de webhook. As entregas de webhook assinadas incluem `X-FluxaChat-Timestamp` e `X-FluxaChat-Signature`; a assinatura é `sha256=` seguida pelo HMAC-SHA256 de `{timestamp}.{raw_request_body}` usando este segredo. As entregas também incluem `X-FluxaChat-Delivery` quando um ID de entrega está disponível."},"account_id":{"type":"number","description":"O id da conta à qual o objeto webhook pertence"}}},"webhook_create_update_payload":{"type":"object","properties":{"url":{"type":"string","description":"A URL para onde os eventos devem ser enviados","example":"https://example.com/webhook"},"name":{"type":"string","description":"O nome do webhook"},"subscriptions":{"type":"array","items":{"type":"string","enum":["conversation_created","conversation_status_changed","conversation_updated","message_created","message_updated","contact_created","contact_updated","webwidget_triggered","conversation_typing_on","conversation_typing_off"]},"description":"Os eventos que você deseja assinar.","example":["conversation_created","conversation_status_changed"]}}},"reporting_events_list_response":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/reporting_event_meta"},"payload":{"type":"array","items":{"$ref":"#/components/schemas/reporting_event"},"description":"Lista de eventos de relatório"}}},"account_summary":{"type":"object","properties":{"avg_first_response_time":{"type":"string"},"avg_resolution_time":{"type":"string"},"conversations_count":{"type":"number"},"incoming_messages_count":{"type":"number"},"outgoing_messages_count":{"type":"number"},"resolutions_count":{"type":"number"},"previous":{"type":"object","properties":{"avg_first_response_time":{"type":"string"},"avg_resolution_time":{"type":"string"},"conversations_count":{"type":"number"},"incoming_messages_count":{"type":"number"},"outgoing_messages_count":{"type":"number"},"resolutions_count":{"type":"number"}}}}},"agent_conversation_metrics":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"},"email":{"type":"string"},"thumbnail":{"type":"string"},"availability":{"type":"string"},"metric":{"type":"object","properties":{"open":{"type":"number"},"unattended":{"type":"number"}}}}},"channel_summary":{"type":"object","description":"Relatório de resumo do canal contendo contagens de conversas agrupadas por tipo de canal e status. Disponível na versão 4.10.0+.","additionalProperties":{"type":"object","description":"Estatísticas de conversa para um tipo de canal específico (por exemplo, Channel::WebWidget, Channel::Api)","properties":{"open":{"type":"number","description":"Número de conversas abertas"},"resolved":{"type":"number","description":"Número de conversas resolvidas"},"pending":{"type":"number","description":"Número de conversas pendentes"},"snoozed":{"type":"number","description":"Número de conversas adiadas"},"total":{"type":"number","description":"Número total de conversas"}}},"example":{"Channel::WebWidget":{"open":10,"resolved":20,"pending":5,"snoozed":2,"total":37},"Channel::Api":{"open":5,"resolved":15,"pending":3,"snoozed":1,"total":24}}},"inbox_summary":{"type":"array","description":"Relatório de resumo da caixa de entrada contendo estatísticas de conversas agrupadas por caixa de entrada.","items":{"type":"object","properties":{"id":{"type":"number","description":"O ID da caixa de entrada"},"conversations_count":{"type":"number","description":"Número de conversas criadas na caixa de entrada durante o período"},"resolved_conversations_count":{"type":"number","description":"Número de conversas resolvidas na caixa de entrada durante o período"},"avg_resolution_time":{"type":["number","null"],"description":"Tempo médio (em segundos) para resolver conversas. Nulo se não houver dados disponíveis."},"avg_first_response_time":{"type":["number","null"],"description":"Tempo médio (em segundos) para a primeira resposta. Nulo se não houver dados disponíveis."},"avg_reply_time":{"type":["number","null"],"description":"Tempo médio (em segundos) entre respostas. Nulo se não houver dados disponíveis."}}},"example":[{"id":1,"conversations_count":150,"resolved_conversations_count":120,"avg_resolution_time":3600,"avg_first_response_time":300,"avg_reply_time":600},{"id":2,"conversations_count":75,"resolved_conversations_count":60,"avg_resolution_time":1800,"avg_first_response_time":180,"avg_reply_time":420}]},"agent_summary":{"type":"array","description":"Relatório de resumo do agente contendo estatísticas de conversa agrupadas por agente.","items":{"type":"object","properties":{"id":{"type":"number","description":"O ID do agente (usuário)"},"conversations_count":{"type":"number","description":"Número de conversas atribuídas ao agente durante o período"},"resolved_conversations_count":{"type":"number","description":"Número de conversas resolvidas pelo agente durante o período"},"avg_resolution_time":{"type":["number","null"],"description":"Tempo médio (em segundos) para resolver conversas. Nulo se não houver dados disponíveis."},"avg_first_response_time":{"type":["number","null"],"description":"Tempo médio (em segundos) para a primeira resposta. Nulo se não houver dados disponíveis."},"avg_reply_time":{"type":["number","null"],"description":"Tempo médio (em segundos) entre respostas. Nulo se não houver dados disponíveis."}}},"example":[{"id":1,"conversations_count":150,"resolved_conversations_count":120,"avg_resolution_time":3600,"avg_first_response_time":300,"avg_reply_time":600},{"id":2,"conversations_count":75,"resolved_conversations_count":60,"avg_resolution_time":1800,"avg_first_response_time":180,"avg_reply_time":420}]},"team_summary":{"type":"array","description":"Relatório de resumo da equipe contendo estatísticas de conversas agrupadas por equipe.","items":{"type":"object","properties":{"id":{"type":"number","description":"O ID da equipe"},"conversations_count":{"type":"number","description":"Número de conversas atribuídas à equipe durante o período"},"resolved_conversations_count":{"type":"number","description":"Número de conversas resolvidas pela equipe durante o período"},"avg_resolution_time":{"type":["number","null"],"description":"Tempo médio (em segundos) para resolver conversas. Nulo se não houver dados disponíveis."},"avg_first_response_time":{"type":["number","null"],"description":"Tempo médio (em segundos) para a primeira resposta. Nulo se não houver dados disponíveis."},"avg_reply_time":{"type":["number","null"],"description":"Tempo médio (em segundos) entre respostas. Nulo se não houver dados disponíveis."}}},"example":[{"id":1,"conversations_count":250,"resolved_conversations_count":200,"avg_resolution_time":2800,"avg_first_response_time":240,"avg_reply_time":500},{"id":2,"conversations_count":180,"resolved_conversations_count":150,"avg_resolution_time":2400,"avg_first_response_time":200,"avg_reply_time":450}]},"first_response_time_distribution":{"type":"object","description":"Relatório de distribuição do primeiro tempo de resposta agrupado por tipo de canal. Mostra a contagem de conversas com tempos de primeira resposta em diferentes intervalos de tempo.","additionalProperties":{"type":"object","description":"Primeira distribuição do tempo de resposta para um tipo de canal específico (por exemplo, Channel::WebWidget, Channel::Api)","properties":{"0-1h":{"type":"number","description":"Número de conversas com tempo de primeira resposta inferior a 1 hora"},"1-4h":{"type":"number","description":"Número de conversas com tempo de primeira resposta entre 1 e 4 horas"},"4-8h":{"type":"number","description":"Número de conversas com tempo de primeira resposta entre 4 e 8 horas"},"8-24h":{"type":"number","description":"Número de conversas com tempo de primeira resposta entre 8 e 24 horas"},"24h+":{"type":"number","description":"Número de conversas com tempo de primeira resposta superior a 24 horas"}}},"example":{"Channel::WebWidget":{"0-1h":150,"1-4h":80,"4-8h":45,"8-24h":30,"24h+":15},"Channel::Api":{"0-1h":75,"1-4h":40,"4-8h":20,"8-24h":10,"24h+":5}}},"inbox_label_matrix":{"type":"object","description":"Relatório de matriz de rótulo de caixa de entrada mostrando a contagem de conversas para cada combinação de rótulo de caixa de entrada.","properties":{"inboxes":{"type":"array","description":"Lista de caixas de entrada incluídas no relatório","items":{"type":"object","properties":{"id":{"type":"number","description":"O ID da caixa de entrada"},"name":{"type":"string","description":"O nome da caixa de entrada"}}}},"labels":{"type":"array","description":"Lista de rótulos incluídos no relatório","items":{"type":"object","properties":{"id":{"type":"number","description":"O ID do rótulo"},"title":{"type":"string","description":"O título do rótulo"}}}},"matrix":{"type":"array","description":"Matriz 2D onde matriz[i][j] representa a contagem de conversas em caixas de entrada[i] com rótulos[j]","items":{"type":"array","items":{"type":"number"}}}},"example":{"inboxes":[{"id":1,"name":"Website Chat"},{"id":2,"name":"Email Support"}],"labels":[{"id":1,"title":"erro"},{"id":2,"title":"solicitação de recurso"},{"id":3,"title":"urgente"}],"matrix":[[10,5,3],[8,12,2]]}},"outgoing_messages_count":{"type":"array","description":"Relatório de contagem de mensagens de saída agrupadas por entidade (agente, equipe, caixa de entrada ou rótulo).","items":{"type":"object","properties":{"id":{"type":"number","description":"O ID da entidade agrupada (agente, equipe, caixa de entrada ou rótulo)."},"name":{"type":"string","description":"O nome da entidade agrupada."},"outgoing_messages_count":{"type":"number","description":"O número total de mensagens de saída para esta entidade no intervalo de tempo determinado."}}},"example":[{"id":1,"name":"Agent One","outgoing_messages_count":42},{"id":2,"name":"Agent Two","outgoing_messages_count":18}]},"account_create_update_payload":{"type":"object","properties":{"name":{"type":"string","description":"Nome da conta","example":"My Account"},"locale":{"type":"string","description":"A localidade da conta","example":"en"},"domain":{"type":"string","description":"O domínio da conta","example":"example.com"},"support_email":{"type":"string","description":"O e-mail de suporte da conta","example":"support@example.com"},"status":{"type":"string","enum":["active","suspended"],"description":"O status da conta","example":"active"},"limits":{"type":"object","description":"Os limites da conta","example":{}},"custom_attributes":{"type":"object","description":"Os atributos personalizados da conta","example":{}}}},"platform_account":{"type":"object","properties":{"id":{"type":"number","description":"ID da conta"},"name":{"type":"string","description":"Nome da conta"}}},"account_user":{"type":"array","description":"Lista de usuários da conta","items":{"type":"object","properties":{"account_id":{"type":"integer","description":"O ID da conta"},"user_id":{"type":"integer","description":"O ID do usuário"},"role":{"type":"string","description":"se o usuário é um administrador ou agente"}}}},"account_user_create_update_payload":{"type":"object","required":["user_id","role"],"properties":{"user_id":{"type":"integer","description":"O ID do usuário","example":1},"role":{"type":"string","description":"se o usuário é um administrador ou agente","example":"administrator"}}},"platform_agent_bot_create_update_payload":{"type":"object","properties":{"name":{"type":"string","description":"O nome do bot agente","example":"My Agent Bot"},"description":{"type":"string","description":"A descrição do bot agente","example":"This is a sample agent bot"},"outgoing_url":{"type":"string","description":"O URL do webhook do bot","example":"https://example.com/webhook"},"account_id":{"type":"integer","description":"O ID da conta para associar o bot do agente","example":1},"avatar":{"type":"string","format":"binary","description":"Envie os dados do formulário com o binário da imagem do avatar ou use o avatar_url"},"avatar_url":{"type":"string","description":"O URL para um arquivo jpeg, png para o avatar do bot do agente","example":"https://example.com/avatar.png"}}},"user_create_update_payload":{"type":"object","properties":{"name":{"type":"string","description":"Nome do usuário","example":"Daniel"},"display_name":{"type":"string","description":"Nome de exibição do usuário","example":"Dan"},"email":{"type":"string","description":"E-mail do usuário","example":"daniel@acme.inc"},"password":{"type":"string","description":"A senha deve conter letras maiúsculas, minúsculas, números e um caractere especial","example":"Password2!"},"custom_attributes":{"type":"object","description":"Atributos personalizados que você deseja associar ao usuário","example":{}}}},"public_contact_create_update_payload":{"type":"object","properties":{"identifier":{"type":"string","description":"Identificador externo do contato","example":"1234567890"},"identifier_hash":{"type":"string","description":"Hash de identificador preparado para autenticação HMAC","example":"e93275d4eba0e5679ad55f5360af00444e2a888df9b0afa3e8b691c3173725f9"},"email":{"type":"string","description":"E-mail do contato","example":"alice@acme.inc"},"name":{"type":"string","description":"Nome do contato","example":"Alice"},"phone_number":{"type":"string","description":"Número de telefone do contato","example":"+123456789"},"avatar":{"type":"string","format":"binary","description":"Envie os dados do formulário com o binário da imagem do avatar ou use o avatar_url"},"custom_attributes":{"type":"object","description":"Atributos personalizados do cliente","example":{}}}},"public_contact":{"type":"object","properties":{"id":{"type":"integer","description":"ID do contato"},"source_id":{"type":"string","description":"O identificador de sessão do contato"},"name":{"type":["string","null"],"description":"Nome do contato quando disponível"},"email":{"type":["string","null"],"description":"E-mail do contato"},"phone_number":{"type":["string","null"],"description":"Número de telefone do contato"},"pubsub_token":{"type":"string","description":"O token a ser usado para conectar-se ao websocket FluxaChat"}}},"public_contact_record":{"type":"object","additionalProperties":true,"description":"Registro de contato serializado completo retornado quando a API pública renderiza um modelo de contato diretamente.","properties":{"id":{"type":"integer","description":"ID do contato"},"name":{"type":["string","null"],"description":"Nome do contato quando disponível"},"email":{"type":["string","null"],"description":"E-mail do contato"},"phone_number":{"type":["string","null"],"description":"Número de telefone do contato"},"identifier":{"type":["string","null"],"description":"Identificador do contato"},"blocked":{"type":"boolean","description":"Se o contato está bloqueado"},"additional_attributes":{"type":["object","null"],"description":"Atributos adicionais do contato quando presente"},"custom_attributes":{"type":["object","null"],"description":"Atributos personalizados do contato quando presente"},"contact_type":{"type":["string","null"],"description":"Tipo de contato do contato quando disponível"},"country_code":{"type":["string","null"],"description":"Código do país do contato"},"last_activity_at":{"type":["string","null"],"description":"Carimbo de data/hora da última atividade do contato no formato ISO 8601"},"created_at":{"type":["string","null"],"description":"Carimbo de data e hora criado do contato no formato ISO 8601"},"updated_at":{"type":["string","null"],"description":"Carimbo de data e hora atualizado do contato no formato ISO 8601"},"last_name":{"type":["string","null"],"description":"Sobrenome do contato"},"middle_name":{"type":["string","null"],"description":"Nome do meio do contato"},"location":{"type":["string","null"],"description":"Localização do contato"},"account_id":{"type":"integer","description":"ID da conta do contato"},"company_id":{"type":["integer","null"],"description":"ID da empresa do contato"},"label_list":{"type":"array","description":"Rótulos aplicados ao contato","items":{"type":"string"}}}},"public_conversation_create_payload":{"type":"object","properties":{"custom_attributes":{"type":"object","description":"Atributos personalizados da conversa","example":{}}}},"public_conversation":{"type":"object","properties":{"id":{"type":"integer","description":"ID da conversa"},"uuid":{"type":"string","description":"UUID da conversa"},"inbox_id":{"type":"integer","description":"O ID da caixa de entrada da conversa"},"contact_last_seen_at":{"type":"integer","description":"Carimbo de data e hora de quando o contato viu a conversa pela última vez (carimbo de data e hora Unix)"},"status":{"type":"string","enum":["open","resolved","pending","snoozed"],"description":"O status da conversa"},"agent_last_seen_at":{"type":"integer","description":"Carimbo de data/hora de quando o agente viu a conversa pela última vez (carimbo de data/hora Unix)"},"messages":{"type":"array","items":{"$ref":"#/components/schemas/public_message"},"description":"Mensagens na conversa"},"contact":{"$ref":"#/components/schemas/public_contact_record"}}},"public_message_create_payload":{"type":"object","properties":{"content":{"type":"string","description":"Conteúdo da mensagem","example":"Hello, how can I help you?"},"echo_id":{"type":"string","description":"Identificador temporário que será repassado via websockets","example":"1234567890"}}},"public_message":{"type":"object","properties":{"id":{"type":"integer","description":"ID da mensagem"},"content":{"type":["string","null"],"description":"Conteúdo de texto da mensagem. Pode ser nulo para mensagens somente com anexos."},"message_type":{"type":"integer","description":"Indica o tipo de mensagem. Valores possíveis: 0 (entrada), 1 (saída), 2 (atividade), 3 (modelo)"},"content_type":{"type":"string","description":"Tipo de conteúdo da mensagem"},"content_attributes":{"type":"object","description":"Atributos de conteúdo adicionais da mensagem"},"created_at":{"type":"integer","description":"Criado no carimbo de data/hora Unix da mensagem"},"conversation_id":{"type":"integer","description":"Exibir ID da conversa à qual a mensagem pertence"},"attachments":{"type":"array","description":"Anexos, se houver","items":{"$ref":"#/components/schemas/public_message_attachment"}},"sender":{"$ref":"#/components/schemas/public_message_sender"}}},"public_message_update_payload":{"type":"object","properties":{"submitted_values":{"type":"object","description":"Respostas aos tipos de mensagens do bot","properties":{"name":{"type":"string","description":"O nome do valor enviado","example":"My Name"},"title":{"type":"string","description":"O título do valor enviado","example":"My Title"},"value":{"type":"string","description":"O valor do valor enviado","example":"value"},"csat_survey_response":{"type":"object","description":"A resposta da pesquisa CSAT","properties":{"feedback_message":{"type":"string","description":"A mensagem de feedback da resposta da pesquisa CSAT","example":"Great service!"},"rating":{"type":"integer","description":"A classificação da resposta da pesquisa CSAT","example":5}}}}}}},"request_error":{"type":"object","properties":{"field":{"type":"string"},"message":{"type":"string"},"code":{"type":"string"}}},"contact_meta":{"type":"object","properties":{"count":{"type":"integer","description":"Número total de contatos"},"current_page":{"type":["string","integer"],"description":"Número da página atual"}}},"contact_list_item":{"type":"object","properties":{"additional_attributes":{"type":"object","description":"O objeto que contém atributos adicionais relacionados ao contato","properties":{"city":{"type":"string","description":"Cidade do contato"},"country":{"type":"string","description":"País do contato"},"country_code":{"type":["string","null"],"description":"Código do país do contato"},"created_at_ip":{"type":"string","description":"Endereço IP quando o contato foi criado"}}},"availability_status":{"type":"string","description":"Status de disponibilidade do contato","enum":["online","offline"]},"email":{"type":["string","null"],"description":"O endereço de e-mail do contato"},"id":{"type":"integer","description":"O ID do contato"},"name":{"type":"string","description":"O nome do contato"},"phone_number":{"type":["string","null"],"description":"O número de telefone do contato"},"blocked":{"type":"boolean","description":"Se o contato está bloqueado"},"identifier":{"type":["string","null"],"description":"O identificador do contato"},"thumbnail":{"type":"string","description":"A miniatura do contato"},"custom_attributes":{"type":"object","description":"Os atributos personalizados do contato"},"last_activity_at":{"type":["integer","null"],"description":"Data e hora da última atividade"},"created_at":{"type":"integer","description":"Carimbo de data e hora em que o contato foi criado"},"contact_inboxes":{"type":"array","description":"Lista de caixas de entrada associadas a este contato","items":{"$ref":"#/components/schemas/contact_inbox"}}}},"inbox_contact":{"type":"object","properties":{"id":{"type":"number","description":"ID da caixa de entrada"},"avatar_url":{"type":"string","description":"A imagem do avatar da caixa de entrada"},"channel_id":{"type":"number","description":"O ID do canal"},"name":{"type":"string","description":"O nome da caixa de entrada"},"channel_type":{"type":"string","description":"O tipo da caixa de entrada"},"provider":{"type":"string","description":"O provedor da caixa de entrada"}}},"contact_inbox":{"type":"object","properties":{"source_id":{"type":"string","description":"Identificador de origem da caixa de entrada de contato"},"inbox":{"type":"object","properties":{"id":{"type":"integer","description":"ID da caixa de entrada"},"avatar_url":{"type":"string","description":"URL para o avatar da caixa de entrada"},"channel_id":{"type":"integer","description":"ID do canal"},"name":{"type":"string","description":"Nome da caixa de entrada"},"channel_type":{"type":"string","description":"Tipo de canal"},"provider":{"type":["string","null"],"description":"Provedor da caixa de entrada"}}}}},"automation_rule_item":{"type":"object","properties":{"id":{"type":"integer","description":"O ID da regra de automação"},"account_id":{"type":"integer","description":"ID da conta"},"name":{"type":"string","description":"O nome da regra","example":"Add label on message create event"},"description":{"type":"string","description":"Descrição para fornecer mais contexto sobre a regra","example":"Add label support and sales on message create event if incoming message content contains text help"},"event_name":{"type":"string","description":"Evento de regra de automação, no qual chamamos as ações (conversation_created, conversa_updated, message_created)","enum":["conversation_created","conversation_updated","message_created"],"example":"message_created"},"conditions":{"type":"array","description":"Conjunto de condições nas quais o filtro de conversa/mensagem funcionaria","items":{"type":"object","properties":{"values":{"type":"array","items":{"type":"string"}},"attribute_key":{"type":"string"},"query_operator":{"type":"string"},"filter_operator":{"type":"string"}},"example":{"attribute_key":"content","filter_operator":"contains","values":["help"],"query_operator":"and"}}},"actions":{"type":"array","description":"Lista de ações que realizamos quando a condição corresponde","items":{"type":"object","properties":{"action_name":{"type":"string"},"action_params":{"type":"array","items":{"type":"string"}}},"example":{"action_name":"add_label","action_params":["support","sales"]}}},"created_on":{"type":"integer","description":"O carimbo de data/hora em que a regra foi criada"},"active":{"type":"boolean","description":"Habilitar/desabilitar regra de automação"}}},"inbox_create_web_widget_channel_payload":{"type":"object","title":"Canal do site","required":["type","website_url"],"properties":{"type":{"type":"string","enum":["web_widget"],"example":"web_widget"},"website_url":{"type":"string","description":"URL na qual o widget será carregado","example":"https://example.com"},"welcome_title":{"type":"string","description":"Título de boas-vindas a ser exibido no widget","example":"Welcome to our support"},"welcome_tagline":{"type":"string","description":"Slogan de boas-vindas a ser exibido no widget","example":"We are here to help you"},"widget_color":{"type":"string","description":"Uma string de cor hexadecimal usada para personalizar o widget","example":"#FF5733"},"reply_time":{"type":"string","description":"Tempo de resposta esperado mostrado no widget","enum":["in_a_few_minutes","in_a_few_hours","in_a_day"],"example":"in_a_few_minutes"},"pre_chat_form_enabled":{"type":"boolean","description":"Habilite o formulário pré-chat antes de iniciar uma conversa","example":false},"pre_chat_form_options":{"type":"object","description":"Configuração do formulário pré-chat","example":{"pre_chat_message":"Share your queries or comments here.","pre_chat_fields":[{"field_type":"standard","label":"Email Id","name":"emailAddress","type":"email","required":true,"enabled":true}]}},"continuity_via_email":{"type":"boolean","description":"Continue as conversas por e-mail quando o contato sair do site","example":true},"hmac_mandatory":{"type":"boolean","description":"Exigir verificação HMAC para contatos usando o widget","example":false},"allowed_domains":{"type":"string","description":"Lista separada por vírgulas de domínios onde o widget pode ser carregado","example":"example.com"},"selected_feature_flags":{"type":"array","description":"Sinalizadores de recursos de widget ativados","items":{"type":"string","enum":["attachments","emoji_picker","end_conversation","use_inbox_avatar_for_bot","allow_mobile_webview"]},"example":["attachments","emoji_picker","end_conversation"]}}},"inbox_create_api_channel_payload":{"type":"object","title":"Canal de API","required":["type"],"properties":{"type":{"type":"string","enum":["api"],"example":"api"},"webhook_url":{"type":"string","description":"URL do webhook para retornos de chamada da caixa de entrada do canal da API","example":"https://example.com/webhook"},"hmac_mandatory":{"type":"boolean","description":"Exigir verificação HMAC para mensagens recebidas do canal API","example":false},"additional_attributes":{"type":"object","description":"Atributos adicionais armazenados em contatos criados por meio do canal API","example":{"source":"mobile_app"}}}},"inbox_create_email_channel_payload":{"type":"object","title":"Canal de e-mail","required":["type","email"],"properties":{"type":{"type":"string","enum":["email"],"example":"email"},"email":{"type":"string","description":"Endereço de e-mail para a caixa de entrada","example":"support@example.com"},"imap_enabled":{"type":"boolean","description":"Habilite IMAP para e-mails recebidos","example":true},"imap_login":{"type":"string","description":"Nome de usuário de login IMAP","example":"support@example.com"},"imap_password":{"type":"string","description":"Senha de login IMAP","example":"your-imap-password"},"imap_address":{"type":"string","description":"Endereço do servidor IMAP","example":"imap.example.com"},"imap_port":{"type":"integer","description":"Porta do servidor IMAP","example":993},"imap_enable_ssl":{"type":"boolean","description":"Habilitar SSL para IMAP","example":true},"imap_authentication":{"type":"string","description":"Método de autenticação IMAP","example":"plain"},"smtp_enabled":{"type":"boolean","description":"Habilite SMTP para e-mails enviados","example":true},"smtp_login":{"type":"string","description":"Nome de usuário de login SMTP","example":"support@example.com"},"smtp_password":{"type":"string","description":"Senha de login SMTP","example":"your-smtp-password"},"smtp_address":{"type":"string","description":"Endereço do servidor SMTP","example":"smtp.example.com"},"smtp_port":{"type":"integer","description":"Porta do servidor SMTP","example":587},"smtp_domain":{"type":"string","description":"Domínio SMTP HELO","example":"example.com"},"smtp_enable_starttls_auto":{"type":"boolean","description":"Habilitar automaticamente STARTTLS para SMTP","example":true},"smtp_enable_ssl_tls":{"type":"boolean","description":"Habilitar SSL/TLS para SMTP","example":false},"smtp_openssl_verify_mode":{"type":"string","description":"Modo de verificação de certificado OpenSSL para SMTP","example":"none"},"smtp_authentication":{"type":"string","description":"Método de autenticação SMTP","example":"login"},"provider":{"type":"string","description":"Provedor de e-mail","example":"google"},"verified_for_sending":{"type":"boolean","description":"Se a caixa de entrada foi verificada para envio de e-mails","example":false}}},"inbox_create_line_channel_payload":{"type":"object","title":"canal LINHA","required":["type","line_channel_id","line_channel_secret","line_channel_token"],"properties":{"type":{"type":"string","enum":["line"],"example":"line"},"line_channel_id":{"type":"string","description":"ID do canal LINE","example":"1234567890"},"line_channel_secret":{"type":"string","description":"Segredo do canal LINE","example":"line-channel-secret"},"line_channel_token":{"type":"string","description":"Token de acesso ao canal LINE","example":"line-channel-token"}}},"inbox_create_telegram_channel_payload":{"type":"object","title":"Canal de telegrama","required":["type","bot_token"],"properties":{"type":{"type":"string","enum":["telegram"],"example":"telegram"},"bot_token":{"type":"string","description":"Token de bot do telegrama","example":"123456789:telegram-bot-token"}}},"inbox_create_whatsapp_channel_payload":{"oneOf":[{"type":"object","title":"Canal WhatsApp Nuvem","required":["type","phone_number","provider","provider_config"],"properties":{"type":{"type":"string","enum":["whatsapp"],"example":"whatsapp"},"phone_number":{"type":"string","description":"Número de telefone do WhatsApp","example":"+15551234567"},"provider":{"type":"string","description":"Provedor de WhatsApp","enum":["whatsapp_cloud"],"example":"whatsapp_cloud"},"provider_config":{"type":"object","description":"Configuração do provedor WhatsApp Cloud","required":["api_key","phone_number_id","business_account_id"],"properties":{"api_key":{"type":"string","description":"Chave de API do WhatsApp Cloud","example":"your-api-key"},"phone_number_id":{"type":"string","description":"ID do número de telefone do WhatsApp Cloud","example":"your-phone-number-id"},"business_account_id":{"type":"string","description":"ID da conta comercial para WhatsApp Cloud","example":"your-business-account-id"}},"example":{"api_key":"your-api-key","phone_number_id":"your-phone-number-id","business_account_id":"your-business-account-id"}}}},{"type":"object","title":"Canal WhatsApp legado do 360dialog","deprecated":true,"required":["type","phone_number","provider_config"],"properties":{"type":{"type":"string","enum":["whatsapp"],"example":"whatsapp"},"phone_number":{"type":"string","description":"Número de telefone do WhatsApp","example":"+15551234567"},"provider":{"type":"string","description":"Provedor legado do 360dialog. Omita este campo ou use `default` apenas para configurações de diálogo 360 obsoletas existentes.","enum":["default"],"deprecated":true,"example":"default"},"provider_config":{"type":"object","description":"Configuração legada do provedor 360dialog","required":["api_key"],"properties":{"api_key":{"type":"string","description":"Chave API 360dialog","example":"your-api-key"}},"example":{"api_key":"your-api-key"}}}}]},"inbox_create_sms_channel_payload":{"type":"object","title":"Canal SMS","required":["type","phone_number"],"properties":{"type":{"type":"string","enum":["sms"],"example":"sms"},"phone_number":{"type":"string","description":"Número de telefone SMS","example":"+15551234567"},"provider_config":{"type":"object","description":"Configuração de SMS específica do provedor","example":{"account_id":"your-account-id","application_id":"your-application-id"}}}},"inbox_update_web_widget_channel_payload":{"type":"object","title":"Configurações do canal do site","properties":{"website_url":{"type":"string","description":"URL na qual o widget será carregado","example":"https://example.com"},"welcome_title":{"type":"string","description":"Título de boas-vindas a ser exibido no widget","example":"Welcome to our support"},"welcome_tagline":{"type":"string","description":"Slogan de boas-vindas a ser exibido no widget","example":"We are here to help you"},"widget_color":{"type":"string","description":"Uma string de cor hexadecimal usada para personalizar o widget","example":"#FF5733"},"reply_time":{"type":"string","description":"Tempo de resposta esperado mostrado no widget","enum":["in_a_few_minutes","in_a_few_hours","in_a_day"],"example":"in_a_few_minutes"},"pre_chat_form_enabled":{"type":"boolean","description":"Habilite o formulário pré-chat antes de iniciar uma conversa","example":false},"pre_chat_form_options":{"type":"object","description":"Configuração do formulário pré-chat","example":{"pre_chat_message":"Share your queries or comments here.","pre_chat_fields":[{"field_type":"standard","label":"Email Id","name":"emailAddress","type":"email","required":true,"enabled":true}]}},"continuity_via_email":{"type":"boolean","description":"Continue as conversas por e-mail quando o contato sair do site","example":true},"hmac_mandatory":{"type":"boolean","description":"Exigir verificação HMAC para contatos usando o widget","example":false},"allowed_domains":{"type":"string","description":"Lista separada por vírgulas de domínios onde o widget pode ser carregado","example":"example.com"},"selected_feature_flags":{"type":"array","description":"Sinalizadores de recursos de widget ativados","items":{"type":"string","enum":["attachments","emoji_picker","end_conversation","use_inbox_avatar_for_bot","allow_mobile_webview"]},"example":["attachments","emoji_picker","end_conversation"]}}},"inbox_update_api_channel_payload":{"type":"object","title":"Configurações do canal API","properties":{"webhook_url":{"type":"string","description":"URL do webhook para retornos de chamada da caixa de entrada do canal da API","example":"https://example.com/webhook"},"hmac_mandatory":{"type":"boolean","description":"Exigir verificação HMAC para mensagens recebidas do canal API","example":false},"additional_attributes":{"type":"object","description":"Atributos adicionais armazenados em contatos criados por meio do canal API","example":{"source":"mobile_app"}}}},"inbox_update_email_channel_payload":{"type":"object","title":"Configurações do canal de e-mail","properties":{"email":{"type":"string","description":"Endereço de e-mail para a caixa de entrada","example":"support@example.com"},"imap_enabled":{"type":"boolean","description":"Habilite IMAP para e-mails recebidos","example":true},"imap_login":{"type":"string","description":"Nome de usuário de login IMAP","example":"support@example.com"},"imap_password":{"type":"string","description":"Senha de login IMAP","example":"your-imap-password"},"imap_address":{"type":"string","description":"Endereço do servidor IMAP","example":"imap.example.com"},"imap_port":{"type":"integer","description":"Porta do servidor IMAP","example":993},"imap_enable_ssl":{"type":"boolean","description":"Habilitar SSL para IMAP","example":true},"imap_authentication":{"type":"string","description":"Método de autenticação IMAP","example":"plain"},"smtp_enabled":{"type":"boolean","description":"Habilite SMTP para e-mails enviados","example":true},"smtp_login":{"type":"string","description":"Nome de usuário de login SMTP","example":"support@example.com"},"smtp_password":{"type":"string","description":"Senha de login SMTP","example":"your-smtp-password"},"smtp_address":{"type":"string","description":"Endereço do servidor SMTP","example":"smtp.example.com"},"smtp_port":{"type":"integer","description":"Porta do servidor SMTP","example":587},"smtp_domain":{"type":"string","description":"Domínio SMTP HELO","example":"example.com"},"smtp_enable_starttls_auto":{"type":"boolean","description":"Habilitar automaticamente STARTTLS para SMTP","example":true},"smtp_enable_ssl_tls":{"type":"boolean","description":"Habilitar SSL/TLS para SMTP","example":false},"smtp_openssl_verify_mode":{"type":"string","description":"Modo de verificação de certificado OpenSSL para SMTP","example":"none"},"smtp_authentication":{"type":"string","description":"Método de autenticação SMTP","example":"login"},"provider":{"type":"string","description":"Provedor de e-mail","example":"google"},"verified_for_sending":{"type":"boolean","description":"Se a caixa de entrada foi verificada para envio de e-mails","example":false}}},"inbox_update_line_channel_payload":{"type":"object","title":"Configurações do canal LINE","properties":{"line_channel_id":{"type":"string","description":"ID do canal LINE","example":"1234567890"},"line_channel_secret":{"type":"string","description":"Segredo do canal LINE","example":"line-channel-secret"},"line_channel_token":{"type":"string","description":"Token de acesso ao canal LINE","example":"line-channel-token"}}},"inbox_update_telegram_channel_payload":{"type":"object","title":"Configurações do canal de telegrama","properties":{"bot_token":{"type":"string","description":"Token de bot do telegrama","example":"123456789:telegram-bot-token"}}},"inbox_update_whatsapp_channel_payload":{"type":"object","title":"Configurações do canal WhatsApp","properties":{"phone_number":{"type":"string","description":"Número de telefone do WhatsApp","example":"+15551234567"},"provider":{"type":"string","description":"Provedor de WhatsApp. `default` é compatível apenas com configurações obsoletas do 360dialog existentes.","enum":["whatsapp_cloud","default"],"example":"whatsapp_cloud"},"provider_config":{"type":"object","description":"Configuração do provedor WhatsApp. Os canais de nuvem usam `api_key`, `phone_number_id` e `business_account_id`; canais de diálogo 360 legados usam `api_key`.","properties":{"api_key":{"type":"string","description":"Chave de API do provedor","example":"your-api-key"},"phone_number_id":{"type":"string","description":"ID do número de telefone do WhatsApp Cloud","example":"your-phone-number-id"},"business_account_id":{"type":"string","description":"ID da conta comercial para WhatsApp Cloud","example":"your-business-account-id"}},"example":{"api_key":"your-api-key","phone_number_id":"your-phone-number-id","business_account_id":"your-business-account-id"}}}},"inbox_update_sms_channel_payload":{"type":"object","title":"Configurações do canal SMS","properties":{"phone_number":{"type":"string","description":"Número de telefone SMS","example":"+15551234567"},"provider_config":{"type":"object","description":"Configuração de SMS específica do provedor","example":{"api_key":"your-api-key","api_secret":"your-api-secret","application_id":"your-application-id","account_id":"your-account-id"}}}},"reporting_event_meta":{"type":"object","properties":{"count":{"type":"integer","description":"Número total de eventos de relatório"},"current_page":{"type":"integer","description":"Número da página atual"},"total_pages":{"type":"integer","description":"Número total de páginas"}}},"public_message_attachment":{"type":"object","additionalProperties":true,"description":"Carga útil do anexo. Os campos disponíveis variam de acordo com o tipo de arquivo do anexo.","properties":{"id":{"type":"integer","description":"ID do anexo"},"message_id":{"type":"integer","description":"ID da mensagem pai"},"file_type":{"type":"string","enum":["image","audio","video","file","location","fallback","share","story_mention","contact","ig_reel","ig_post","ig_story","embed"],"description":"Tipo do arquivo anexado"},"account_id":{"type":"integer","description":"ID da conta"},"extension":{"type":["string","null"],"description":"Extensão de arquivo"},"data_url":{"type":["string","null"],"description":"URL do arquivo. Pode ser nulo quando uma variante de anexo não possui URL externo."},"thumb_url":{"type":"string","description":"URL da miniatura do arquivo"},"file_size":{"type":"integer","description":"Tamanho do arquivo em bytes"},"width":{"type":["integer","null"],"description":"Largura do anexo quando disponível"},"height":{"type":["integer","null"],"description":"Altura do acessório quando disponível"},"coordinates_lat":{"type":"number","description":"Latitude para anexos de localização"},"coordinates_long":{"type":"number","description":"Longitude para anexos de localização"},"fallback_title":{"type":["string","null"],"description":"Título alternativo para localização, substituto e anexos de contato, quando disponível"},"meta":{"type":"object","description":"Metadados para anexos de contato"},"transcribed_text":{"type":"string","description":"Texto transcrito para anexos de áudio"}}},"public_message_sender":{"type":"object","additionalProperties":true,"description":"Carga útil do remetente polimórfica retornada por push_event_data. Os campos disponíveis variam de acordo com o tipo de remetente.","properties":{"id":{"type":"integer","description":"ID do remetente"},"name":{"type":["string","null"],"description":"Nome do remetente quando disponível"},"avatar_url":{"type":"string","description":"URL do avatar do remetente. Presente para remetentes do tipo usuário, agente_bot e capitão_assistant. Não presente para remetentes de contato (use miniatura)."},"thumbnail":{"type":"string","description":"URL do avatar/miniatura do remetente. Os remetentes de contato usam este campo; os remetentes dos usuários também podem incluí-lo."},"type":{"type":"string","enum":["contact","user","agent_bot","captain_assistant"],"description":"Tipo do remetente"},"available_name":{"type":["string","null"],"description":"Nome de exibição para remetentes de usuários"},"availability_status":{"type":["string","null"],"description":"Status de disponibilidade para remetentes de usuários"},"email":{"type":["string","null"],"description":"Email do remetente quando o remetente é um contato"},"phone_number":{"type":["string","null"],"description":"Número de telefone do remetente quando o remetente é um contato"},"identifier":{"type":["string","null"],"description":"Identificador do remetente quando o remetente é um contato"},"blocked":{"type":"boolean","description":"Se o remetente está bloqueado quando o remetente é um contato"},"additional_attributes":{"type":["object","null"],"description":"Atributos adicionais quando o remetente é um contato e está disponível"},"custom_attributes":{"type":["object","null"],"description":"Atributos personalizados quando o remetente é um contato e está disponível"},"description":{"type":["string","null"],"description":"Descrição quando o remetente é capitão assistente"},"created_at":{"type":["string","null"],"description":"Criado carimbo de data/hora no formato ISO 8601 quando o remetente é um capitão assistente"}}},"agent_create_payload":{"type":"object","required":["name","email","role"],"properties":{"name":{"type":"string","description":"Nome completo do agente","example":"João Silva"},"email":{"type":"string","description":"Email do agente","example":"joao@empresa.com.br"},"role":{"type":"string","enum":["agent","administrator"],"description":"Se é administrador ou agente","example":"agent"},"availability":{"type":"string","enum":["online","busy","offline"],"description":"Disponibilidade configurada do agente.","example":"online"},"auto_offline":{"type":"boolean","description":"Se o agente fica offline automaticamente quando está ausente.","example":true}}},"agent_update_payload":{"type":"object","required":["role"],"properties":{"role":{"type":"string","enum":["agent","administrator"],"description":"Se é administrador ou agente","example":"agent"},"availability":{"type":"string","enum":["online","busy","offline"],"description":"Disponibilidade configurada do agente.","example":"online"},"auto_offline":{"type":"boolean","description":"Se o agente fica offline automaticamente quando está ausente.","example":true}}},"canned_response":{"type":"object","properties":{"id":{"type":"integer","description":"ID da resposta pronta."},"account_id":{"type":"integer","description":"ID da conta."},"short_code":{"type":"string","description":"Código curto para acessar rapidamente a resposta pronta."},"content":{"type":"string","description":"Conteúdo da mensagem da resposta pronta."},"created_at":{"type":"string","description":"Data e hora de criação da resposta pronta."},"updated_at":{"type":"string","description":"Data e hora da última atualização da resposta pronta."}}},"canned_response_payload":{"type":"object","required":["content","short_code"],"properties":{"content":{"type":"string","description":"Conteúdo da mensagem da resposta pronta.","example":"Olá, {{contact.name}}! Como podemos ajudar?"},"short_code":{"type":"string","description":"Código curto para acessar rapidamente a resposta pronta.","example":"boas_vindas"}}}},"parameters":{"account_id":{"in":"path","name":"account_id","schema":{"type":"integer"},"required":true,"description":"O ID numérico da conta"},"contact_sort_param":{"in":"query","name":"sort","schema":{"type":"string","enum":["name","email","phone_number","last_activity_at","-name","-email","-phone_number","-last_activity_at"]},"required":false,"description":"O atributo pelo qual a lista deve ser classificada"},"page":{"in":"query","name":"page","schema":{"type":"integer","default":1},"required":false,"description":"O parâmetro da página"},"inbox_id":{"in":"path","name":"inbox_id","schema":{"type":"integer"},"required":true,"description":"O ID da caixa de entrada"},"hook_id":{"in":"path","name":"hook_id","schema":{"type":"integer"},"required":true,"description":"O ID numérico do webhook de integração"},"team_id":{"in":"path","name":"team_id","schema":{"type":"integer"},"required":true,"description":"O ID da equipe a ser atualizada"}},"securitySchemes":{"userApiKey":{"type":"apiKey","in":"header","name":"api_access_token","description":"Este token pode ser obtido visitando a página de perfil ou através do console Rails. Fornece acesso a endpoints com base nos níveis de permissões do usuário. Este token pode ser salvo por um sistema externo quando o usuário é criado via API, para realizar atividades em nome do usuário."},"agentBotApiKey":{"type":"apiKey","in":"header","name":"api_access_token","description":"Este token deve ser fornecido pelo administrador do sistema ou obtido através do console Rails. Este token pode ser usado para criar integrações de bot e só pode acessar APIs limitadas."},"platformAppApiKey":{"type":"apiKey","in":"header","name":"api_access_token","description":"Este token pode ser obtido pelo administrador do sistema após criar um platformApp. Este token deve ser usado para provisionar bots de agentes, contas, usuários e suas funções."}}}}