Pre Chat Form API in Live Chat

The API allows you to automatically send the chat transcript after each chat session to your application or 3rd party application integration. Simply specify the URL and other details. The transcript will be posted to the specified URL, which you can add to your customer log, etc.


Here's How can you enable Chat Transcript API:

Step 1: Log in to your ProProfs Live Chat account and then navigate to  ‘Settings’.

Chat Transcript API


Step 2: Click on 'Advanced' and select the ‘API’.

Select Chat Transcript API


Step 3: Select ‘Chat Transcripts’ and enable the post-chat transcript API toggle button to ‘Yes’.

Enable Chat Transcript API


Step 4: After enabling the post-chat transcript API fill in the information as instructed below:

Setting up Chat Transcript API


Field Name Description
Host The domain name for the script, for example- or
Script Path The path for the script /yourtestscript.php or /yourtestscript.asp etc.

Default: HTTP:// connections are not secure because they exchange credentials and data in clear text, so we recommend using HTTPS.

Secure (Recommended): HTTPS:// connections are secure, encrypting both credentials and information.


Enter all the required values for the hostname, script path, and then select the port.


Step 5: Navigate and click on the ‘Check Connection’ option to verify the API connection. Then click on the ‘Save’ button to save the entered values.


Once you are done with the above steps the chat transcript details will be automatically sent to the desired path in JSON (JavaScript Object Notation) format.


Example Response [Success] 


Content-Type: application/json
             "visitor_name":    "Test",
             "visitor_email":    "",
             "Phone_Number":     "99999999999"



Note: Each pre-chat form is associated with a particular operator group. The information extracted through the pre-chat form API will vary according to the pre-chat form used.





Was this information helpful?
© 2005 - 2023 ProProfs
add chat to your website