Email Destination Configuration

Defines how call data is sent via email to the configured destination_email_id. Includes the API endpoint, headers, and a dynamic payload with details like customer info, enquiry summary, and transcript for real-time notifications.

This can be used in raw for testing the Email API, and as a Destination for our Agent.

For Endpoint Reference - Email Destination.

Email Payload Field Descriptions

Field	Description
`destination_email_id`	The recipient's email address (e.g., hotel manager or stakeholder).
`email_subject`	The subject line for the email notification.
`name`	Name of the customer who was part of the interaction.
`phone_number`	Customer’s phone number (with country code).
`email_id`	Customer’s email address.
`call_type`	Nature of the interaction, e.g., Enquiry, Booking, Support.
`call_status`	Final status of the interaction—typically `Completed`, `Missed`, or `Failed`.
`timestamp`	Date and time when the interaction occurred.
`stakeholder_phone`	Phone number of the business contact receiving this information.
`is_manager_call`	Indicates if the call involved a manager or senior executive.
`enquiry_type`	Categorization of the enquiry (e.g., Reservation, Complaint, Info Request).
`enquiry_details`	Summary of what the customer asked or discussed.
`occasion`	Occasion type if mentioned (e.g., Birthday, Anniversary).
`booking_metadata`	Structured booking notes—guest count, date/time, and special requests.
`transcript`	Text transcript or notes captured from the interaction.

Step-by-Step Flow

Step 1: POST Variable

Define all dynamic variables that will be used in the email body.

Endpoint:
POST /v2/post_call/data/outlet/variables

Sample Request Body:

[
    {
        "var_name": "customer_name",
        "var_type": "string",
        "description": "name of the customer as inferred from the conversation",
        "variable_id": 98765432,
        "destination_ids": [
            32657790,
            81891481,
            22529718
        ]
    },
    {
        "var_name": "customer_phone_no.",
        "var_type": "string",
        "description": "phone No. of the customer as inferred from the conversation",
        "variable_id": 25589883,
        "destination_ids": [
            90824215
        ]
    }
]

Step 2: GET Variable

Fetch the variables defined in the system for mapping and validation.

Endpoint:
GET /v2/post_call/data/outlet/variables

Sample Response Body

{
    "message": "success",
    "payload": [
        {
            "var_name": "name",
            "var_type": "string",
            "description": "Name of the customer",
            "variable_id": 54,
            "destination_ids": [
                4,
                5
            ]
        },
        {
            "var_name": "email_id",
            "var_type": "string",
            "description": "Email of the user",
            "variable_id": 55,
            "destination_ids": [
                4,
                5
            ]
        },
        {
            "var_name": "phone_number",
            "var_type": "string",
            "description": "phone number of the user",
            "variable_id": 56,
            "destination_ids": [
                4,
                4,
                5
            ]
        },
        {
            "var_name": "enquiry_type",
            "var_type": "string",
            "description": "enquiry asked by the user",
            "variable_id": 57,
            "destination_ids": [
                4,
                5
            ]
        },
        {
            "var_name": "occasion",
            "var_type": "string",
            "description": "occasion mentioned by the user",
            "variable_id": 58,
            "destination_ids": [
                4,
                5
            ]
        },
        {
            "var_name": "call_summary",
            "var_type": "string",
            "description": "Summary of the entire conversation with the user , described in around 30-40 words",
            "variable_id": 60,
            "destination_ids": [
                4,
                5
            ]
        }
    ]
}

Step 3: POST Destination (Email)

Create a destination of type email that specifies the API endpoint and body.

Endpoint:
POST /v2/post_call/data/destinations

Sample Request Body:

[
    {
        "destination_name": "Email",
        "destination_type": "email",
        "api_url": "https://api.formi.co.in/v2/destinations/email",
        "api_method": "POST",
        "api_headers": {
            "Content-Type": "application/json"
        },
        "api_body": {
            "destination_email_id": "admin@olivehotels.com",
            "email_subject": "Call Notification | Formi Chat AI",
            "name": "John Smith",
            "phone_number": "{{customer_phone_number}}",
            "email_id": "{{customer_email_id}}",
            "call_type": "Enquiry",
            "call_status": "Completed",
            "timestamp": "2024-01-20 14:30:00",
            "stakeholder_phone": "+91 1234567890",
            "is_manager_call": "No",
            "enquiry_type": "Reservation",
            "enquiry_details": "{{enquiry_summary}}",
            "occasion": "{{occasion}}",
            "booking_metadata": "{{booking_metadata}}",
            "transcript": "{{transcript}}"
        }
    }
]

Step 4: GET Destination

Fetch destination details to ensure proper setup and structure.

Endpoint:
GET /v2/post_call/data/destinations

Sample Response Body

{
  "message": "Destinations fetched successfully",
  "payload": [
    {
      "destination_id": 1,
      "destination_name": "Email",
      "destination_type": "email",
      "api_url": "https://api.formi.co.in/v2/destinations/email",
      "api_method": "POST",
      "api_headers": {
        "Content-Type": "application/json"
      },
      "api_body": {
        "destination_email_id": "admin@olivehotels.com",
        "email_subject": "Call Notification | Formi Chat AI",
        "name": "John Smith",
        "phone_number": "{{customer_phone_number}}",
        "email_id": "{{customer_email_id}}",
        "call_type": "Enquiry",
        "call_status": "Completed",
        "timestamp": "2024-01-20 14:30:00",
        "stakeholder_phone": "+91 1234567890",
        "is_manager_call": "No",
        "enquiry_type": "Reservation",
        "enquiry_details": "{{enquiry_summary}}",
        "occasion": "{{occasion}}",
        "booking_metadata": "{{booking_metadata}}",
        "transcript": "{{transcript}}"
      },
      "created_at": "2024-01-19T18:30:00Z",
      "updated_at": "2024-01-20T10:15:00Z",
      "active": true
    }
  ]
}

Step 5: Connect Variables to Destination

Map defined variables to the placeholders used in the destination payload.

Endpoint:
POST /v2/post_call/data/outlet/{outlet_id}/map

Sample Request Body:

[
    {
        "variable_id": 20,
        "destination_id": 3
    }
]

Email Payload Field Descriptions#

Step-by-Step Flow#

Step 1: POST Variable#

Step 2: GET Variable#

Sample Response Body#

Step 3: POST Destination (Email)#

Step 4: GET Destination#

Sample Response Body#

Step 5: Connect Variables to Destination#

Email Payload Field Descriptions

Step-by-Step Flow

Step 1: POST Variable

Step 2: GET Variable

Sample Response Body

Step 3: POST Destination (Email)

Step 4: GET Destination

Sample Response Body

Step 5: Connect Variables to Destination