Skip to main content
GET
/
interactions
List all interactions
curl --request GET \
  --url https://api.voice-mate.com/v1/interactions \
  --header 'Authorization: Bearer <token>'
{
  "status": "success",
  "pagination": {
    "total": 2800,
    "page": 1,
    "num_pages": 3,
    "page_size": 1000,
    "has_next": true
  },
  "interactions": [
    {
      "sid": "interaction_340846df-6fc5-4550-8c8e-590761765548",
      "from_number": "+15893858485",
      "to_number": "+15893858485",
      "direction": "inbound",
      "type": "phone_call",
      "status": "in_progress",
      "duration": 100,
      "agent_sid": "agent_340846df-6fc5-4550-8c8e-590761765548",
      "started_at": 1746297830472,
      "ended_at": 1746297830472,
      "cost": 0.0094
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer auth header. Pass with value 'Bearer {api_key}'. Api key can be found in account Settings -> API Keys page

Query Parameters

​
agent_id
string

Filter by agent identifier

​
type
enum<string>

Filter by interaction type

Available options:
phone_call,
web_call,
test_chat
​
direction
enum<string>

Filter by interaction direction

Available options:
inbound,
outbound
​
status
enum<string>

Filter by interaction status

Available options:
initiated,
in_progress,
agent_hangup,
user_hangup,
dial_rejected,
dial_busy,
dial_failed,
transferred,
error,
insufficient_balance
​
started_at_gte
integer<int64>

Filter by start time (greater than or equal to, Unix timestamp in milliseconds)

Required range: x >= 0
​
started_at_lte
integer<int64>

Filter by start time (less than or equal to, Unix timestamp in milliseconds)

Required range: x >= 0
​
duration_gte
integer<int32>

Filter by duration (greater than or equal to, in seconds)

Required range: x >= 0
​
duration_lte
integer<int32>

Filter by duration (less than or equal to, in seconds)

Required range: x >= 0
​
page
integer<int32>
default:1

Page number for pagination (starts at 1)

Required range: x >= 1

Response

List of interactions

​
status
enum<string>
required
Available options:
success,
error
​
pagination
object
required
​
interactions
object[]
required