v1

latestOpenAPI 3.0.3Proprietary2026-07-13261150.7 KB
Spam

Batch Spam Lookup

Process up to 100 phone numbers for spam detection in a single request.

Features:

  • Automatic deduplication (duplicates charged once)
  • Two-phase billing (reserve → process → settle)
  • Job tracking with unique ID
  • Full transparency in response with timing and billing breakdown
post/api/v1/spam/batch

Request body

phone_numbersstring[] required
check_spamboolean

Whether to query external spam provider

Example request

{
  "phone_numbers": [
    "15555550123",
    "19494600638"
  ]
}

Response

Successful batch spam lookup

job_idstring uuid

Example response

{
  "job_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "results": [
    {
      "phone_number": "15555550123",
      "is_spam": true,
      "source": "MCL_PROVIDER",
      "input_indices": [
        0,
        2
      ],
      "status": "success"
    }
  ],
  "summary": {
    "submitted": 3,
    "unique": 2,
    "duplicates_removed": 1,
    "succeeded": 2
  },
  "billing": {
    "estimated_cost": 0.02,
    "actual_cost": 0.02,
    "savings_from_deduplication": 0.01,
    "per_lookup_rate": 0.01
  },
  "timing": {
    "duration_ms": 1234
  }
}