Skip to main content
POST
/
calls
/
bulk
cURL
curl --request POST \
  --url https://sandbox.veritusagent.ai/api/v1/calls/bulk \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "agentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "customerIds": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "webhook": {
    "url": "<string>",
    "secretId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}
'
{
  "requestId": "838be160-334c-47aa-a559-d92d5cdc2ef4",
  "success": true,
  "data": {
    "summary": {
      "total": 3,
      "successful": 2,
      "failed": 1
    },
    "results": [
      {
        "customerId": "550e8400-e29b-41d4-a716-446655440000",
        "success": true,
        "data": {
          "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
          "threadId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "toPhoneNumber": "+14155551234",
          "fromPhoneNumber": "+14155559876",
          "compliance": {
            "passed": true,
            "checksPassed": [
              {
                "id": "is-active",
                "name": "Is Active",
                "description": "Check if customer is active",
                "reason": "Customer is active"
              },
              {
                "id": "cease-and-desist-exclusion",
                "name": "Cease and Desist Exclusion",
                "description": "Prevent calling customers who have requested cease and desist",
                "reason": "Customer has not requested cease and desist"
              }
            ],
            "checksFailed": []
          },
          "createdAt": "2024-10-24T15:30:00.000Z"
        }
      },
      {
        "customerId": "550e8400-e29b-41d4-a716-446655440001",
        "success": true,
        "data": {
          "id": "a1b2c3d4-e5f6-4789-a012-3456789abcde",
          "threadId": "b2c3d4e5-f6a7-4890-b123-456789abcdef",
          "toPhoneNumber": "+14155552345",
          "fromPhoneNumber": "+14155559876",
          "compliance": {
            "passed": true,
            "checksPassed": [
              {
                "id": "is-active",
                "name": "Is Active",
                "description": "Check if customer is active",
                "reason": "Customer is active"
              }
            ],
            "checksFailed": []
          },
          "createdAt": "2024-10-24T15:30:00.500Z"
        }
      },
      {
        "customerId": "550e8400-e29b-41d4-a716-446655440002",
        "success": false,
        "error": "Customer not eligible for call. 2 failed rule(s): 1. Respectful Hours Check [Customer local time is 03:00 (outside respectful hours 8am-8:50pm)], 2. Four Voice Call Per Day [Customer has had 4 voice calls today within respectful hours window (America/Los_Angeles), exceeding the limit of 4]"
      }
    ]
  }
}

​
Partial success behavior

This endpoint returns a 200 status code even when some calls fail. The response includes a summary with counts of successful and failed operations, along with detailed results for each customer.

​
Request limits

  • Maximum 100 customers per request
  • Customer IDs must be unique within a single request

​
Compliance checks

Each customer is evaluated through the compliance engine individually. Common reasons for compliance failures include:
  • Customer outside respectful hours
  • Daily call limit exceeded
  • Customer has requested cease and desist (Collections-specific)
  • Missing required customer information

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
agentId
string<uuid>
required

The agent identifier to use for all calls. This will be assigned to you.

​
customerIds
string<uuid>[]
required

Array of customer IDs to create calls for. Must contain between 1 and 100 unique customer IDs.

Required array length: 1 - 100 elements
​
webhook
object

Webhook-related information to send the call updates to.

Response

Bulk create calls response. Contains summary counts and detailed results for each customer.

​
requestId
string<uuid>
required

The request identifier.

​
success
boolean
required

Whether the bulk operation completed (always true for 200 responses).

​
data
object
required