- REST API Overview
- Prerequisite
- Operators
- Portals
- Departments
- Articles
- Articles Category
- Canned Response
- Canned Response Category
- Lead Scoring Rule
- postCreate Lead Scoring Rule
- putUpdate Lead Scoring Rule Details
- putEnable/Disable Lead Scoring Rule
- deleteDelete Lead Scoring Rule
- getList Lead Scoring Rules
- getDetails of Lead Scoring Rule
- getFrequency Details of Lead Scoring Rule
- PutUpdate Frequency Details of Lead Scoring Rule
- getLead Scoring Module Fields Criteria
- Visitor Routing
- postAdd Visitor Routing Rule
- getList Visitor Routing Rule
- getVisitor Routing Rule details
- putUpdate Visitor Routing Rule Details
- putEnable/Disable Visitor Routing Rule
- putUpdate Visitor Routing Rule Order
- deleteDelete Visitor Routing Rule
- getVisitor Routing Rule Configurations
- putUpdate Common Visitor Routing Rule
- getVisitor Routing Module Fields Criteria
- Chat Routing
- Blocked IPs
- Chat Monitor
- Zobot
- Apps
- Feedback
- Tracking Preset
- Visitor History View
- Intelligent Trigger Rule
- postCreate Intelligent Trigger Rule
- getList Intelligent Trigger Rules
- getIntelligent Trigger Rule Details
- putUpdate Intelligent Trigger Rule Details
- putEnable/Disable Intelligent Trigger
- putChange Intelligent Trigger Rule Order
- deleteDelete Intelligent Trigger Rule
- getIntelligent Trigger Module Fields Criteria
- Chat
- Calls
- Visitor
- Tags
- Webhooks
- getWebhooks List
- getWebhook Details
- postCreate Webhook
- putUpdate a Webhook
- deleteDelete a Webhook
- postGenerate Public Key
- deleteDelete a Public Key
- postAdd an Event
- deleteRemove Events
- postAdd Apps
- deleteRemove Apps
- getFailed Execution List
- postRetry Failed Execution
- deleteDelete the Failed Executions
- POSTExport Failed Executions
- getWebhook Summary
- getWebhook Execution Summary
- Callbacks
- Encryptions
Pick up Chat
This API can be used to pick up an incoming chat request.
OAuth Scope:
SalesIQ.conversations.UPDATE
URL
Copiedhttps://{zohosalesiq_server_uri}/api/v2/{screen name}/conversations/{conversation_id}/pickup
Example
Copiedhttps://salesiq.zoho.com/api/v2/zylker/conversations/19000000033103/pickup
Sample Response
Copied{
"url": "/api/v2/zylker/conversations/19000000033103/pickup",
"object": "conversations",
"data": {
"reference_id": "151",
"owner": {
"image_key": "0_466756000000002001",
"email": "patricia@zylker.com",
"name": "Patricia",
"is_bot": false,
"id": "466756000000002001"
},
"chat_id": "LD_2242278138463036757_1690029162",
"attender": {
"image_key": "0_466756000000002001",
"email": "patricia@zylker.com",
"name": "Patricia",
"is_bot": false,
"id": "466756000000002001"
},
"type": "chat",
"participants": [
{
"image_key": "0_466756000000002001",
"email": "patricia@zylker.com",
"name": "Patricia",
"is_bot": false,
"id": "466756000000002001"
}
],
"unread_chats": false,
"chat_status": {
"status_code": 0,
"state": 2,
"label": "Connected"
},
"uvid": "c9db3d6f-c77a-463b-bfd3-01c771b2a96b-1",
"question": "Can you help me with the payment process?",
"notes": false,
"attended_time": "1612943681060",
"start_time": "1612943653720",
"id": "19000000033103",
"last_modified_time": "1612943681060",
"status": "Connected",
"app_id": "466756000000002043",
"department": {
"name": "Zylker",
"id": "466756000000002013"
},
"visitor": {
"name": "James",
"id": "466756000000969001",
"country_code": "IN",
"supported_operations": [
"bot_chat",
"file_share",
"audio_call",
"video_call",
"screen_share",
"remote_share",
"edit_message",
"delete_message",
"reply_message",
"block_ip",
"article_share"
],
"ip": "121.244.91.20",
"phone": "9123337778",
"email": "james@zyker.com",
"type": "contact",
"channel_name": "website",
"user_id": "$3403221679883552585"
}
}
}
© 2025, Zoho Corporation Pvt. Ltd. All Rights Reserved.