Get the Interaction list

Developing

Staging Env

https://staging-api.formi.co.in

GET

/v2/interactions/

Last modified:2025-07-12 12:09:44

Maintainer:Not configured

x-apidog-folder:Interactions/Pre-Interaction Context

x-apidog-status:developing

x-run-in-apidog:https://app.apidog.com/web/project/612031/apis/api-18773233-run

Get the list of interactions for the given token , and apply filters using get params

Request

Query Params

Header Params

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET 'https://staging-api.formi.co.in/v2/interactions/?page&page_size&contact_id&customer_name&phone_number&email&contact_stage&interactions_schedule_start_time&interaction_schedule_end_time&interaction_schedule_timezone&interaction_modality&interaction_start_datetime_left&interaction_end_datetime_right' \
--header 'token;'

Responses

🟢200Success

application/json

Body

Example

{
    "success": true,
    "message": "Interaction list fetched successfully",
    "payload": {
        "interactions": [
            {
                "interaction_id": 125,
                "interaction_flow_type": "BIZ_START",
                "interaction_modality": "CALL",
                "interaction_status": "init",
                "scheduled_time": "2025-07-03 10:00:00",
                "ended_time": "2025-07-03 10:10:00",
                "scheduled_time_timezone": "Asia/Kolkata",
                "variables": {
                    "campaign": "early_access"
                },
                "messages": [
                    {
                        "sender": "agent",
                        "text": "Hi! Are you available for a quick chat?"
                    }
                ],
                "transcript": "Agent greeted the customer and confirmed interest.",
                "customer_details": {
                    "customer_name": "Amit Shah",
                    "customer_email": "amit@example.com",
                    "customer_phone_number": "+919876543210"
                },
                "interaction_start_time": "2025-07-03 09:59:00",
                "interaction_end_time": "2025-07-03 10:10:00",
                "interaction_scheduled_time": "2025-07-03 10:00:00",
                "criticality_metadata": {}
            }
        ],
        "total_count": 1,
        "page": 1,
        "page_size": 10,
        "filters": {
            "page": 1,
            "page_size": 10,
            "outlet_id": 55,
            "customer_name": "Amit"
        }
    }
}

Modified at 2025-07-12 12:09:44

Resolve an Escalated Interaction

Get Information regarding Single Interaction