Archives List

Archives List

List API handles to get list of archives.

You can refer to the sample code provided on the right side of the screen and switch to your preferred language.

Access the list of archives endpoint to get list of archives. You can fetch only 30 days data at a time. To access this API endpoint, login/signup to Appy Pie Developer account and obtain the required AccessToken Key from the Authentication section.

POST https://livechat-gateway-cavg9c0h.uc.gateway.dev/api/v1/archives/list

Parameter NameRequiredParameter TypeParameter Description
accountKeyYesStringThis is unique(To get this key login into your Livechat account and click on My Profile icon > My Profile > Account Key)
from_dateYesStringThis is start date.
to_dateYesStringThis is end date.
Required Parameters are mandatory to access the API endpoint.

Errors

This error section displays all the errors with details.

Following are the error codes that indicate the success or failure of an API request:

Error CodeMeaning
400Bad Request -- Your request is invalid.
401Unauthorized -- Your API key is wrong.
403Forbidden -- The method requested is hidden for administrators only.
404Not Found -- The specified method could not be found.
405Method Not Allowed -- You tried to access a method with an invalid method.
406Not Acceptable -- You requested a format that is not json.
410Gone -- Request has been removed from our servers.
429Too Many Requests
500Internal Server Error -- We had a problem with our server. Try again later.
503Service Unavailable -- We are temporarily offline for maintenance. Please try again later.
To authorize, use this code:

1wget --no-check-certificate --quiet \
2	--method POST \
3	--timeout=0 \
4	--header "ACCESSTOKEN: Access Token Key" \
5	--header "Content-Type: application/json" \
6	--body-data
7	'{
8		"accountKey":"162524536115054798",
9		"from_date":"01/01/2021",
10		"to_date":"30/01/2021"
11	 }' \
12	"https://livechat-gateway-cavg9c0h.uc.gateway.dev/api/v1/archives/list"

RESPONSE

{
  "status": "success",
  "total": 1,
  "list": [
    {
      "ownerId": "162524536115054798",
      "visitorId": "CLIENT1536958179252",
      "addedon": 1636958151017,
      "agent_ids": [
        "162124137433533731"
      ],
      "agent_leave": [],
      "browser": "Firefox",
      "country": "IN",
      "operating": "Mac OS",
      "email": "demo@demo.com",
      "visitor_timezone": "Asia/Kolkata",
      "isChatend": 1,
      "geoDetails": {
        "country_code": "IN",
        "country_name": "India",
        "country_ip": "122.161.52.25"
      },
      "name": "Demo Demo",
      "phone": "+919999999999",
      "visitor_email": "VISITOR1636958119252",
      "visitor_status": 5,
      "feedback_score": "",
      "feedback_received": "",
      "picktime": 1636965636109,
      "completedon": 1636965641267,
      "feedback_comment": "",
      "feedback_type": "star",
      "plan_name": "Premium",
      "source": "chat",
      "chat_type": 1
    }
  ]
}