Thành viên

Đường dẫn /{member-id}

Biểu thị một đối tượng người dùng là thành viên của cộng đồng hoặc nhóm Workplace.

Đường dẫn /community/members

Trả về danh sách tất cả tài khoản người dùng hiện tại. Cần có quyền Quản lý hồ sơ công việc.

Lọc dựa trên external_id

Để lọc người dùng dựa trên ID bên ngoài, hãy sử dụng thông số external_ids và chuyển danh sách các ID bên ngoài của người dùng mong muốn, được phân tách bằng dấu phẩy.

Đường dẫn /community/organization_members

Trả về danh sách người dùng. Cần có quyền Đọc thành viên nhóm. Các tài khoản người dùng đang hoạt động sẽ được liệt kê theo mặc định. Bạn có thể dùng thông số URL inactive=1 để hiển thị những tài khoản người dùng bị vô hiệu hóa.

Đọc

Trả về một đối tượng Người dùng biểu thị một người dùng Workplace. Có thể truy cập thông qua ID Workplace của thành viên hoặc địa chỉ email mà thành viên đó sử dụng khi đăng nhập vào Workplace.

  • /{member_id}
  • /{email_address}

Quyền

Bạn cần có quyền Đọc hồ sơ công việc hoặc Quản lý tài khoản để đọc thông tin về thành viên. Nếu một Tiện ích tích hợp đang sử dụng quyền Quản lý tài khoản và nằm trong phạm vi của các nhóm cụ thể, tiện ích tích hợp đó sẽ không thể truy cập một số trường Thành viên.

Trường

Tên trườngMô tảLoại

id

Id tài khoản người dùng của người này.

string

first_name

Tên của người này.

string

last_name

Họ của người này.

string

email

Địa chỉ email chính của người này. Địa chỉ email này cũng được dùng làm tên người dùng của họ trên Workplace.

string

title

Chức danh của người này trên Workplace nếu được đặt thông qua API Quản lý tài khoản.

string

organization

Tổ chức của người này trên Workplace nếu được đặt thông qua API Quản lý tài khoản.

string

division

Bộ phận của người này trên Workplace nếu được đặt thông qua API Quản lý tài khoản.

string

department

Tên phòng ban của người này trên Workplace nếu được đặt thông qua API Quản lý tài khoản.

string

primary_phone

Số điện thoại chính được liệt kê của người này. Đối ghép với mục phoneNumbers được đánh dấu là primary trên API Quản lý tài khoản.

string

primary_address

Địa chỉ chính được liệt kê của người này. Đối ghép với mục addresses được đánh dấu là primary trên API Quản lý tài khoản

string

picture

Ảnh đại diện của người này.

url

link

Liên kết đến trang cá nhân của người này.

url

locale

Ngôn ngữ của người này.

string

name

Họ tên của người này.

string

name_format

Tên của người này được định dạng để xử lý chính xác thứ tự trong tiếng Trung, tiếng Nhật hoặc tiếng Hàn.

string

updated_time

Thời gian cập nhật.

datetime

account_invite_time

Thời gian mời tài khoản theo định dạng UTC.

datetime

account_claim_time

Thời gian xác nhận tài khoản theo định dạng UTC.

datetime

account_deactivate_time

Thời gian vô hiệu hóa tài khoản theo định dạng UTC

datetime

external_id

Thông tin nhận dạng cho thành viên do khách hàng xác định. Mỗi thành viên CÓ THỂ thêm một tập giá trị external_id không trống bằng cách sử dụng API Quản lý tài khoản. Workplace sẽ không bao giờ chỉ định giá trị của thuộc tính external_id.

string

start_date

Ngày và giờ mà người này gia nhập công ty, nếu được đặt thông qua API Quản lý tài khoản.

datetime

about

Tiểu sử của người này.

string

cost_center

Xác định tên trung tâm chi phí.

string

impersonate_token

Mã truy cập thành viên cho phép một tiện ích tích hợp thực hiện lệnh gọi thay mặt một người cụ thể.

Mạo danh là một quyền đã bị ngừng cấp. Không xây dựng chức năng mới bằng quyền này. Quyền này chỉ dành cho các tiện ích tích hợp tùy chỉnh hiện đã được bật.

string

claim_link

Cung cấp liên kết mà người dùng có thể truy cập để xác nhận tài khoản Workplace của họ (chỉ dành cho người dùng chưa được xác nhận).

string

access_code

Cung cấp mã truy cập mà người dùng có thể sử dụng để xác nhận tài khoản Workplace của họ (chỉ dành cho người dùng chưa được xác nhận).

string

work_locale

Ngôn ngữ của người dùng. Đây là ngôn ngữ mà Workplace sẽ sử dụng cho người dùng này cho đến khi có cách khác để xác định ngôn ngữ của họ (chẳng hạn như cài đặt ngôn ngữ thiết bị hoặc trình duyệt)

string Giá trị hợp lệ là sự ghép nối của mã ngôn ngữ gồm 2 chữ cái theo ISO 639-1 cùng dấu gạch dưới và mã quốc gia gồm 2 chữ cái theo ISO 3166-1. Ví dụ: en_US sẽ chỉ định ngôn ngữ tiếng Anh và quốc gia Hoa Kỳ.

frontline

Thông tin về trạng thái công việc tuyến đầu của người dùng

object (xem ví dụ bên dưới)

active

Cho biết liệu tài khoản người dùng có đang hoạt động hay không

boolean

Cạnh

Tên cạnhMô tả

/events

Các sự kiện dành cho người này. Theo mặc định, cạnh này không bao gồm các sự kiện mà người này đã từ chối hoặc không trả lời.

/feed

Nguồn cấp dữ liệu bài viết (bao gồm cả cập nhật trạng thái) và liên kết do người này đăng.

/conversations

Tin nhắn trên Workplace của trang bot hoặc của người này. Bạn cần có quyền Đọc tất cả tin nhắn để xem cuộc trò chuyện của một người.

/managers

(Những) người quản lý được liệt kê của một người.

/reports

Báo cáo được liệt kê của một người.

/photos

Ảnh đại diện của thành viên.

/groups

Các nhóm được liên kết với một thành viên.

/phones

Các số điện thoại được liên kết với một thành viên.

/skills

Kỹ năng của thành viên.

/badges

Những huy hiệu mà người dùng nhận được

/logout

Đăng xuất một người dùng khỏi Workplace. Chỉ POST

/remove_profile_information

Gỡ thông tin trên trang cá nhân của người dùng bị vô hiệu hóa. Chỉ POST

Ví dụ

Truy xuất thông tin về một thành viên cộng đồng


Lấy tên và địa chỉ email của một thành viên cụ thể.

GET /{member_id}?fields=email,name HTTP/1.1
Host: graph.facebook.com


Lấy ID của một thành viên từ địa chỉ email của họ

GET /{email_address} HTTP/1.1
Host: graph.facebook.com


Liệt kê các thành viên công ty dựa trên id bên ngoài của người dùng

GET /community/members?external_ids=12356,abc123 HTTP/1.1
Host: graph.facebook.com


Liệt kê các thành viên công ty, kể cả những tài khoản bị vô hiệu hóa

GET /community/organization_members?inactive=1 HTTP/1.1
Host: graph.facebook.com


Lấy các sự kiện của một thành viên:

GET graph.facebook.com
      /{member-id}/events

Truy xuất thông tin về Người quản lý và Cấp dưới của người dùng


Lấy cấp dưới của một thành viên cụ thể

GET /{member_id}/reports HTTP/1.1
Host: graph.facebook.com


Lấy người quản lý của một thành viên cụ thể

GET /{member_id}/managers HTTP/1.1
Host: graph.facebook.com

Truy xuất tin nhắn dành cho một thành viên


Lấy cuộc trò chuyện của một thành viên, bao gồm cả tin nhắn, người gửi và file đính kèm:

Cần có mã tiện ích tích hợp tùy chỉnh có quyền Đọc tất cả tin nhắn:

GET graph.facebook.com
      /{member-id}/conversations?fields=messages{message,attachments,from}


Lấy ID chuỗi trò chuyện của một thành viên theo chuỗi trò chuyện:

Cần có mã tiện ích tích hợp tùy chỉnh có quyền Đọc tất cả tin nhắn:

GET graph.facebook.com
      /{member-id}/conversations


Lấy các tin nhắn của một ID chuỗi trò chuyện cụ thể, dành cho người dùng cụ thể:

Cần có mã tiện ích tích hợp tùy chỉnh có quyền Đọc tất cả tin nhắn:

GET graph.facebook.com
      /{thread-id}/messages?user={user-id}


Lấy cuộc trò chuyện của một trang bot, kể cả tin nhắn và file đính kèm:

GET graph.facebook.com
      /me/conversations?fields=messages{message,attachments}

Bí danh /me trỏ đến trang của bot khi sử dụng mã tiện ích tích hợp tùy chỉnh

Xóa một tin nhắn cụ thể trong hộp thư của thành viên bằng mã tiện ích tích hợp tùy chỉnh:

Cần có mã tiện ích tích hợp tùy chỉnh có quyền Xóa tin nhắn chat

DELETE graph.facebook.com
      /{message-id}?user={user-id}

Thao tác xóa tin nhắn chỉ xóa tin nhắn đó khỏi chế độ xem của thành viên được chỉ định trong yêu cầu. Để xóa hoàn toàn một tin nhắn, bạn phải xóa chế độ xem tin nhắn đó của từng thành viên.


Lấy ngày và giờ mà một thành viên được mời và xác nhận tài khoản của họ:

Cần có mã tiện ích tích hợp tùy chỉnh có quyền Quản lý tài khoản:

GET graph.facebook.com
      /{member-id}?fields=account_invite_time,account_claim_time

Những trường này chỉ hiển thị nếu thành viên đã được mời hoặc xác nhận tài khoản của họ


Lấy ngày và giờ mà tài khoản của thành viên bị vô hiệu hóa:

Cần có mã tiện ích tích hợp tùy chỉnh có quyền Quản lý tài khoản:

GET graph.facebook.com
      /{member-id}?fields=account_deactivate_time

Những trường này chỉ hiển thị nếu tài khoản của thành viên đã bị vô hiệu hóa


Đăng xuất một người dùng khỏi Workplace

Cần có mã truy cập có quyền Đăng xuất:

POST graph.facebook.com
      /{member-id}/logout


Đặt ảnh đại diện

Cần có mã truy cập có quyền Quản lý hồ sơ công việc. Hỗ trợ cả URL file và tải file lên trong yêu cầu.

POST graph.facebook.com
      /{member-id}/profile_pictures?
      image_url={...}&
      caption={...}
POST graph.facebook.com
      /{member-id}/profile_pictures?
      caption={...}
Content-Type: multipart/form-data;
Content-Disposition: form-data; name="image_data"; filename="/profile_picture.png


Thêm số điện thoại của thành viên

Cần có mã truy cập có quyền Quản lý hồ sơ công việc.

POST graph.facebook.com
      /{member-id}/phones?
      type={...}&
      primary={...}&
      number={...}


Lấy kỹ năng của thành viên

Cần có mã truy cập có quyền Đọc hồ sơ công việc.

GET graph.facebook.com
      /{member-id}/skills


Thêm kỹ năng

Cần có mã truy cập có quyền Quản lý hồ sơ công việc.

POST graph.facebook.com
      /{member-id}/skills?name={...}


Gỡ kỹ năng

Cần có mã truy cập có quyền Quản lý hồ sơ công việc.

DELETE graph.facebook.com
      /{member-id}/skills?name={...}


Lấy huy hiệu của thành viên

Cần có mã truy cập có quyền Đọc hồ sơ công việc.

GET graph.facebook.com
      /{member-id}/badges?fields=id,name,description,icon,category


Trao một huy hiệu tích hợp sẵn cho người dùng

Cần có mã truy cập có quyền Quản lý huy hiệu. Hãy xem tài liệu về cộng đồng để biết cách liệt kê các huy hiệu có sẵn và ID tương ứng.

POST graph.facebook.com
      /{member-id}/badges?badge=workplace_champion


Trao một huy hiệu tùy chỉnh cho người dùng

Cần có mã truy cập có quyền Quản lý huy hiệu. Hãy xem tài liệu về cộng đồng để biết cách liệt kê các huy hiệu có sẵn và ID tương ứng. Lưu ý rằng # trong URL cần được mã hóa URL.

POST graph.facebook.com
      /{member-id}/badges?badge=workplace_custom#{badge_id}


Vô hiệu hóa thành viên

Cần có mã truy cập có quyền Cấp phép tài khoản người dùng.

POST graph.facebook.com
      /{member-id}?active=false


Xóa thành viên

Cần có mã truy cập có quyền Cấp phép tài khoản người dùng.

DELETE graph.facebook.com
      /{member-id}

Bạn chỉ có thể xóa các thành viên chưa được xác nhận.

Lấy trạng thái công việc tuyến đầu của người dùng

GET graph.facebook.com
      /{user-id}?fields=frontline
      
    {
      "frontline": {
        "is_frontline": true
      },
    "id": "100038142594104"
    }