Enumerações

O significado de cada valor numérico usado nos campos de enumeração da API pública.

Nos corpos JSON, os campos de enumeração viajam como número inteiro. A API não aceita nem devolve o nome nesses campos, então {"TipoPessoa": 1} funciona e {"TipoPessoa": "PessoaFisica"} não.

Nos filtros de query string é o contrário. Ali o valor vai pelo nome, como em ?prioridade=Alta ou ?status=Aberto. Os nomes aceitos em cada filtro estão na página do endpoint, na descrição do parâmetro.

Os números são estáveis, e um valor existente nunca muda de significado. Valores novos podem ser acrescentados, então trate número desconhecido como "outro" em vez de deixar o código quebrar.

Contatos e pessoas

`TipoDeContato`

Por qual canal o contato se comunica. Usado em ContatoCreateRequest, ContatoUpdateRequest e ContatoResponse.

Valor	Nome	Significado
`0`	`TelefonePrincipal`	Telefone, sem canal de mensageria associado
`1`	`Whatsapp`	WhatsApp
`2`	`Instagram`	Instagram Direct
`3`	`Facebook`	Facebook Messenger
`4`	`Telegram`	Telegram
`5`	`WebChat`	Chat do site

`TipoPessoa`

Valor	Nome
`1`	`PessoaFisica`
`2`	`PessoaJuridica`

`IndicadorDeIe`

Situação da inscrição estadual, usada na emissão fiscal.

Valor	Nome	Significado
`1`	`ContribuinteIcms`	Contribuinte de ICMS
`2`	`ContribuinteIsento`	Contribuinte isento de inscrição
`9`	`NaoContribuinte`	Não contribuinte

`FusoHorario`

Valor	Nome
`0`	`Brasilia`
`1`	`SaoPaulo`

Mensagens

Todos os três campos abaixo aparecem em MensagemDoAtendimentoResponse, ao listar mensagens de um atendimento.

`Tipo`, de `TipoDeMensagemDeChat`

Valor	Nome	Significado
`0`	`Chat`	Mensagem trocada com o cliente
`1`	`Nota`	Nota interna, invisível para o cliente
`2`	`Notificacao`	Aviso gerado pelo sistema

`Status`, de `StatusMensagemEnum`

Valor	Nome	Significado
`-1`	`Falha`	Não foi entregue. Pode ser reenviada
`0`	`Enviada`	Saiu da plataforma
`1`	`Entregue`	Chegou ao dispositivo
`2`	`Lida`	Foi lida pelo cliente
`3`	`Reproduzida`	Áudio ouvido pelo cliente

`Origem`, de `OrigemMensagemDeChat`

Valor	Nome	Significado
`0`	`Normal`	Enviada por um usuário na plataforma
`1`	`Api`	Enviada pela API pública
`2`	`PesquisaSatisfacao`	Pesquisa de satisfação
`3`	`Campanha`	Disparo de campanha
`4`	`EncerramentoAutomatico`	Aviso de encerramento por inatividade
`5`	`Bot`	Fluxo ou agente de IA
`6`	`RecuperacaoDeCarrinho`	Recuperação de carrinho abandonado
`7`	`Sincronizacao`	Importada na sincronização do canal
`8`	`PosicaoNaFila`	Aviso de posição na fila

Tickets

`Privacidade`, de `PrivacidadeTicket`

Valor	Nome	Significado
`0`	`Publico`	Visível ao solicitante
`1`	`Privado`	Restrito ao time

`TipoResponsavel`, de `TipoResponsavelEnum`

Diz se o responsável é uma pessoa ou um departamento.

Valor	Nome
`0`	`Usuario`
`1`	`Departamento`

Este é o único campo enum da API que, em uma escrita, exige o nome e não o número. No PATCH /v1/ticket/{idTicket} envie "tipoResponsavel": "Usuario" ou "Departamento". Número resulta em 422. Nas respostas, o mesmo campo volta como número.

`Tipo` do solicitante, de `TipoSolicitanteEnum`

Valor	Nome
`0`	`Contato`
`1`	`Usuario`

`TipoDeGerador`, de `TipoDeGeradorEnum`

Quem originou o ticket.

Valor	Nome
`0`	`ClientesDoTicket`
`1`	`ResponsavelPeloTicket`
`2`	`GeradorDoTicket`
`3`	`RegistradoPeloSistema`
`4`	`UsuarioEspecifico`
`5`	`PessoaLogada`
`6`	`MembrosDaEquipeDaPessoaLogada`
`7`	`Agente`
`8`	`Cliente`

`ModeloIteracao`

Tipo da interação incluída em POST /v1/ticket/IncluirInteracao.

Valor	Nome	Significado
`0`	`AcaoPublica`	Visível ao solicitante
`1`	`AcaoInterna`	Restrita ao time
`2`	`MensagemInterna`	Recado entre usuários

`MeioDeAberturaDeTicket`

Por onde o ticket entrou. Somente leitura, em TicketResponse.

Valor	Nome	Valor	Nome
`0`	`AcessoRemoto`	`14`	`FormularioDeContato`
`1`	`ActiveWhatsappNLU`	`15`	`GatilhoDoSistema`
`2`	`AgendamentoAutomatico`	`16`	`IntegracaoSunchatPlus`
`3`	`Agente`	`17`	`IssueJira`
`4`	`ChamadaCancelada`	`18`	`IssueRedmine`
`5`	`ChamadaEfetuada`	`19`	`MensagemOffline`
`6`	`ChamadaEfetuadaPerdida`	`20`	`WebApi`
`7`	`ChamadaRecebida`	`21`	`Whatsapp`
`8`	`ChamadaRecebidaPerdida`	`22`	`WhatsappNLU`
`9`	`Chat`	`23`	`WhatsappAtivo`
`10`	`ChatNLU`	`24`	`WhatsappBusinessSunchatPlus`
`11`	`ChatOnline`	`25`	`ZenviaChat`
`12`	`Email`	`26`	`Agenda`
`13`	`FacebookMessenger`	`27`	`Cliente`

Ticket criado pela API pública chega como 20 (WebApi).

Campos personalizados

`Tipo`, de `TipoCampoPersonalizadoEnum`

Define o tipo do valor aceito pelo campo.

Valor	Nome	Valor aceito
`0`	`TextoCurto`	Texto de uma linha
`1`	`TextoLongo`	Texto de várias linhas
`2`	`ValorDecimal`	Número com decimais
`3`	`ValorInteiro`	Número inteiro
`4`	`ListaDeOpcoes`	Uma opção da lista configurada
`5`	`Horario`	Hora do dia
`6`	`Data`	Data
`7`	`DataHora`	Data e hora
`8`	`Booleano`	`true` ou `false`
`9`	`Link`	URL
`10`	`SimNao`	Sim ou não
`11`	`CnpjCpf`	CNPJ ou CPF
`12`	`Cep`	CEP
`13`	`ListaDeValores`	Várias opções da lista configurada

Vendas

`Status`, de `StatusDaVenda`

Valor	Nome	Significado
`0`	`Carrinho`	Carrinho aberto, sem pedido fechado
`1`	`AguardandoPagamento`	Pedido fechado, pagamento pendente
`2`	`Confirmada`	Pedido confirmado
`3`	`Pago`	Pagamento aprovado
`4`	`EmSeparacao`	Em separação
`5`	`Separado`	Separado
`6`	`EmRotaProntoParaRetirada`	Em rota de entrega ou pronto para retirada
`7`	`Chegou`	Chegou ao destino
`8`	`Entregue`	Entregue
`99`	`Cancelada`	Cancelada

O 99 quebra a sequência de propósito. Cancelamento é um desvio do fluxo, e não a última etapa dele.