Schedule an Interaction - AgenticUniverse

Adds a new interaction to the queue with all required context and scheduling information.

Request

Header Params

Body Params application/json

Example

{
  "interactions": [
    {
      "contact_id": "8017727622",
      "customer_name": "Aryamann",
      "interaction_modality": "CALL",
      "type": "BIZ_START",
      "scheduled_time": "2025-10-27 10:53:12",
      "scheduled_time_timezone": "Asia/Kolkata",
      "agent_id": 38,
      "phone_number": "8017727622",
      "email": "daksesh@gmail.com",
      "contact_stage": "NEW_INTERACTION",
      "variables": {
  "customer_full_name": "Manik",
  "phone_number": "9811804205",
  "reason_for_cancellation": "Requote price not acceptable",
  "amount": 55000,
  "cancelled_by": "partner",
  "after_condition_price": 50000,
  "device_name": "Apple iPhone 15 Pro (8 GB/256 GB)",
  "partner_cancellation_notes": "[{\"c\":\"Screen Condition\",\"cid\":99,\"psli\":[{\"pl\":\"Screen Physical Condition\",\"pid\":375,\"s1\":1,\"v1\":\"Excellent\",\"v2\":\"Heavy Scratches\",\"s2\":0,\"p\":1},{\"pl\":\"Screen Discoloration\",\"pid\":575,\"s1\":1,\"v1\":\"No Discoloration\",\"v2\":\"Minor Discoloration\",\"s2\":0,\"p\":2}]},{\"c\":\"Functional Condition\",\"cid\":100,\"psli\":[{\"pl\":\"Battery\",\"pid\":384,\"s1\":1,\"v1\":\"Battery is Working Fine\",\"v2\":\"Battery Faulty or Low Back up\",\"s2\":0,\"p\":1},{\"pl\":\"Copy Screen\",\"pid\":468,\"s1\":1,\"v1\":\"Phone DOESN'T have copy screen\",\"v2\":\"Phone has copy screen\",\"s2\":0,\"p\":2}]},{\"c\":\"Phone's Overall Condition\",\"cid\":105,\"psli\":[{\"pl\":\"Physical Condition (Scratch)\",\"pid\":429,\"s1\":1,\"v1\":\"No Scratches\",\"v2\":\"Major Scratch\",\"s2\":0,\"p\":1},{\"pl\":\"Physical Condition (Dent)\",\"pid\":430,\"s1\":1,\"v1\":\"No Dents\",\"v2\":\"Major Dents\",\"s2\":0,\"p\":2},{\"pl\":\"Physical Condition (Panel)\",\"pid\":431,\"s1\":1,\"v1\":\"No Defect in Panel\",\"v2\":\"Loose Panel\",\"s2\":0,\"p\":3}]}]",
  "customer_email": "",
  "customer_name": "Apoorva",
  "customer_phone_number": "+9811804204"
}
,
      "metadata": {
        "crm_id": "124343634566565",
        "metadata_test" : "abcxyz-hello123"
      },
      "attempt_config": {
        "attempt_number": 0,
        "attempt_interval": 2,
        "max_attempts": 10
      },
      "connection_provider" : "exotel"
    } 
  ]
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://staging-api.formi.co.in/v2/interactions/schedule' \
--header 'token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6MTQ3OX0.67xynvySiQ_jhY-_IE7_o4AsZ1dEWDxLZ8XiVCxkNIw' \
--header 'Content-Type: application/json' \
--data-raw '{
  "interactions": [
    {
      "contact_id": "8017727622",
      "customer_name": "Aryamann",
      "interaction_modality": "CALL",
      "type": "BIZ_START",
      "scheduled_time": "2025-10-27 10:53:12",
      "scheduled_time_timezone": "Asia/Kolkata",
      "agent_id": 38,
      "phone_number": "8017727622",
      "email": "daksesh@gmail.com",
      "contact_stage": "NEW_INTERACTION",
      "variables": {
  "customer_full_name": "Manik",
  "phone_number": "9811804205",
  "reason_for_cancellation": "Requote price not acceptable",
  "amount": 55000,
  "cancelled_by": "partner",
  "after_condition_price": 50000,
  "device_name": "Apple iPhone 15 Pro (8 GB/256 GB)",
  "partner_cancellation_notes": "[{\"c\":\"Screen Condition\",\"cid\":99,\"psli\":[{\"pl\":\"Screen Physical Condition\",\"pid\":375,\"s1\":1,\"v1\":\"Excellent\",\"v2\":\"Heavy Scratches\",\"s2\":0,\"p\":1},{\"pl\":\"Screen Discoloration\",\"pid\":575,\"s1\":1,\"v1\":\"No Discoloration\",\"v2\":\"Minor Discoloration\",\"s2\":0,\"p\":2}]},{\"c\":\"Functional Condition\",\"cid\":100,\"psli\":[{\"pl\":\"Battery\",\"pid\":384,\"s1\":1,\"v1\":\"Battery is Working Fine\",\"v2\":\"Battery Faulty or Low Back up\",\"s2\":0,\"p\":1},{\"pl\":\"Copy Screen\",\"pid\":468,\"s1\":1,\"v1\":\"Phone DOESN'\''T have copy screen\",\"v2\":\"Phone has copy screen\",\"s2\":0,\"p\":2}]},{\"c\":\"Phone'\''s Overall Condition\",\"cid\":105,\"psli\":[{\"pl\":\"Physical Condition (Scratch)\",\"pid\":429,\"s1\":1,\"v1\":\"No Scratches\",\"v2\":\"Major Scratch\",\"s2\":0,\"p\":1},{\"pl\":\"Physical Condition (Dent)\",\"pid\":430,\"s1\":1,\"v1\":\"No Dents\",\"v2\":\"Major Dents\",\"s2\":0,\"p\":2},{\"pl\":\"Physical Condition (Panel)\",\"pid\":431,\"s1\":1,\"v1\":\"No Defect in Panel\",\"v2\":\"Loose Panel\",\"s2\":0,\"p\":3}]}]",
  "customer_email": "",
  "customer_name": "Apoorva",
  "customer_phone_number": "+9811804204"
}
,
      "metadata": {
        "crm_id": "124343634566565",
        "metadata_test" : "abcxyz-hello123"
      },
      "attempt_config": {
        "attempt_number": 0,
        "attempt_interval": 2,
        "max_attempts": 10
      },
      "connection_provider" : "exotel"
    } 
  ]
}'

Responses

🟢200Success

application/json

Body

Example

{
    "success": true,
    "message": "1 interactions scheduled successfully, 0 failed",
    "payload": {
        "interactions": [
            {
                "order": 1,
                "status": "success",
                "contact_id": "9988776655",
                "customer_name": "John Doe",
                "scheduled_time": "2025-07-03 10:00:00",
                "interaction_id": 454
            }
        ],
        "successful_count": 1,
        "failed_count": 0,
        "queue_size": 12
    }
}