Get Transcript from Conversation

Description

You can use this API to get the transcript of the specified conversation_id.

Query Parameters:

limit - To specify the number of chat transcripts to fetch per page. The default limit is 20.
from_time - To specify the starting time of conversations.
to_time - To specify the end time of conversations.

Note that if the from_time and to_time is given, the chat transcripts in that specific range will be displayed. However, if only the to_time is specified, then the most recent to older chat transcripts will be displayed.

OAuth Scope:

conversations.READ

URL:

Copiedhttps://{[zohosalesiq_server_uri](https://www.zoho.com/salesiq/help/developer-section/rest-api-v2.html)}/api/v2/{screen name}/conversations/{conversation_id}/messages

Example

Copiedhttps://salesiq.com/api/v2/zylker/conversations/83396000004516005/messages

Sample response

Copied{
    "url": "/api/v2/zylker/conversations/83396000004516005/messages",
    "object": "list",
    "data": [
        {
            "sequence_id": "1",
            "sender": {
                "name": "Bot",
                "id": "b83396000000427003"
            },
            "type": "text",
            "message": {
                "text": "Hello there! 👋 Select an option:"
            },
            "time": "1684822418056",
            "meta": {
                "suggestions": [
                    "Happiness rating",
                    "Date - Time slots",
                    "Time Slots",
                    "Calendar",
                    "Email"
                ],
                "version": 1,
                "hand_off": true,
                "handoff_config": {
                    "type": "default",
                    "text": "Want to connect with a human?",
                    "ack": "Yes"
                },
                "typing_delay": 2
            },
            "last_message_time": "-1",
            "id": "1684822418056_205490192843"
        },
        {
            "is_read": true,
            "sequence_id": "2",
            "sender": {
                "name": "call",
                "id": "$2466774968561195007"
            },
            "type": "text",
            "message": {
                "text": "Hii"
            },
            "time": "1684822418073",
            "last_message_time": "1684822418056",
            "id": "1684822418073_209785171295"
        },
        {
            "sequence_id": "3",
            "sender": {
                "name": "Bot",
                "id": "b83396000000427003"
            },
            "type": "text",
            "message": {
                "text": "Hello there! 👋 Looking for anything specific?"
            },
            "time": "1684822419132",
            "meta": {
                "suggestions": [
                    "Calendar",
                    "Happiness Rating",
                    "Date - Time slots",
                    "Time Slots"
                ],
                "version": 1,
                "hand_off": true,
                "handoff_config": {
                    "type": "default",
                    "text": "Want to connect with a human?",
                    "ack": "Yes"
                },
                "typing_delay": 2
            },
            "last_message_time": "1684822418056",
            "id": "1684822419132_2014080140966"
        },
        {
            "sequence_id": "4",
            "sender": {
                "name": "Bot",
                "id": "b83396000000427003"
            },
            "type": "info",
            "message": {
                "showalert": true,
                "operation_user": {
                    "name": "GBOT",
                    "id": "83396000000427003"
                },
                "message": "Chat forwarded",
                "time": "1684822421411",
                "mode": "forwardsupport"
            },
            "time": "1684822421443",
            "last_message_time": "1684822419132",
            "id": "1684822421443_2018375110595"
        },
        {
            "sequence_id": "6",
            "type": "info",
            "message": {
                "user_list": {
                    "b83396000000427003": "b83396000000427003"
                },
                "operation_user": {
                    "name": "",
                    "id": "83396000000002002"
                },
                "mode": "userdeleted"
            },
            "time": "1684822425120",
            "id": "1684822425120_2026965048864"
        },
        {
            "sequence_id": "7",
            "sender": {
                "name": "James",
                "id": "83396000000002002"
            },
            "type": "info",
            "message": {
                "operation_user": {
                    "name": "James",
                    "image_file_key": "1673606265905_83396000000002002",
                    "id": "83396000000002002"
                },
                "is_auto_accept": false,
                "message": "TransferChat Accepted Successfully",
                "components": "chat",
                "time": "1684822425395",
                "mode": "accepttransfer"
            },
            "time": "1684822425416",
            "last_message_time": "1684822425064",
            "id": "1684822425416_2031260016456"
        }
    ],
    "more_data_available": false
}