Перейти к содержимому
TalismanLeadsDocs
ГлавнаяПолучить API-ключ

Справочник API

Базовый адрес: https://api.talismanleads.io/v1. Запросы и ответы в формате JSON, кроме ссылок для загрузки и скачивания. Также доступен файл OpenAPI.

Ваш баланс

GET/account

Ваш баланс и действующие лимиты.

Нужен API-ключ: Только для чтения или с размещением заказов

Пример запроса

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

Пример ответа (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
  }
}

Список проверок

GET/checkers

Что этот аккаунт может заказать сейчас, по его ценам. Приостановленная или заблокированная проверка в списке не показывается.

Нужен API-ключ: Только для чтения или с размещением заказов

Пример запроса

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

Пример ответа (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
    }
  ]
}

Загрузка большого списка

POST/uploads

Ссылка для отправки файла напрямую в хранилище. Отправьте его методом PUT с указанными заголовками. Ссылка действует 2 часа.

Нужен API-ключ: С размещением заказов

Тело

size_bytesinteger · обязательный
Размер файла в байтах.
file_namestring · необязательный
Имя списка, оканчивающееся на .txt.

Пример запроса

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}'

Пример ответа (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"
}

Узнать, сколько будет стоить заказ

POST/estimates

Считает записи, рассчитывает цену и сообщает о возможных проблемах со списком. Ничего не списывает. Закладывайте до 5 минут на ответ.

Нужен API-ключ: С размещением заказов

Тело

checkerstring · обязательный
id проверки из GET /checkers.
entriesstring[] · необязательный
Список, по одной строке на запись, до 100 000 записей и 4 MB. Передайте это поле или upload_id.
upload_idstring · необязательный
upload_id из POST /uploads. Передайте это поле или entries.
countrystring · необязательный
Двухбуквенный код страны, если вы хотите указать, из какой страны номера.
file_namestring · необязательный
Имя списка, оканчивающееся на .txt.

Пример запроса

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"]}'

Пример ответа (200)

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

Разместить заказ

POST/orders

Списывает средства с вашего баланса и ставит работу в очередь. Отвечает 201 на новый заказ и 200 с Idempotent-Replay: true на повтор; повтор в тот же момент также может получить ответ 201, поэтому различайте заказы по id. Закладывайте до 5 минут на ответ.

Нужен API-ключ: С размещением заказов

Заголовки

Idempotency-Keystring · обязательный
До 200 символов ASCII без пробелов. В течение 7 дней один и тот же Idempotency-Key означает один и тот же заказ.

Тело

checkerstring · обязательный
id проверки из GET /checkers.
entriesstring[] · необязательный
Список, по одной строке на запись, до 100 000 записей и 4 MB. Передайте это поле или upload_id.
upload_idstring · необязательный
upload_id из POST /uploads. Передайте это поле или entries.
countrystring · необязательный
Двухбуквенный код страны, если вы хотите указать, из какой страны номера.
file_namestring · необязательный
Имя списка, оканчивающееся на .txt.
expected_chargestring · необязательный
Цена в долларах, например "18.00". Заказ отклоняется с кодом price_changed, если его стоимость окажется любой другой.

Пример запроса

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"]}'

Пример ответа (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
}

Список ваших заказов

GET/orders

Сначала новые. Передайте next_cursor обратно как cursor, чтобы получить следующую страницу.

Нужен API-ключ: Только для чтения или с размещением заказов

Параметры запроса

limitinteger · необязательный
Сколько вернуть, от 1 до 100. По умолчанию 20.
cursorstring · необязательный
next_cursor с предыдущей страницы.

Пример запроса

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

Пример ответа (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
}

Один заказ

GET/orders/{id}

Его состояние, записи, списание, возврат, части и количества. results равно null, пока ни одна часть не завершена, а количество равно null, если проверка его не сообщает.

Нужен API-ключ: Только для чтения или с размещением заказов

Параметры пути

idstring · обязательный
id заказа.

Пример запроса

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

Пример ответа (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"
}

Файлы с результатами

GET/orders/{id}/results

Ссылка для скачивания по каждой части, действующая 15 минут. У выполняющейся части ссылки нет. Обратитесь в поддержку, если её нет у завершённой части.

Нужен API-ключ: Только для чтения или с размещением заказов

Параметры пути

idstring · обязательный
id заказа.

Пример запроса

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

Пример ответа (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"
    }
  ]
}

Ошибки

Назад

Проверки

Далее

На этой странице

Ваш балансСписок проверокЗагрузка большого спискаУзнать, сколько будет стоить заказРазместить заказСписок ваших заказовОдин заказФайлы с результатами