Get list of users

This API is used to get the list of users interacting with OA

Note:

• For APIs used for Shop, the API key is: <api_key>. The base_url information of the Shop.

• For APIs used for Partner, the API key is: <shop_key>. The base_url information of the Partner.

ListFollowers

POST$BASE_URL.Zalo/ListFollowers

Body

application/json

filtermrListFollowersFilter (object)

pagingktCursorPaging (object)

Response

200

A successful response

Body

application/json

followersarray of mrZlOAFollower (object)

pagingktCursorPageInfo (object)

Request

JavaScriptCurlPython

const response = await fetch('$BASE_URL.Zalo/ListFollowers', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

{
  "followers": [
    {
      "assigned_user_id": "text",
      "avatar": "text",
      "avatars": {
        "120": "text",
        "240": "text"
      },
      "created_at": "2025-01-09T21:42:40.273Z",
      "full_name": "text",
      "gender": "unknown",
      "has_conversation": false,
      "id": "text",
      "oa_id": "text",
      "phone": "text",
      "shared_info": {
        "address": "text",
        "city": "text",
        "district": "text",
        "name": "text",
        "phone": "text",
        "ward": "text"
      },
      "shop_id": "text",
      "state": "follow",
      "tags_and_notes_info": {
        "notes": [
          "text"
        ],
        "tag_names": [
          "text"
        ]
      },
      "updated_at": "2025-01-09T21:42:40.273Z",
      "zl_user_id": "text",
      "zl_user_id_by_app": "text"
    }
  ],
  "paging": {
    "after": "text",
    "before": "text",
    "limit": 0,
    "next": "text",
    "prev": "text",
    "sort": "text"
  }
}

Request:

curl --location '$BASE_URL.Zalo/ListFollowers' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer $API_KEY' \
--data '{
  "filter": {
    "assigned_user_id": "string",
    "date_from": "2019-08-24T14:15:22Z",
    "date_to": "2019-08-24T14:15:22Z",
    "gender": "unknown",
    "has_conversation": true,
    "name": "string",
    "oa_id": "string",
    "phone": "string",
    "state": "follow",
    "tags": [
      "string"
    ],
    "zl_user_id": "string",
    "zl_user_ids": [
      "string"
    ]
  },
  "paging": {
    "after": "string",
    "before": "string",
    "limit": 0,
    "sort": "string"
  }
}'

Response:

{
  "followers": [
    {
      "assigned_user_id": "string",
      "avatar": "string",
      "avatars": {
        "120": "string",
        "240": "string"
      },
      "created_at": "2019-08-24T14:15:22Z",
      "full_name": "string",
      "gender": "unknown",
      "has_conversation": true,
      "id": "string",
      "oa_id": "string",
      "phone": "string",
      "shared_info": {
        "address": "string",
        "city": "string",
        "district": "string",
        "name": "string",
        "phone": "string",
        "ward": "string"
      },
      "shop_id": "string",
      "state": "follow",
      "tags_and_notes_info": {
        "notes": [
          "string"
        ],
        "tag_names": [
          "string"
        ]
      },
      "updated_at": "2019-08-24T14:15:22Z",
      "zl_user_id": "string",
      "zl_user_id_by_app": "string"
    }
  ],
  "paging": {
    "after": "string",
    "before": "string",
    "limit": 0,
    "next": "string",
    "prev": "string",
    "sort": "string"
  }
}

Request body structure

Parameters	Data type	Describe
assigned_user_id	string	Employee ID assigned
id	int64	OA ID
name	string	Zalo Username
date_from	string<date-time>	Start date
date_to	string<date-time>	End date
gender	string (pwGender) Enum	Gender " unknown" " male" female" " other"
has_conversation	boolean	True: Have a conversation False: No conversation
phone	string	User phone number
state	string (gqFollowState) Enum	follow: Interested
tags	Array of strings	Labels assigned to users
zl_user_id	string	Zalo User ID

Return data attribute structure

Parameters	Data type	Describe
assigned_user_id	string	Employee ID assigned
avatar	string	User avatar
full_name	string	User name
id	string	User ID on eTelecom
id	int64	OA ID
shared_info	object (mrSharedInfo)	User consents to share information
address	string	Address
city	string	City
district	string	District
ward	string	Ward
name	string	Zalo Username
created_at	string<date-time>	Time of recording interaction
updated_at	string<date-time>	Update time
gender	string (pwGender) Enum	Gender " unknown" " male" female" " other"
has_conversation	boolean	True: Have a conversation False: No conversation
phone	string	User phone number
shop_id	string	Shop ID on eTelecom
state	string (gqFollowState) Enum	follow: Interested unfollow: Not interested
tags	Array of strings	Labels assigned to users
zl_user_id	string	Zalo User ID
zl_user_id_by_app	string	Zalo user ID by app