Get Thread List

Description:

This API retrieves the list of threads from a conversation on your SalesIQ account.

Query Parameters:

  • page – Fetches thread in batches of 50 per page. Use this parameter to navigate through different pages of conversation data.
  • limit – Specifies the number of threads to retrieve per request. The default and maximum value is 50
  • include_fields – Fetches additional details by specifying any of the following values.
    • attender – Includes the operator handling the conversation.
    • department – Includes the department to which the thread belongs.
    • brand – Includes brand-related details.
    • metrics – Provides metadata of the conversation.
    • transfer_details – Displays details of all operators and departments involved in the conversation.

OAuth Scope:

SalesIQ.conversations.READ

Method:

GET

URL

Copiedhttps://{zohosalesiq_server_uri}/api/v2/{screenname}/conversations/{conv_id}/threads

Example

Copiedhttps://salesiq.com/api/v2/zylkerinc/conversations/115844000015066005/threads?include_fields=%5B%22metrics%22%2C%20%22attender%22%2C%20%22brand%22%2C%20%22transfer_details%22%2C%20%22department%22%5D

Success Response

Copied{
  "url": "/api/v2/zylkerinc/conversations/115844000015066005/threads",
  "object": "conversations",
  "data": [
    {
      "id": "0",
      "thread_id": "0",
      "thread_number": "1",
      "conversation_id": "115844000015066005",
      "reference_id": "30104",
      "wms_chat_id": "LD_1599956846284843702_165423290",
      "question": "Hi",
      "status": "Tracked in CRM",
      "status_code": "8",
      "inititated_by": "visitor",
      "ended_by": "scheduler",
      "from_time": "1725445341729",
      "to_time": "1725445402370",
      "attender": {
        "name": "Bubble",
        "type": "bot",
        "id": "115844000013286013"
      },
      "department": {
        "name": "Support",
        "id": "115844000000002016"
      },
      "brand": {
        "name": "Zylker Commerce",
        "id": "115844000005167061"
      },
      "metrics": {
        "operator_message_count": "2",
        "visitor_message_count": "3",
        "bot_message_count": "2",
        "info_message_count": "4",
        "system_event_count": "1",
        "average_response_time": "5792",
        "first_response_time": "6105",
        "total_chat_duration": "20151",
        "visitor_waiting_time": "5434",
        "missed_reason": "All the operators are busy.",
        "bot_pickup_after": "1721652997651",
        "bot_duration": "172165299764",
        "queued_duration": "1721652997751",
        "first_agent_accept_after": "1721652999651",
        "total_operator_duration": "1721652997651"
      },
      "time": {
        "initiated_time": "1721652997651",
        "connected_time": "1721652997655",
        "bot_pickup_time": "1721652997655",
        "bot_transfer_time": "1721652997687",
        "queue_intime": "1721652997651",
        "queue_outtime": "1721672997651",
        "missed_time": "1721652997653",
        "first_agent_accept_time": "1721652998651",
        "end_time": "1721652998651",
        "last_mail_at": "1721652999651"
      },
      "operators_involved": [
        "115844000000002084",
        "115844000002256033"
      ],
      "departments_involved": [
        "115844000000002016"
      ]
    },
    {
      "id": "1940",
      "thread_id": "1940",
      "conversation_id": "115844000015066005",
      "reference_id": "30104",
      "wms_chat_id": "LD_1599956846284843702_165423290",
      "question": "Hi",
      "status": "Tracked in CRM",
      "status_code": "8",
      "inititated_by": "visitor",
      "ended_by": "scheduler",
      "from_time": "1725445057107",
      "to_time": "1725445118532",
      "attender": {
        "name": "Bubble",
        "type": "bot",
        "id": "115844000013286013"
      },
      "department": {
        "name": "Support",
        "id": "115844000000002016"
      },
      "brand": {
        "name": "Zylker Commerce",
        "id": "115844000005167061"
      },
      "metrics": {
        "operator_message_count": "2",
        "visitor_message_count": "3",
        "bot_message_count": "2",
        "info_message_count": "4",
        "system_event_count": "1",
        "average_response_time": "5792",
        "first_response_time": "6105",
        "total_chat_duration": "20151",
        "visitor_waiting_time": "5434",
        "missed_reason": "All the operators are busy.",
        "bot_pickup_after": "1721652997651",
        "bot_duration": "172165299764",
        "queued_duration": "1721652997751",
        "first_agent_accept_after": "1721652999651",
        "total_operator_duration": "1721652997651"
      },
      "time": {
        "initiated_time": "1721652997651",
        "connected_time": "1721652997655",
        "bot_pickup_time": "1721652997655",
        "bot_transfer_time": "1721652997687",
        "queue_intime": "1721652997651",
        "queue_outtime": "1721672997651",
        "missed_time": "1721652997653",
        "first_agent_accept_time": "1721652998651",
        "end_time": "1721652998651",
        "last_mail_at": "1721652999651"
      },
      "operators_involved": [
        "115844000000002084",
        "115844000002256033"
      ],
      "departments_involved": [
        "115844000000002016"
      ]
    }
  ],
  "more_data_available": false
}