post https://refer-base-url-sub-domains.imi.chat/v3.1/chats/search
This endpoint allows you to search for existing chats within your tenant.
Note:
The /chats/search endpoint is applicable only for v3.0 rest APIs. So, please consider the below base URL:
https://refer-base-url-sub-domains.imi.chat/v3.0
Supported Params and Operators
| Param Name | Operator |
|---|---|
| status | eq,not_eq |
| created_at | eq,lt,gt,lte,gte |
| updated_at | eq,lt,gt,lte,gte |
| channel | eq |
| tag | eq |
| assignee | eq |
| facebook_psid | eq |
| twitter_id | eq |
| email_id | eq |
| mobile | eq |
| livechat_id | eq |
| abc_user_id | eq |
| whatsapp_mobile_number | eq |
| intent (Applicable to ABC channel) | eq |
| group (Applicable to ABC channel) | eq |
Response Body Params:
| Param Name | Description |
|---|---|
| status_code | Denotes the status of the response. Detailed guide can be found here |
| description | States the description of the status_code. Gives you information about the success/error |
| response | Contains details of the current resource fetched/updated/created |
Note
This endpoint is paginated response and retrieves 10 records at a time. To access any page you can append
pageas a query param to the URL
Chat List OBJECT
| Parameter | Data Type | Description |
|---|---|---|
| chat_id | string | Unique identifier of a chat |
| alias_id | string | External ID that can be used to reference a chat |
| created_at | datetime - UTC Format | Timestamp when chat was created |
| updated_at | datetime -UTC Format | Timestamp when chat was last updated |
| status | enum | Current status of the chat. Possible Values: - queued- picked - onhold- closed |
| channel | enum | Channel on which chat has been created: - sms- facebook- twitter- livechat- email- abc- whatsapp- api |
| asset | Asset OBJECT | An object containing the details of the channel asset that the chat has been created on |
| customer_id | string | Unique identifier of the end-customer |
| destination_id | string | The destination ID of the end-customer being addressed based on the channel - SMS - Mobile No- Facebook - PS ID- Twitter - Twitter ID- Email - Email ID- API - User ID- Livechat - Livechat ID- Apple Business Chat - ABC Opaque User ID- WhatsApp Business - WhatsApp Mobile Number |
| assignee | string | Login ID of the user the chat is currently assigned to |
| flag | string | Flag currently applied on a chat |
| tag | ARRAY | Array of tags currently applied on a chat |
| other_details | OBJECT | Contains additional information linked to a chat as Key Value Pairs |
Asset OBJECT
| Parameter | Data Type | Description |
|---|---|---|
| id | integer | Unique identifier of the channel asset based on the channel: - SMS - Longcode- Facebook - Page ID- Twitter - Owner ID- Email - Business Email ID (From Address)- API - Service Key- Livechat - App ID- Apple Business Chat - Service Key- WhatsApp Business - Service Key |
| name | string | Name of the Asset |
Note
Please reach out to your Account Manager/Customer Success Representative/Support Team for asset details of the following channels:
Livechat
Apple Business Chat
Response Codes
| status_code | HTTP Status | Description |
|---|---|---|
| 4305 | 200 | The list of chats retrieved successfully |
| 2002 | 400 | Invalid header param - could not find mandatory header parameters |
| 2003 | 400 | Invalid Access Token |
| 2004 | 401 | Access Token expired |
| 2007 | 500 | Internal Server Error |
| 2010 | 404 | Could not find details of team based on the teamid passed in the header |
| 2099 | 405 | Method not allowed |
| 3114 | 400 | Request body not provided Check Content-Type header |
| 3115 | 400 | Request is invalid |
| 3445 | 400 | Provided filtration parameter: <param_name> is not valid |
| 3446 | 400 | Provided operator for filtration parameter: <param_name> is not valid |
| 3447 | 400 | Provided condition is not valid |
| 3451 | 400 | Search query request format is not valid |
| 4303 | 400 | Invalid input value:'{0}' provided for filtration parameter:'{1}' |
| 3454 | 500 | Chat list could not be retrieved |