Good News! Tagove Launches Its Own CRM to Manage Live Chat Conversations & Leads Read More
Welcome to the Tagove API documentation! Our API provides flexible tools that can be used in the creation of new, outstanding projects. Each time we see creative development by skilled engineers we smile a bit more! Please note that this documentation refers to the latest, API.
Signup & Login to Tagove. Go to Settings > API Key from the left menu, click on the API Key block and copy the API key obtained. You must use your API_KEY for each method call. Provide your basic auth the API_KEY. You must authenticate for all requests. All API requests must be made over HTTPS-only.
Tagove Chat API requests start with
https://api.tagove.com/{action}The next segment of the URI path depends on the type of request. For example:
Tagove API returns data in JSON & XML format. Example Chat History returned in this format:
Accept : application/xml or application/json
Chat History API lets you conduct a chat with a support agent from the visitor's perspective.
Tagove Chat History API requests start with
Request Url
"https://api.tagove.com/chats?start_date={yyyy-mm-dd}&end_date={yyyy-mm-dd}&page={page-no}&limit={limit}&with=messages,account"Sample Request
curl --request GET \
--url '{{tagove_api}}/chats?start_date=2016-08-01&end_date=2016-12-01&page=1&limit=10&with=messages%2Caccount' \
--header '//accept: ' \
--header 'authorization: Bearer b1adac97642515fdccf9f3edc1b838db'
Example Response
{
"success": true,
"data": {
"account": {
"first_name": "John",
"last_name": "",
"mobile_number": null,
"email": "john@gmail.com"
},
"chat": {
"id": "43074",
"account_id": "2675",
"session_id": "907029",
"type": "text",
"status": "closed",
"date_created": "2016-11-08 13:35:05",
"date_updated": "2016-11-08 13:35:05",
"department_id": null,
"chat_duration": "0",
"chat_wait_time": null,
"feedback_rating": null,
"feedback_message": null,
"comments": null,
"initiator": "visitor",
"messages": [
{
"id": "393235",
"chat_id": "43074",
"account_id": "2675",
"sender_type": "system",
"sender_id": null,
"type": "event",
"message": "#838161 just joined this chat.",
"date_created": "2016-11-08 13:35:05",
"seen": "unseen"
}
]
}
}
}
Request Url
"https://api.tagove.com/chat/{chat-id}"Example Request
"https://api.tagove.com/chat/43074"
Example Response
{
"success": true,
"data": {
"chat": {
"id": "43074",
"account_id": "2675",
"session_id": "907029",
"type": "text",
"status": "closed",
"date_created": "2016-11-08 13:35:05",
"date_updated": "2016-11-08 13:35:05",
"department_id": null,
"chat_duration": "0",
"chat_wait_time": null,
"feedback_rating": null,
"feedback_message": null,
"comments": null,
"initiator": "visitor"
}
}
}
Chat Message API lets you conduct a chat message records.
Tagove Chat Message API requests start with
Request Url
"https://api.tagove.com/chat/{chat-id}}/messages"Example Request
"https://api.tagove.com/chat/43074/messages"
Example Response
{
"success": true,
"data": {
"chat": {
"id": "43074",
"account_id": "2675",
"session_id": "907029",
"type": "text",
"status": "closed",
"date_created": "2016-11-08 13:35:05",
"date_updated": "2016-11-08 13:35:05",
"department_id": null,
"chat_duration": "0",
"chat_wait_time": null,
"feedback_rating": null,
"feedback_message": null,
"comments": null,
"initiator": "visitor",
"messages": [
{
"id": "393235",
"chat_id": "43074",
"account_id": "2675",
"sender_type": "system",
"sender_id": null,
"type": "event",
"message": "#838161 just joined this chat.",
"date_created": "2016-11-08 13:35:05",
"seen": "unseen"
}
]
}
}
}
Recording API lets you conduct a recording files path.
Tagove Recording API requests start with
Request Url
"https://api.tagove.com/chat/{chat-id}/recording"Example Request
"https://api.tagove.com/chat/43074/recording"
Example Response
{
"success": true,
"data": {
"chat": {
"id": "43074",
"account_id": "2675",
"session_id": "907029",
"type": "text",
"status": "closed",
"date_created": "2016-11-08 13:35:05",
"date_updated": "2016-11-08 13:35:05",
"department_id": null,
"chat_duration": "0",
"chat_wait_time": null,
"feedback_rating": null,
"feedback_message": null,
"comments": null,
"initiator": "visitor"
}
}
}
Visitor API lets you conduct a recording files path.
Tagove Visitor API requests start with
Request Url
"https://api.tagove.com/visitor?start_date={yyyy-mm-dd}&end_date={yyyy-mm-dd}&page={page-no}&limit={limit}"Example Request
"https://api.tagove.com/visitor?start_date=2016-10-05&end_date=2016-12-08&page=1&limit=2"
Example Response
{
"success": true,
"data": {
"visitor_session": {
"id": "907029",
"visitor_id": "838161",
"account_id": "2675",
"date_created": "2016-10-07 09:04:58",
"date_updated": "2016-11-18 09:56:04",
"date_close": "2016-11-18 09:56:04",
"status": "offline",
"visitor": {
"id": "838161",
"ip": "138.68.128.28",
"date_created": "2016-10-07 09:04:58",
"date_updated": "2016-11-24 08:23:12",
"date_last_visit": "2016-11-24 08:23:12",
"date_first_visit": "2016-10-07 09:04:58",
"location_full_name": "Wilmington, Delaware, United States",
"location_geo_ip_lat": "39.72845458984375",
"location_geo_ip_lng": "-75.53726196289062",
"user_agent_browser_name": "Firefox",
"user_agent_browser_version": "45.0",
"user_agent_os_name": "Linux",
"user_agent_os_version": "i686",
"user_agent_engine_name": "Gecko",
"user_agent_engine_version": "45.0",
"user_agent_cpu_arch": "ia32"
},
"visitorDetail": {
"id": "13530",
"visitor_id": "838161",
"account_id": "2675",
"name": "",
"email": "",
"first_name": null,
"last_name": null,
"phone": "",
"remarks": "",
"external_account_id": null,
"disposition": null,
"update_by": "app"
}
}
}
}
Request Url
"https://api.tagove.com/visitor/{visitor-id}"Example Request
"https://api.tagove.com/visitor/838161"
Example Response
{
"success": true,
"data": {
"visitor_session": [
{
"id": "907029",
"visitor_id": "838161",
"account_id": "2675",
"date_created": "2016-10-07 09:04:58",
"date_updated": "2016-11-18 09:56:04",
"date_close": "2016-11-18 09:56:04",
"status": "offline",
"visitor": {
"id": "838161",
"ip": "138.68.128.28",
"date_created": "2016-10-07 09:04:58",
"date_updated": "2016-11-24 08:23:12",
"date_last_visit": "2016-11-24 08:23:12",
"date_first_visit": "2016-10-07 09:04:58",
"location_full_name": "Wilmington, Delaware, United States",
"location_geo_ip_lat": "39.72845458984375",
"location_geo_ip_lng": "-75.53726196289062",
"user_agent_browser_name": "Firefox",
"user_agent_browser_version": "45.0",
"user_agent_os_name": "Linux",
"user_agent_os_version": "i686",
"user_agent_engine_name": "Gecko",
"user_agent_engine_version": "45.0",
"user_agent_cpu_arch": "ia32"
},
"visitorDetail": {
"id": "13530",
"visitor_id": "838161",
"account_id": "2675",
"name": "",
"email": "",
"first_name": null,
"last_name": null,
"phone": "",
"remarks": "",
"external_account_id": null,
"disposition": null,
"update_by": "app"
}
},
{
"id": "978803",
"visitor_id": "838161",
"account_id": "2675",
"date_created": "2016-10-21 16:13:22",
"date_updated": "2016-10-21 16:13:22",
"date_close": "2016-10-21 16:13:22",
"status": "offline",
"visitor": {
"id": "838161",
"ip": "138.68.128.28",
"date_created": "2016-10-07 09:04:58",
"date_updated": "2016-11-24 08:23:12",
"date_last_visit": "2016-11-24 08:23:12",
"date_first_visit": "2016-10-07 09:04:58",
"location_full_name": "Wilmington, Delaware, United States",
"location_geo_ip_lat": "39.72845458984375",
"location_geo_ip_lng": "-75.53726196289062",
"user_agent_browser_name": "Firefox",
"user_agent_browser_version": "45.0",
"user_agent_os_name": "Linux",
"user_agent_os_version": "i686",
"user_agent_engine_name": "Gecko",
"user_agent_engine_version": "45.0",
"user_agent_cpu_arch": "ia32"
},
"visitorDetail": {
"id": "13530",
"visitor_id": "838161",
"account_id": "2675",
"name": "",
"email": "",
"first_name": null,
"last_name": null,
"phone": "",
"remarks": "",
"external_account_id": null,
"disposition": null,
"update_by": "app"
}
}
]
}
}
You need to get your chat box initiate code.
Visit tagove.com and click a Sign Up.
Once logged In then click on integration button and inside widget section get chat box initiate code. Widget Code..
Copy the following example widget code
/* Widget Code */
<script async src="https://s.tagove.com/{code}/init.js"></script>
<script async src="https://s.tagove.com/main.js"></script>
/* / Widget Code */
Paste the code in to your website source code, inside the head tag with at first position.
Save your page and reload website.
you can initiate your chat box and integrate better snippet with your website in a number of ways. Ensure that you have the latest chat box snippet installed on your site.
Start video call with one click of button.Copy the following code inside the body tag to customize & quick video call button.
<a href="javascript:tagoveApp.max('video')"> Start Video Call Now </a>
Start voice call with one click of button.Copy the following code inside the body tag to customize & quick Audio call support button.
<a href="javascript:tagoveApp.max('audio')"> Get Audio Call Support </a>
Start text chat with one click of button.Copy the following code inside the body tag to customize & text chat button.
<a href="javascript:tagoveApp.max('text')"> Start the Chat </a>
You can use these links for 3 party social media like Facebook or Twitter,Clicking on this link will automatically redirect to your website URL and start the chat.Replace "www.tagove.com" with your website URL.
Start video call with one click of button.
<a href="https://www.tagove.com/#start-video-chat"> Start Video Call Now </a>
Start voice call with one click of button.
<a href="https://www.tagove.com/#start-audio-chat"> Get Audio Call Support </a>
Start text chat with one click of button.
<a href="https://www.tagove.com/#start-chat"> Start the Chat </a>
Use following script to update visitor details. Make sure you replace inside bracket words with your own code that outputs real user data for the currently logged-in user on each of your pages All are optional, you can pass only those value that you wanted and you can remove which details you don't have.
Copy the following example customer tracking
<script>
window.tagove=window.tagove||[];
tagove.push({
userDetails:{
name:'<name>', //FULL_NAME
email:'<email>', //EMAIL
phone:'<phone>', //PHONE_NUMBER
remarks:'<comment>', //REMARKS
}
});
</script>
Paste the code in to your website source code, inside the head tag with at before Widget Code.
This should be with all different programming language. please go to integration and have a look there.
Save your page and reload website.
Hide customer sensitive information to agent. Please add this tag in your html text box.
"data-skip-cobrowse"
So it will be look like this.
<input data-skip-cobrowse type="text" name="creditcard" placeholder="credit card number">
