Pular para o conteúdo
TalismanLeadsDocs
InícioObter uma chave de API

Referência da API

O endereço base é https://api.talismanleads.io/v1. As requisições e respostas são em JSON, exceto os links de upload e download. Também disponível como arquivo OpenAPI.

Seu saldo

GET/account

Seu saldo e os limites em vigor.

A chave de API precisa: Somente leitura, ou poder fazer pedidos

Exemplo de requisição

curl "https://api.talismanleads.io/v1/account" \
  -H "Authorization: Bearer tl_live_your_key_here"

Exemplo de resposta (200)

{
  "balance": "100.00",
  "currency": "USD",
  "key": {
    "id": "11111111-1111-4111-8111-111111111111",
    "scopes": [
      "read",
      "orders"
    ]
  },
  "limits": {
    "reads_per_minute": 60,
    "result_downloads_per_minute": 30,
    "uploads_per_minute": 10,
    "estimates_per_minute": 10,
    "orders_per_minute": 10,
    "open_task_parts": 20
  }
}

Listar os verificadores

GET/checkers

O que esta conta pode pedir agora, pelos preços dela. Um verificador pausado ou bloqueado não aparece.

A chave de API precisa: Somente leitura, ou poder fazer pedidos

Exemplo de requisição

curl "https://api.talismanleads.io/v1/checkers" \
  -H "Authorization: Bearer tl_live_your_key_here"

Exemplo de resposta (200)

{
  "checkers": [
    {
      "id": "whatsapp_status_detection",
      "name": "WhatsApp Status Detection",
      "input": "phone",
      "price": {
        "amount": "3.00",
        "per_entries": 10000,
        "currency": "USD"
      },
      "minimum_entries": 0,
      "minimum_billed_entries": 2000,
      "calling_code": null
    }
  ]
}

Enviar uma lista grande

POST/uploads

Um link para enviar um arquivo, direto para o armazenamento. Envie com PUT e os cabeçalhos informados. O link dura 2 horas.

A chave de API precisa: Poder fazer pedidos

Corpo

size_bytesinteger · obrigatório
O tamanho do arquivo, em bytes.
file_namestring · opcional
Um nome para a lista, terminando em .txt.

Exemplo de requisição

curl -X POST "https://api.talismanleads.io/v1/uploads" \
  -H "Authorization: Bearer tl_live_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{"file_name":"list.txt","size_bytes":1048576}'

Exemplo de resposta (201)

{
  "upload_id": "upl_2b7d9f10-6c3e-4a1f-8d2b-9e8f7a6b5c4d",
  "upload_url": "https://storage.example.com/upload/sign/list.txt?token=...",
  "method": "PUT",
  "headers": {
    "Content-Type": "text/plain"
  },
  "expires_at": "2026-11-05T11:00:00.000Z"
}

Ver quanto um pedido custaria

POST/estimates

Conta as entradas, calcula o preço e informa qualquer problema na lista. Não cobra nada. Aguarde até 5 minutos pela resposta.

A chave de API precisa: Poder fazer pedidos

Corpo

checkerstring · obrigatório
O id de um verificador, de GET /checkers.
entriesstring[] · opcional
A lista, uma string por entrada, até 100.000 entradas e 4 MB. Envie isto ou upload_id.
upload_idstring · opcional
Um upload_id de POST /uploads. Envie isto ou entries.
countrystring · opcional
Um código de país de duas letras, se você quiser dizer de que país são os números.
file_namestring · opcional
Um nome para a lista, terminando em .txt.

Exemplo de requisição

curl -X POST "https://api.talismanleads.io/v1/estimates" \
  -H "Authorization: Bearer tl_live_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{"checker":"whatsapp_status_detection","entries":["+14155550142","+12125550187"]}'

Exemplo de resposta (200)

{
  "checker": "whatsapp_status_detection",
  "entries": 2,
  "billed_entries": 2000,
  "charge": "0.60",
  "currency": "USD",
  "parts": 1,
  "country": {
    "code": "US",
    "share": 1
  }
}

Fazer um pedido

POST/orders

Cobra do seu saldo e coloca o trabalho na fila. Responde 201 para um novo pedido e 200 com Idempotent-Replay: true para uma repetição; uma repetição no mesmo momento também pode responder 201, então diferencie os pedidos pelo id. Aguarde até 5 minutos pela resposta.

A chave de API precisa: Poder fazer pedidos

Cabeçalhos

Idempotency-Keystring · obrigatório
Até 200 caracteres ASCII sem espaços. Por 7 dias, a mesma chave de idempotência significa o mesmo pedido.

Corpo

checkerstring · obrigatório
O id de um verificador, de GET /checkers.
entriesstring[] · opcional
A lista, uma string por entrada, até 100.000 entradas e 4 MB. Envie isto ou upload_id.
upload_idstring · opcional
Um upload_id de POST /uploads. Envie isto ou entries.
countrystring · opcional
Um código de país de duas letras, se você quiser dizer de que país são os números.
file_namestring · opcional
Um nome para a lista, terminando em .txt.
expected_chargestring · opcional
Um preço em dólares, como "18.00". O pedido é recusado com price_changed se custar qualquer outro valor.

Exemplo de requisição

curl -X POST "https://api.talismanleads.io/v1/orders" \
  -H "Authorization: Bearer tl_live_your_key_here" \
  -H "Idempotency-Key: crm-export-2026-11-05" \
  -H "Content-Type: application/json" \
  -d '{"checker":"whatsapp_status_detection","entries":["+14155550142","+12125550187"]}'

Exemplo de resposta (201)

{
  "id": "ord_8f2c1e7a-3b4d-4c5e-9f60-1a2b3c4d5e6f",
  "checker": "whatsapp_status_detection",
  "status": "queued",
  "entries": 2,
  "charge": "0.60",
  "refunded": "0.00",
  "currency": "USD",
  "parts": {
    "total": 1,
    "completed": 0,
    "failed": 0
  },
  "results": null,
  "error": null,
  "source": "api",
  "created_at": "2026-11-05T09:00:00.000Z",
  "completed_at": null
}

Listar seus pedidos

GET/orders

Os mais recentes primeiro. Passe next_cursor de volta como cursor para obter a próxima página.

A chave de API precisa: Somente leitura, ou poder fazer pedidos

Parâmetros de consulta

limitinteger · opcional
Quantos retornar, de 1 a 100. O padrão é 20.
cursorstring · opcional
next_cursor da última página.

Exemplo de requisição

curl "https://api.talismanleads.io/v1/orders?limit=20" \
  -H "Authorization: Bearer tl_live_your_key_here"

Exemplo de resposta (200)

{
  "orders": [
    {
      "id": "ord_8f2c1e7a-3b4d-4c5e-9f60-1a2b3c4d5e6f",
      "checker": "whatsapp_status_detection",
      "status": "completed",
      "entries": 2,
      "charge": "0.60",
      "refunded": "0.00",
      "currency": "USD",
      "parts": {
        "total": 1,
        "completed": 1,
        "failed": 0
      },
      "results": {
        "registered": 1,
        "not_registered": 1
      },
      "error": null,
      "source": "api",
      "created_at": "2026-11-05T09:00:00.000Z",
      "completed_at": "2026-11-05T09:02:10.000Z"
    }
  ],
  "next_cursor": null
}

Um pedido

GET/orders/{id}

O status, as entradas, a cobrança, o reembolso, as partes e as contagens. results é null até uma parte terminar, e uma contagem é null quando o verificador não a informa.

A chave de API precisa: Somente leitura, ou poder fazer pedidos

Parâmetros de caminho

idstring · obrigatório
O id do pedido.

Exemplo de requisição

curl "https://api.talismanleads.io/v1/orders/ord_8f2c1e7a-3b4d-4c5e-9f60-1a2b3c4d5e6f" \
  -H "Authorization: Bearer tl_live_your_key_here"

Exemplo de resposta (200)

{
  "id": "ord_8f2c1e7a-3b4d-4c5e-9f60-1a2b3c4d5e6f",
  "checker": "whatsapp_status_detection",
  "status": "completed",
  "entries": 2,
  "charge": "0.60",
  "refunded": "0.00",
  "currency": "USD",
  "parts": {
    "total": 1,
    "completed": 1,
    "failed": 0
  },
  "results": {
    "registered": 1,
    "not_registered": 1
  },
  "error": null,
  "source": "api",
  "created_at": "2026-11-05T09:00:00.000Z",
  "completed_at": "2026-11-05T09:02:10.000Z"
}

Arquivos de resultado

GET/orders/{id}/results

Um link de download para cada parte, válido por 15 minutos. Uma parte ainda em execução não tem link. Fale com o suporte se uma parte concluída não tiver.

A chave de API precisa: Somente leitura, ou poder fazer pedidos

Parâmetros de caminho

idstring · obrigatório
O id do pedido.

Exemplo de requisição

curl "https://api.talismanleads.io/v1/orders/ord_8f2c1e7a-3b4d-4c5e-9f60-1a2b3c4d5e6f/results" \
  -H "Authorization: Bearer tl_live_your_key_here"

Exemplo de resposta (200)

{
  "order_id": "ord_8f2c1e7a-3b4d-4c5e-9f60-1a2b3c4d5e6f",
  "status": "completed",
  "parts": [
    {
      "part": 1,
      "status": "completed",
      "file_name": "result.csv",
      "url": "https://storage.example.com/sign/result.csv?token=...",
      "expires_at": "2026-11-05T09:17:10.000Z"
    }
  ]
}

Erros

Anterior

Verificadores

Próxima

Nesta página

Seu saldoListar os verificadoresEnviar uma lista grandeVer quanto um pedido custariaFazer um pedidoListar seus pedidosUm pedidoArquivos de resultado