squad-calls

Create Squad Outbound Campaign

Create an outbound calling campaign using a squad.

The campaign will be distributed across squad members based on:

Agent availability
Agent calling schedules
Agent daily limits
Squad routing strategy

Example:

{
  "squad_id": "squad-uuid",
  "name": "Q4 Sales Campaign",
  "targets": [
    {"to_number": "+1234567890", "context": {"customer_id": "123"}},
    {"to_number": "+0987654321", "context": {"customer_id": "456"}}
  ],
  "routing_strategy": "load_based",
  "concurrent_calls_per_agent": 2
}

POST

squad-calls

squads

{squad_id}

outbound-campaign

Create Squad Outbound Campaign

curl --request POST \
  --url https://api.example.com/squad-calls/squads/{squad_id}/outbound-campaign \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "squad_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "targets": [
    {}
  ],
  "routing_strategy": "load_based",
  "concurrent_calls_per_agent": 2,
  "context": {}
}
'

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Authorizations

Authorization

string

header

required

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

Path Parameters

squad_id

string<uuid>

required

Body

application/json

Squad-based outbound campaign request.

squad_id

string<uuid>

required

name

string

required

Required string length: 1 - 255

targets

Targets · object[]

required

Minimum array length: 1

routing_strategy

string

default:load_based

Pattern: ^(round_robin|load_based|skill_based|priority)$

concurrent_calls_per_agent

integer

default:2

Required range: 1 <= x <= 5

context

Context · object

Response

Successful Response

Get Squad Call StatsGet call statistics for a squad. Returns total calls and breakdown by agent for the specified date.

Create Squad Outbound Campaign

curl --request POST \
  --url https://api.example.com/squad-calls/squads/{squad_id}/outbound-campaign \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "squad_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "targets": [
    {}
  ],
  "routing_strategy": "load_based",
  "concurrent_calls_per_agent": 2,
  "context": {}
}
'

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Documentation Index

Authorizations

Path Parameters

Body

Response