# Zoho SalesIQ Integration via LowCodeAPI

## Overview

Live chat software

## Base Endpoint

```
https://api.lowcodeapi.com/zohosalesiq/
```

## Authentication

LowCodeAPI handles authentication automatically. You only need to:

1. **Sign up** at [Zoho SalesIQ](https://www.zoho.com/salesiq)
2. **Get your credentials** from [credential page](https://accounts.zoho.com/developerconsole)
3. **Connect your account** in LowCodeAPI dashboard
4. **Use your `api_token`** in all requests

**Auth Type**: OAUTH2.0

## API Categories

- **Chat** - 4 endpoints
- **Visitor** - 2 endpoints

## Common Endpoints

### Category: Chat

#### Get Chat

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/screenname/chats/chat_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohosalesiq/api/v1/screenname/chats/chat_id?api_token={api_token}
```

**Description**: You can get information about a specific chat in your department by providing the chat_id

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`screenname` | string | Yes | Screenname |
|`chat_id` | string | Yes | Chat Id |

---

#### List all Chats

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/screenname/chats`

**Full URL**:
```
https://api.lowcodeapi.com/zohosalesiq/api/v1/screenname/chats?limit={limit}&fromtime={fromtime}&totime={totime}&api_token={api_token}
```

**Description**: You can use this API to get the complete list of chats 

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`screenname` | string | Yes | Screenname |

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`limit` | number | No | The Number of chats you would like to receive the default limit is 50 |
|`fromtime` | number | No | The Chats after the specified time will be retreived and displayed |
|`totime` | number | No | The Chats before the specified time will be retreived and displayed |

---

#### Get the Attachment URL

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/screenname/chats/chat_id/attachmenturl`

**Full URL**:
```
https://api.lowcodeapi.com/zohosalesiq/api/v1/screenname/chats/chat_id/attachmenturl?api_token={api_token}
```

**Description**: To download a file attachment given the attachment URL

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`screenname` | string | Yes | Screenname |
|`chat_id` | string | Yes | Chat Id |
|`attachmenturl` | string | Yes | Attachmenturl |

---

#### Get Chat Messages

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/screenname/chats/chat_id/transcript`

**Full URL**:
```
https://api.lowcodeapi.com/zohosalesiq/api/v1/screenname/chats/chat_id/transcript?limit={limit}&fromtime={fromtime}&totime={totime}&api_token={api_token}
```

**Description**: You can get the transcript of a specific chat

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`screenname` | string | Yes | Screenname |
|`chat_id` | string | Yes | Chat Id |

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`limit` | number | No | The Number of chats you would like to receive (The default limit is 50.) |
|`fromtime` | number | No | The Chats after the specified time will be retreived and displayed |
|`totime` | number | No | The Chats before the specified time will be retreived and displayed |

---

### Category: Visitor

#### Get Visitor Details

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/screenname/visitorsview/viewid/visitors`

**Full URL**:
```
https://api.lowcodeapi.com/zohosalesiq/api/v1/screenname/visitorsview/viewid/visitors?startkey={startkey}&api_token={api_token}
```

**Description**: You can use this API to get the visitors and their details for the given ViewID

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`screenname` | string | Yes | Screenname |
|`viewid` | string | Yes | Viewid |

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`startkey` | string | No | The maximum number of visitors that can be present in a response JSON is 100 |

---

#### Update Visitor Info

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/screenname/visitorsbyemail/email`

**Full URL**:
```
https://api.lowcodeapi.com/zohosalesiq/api/v1/screenname/visitorsbyemail/email?customerinfo ={customerinfo }&api_token={api_token}
```

**Description**: This API is used to update the custom visitor information

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`screenname` | string | Yes | Screenname |
|`email` | string | Yes | Email |

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`customerinfo ` | object | No | A JSON object containing the visitor information |

---

## Complete Endpoint Reference

For a complete list of all 6 endpoints, refer to:
- **OpenAPI Definition**: `https://backend.lowcodeapi.com/zohosalesiq/definition`
- **Official Provider Documentation**: https://www.zoho.com/salesiq/help/developer-section/rest-api-new.html