GET/customers/search

Buscar atendimento pelo telefone

Retorna o último atendimento criado para um número de telefone, com contato, canal, departamento e atendentes vinculados.

GEThttps://apiv3.ihelpchat.com/api/v2/customers/search

Retorna o último atendimento criado para um número de telefone, com contato, canal, departamento e atendentes vinculados.

Parâmetros

searchTextstringobrigatório

Número de telefone do contato, sem máscara (ex: 17936189969).

quantidadenumber

Quantidade de registros por página. Os exemplos usam 20.

skipnumber

Quantidade de registros a pular, para paginar. Os exemplos usam 0.

Exemplo

curl -G https://apiv3.ihelpchat.com/api/v2/customers/search \
  --data-urlencode "searchText=17936189969" \
  --data-urlencode "quantidade=20" \
  --data-urlencode "skip=0" \
  -H "Authorization: Bearer $IHELP_TOKEN"

const params = new URLSearchParams({ searchText: '17936189969', quantidade: '20', skip: '0' });

const res = await fetch(`https://apiv3.ihelpchat.com/api/v2/customers/search?${params}`, {
  headers: { Authorization: `Bearer ${process.env.IHELP_TOKEN}` },
});

const { dados } = await res.json();
console.log(dados[0].idRef);

import os, requests

r = requests.get(
    "https://apiv3.ihelpchat.com/api/v2/customers/search",
    params={"searchText": "17936189969", "quantidade": 20, "skip": 0},
    headers={"Authorization": f"Bearer {os.environ['IHELP_TOKEN']}"},
    timeout=15,
)
print(r.json()["dados"][0]["idRef"])

GET https://apiv3.ihelpchat.com/api/v2/customers/search?searchText=<numero>&quantidade=20&skip=0
GET https://apiv3.ihelpchat.com/api/v2/customers/search?searchText=17936189969&quantidade=20&skip=0

ID para enviar mensagem

O ID do atendimento usado para enviar mensagem é o idRef (ex: 69ea67a0ab43821f9dcb3976), não o id curto numérico (ex: 20922413).

Resposta

200 OK

{
   "dados":[
      {
         "id":20922413,
         "ativo":true,
         "atendimentoTransferido":false,
         "chatIdExterno":"5517936189969",
         "chatImagemPerfil":"https://images.ihelpchat.com/medias/fa075ed8-2c2e-4e5b-87a7-8d05c7cc4484.jpg",
         "chatNome":"Gian",
         "chatUltimaMensagem":"gfgf",
         "chatUltimaMensagemTipoMensagem":0,
         "chatUltimaMensagemData":"2026-04-24T19:37:40Z",
         "chatUltimaMensagemDirecao":1,
         "chatUltimaMensagemStatus":4,
         "chatNotificacoes":0,
         "canalId":2,
         "departamentoId":10,
         "statusId":0,
         "chatId":"696fcae1594bdd140221c31f",
         "contatoId":4752052,
         "idRef":"69ea67a0ab43821f9dcb3976",
         "tipoAtendimento":1,
         "customerMood":0,
         "createdDate":"2026-04-23T18:40:35Z",
         "priority":false,
         "customizedFilterId":0,
         "channelTitle":"17 99261-0896 | iHelp Comercial | Geral",
         "channelNumber":"5517992610896",
         "channelType":1,
         "channelProvider":0,
         "cloudApi":false,
         "departmentTitle":"Suporte",
         "contato":{
            "id":4752052,
            "nome":"Gian - Automação",
            "empresaId":1,
            "idRef":"696fcae1594bdd140221c328",
            "tags":[
               {
                  "id":279,
                  "nome":"FECHAMENTO",
                  "empresaId":1,
                  "idRef":"647f93f3a91a19b37f5caf09"
               }
            ],
            "saved":true
         },
         "atendimentoUsuarios":[
            {
               "id":16089801,
               "atendimentoId":20922413,
               "userId":10783,
               "idRef":"69ea67a3ab43821f9dcb3bee",
               "usuario":{
                  "status":true,
                  "imagem":"https://images.ihelpchat.com/medias/17111111111111111111111111111E606CCF.jpg",
                  "usuarioPerfil":1,
                  "ocultarAbaDepartamento":false,
                  "ocultarAbaFinalizados":false,
                  "ocultarMenuMarketing":false,
                  "ocultarMenuRelatorio":false,
                  "ocultarAbaRobo":false,
                  "notificacoes":true,
                  "audioNotificacao":"sound3.mp3",
                  "hideContactMenu":false,
                  "canReopen":false,
                  "id":10783,
                  "nome":"Gian",
                  "idRef":"6984906b7c3462bdfd16f3e7"
               }
            }
         ]
      }
   ]
}

Campos relevantes

dados[].idRef

Identificador do atendimento usado no envio de mensagens.

dados[].canalId

Canal do atendimento.

dados[].departamentoId

Departamento do atendimento.

dados[].contato

Contato do atendimento, com nome, idRef e tags.

dados[].atendimentoUsuarios

Atendentes vinculados ao atendimento.