Get a contacts transcript

This request/endpoint is platform-agnostic (e.g., WhatsApp, website) and returns a list of contacts along with their associated profile data. It also supports various filtering options in the request

POST https://api-v7.express-chat.com/inbox/users

Headers

Name	Value
Content-Type	application/json
Authorization	Bearer <token>
authtype	Key

Request Body

The request body consists of a JavaScript Object Notation (JSON) object containing the fields described in the table below. Examples of the request body can be found in the Sample Requests section.

Field	Type	Description
id	string	Search text to filter contacts.
botName	array	Filter contacts based on an array of existing tag names
leadName	array	An array of status values to filter contacts.
leadNumber	boolean	Indicates whether contacts are online.
senderEmail	array	Filter contacts based on interactions on the website.

Responses

400 - Bad Request

The <token> being used is incorrect.

{
  "success": false,
  "message": "Argument passed in must be a single String of 12 bytes or a string of 24 hex characters",
  "code": 400
}

401 - Unauthorized

Your request is missing the authtype: Key header

{
  "success": false,
  "message": "jwt malformed",
  "code": 401
}

Sample Requests

Replace <token> in the below example requests with your valid Bearer token and customize the request body filters as needed for your use case.

curl

curl 'https://api-v7.express.com/inbox/users' \
  -X 'POST' \
  -H 'Authorization: Bearer <token>' \
  -H 'Content-Type: application/json' \
  -H 'authtype: Key' \
  -d '{
    "searchText": "",
    "tags": [],
    "status": [],
    "isOnline": false,
    "_botWebsite": [],
    "_botWhatsapp": [],
    "_botTelegram": [],
    "_botFacebook": [],
    "_agentAssigned": [],
    "segments": [],
    "applicableFilters": ["userInteracted"],
    "lastSeenAt": {
      "startAt": "",
      "endsAt": ""
    },
    "createdAt": {
      "startAt": "",
      "endsAt": ""
    },
    "userInteracted": true,
    "lastMessageBy": [],
    "isLiveChatActive": false,
    "hasOrdered": {
      "status": false,
      "lastAt": ""
    },
    "page": 1,
    "isExport": "none",
    "isContact": true
  }' \
  --compressed

❓ Got any questions?

If you have any questions, you can look into our repository of FAQs, most likely, you will find your answer here, If not, write us at [email protected].