List Interactions

curl --request GET \
  --url https://api.prod.usesimple.ai/api/v1/interactions \
  --header 'Authorization: <api-key>'

{
  "interactions": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "modality": "voice",
      "status": "<string>",
      "started_at": "2023-11-07T05:31:56Z",
      "created_at": "2023-11-07T05:31:56Z",
      "transcripts": [
        {
          "text": "<string>",
          "role": "<string>",
          "timestamp": "2023-11-07T05:31:56Z",
          "function_name": "<string>",
          "arguments": {}
        }
      ],
      "language": "en",
      "from_number": "<string>",
      "to_number": "<string>",
      "transferred": true,
      "direction": "<string>",
      "tags": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "name": "<string>",
          "description": "<string>",
          "color": "<string>"
        }
      ],
      "ended_at": "2023-11-07T05:31:56Z",
      "duration": 123,
      "external_identifiers": {},
      "params": {},
      "recording_presigned_url": "<string>",
      "answered_by": "voicemail",
      "analyzers": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "prompt": "<string>",
          "output_config": {
            "type": "string",
            "properties": {}
          }
        }
      ],
      "analysis_results": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "analyzer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "prompt": "<string>",
          "output_config": {},
          "result": {}
        }
      ],
      "summary": {}
    }
  ],
  "total_count": 123,
  "page": 123,
  "page_size": 123,
  "total_pages": 123,
  "filters": {
    "status": "<string>",
    "modality": "voice",
    "agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "agent_version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "transferred": true,
    "created_at_gte": "2023-11-07T05:31:56Z",
    "created_at_lte": "2023-11-07T05:31:56Z"
  },
  "sorting": {
    "sort_by": "<string>",
    "sort_direction": "<string>"
  }
}

GET

interactions

List Interactions

curl --request GET \
  --url https://api.prod.usesimple.ai/api/v1/interactions \
  --header 'Authorization: <api-key>'

{
  "interactions": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "modality": "voice",
      "status": "<string>",
      "started_at": "2023-11-07T05:31:56Z",
      "created_at": "2023-11-07T05:31:56Z",
      "transcripts": [
        {
          "text": "<string>",
          "role": "<string>",
          "timestamp": "2023-11-07T05:31:56Z",
          "function_name": "<string>",
          "arguments": {}
        }
      ],
      "language": "en",
      "from_number": "<string>",
      "to_number": "<string>",
      "transferred": true,
      "direction": "<string>",
      "tags": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "name": "<string>",
          "description": "<string>",
          "color": "<string>"
        }
      ],
      "ended_at": "2023-11-07T05:31:56Z",
      "duration": 123,
      "external_identifiers": {},
      "params": {},
      "recording_presigned_url": "<string>",
      "answered_by": "voicemail",
      "analyzers": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "prompt": "<string>",
          "output_config": {
            "type": "string",
            "properties": {}
          }
        }
      ],
      "analysis_results": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "analyzer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "prompt": "<string>",
          "output_config": {},
          "result": {}
        }
      ],
      "summary": {}
    }
  ],
  "total_count": 123,
  "page": 123,
  "page_size": 123,
  "total_pages": 123,
  "filters": {
    "status": "<string>",
    "modality": "voice",
    "agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "agent_version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "transferred": true,
    "created_at_gte": "2023-11-07T05:31:56Z",
    "created_at_lte": "2023-11-07T05:31:56Z"
  },
  "sorting": {
    "sort_by": "<string>",
    "sort_direction": "<string>"
  }
}

Authorizations

Authorization

string

header

required

Query Parameters

page

integer | null

default:1

page_size

integer | null

default:20

status

string

Filter by interaction status. Multiple values can be provided separated by commas.

modality

enum<string>

Filter by interaction modality (voice or text)

Available options:

voice,

text

agent_id

string<uuid>

Filter by agent group UUID. Returns interactions from all versions of the specified agent.

agent_version_id

string<uuid>

Filter by specific agent version UUID. Returns interactions from only the specified agent version.

transferred

boolean

Filter by whether the interaction was transferred

created_at_gte

string<date-time>

Filter interactions created at or after this datetime (ISO 8601 format)

created_at_lte

string<date-time>

Filter interactions created at or before this datetime (ISO 8601 format)

sort_by

enum<string>

default:created_at

Field to sort results by

Available options:

created_at,

updated_at,

started_at,

ended_at,

duration,

status

sort_direction

enum<string>

default:desc

Sort direction

Available options:

asc,

desc

Response

Successful Response

interactions

InteractionDetailsResponse · object[]

required

Show child attributes

interactions.id

string<uuid>

required

interactions.modality

enum<string>

required

The modality of the interaction - voice calls or text conversations

Available options:

voice,

text

interactions.status

string

required

interactions.started_at

string<date-time> | null

required

interactions.created_at

string<date-time>

required

interactions.transcripts

CallTranscriptResponse · object[]

required

Show child attributes

interactions.transcripts.text

string | null

required

interactions.transcripts.role

string

required

interactions.transcripts.timestamp

string<date-time>

required

interactions.transcripts.function_name

string | null

required

interactions.transcripts.arguments

Arguments · object

required

interactions.language

enum<string>

The language to use for the call - English (en) or Spanish (es)

Available options:

en,

es,

ar

interactions.from_number

string | null

interactions.to_number

string | null

interactions.transferred

boolean | null

Indicates if the interaction was transferred

interactions.direction

string | null

The direction of the interaction (inbound/outbound)

interactions.tags

Tags · object[]

Tags associated with the interaction

Show child attributes

interactions.tags.id

string<uuid>

interactions.tags.name

string

interactions.tags.description

string

interactions.tags.color

string

interactions.ended_at

string<date-time> | null

interactions.duration

integer | null

interactions.external_identifiers

External Identifiers · object

External identifiers associated with the interaction

Show child attributes

interactions.external_identifiers.{key}

string

interactions.params

Params · object

Parameters associated with the interaction

Show child attributes

interactions.params.{key}

string

interactions.recording_presigned_url

string | null

Presigned URL for the recording (for voice modality only)

interactions.answered_by

enum<string> | null

Indicates how the call was answered - by a human, voicemail, or if there was no answer

Available options:

voicemail,

human,

no_answer,

unknown

interactions.analyzers

AnalyzerResponse · object[]

List of analyzers configured for this interaction

Show child attributes

interactions.analyzers.id

string<uuid>

required

Unique identifier for the analyzer

interactions.analyzers.prompt

string

required

The prompt used for analysis

interactions.analyzers.output_config

Output Config · object

required

Configuration for the expected output format

Show child attributes

interactions.analyzers.output_config.type

enum<string>

The type of output expected

Available options:

string,

boolean,

datetime,

object

interactions.analyzers.output_config.properties

object

Required when type is 'object'. Defines the structure of the object

Show child attributes

interactions.analyzers.output_config.properties.{key}

object

Show child attributes

interactions.analyzers.output_config.properties.{key}.type

enum<string>

Available options:

string,

boolean,

datetime

interactions.analysis_results

AnalysisResultResponse · object[]

Results from analyzers that have completed

Show child attributes

interactions.analysis_results.id

string<uuid>

required

Unique identifier for the analysis result

interactions.analysis_results.analyzer_id

string<uuid>

required

Identifier of the analyzer that produced this result

interactions.analysis_results.prompt

string

required

The prompt used for analysis

interactions.analysis_results.output_config

Output Config · object

required

Configuration for the expected output format

interactions.analysis_results.result

Result · object

required

The analysis result, structure depends on the output_config

interactions.summary

Summary · object

The summary of the interaction if available

total_count

integer

required

page

integer

required

page_size

integer

required

total_pages

integer

required

filters

Filters · object

Show child attributes

filters.status

string | null

filters.modality

enum<string> | null

Available options:

voice,

text

filters.agent_id

string<uuid> | null

filters.agent_version_id

string<uuid> | null

filters.transferred

boolean | null

filters.created_at_gte

string<date-time> | null

filters.created_at_lte

string<date-time> | null

sorting

Sorting · object

Show child attributes

sorting.sort_by

string

sorting.sort_direction

string

Delete Call Get Interaction

⌘I

API Documentation

Simple Example

Calls

Interactions

Call Tags

Call Notes

Agents

Numbers

Voices

Webhooks

List Interactions

Authorizations

Query Parameters

Response