Reopen chat

Description

This API allows reopening a closed chat from the visitor's end.

Note: To use this API, ensure to pass the encrypted conversation ID in the request URL. To obtain the encrypted conversation ID, use the Open Conversation API.

Payload

Parameter	Type	Description
message	String	The visitor's message used to reopen the chat.
cookie_enabled	Boolean	Indicates whether cookies are enabled for the visitor’s session.
platform	String	The OS platform from which the visitor accessed the chat (e.g., MacIntel, Windows).
local_time_zone	String	The visitor’s local time zone and time at the moment of chat initiation.
page_title	String	Title of the page where the visitor started the chat.
current_page	String	URL of the page where the visitor initiated the chat.
referrer	String	URL from which the visitor navigated to the current page.

HTTP Method - POST

Scope - conversations.CREATE

URL

Copiedhttps://{[zohosalesiq_server_uri](https://www.zoho.com/salesiq/help/developer-section/rest-api-v2.html)}/api/visitor/v1/{screenname}/conversations/{conversationId}/reopen

Example

Copiedhttps://salesiq.zoho.com/api/visitor/v1/zylker/conversations/siq049749fab02b8b2370f667ef9f3e43dbc59f4f0312ef642392/reopen

Payload

Copied{
  "message": "I'm facing the same issue [order id - #343422]",
  "visitor": {
    "cookie_enabled": true,
    "platform": "MacIntel",
    "local_time_zone": "GMT+0530 (India Standard Time)",
    "page_title": "Zylker Home",
    "current_page": "https://www.zylker/mobiles.html",
    "referrer": "https://www.zylker.com",
}

Response

Copied{
    "url": "api/visitor/v1/zylker/conversations/siq049749fab02b8b2370f667ef9f3e43dbc59f4f0312ef642392/reopen",
    "object": "conversations",
    "data": {
        "id": "siq04974d2bf3f20042b9f9fab02b8b2370f667ef9f3e43dbc59f4f0312ef642392",
        "wms_chat_id": "LD_1310810914844698785_174759016",
        "unread_chats": false,
        "time_difference": "533",
        "question": "I'm facing the same issue [order id - #343422],
        "department": {
            "name": "rtcpwebclient",
            "id": "213490000000002018"
        },
        "last_modified_time": "1706769495515",
        "start_time": "1706769495515",
        "visitor": {
            "uuid": "38095cc3-3379-4de5-9afb-e49e2a9269de_a0",
            "name": "Jack",
            "id": "213490000000602001",
            "country_code": "GB",
            "channel_details": {
                "channel": "website",
                "source": "https://www.zylker.com"
            },
            "supported_operations": [
                "bot_chat",
                "file_share",
                "audio_call",
                "video_call",
                "screen_share",
                "remote_share",
                "edit_message",
                "delete_message",
                "reply_message",
                "block_ip",
                "article_share",
                "read_recipients"
            ],
            "ip": "172.20.3.127",
            "email": "james@zillium.com",
            "type": "contact",
            "channel_name": "website",
            "user_id": "$2743659277284407622"
        },
        "type": "chat",
        "chat_id": "siq049749fab02b8b2370f667ef9f3e43dbc59f4f0312ef642392",
        "chat_status": {
            "state_key": "waiting",
            "status_code": 3,
            "state": 1,
            "status_key": "reopen"
        },
        "last_message_info": {
            "sequence_id": "2",
            "sender": {
                "name": "$2743659277284407622",
                "id": "$2743659277284407622"
            },
            "type": "info",
            "message": {
                "user_list": {
                    "213490000000599001": "213490000000599001"
                },
                "operation_user": {
                    "name": "James",
                    "id": "$2743659277284407622"
                },
                "mode": "useradded"
            },
            "time": "1706768438835",
            "id": "1706768438835_2010256356915"
        },
        "reference_id": "454"
    }
}