Authentication

• You must use your API_KEY for each method call.

• You must authenticate for all requests.

• All API requests must be made over HTTPS-only.


Step 1: Visit API key Page

Go to Settings > API Key from the left menu.

Step 2: Obtain API key

Click on the API Key block and copy the API key obtained.

Step 3: Using API key

Provide your basic auth the API_KEY.






9d182cd5a1f57b3e216aabc9854bfe46

Basic API Usage

Tagove Chat API requests start with https://api.tagove.com/

The next segment of the URI path depends on the type of request.

https://api.tagove.com/{action}

Data Format

Tagove API returns data in JSON & XML format

Accept : application/xml or application/json

Chat History

Chat History API lets you conduct a chat with a support agent from the visitor's perspective.


GET request parameters

Parameter Format Description
start_date yyyy-mm-dd Start date to get chat history in reponse
end_date yyyy-mm-dd End date to get chat history in reponse
page integer Number of pages to get in reponse
limit integer To limit number of search results obtained in response
with comma seperated With specified fields. Possible value are 'messages', 'account'


RESPONSE object

Attribute Type Description
success boolean Specifies success and faliure of response
data object Contains chat history data on successfull response


Data object

Attribute Type Description
account object Contains account info
chat object Contains chat info


Account object

Attribute Type Description
first_name string First name of account holder
last_name string Last name of account holder ( if given )
mobile_number string Mobile Number of account holder ( if given )
email string Email of account holder


Chat object

Attribute Type Description
id string First name of account holder
account_id string Id of account holder
session_id string Session id of chat
type string Chat type
status string Chat status
date_created string Date at which chat is first created
date_updated string Date at which chat is updated
department_id string Department assigned to account holder
chat_duration string Time for which chat is active
chat_wait_time string Time before actual chat starts
feedback_rating string Rating for chat feedback
feedback_message string Message given in feedback
comments string Comments for feedback
initiator string Person who initiates chat
messages object Message in chat


Messages object

Attribute Type Description
id string Id for the message in chat
chat_id string Chat id for the message
account_id string Mobile Number of account holder ( if given )
sender_type string Sender type formessage
type string Type of message
message string Text in the message
date_created string Creation date for message
seen string Status of message



 https://api.tagove.com/chats?start_date={yyyy-mm-dd}&end_date={yyyy-mm-dd}&page={page-no}&limit={limit}&with=messages,account
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'
                
{
  "success": true,
  "data": {
    "account": {
      "first_name": "John",
      "last_name": "",
      "mobile_number": null,
      "email": "john@gmail.com"
    },
    "chat": {
      "id": "44074",
      "account_id": "21075",
      "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": "200",
      "chat_wait_time": "40",
      "feedback_rating": null,
      "feedback_message": null,
      "comments": null,
      "initiator": "visitor",
      "messages": [
        {
          "id": "342235",
          "chat_id": "41074",
          "account_id": "21075",
          "sender_type": "system",
          "sender_id": null,
          "type": "event",
          "message": "#838161 just joined this chat.",
          "date_created": "2016-11-08 13:35:05",
          "seen": "unseen"
        }
      ]
    }
  }
}
                

Chat Message

Chat Message API lets you conduct a chat message records.


GET request format

URL Format Description
https://api.tagove.com/chat/{chat-id}}/messages Get messages in chat as JSON




RESPONSE object

Attribute Type Description
success boolean Specifies success and faliure of response
data object Contains chat history data on successfull response


Data object

Attribute Type Description
chat object Contains chat info


Chat object

Attribute Type Description
id string First name of account holder
account_id string Id of account holder
session_id string Session id of chat
type string Chat type
status string Chat status
date_created string Date at which chat is first created
date_updated string Date at which chat is updated
department_id string Department assigned to account holder
chat_duration string Time for which chat is active
chat_wait_time string Time before actual chat starts
feedback_rating string Rating for chat feedback
feedback_message string Message given in feedback
comments string Comments for feedback
initiator string Person who initiates chat
messages object Message in chat


Messages object

Attribute Type Description
id string Id for the message in chat
chat_id string Chat id for the message
account_id string Mobile Number of account holder ( if given )
sender_type string Sender type formessage
type string Type of message
message string Text in the message
date_created string Creation date for message
seen string Status of message



https://api.tagove.com/chat/{chat-id}}/messages
https://api.tagove.com/chat/43074/messages
{
  "success": true,
  "data": {
    "chat": {
      "id": "43074",
      "account_id": "21075",
      "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": "21075",
          "sender_type": "system",
          "sender_id": null,
          "type": "event",
          "message": "#838161 just joined this chat.",
          "date_created": "2016-11-08 13:35:05",
          "seen": "unseen"
        }
      ]
    }
  }
}
                

Chat Recording

Recording API lets you conduct a recording files path.



RESPONSE object

Attribute Type Description
success boolean Specifies success and faliure of response
data object Contains chat history data on successfull response


Data object

Attribute Type Description
chat object Contains chat info


Chat object

Attribute Type Description
id string First name of account holder
account_id string Id of account holder
session_id string Session id of chat
type string Chat type
status string Chat status
date_created string Date at which chat is first created
date_updated string Date at which chat is updated
department_id string Department assigned to account holder
chat_duration string Time for which chat is active
chat_wait_time string Time before actual chat starts
feedback_rating string Rating for chat feedback
feedback_message string Message given in feedback
comments string Comments for feedback
initiator string Person who initiates chat


https://api.tagove.com/chat/{chat-id}/recording
https://api.tagove.com/chat/43074/recording
{
  "success": true,
  "data": {
    "chat": {
      "id": "43074",
      "account_id": "21075",
      "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 Visitor

Visitor API lets you conduct a recording files path.


GET request parameters

Parameter Format Description
start_date yyyy-mm-dd Start date to get chat history in reponse
end_date yyyy-mm-dd End date to get chat history in reponse
page integer Number of pages to get in reponse
limit integer To limit number of search results obtained in response




RESPONSE object

Attribute Type Description
success boolean Specifies success and faliure of response
data object Contains chat history data on successfull response


Data object

Attribute Type Description
visitor_session object Contains info for visitor session
visitorDetail object Contains details of visitor


VisitorDetail object

Attribute Type Description
visitor_id string Contains id of visitor
account_id string Account id of account holder
name string Name of visitor
email string Email of visitor
first_name string First name of visitor
last_name string Last name of visitor
phone string Phone number of visitor
remarks string Remarks for visitor
external_account_id string External account id
disposition string Disposition
update_by string Source of updation


Visitor_Session object

Attribute Type Description
id string Id for visitor session
visitor_id string Visitor id in session
account_id string Accunt id for account holder
date_created string Creation date of chat session
date_updated string Update date of chat session
date_close string Closing date of chat session
status string Status of chat session
visitor object Details of visitor in session


Visitor object

Attribute Type Description
id string Id of visitor
ip string Contains details of visitor
date_created string Profile creation date
date_updated string Profile update date
date_last_visit string Last date of visit to app
date_first_visit string First visit to app
location_full_name string Full name of lcoation
location_geo_ip_lat string Latitude of location
location_geo_ip_lng string Longitude of location
user_agent_browser_name string Name of browser used
user_agent_browser_version string Version of browser used
user_agent_os_name string Name of OS used
user_agent_os_version string Version of OS used
user_agent_engine_name string Engine of user agent
user_agent_engine_version string Version of engine of user agent
user_agent_cpu_arch string CPU architecture of user agent




 https://api.tagove.com/visitor?start_date={yyyy-mm-dd}&end_date={yyyy-mm-dd}&page={page-no}&limit={limit}"
                                        
https://api.tagove.com/visitor?start_date=2016-10-05&end_date=2016-12-08&page=1&limit=2
{
  "success": true,
  "data": {
    "visitor_session": {
      "id": "907029",
      "visitor_id": "838161",
      "account_id": "21075",
      "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": {
        "visitor_id": "838161",
        "account_id": "21075",
        "name": "",
        "email": "",
        "first_name": null,
        "last_name": null,
        "phone": "",
        "remarks": "",
        "external_account_id": null,
        "disposition": null,
        "update_by": "app"
      }
    }
  }
}