Contact Us

If you still have questions or prefer to get help directly from an agent, please submit a request.
We’ll get back to you as soon as possible.

Please fill out the contact form below and we will reply as soon as possible.

  • Go to Haptik Website
  • Contact Us
  • Home
  • Developer Guides
  • Code Step Integration

Using "final_response" in Main Method

Written by Medha Anand

Updated on April 19th, 2023

Contact Us

If you still have questions or prefer to get help directly from an agent, please submit a request.
We’ll get back to you as soon as possible.

Please fill out the contact form below and we will reply as soon as possible.

  • Getting Started
    Build Deploy Analyse Manage Account Bot Deactivation
  • Bot Building
    Essentials Smart Skills Steps User Messages Bot Responses Entities Connections Customisations User feedback collection Testing Whatsapp Bots NLU Bot Maintenance
  • Smart Agent Chat
    Set up Admin Settings MyChats Section (Agent Inbox) Live Traffic Section Teams Section Archives Section Analytics Plans on Smart Agent Chat
  • Conversation Design
    Design Basics Design Guides Designing for Platforms Designing WhatsApp Bots
  • Developer Guides
    Code Step Integration Static Step Integration Shopify Integration SETU Integration Exotel Integration CIBIL integration Freshdesk KMS Integration PayU Integration Zendesk Guide Integration Twilio Integration Razorpay Integration LeadSquared Integration USU(Unymira) Integration Helo(VivaConnect) Integration Salesforce KMS Integration Stripe Integration PayPal Integration CleverTap Integration Fynd Integration HubSpot Integration Magento Integration WooCommerce Integration Microsoft Dynamics 365 Integration
  • Deployment
    Web SDK WhatsApp Facebook Instagram Sunshine Conversation LINE Google Business Messages Telegram MS Teams Bot as an API iOS SDK Android SDK
  • External Agent Tool Setup
    Zendesk Chat Salesforce Service Cloud Freshchat Zoho NICE CXOne Gorgias
  • Analytics & Reporting
    Intelligent Analytics
  • Notifications
    SMS Notifications Success Measurement
  • Commerce Plus
    Catalog Integration Bot Building Guide Channel Deployments Unified ML Pipeline Documentation
  • Troubleshooting Guides
    Error Messages FAQs
  • Release Notes
+ More

Table of Contents

Using final_response

Using final_response

The format or values which the code will return depends on final_response present in def main(event, context).

The default final_response is as follows -

final_response = {
 'status': True,
 'entities':entities,
 'user_full_name': user_data.get("full_name"),
 'user_device_platform': user_data.get("device_platform"),
 'conversation_details':conversation_details
 }
 response = {'statusCode': 200, 'body': json.dumps(final_response), 'headers': {'Content-Type': 'application/json'}}
 return response

The main method returns response. In response we dump them final_response in JSON format. The final_reponse is the JSON key-value pair that gets executed every time the code runs. The output which you will receive upon running this code will be in the same format as defined in the final_response.

On final_response -

  • You can call any method defined on the code editor.
  • You can call any variable name declared on the code editor.

A sample final_response -

 final_response = {
 'status': status,
 'hsl': hsl,
 'channel': channel,
 'name': name,
 'query':get_query(entities),
 'message': message,
 'email': email,
 'ps_date': date,
 'ps_time': time,
 'tool': tool_name,
 'issue_type': issue_type,
 'description': description,
 'env': issue_faced_at,
 'issue_key': issue_key,
 'issue_link': issue_link,
 'conversation_details': conversation_details
 }

After defining the final_response and providing the Sample input data (JSON), you can run the code. When the code is executed successfully, you get a program output in JSON format. This format is the same as final_response.

To know more about live testing of your code, click here

This output format needs to be added as a Sample Output JSON Format on Code stepas well to create a connection between Code stepand Output step.

If the format of final_response is wrong, the bot gives a bot break message.

Was this article helpful?

Yes
No
Give feedback about this article

Related Articles

  • What is Code Step? How to Use Code Step?
  • How to Send Entity Values to API to Fetch Data
  • How to Use Entity Values on Code Step
  • Different APIs that Can be Used on Conversation Studio

Platform

  • Conversation Studio
  • Smart Skills
  • Advanced NLU
  • Intelligent Analytics
  • Omnichannel
  • Smart Agent Chat
  • Enterprise Security
  • Integrations

Solutions

  • Conversational Commerce
  • Lead Generation
  • Customer Care
  • WhatsApp
  • Conversational IVR
  • Google Business Messages

Industries

  • Retail/ E-Commerce
  • Financial Services
  • Travel & Hospitality
  • Telecom

Knowledge

  • ROI Calculator
  • Reports & Research
  • Case Studies
  • Webinars
  • ISAT
  • Tech Blog
  • Business Blog
  • Resources
  • Haptik v/s Yellow
  • Haptik v/s Liveperson
  • Haptik v/s IBM Watson
  • Haptik v/s Verloop
  • Conversations on AI

Company

  • Why Haptik
  • About Us
  • Careers
  • News & Media
  • Awards & Recognition
  • Contact Us
  • Partnerships
  • Investor Relations

Subscribe

Sign up to recieve the latest updates

Find us on

  • Twitter-footer
  • Linkedin-footer
  • YT-footer
  • Insta-footer
  • G2-footer
  • Facebook-footer

Knowledge Base Software powered by Helpjuice

Copyright © jio Haptik Technology Limited 2021 | Data Security & Privacy Policy | GDPR

North America | Asia Pacific | Africa | enterprise@haptik.ai

Definition by Author

0
0