Lấy thông tin chi tiết của 1 người quan tâm

Quyền cần có: Quyền quản lý thông tin OA

HTTP request

URL: https://zns.api.gobysend.com/api/follower/get-profile Method: GET Content Type: application/json Response Type: text/json

Example request

curl
-X GET
-H "Content-Type: application/json" 
"https://zns.api.gobysend.com/api/follower/get-profile?user_id=567826391599986760"

Tham số header

Tham số

Kiểu dữ liệu

Tính bắt buộc

Mô tả

string

yes

Token cho phép ứng dụng đại diện OA gọi API. Xem chi tiết cách lấy access token tại đây.

Tham số

Tham số

Kiểu dữ liệu

Tính bắt buộc

Mô tả

user_id

string

yes

ID của người quan tâm trên Zalo.

Example respond

{
    "error": 0,
    "message": “Success”,
    "data": {
        "user_gender": 1,
        "user_id": 567826391599986760,
        "user_id_by_app": 56782639,
        "avatar": String,
        "avatars": {
            "120": String,
            "240": String
        },
        "display_name": "Phạm Khoa",
        "shared_info":{
               "address": "Phan Đình Phùng",
               "city": "Hồ Chí Minh",
               "district": "Quận 1",
               "phone": 841282987721,
               "name": "Phạm Khoa"
    },
        "tags_and_notes_info": {
            "tag_names":[
                   "Khách VIP"
              ],
            "notes": [
                   "Discount 10%"
              ]
        }
    }
}

Cấu trúc thuộc tính data

Thuộc tính

Kiểu dữ liệu

Mô tả

user_gender

int

Giới tính của người quan tâm. Các giá trị trả về:

  • 0: nữ

  • 1: nam

user_id

long

ID của người quan tâm

user_id_by_app

long

ID của người quan tâm ứng với app

avatar

string

Đường dẫn đến ảnh đại diện của người dùng (ảnh có kích thước đúng với size ảnh hiển thị trên app Zalo)

avatars

string

Đường dẫn đến ảnh đại diện của người dùng.

  • 120: đường dẫn đến ảnh size nhỏ hơn kích thước chuẩn.

  • 240: đường dẫn đến ảnh size lớn hơn kích thước chuẩn.

display_name

string

Tên hiển thị của người quan tâm

shared_info

JSON object

Thuộc tính trả về thông tin người dùng đã submit cho OA. Lưu ý: thuộc tính chỉ được trả về khi người dùng đã gửi thông tin cho OA.

tags_and_notes_info

JSON object

Thông tin nhãn và ghi chú OA gắn cho người quan tâm.

English version

HTTP request

URL: https://zns.api.gobysend.com/api/follower/get-profile Method: GET Content Type: application/json Response Type: text/json

Example request

curl
-X GET
-H "Content-Type: application/json" 
"https://zns.api.gobysend.com/api/follower/get-profile?user_id=567826391599986760"

Header param

Param

Data type

Compulsory

Description

string

yes

The token allows the OA agent to call the API. Reference document

Param

Param

Data type

Compulsory

Description

user_id

string

yes

Followers's Zalo ID

Example respond

{
    "error": 0,
    "message": “Success”,
    "data": {
        "user_gender": 1,
        "user_id": 567826391599986760,
        "user_id_by_app": 56782639,
        "avatar": String,
        "avatars": {
            "120": String,
            "240": String
        },
        "display_name": "Phạm Khoa",
        "shared_info":{
               "address": "Phan Đình Phùng",
               "city": "Hồ Chí Minh",
               "district": "Quận 1",
               "phone": 841282987721,
               "name": "Phạm Khoa"
    },
        "tags_and_notes_info": {
            "tag_names":[
                   "Khách VIP"
              ],
            "notes": [
                   "Discount 10%"
              ]
        }
    }
}

Data attribute structure

Attribute

Data type

Description

user_gender

int

Follower's gender. Return values: 0: female 1: male

user_id

long

Follower's ID

user_id_by_app

long

Follower's ID that corresponding to the app

avatar

string

Link to follower's avatar (The image has the correct size for the image size displayed on the Zalo app)

avatars

string

Link to follower's avatar 120: Link to the image size that smaller than the standard size. 240: Link to the image size that bigger than the standard size.

display_name

string

Display name of follower

shared_info

JSON object

Atributes returns the information the user submitted to the OA.

Note: the atribute is only returned when the user has submitted information to the OA.

tags_and_notes_info

JSON object

Label information and note OA for followers.

Last updated