สมาชิก

พาธ /{member-id}

แสดงถึงอ็อบเจ็กต์ผู้ใช้ในฐานะสมาชิกของชุมชนหรือกลุ่ม Workplace

พาธ /community/members

ส่งคืนรายชื่อบัญชีผู้ใช้ปัจจุบันทั้งหมด จำเป็นต้องใช้สิทธิ์การอนุญาตจัดการโปรไฟล์การทำงาน

การกรองตาม external_id

หากต้องการกรองผู้ใช้ตาม ID ภายนอก ให้ใช้พารามิเตอร์ external_ids และส่งรายการที่คั่นด้วยเครื่องหมายจุลภาคซึ่งประกอบด้วย ID ภายนอกของผู้ใช้ที่ต้องการ

พาธ /community/organization_members

ส่งคืนรายการผู้ใช้ จำเป็นต้องใช้สิทธิ์การอนุญาตอ่านการเป็นสมาชิกของกลุ่ม ระบบจะแสดงบัญชีผู้ใช้ที่กำลังใช้งานอยู่ตามค่าเริ่มต้น เมื่อใช้พารามิเตอร์ URL inactive=1 จะสามารถแสดงบัญชีผู้ใช้ที่ปิดใช้งานแล้วแทนได้

การอ่าน

ส่งคืนอ็อบเจ็กต์ผู้ใช้รายการเดียวซึ่งแสดงถึงผู้ใช้ Workplace โดยคุณสามารถเข้าถึงได้ผ่านทาง Workplace ID ของสมาชิกหรืออีเมลที่สมาชิกใช้เมื่อเข้าสู่ระบบ Workplace

  • /{member_id}
  • /{email_address}

สิทธิ์การอนุญาต

การอ่านข้อมูลเกี่ยวกับสมาชิกจำเป็นต้องใช้สิทธิ์การอนุญาตอ่านโปรไฟล์การทำงานหรือสิทธิ์การอนุญาตจัดการบัญชี อย่างใดอย่างหนึ่ง หากการผสานการทำงานใช้สิทธิ์การอนุญาตจัดการบัญชีอยู่ และมีการจำกัดขอบเขตเฉพาะกลุ่ม จะส่งผลให้ไม่สามารถเข้าถึงช่องสมาชิกบางช่องได้

ช่อง

ชื่อช่องคำอธิบายประเภท

id

ID บัญชีผู้ใช้ของบุคคลนี้

string

first_name

ชื่อของผู้ใช้

string

last_name

นามสกุลของผู้ใช้

string

email

อีเมลหลักของผู้ใช้ ซึ่งใช้เป็นชื่อผู้ใช้บน Workplace ด้วย

string

title

ตำแหน่งบน Workplace ของผู้ใช้ กรณีที่ตั้งค่าผ่าน API การจัดการบัญชี

string

organization

องค์กรบน Workplace ของผู้ใช้ กรณีที่ตั้งค่าผ่าน API การจัดการบัญชี

string

division

ฝ่ายบน Workplace ของผู้ใช้ กรณีที่ตั้งค่าผ่าน API การจัดการบัญชี

string

department

ชื่อแผนกบน Workplace ของผู้ใช้ กรณีที่ตั้งค่าผ่าน API การจัดการบัญชี

string

primary_phone

หมายเลขโทรศัพท์หลักที่ระบุไว้ของผู้ใช้ แผนที่ไปยังข้อมูล phoneNumbers ที่ทำเครื่องหมายเป็น primary ใน API การจัดการบัญชี

string

primary_address

ที่อยู่หลักที่ระบุไว้ของผู้ใช้ แผนที่ไปยังข้อมูล addresses ที่ทำเครื่องหมายเป็น primary ใน API การจัดการบัญชี

string

picture

รูปโปรไฟล์ของผู้ใช้

url

link

ลิงก์ไปยังโปรไฟล์ของผู้ใช้

url

locale

รูปแบบภาษาของผู้ใช้

string

name

ชื่อนามสกุลของผู้ใช้

string

name_format

ชื่อของผู้ใช้ซึ่งจัดรูปแบบให้สามารถรองรับการเรียงลำดับในภาษาจีน ภาษาญี่ปุ่น หรือภาษาเกาหลีได้อย่างถูกต้อง

string

updated_time

เวลาที่อัพเดต

datetime

account_invite_time

เวลาที่เชิญบัญชีในรูปแบบ UTC

datetime

account_claim_time

เวลาที่ขอรับสิทธิ์บัญชีในรูปแบบ UTC

datetime

account_deactivate_time

เวลาที่ปิดใช้งานบัญชีในรูปแบบ UTC

datetime

external_id

ตัวระบุสำหรับสมาชิกที่กำหนดโดยลูกค้า สมาชิกแต่ละรายอาจระบุชุดค่า external_id แบบไม่ปล่อยว่างโดยใช้ API การจัดการบัญชี Workplace จะไม่ระบุค่า attribute external_id โดยเด็ดขาด

string

start_date

วันที่และเวลาที่ผู้ใช้เข้าร่วมบริษัท กรณีที่ตั้งค่าผ่าน API การจัดการบัญชี

datetime

about

คำอธิบายตัวเองของผู้ใช้

string

cost_center

ระบุชื่อของศูนย์ต้นทุน

string

impersonate_token

โทเค็นการเข้าถึงสมาชิกซึ่งช่วยให้การผสานการทำงานสามารถทำการเรียกใช้ในนามของผู้ใช้ที่เฉพาะเจาะจงได้

Impersonate เป็นสิทธิ์การอนุญาตที่เลิกใช้แล้ว ห้ามสร้างฟังก์ชั่นการทำงานใหม่โดยใช้สิทธิ์การอนุญาตนี้ มีเพียงการผสานการทำงานแบบกำหนดเองเท่านั้นที่สามารถใช้สิทธิ์การอนุญาตนี้ได้ ซึ่งเปิดใช้งานอยู่ในขณะนี้

string

claim_link

ระบุลิงก์ที่ผู้ใช้สามารถใช้เพื่อขอรับสิทธิ์บัญชี Workplace ของตนเอง (ใช้ได้กับผู้ใช้ที่ยังไม่ขอรับสิทธิ์เท่านั้น)

string

access_code

ระบุรหัสเข้าถึงที่ผู้ใช้สามารถใช้เพื่อขอรับสิทธิ์บัญชี Workplace ของตนเอง (ใช้ได้กับผู้ใช้ที่ยังไม่ขอรับสิทธิ์เท่านั้น)

string

work_locale

รูปแบบภาษาของผู้ใช้ นี่คือรูปแบบภาษาที่ Workplace จะใช้สำหรับผู้ใช้รายนี้จนกว่าจะมีวิธีอื่นในการกำหนดรูปแบบภาษาของผู้ใช้ดังกล่าว (เช่น การตั้งค่าภาษาในเบราว์เซอร์หรือในอุปกรณ์)

string ค่าที่ถูกต้องคือการเชื่อมกันระหว่างรหัสภาษาแบบ 2 ตัวอักษรตามมาตรฐาน ISO 639-1 ตามด้วยเครื่องหมายขีดล่าง และตามด้วยรหัสประเทศแบบ 2 ตัวอักษรตามมาตรฐาน ISO 3166-1 เช่น en_US บ่งชี้ว่าเป็นภาษาอังกฤษและประเทศสหรัฐอเมริกา

frontline

ข้อมูลเกี่ยวกับสถานะบุคลากรหน้างานของผู้ใช้

object (โปรดดูตัวอย่างด้านล่าง)

active

ระบุว่าบัญชีผู้ใช้กำลังใช้งานอยู่หรือไม่

boolean

การเผยแพร่

โปรดดู API (กราฟ) การจัดการบัญชี

การอัพเดต

โปรดดู API (กราฟ) การจัดการบัญชี

จุดเชื่อมโยง

ชื่อจุดเชื่อมโยงคำอธิบาย

/events

เหตุการณ์เกี่ยวกับผู้ใช้รายนี้ ตามค่าเริ่มต้นแล้ว จะไม่รวมเหตุการณ์ที่ผู้ใช้ปฏิเสธหรือไม่ได้ตอบกลับ

/feed

ฟีดของโพสต์ (รวมถึงการอัพเดตสถานะ) และลิงก์ที่ผู้ใช้รายนี้เผยแพร่

/conversations

ข้อความ Workplace ของผู้ใช้หรือหน้าบอท จำเป็นต้องใช้สิทธิ์การอนุญาตอ่านข้อความทั้งหมด หากต้องการดูการสนทนาของผู้ใช้

/managers

ผู้จัดการ (คนเดียวหรือหลายคน) ที่ระบุไว้ของผู้ใช้

/reports

ผู้อยู่ใต้บังคับบัญชาที่ระบุไว้ของผู้ใช้

/photos

รูปโปรไฟล์ของสมาชิก

/groups

กลุ่มที่เชื่อมโยงกับสมาชิก

/phones

หมายเลขโทรศัพท์ที่เชื่อมโยงกับสมาชิก

/skills

ทักษะของสมาชิก

/badges

เครื่องหมายที่มอบให้ผู้ใช้

/logout

นำผู้ใช้ออกจากระบบ Workplace เฉพาะ POST เท่านั้น

/remove_profile_information

ลบข้อมูลโปรไฟล์ของผู้ใช้ที่ถูกปิดใช้งานออก เฉพาะ POST เท่านั้น

ตัวอย่าง

การดึงข้อมูลเกี่ยวกับสมาชิกในชุมชน


รับข้อมูลชื่อและอีเมลของสมาชิกที่กำหนด

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


รับข้อมูล ID ของสมาชิกจากอีเมล

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


สร้างรายการสมาชิกในบริษัทตาม ID ภายนอกของผู้ใช้

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


สร้างรายการสมาชิกในบริษัทโดยรวมบัญชีที่ปิดใช้งานแล้วด้วย

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


รับข้อมูลเหตุการณ์ของสมาชิก:

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

การดึงข้อมูลเกี่ยวกับผู้จัดการและผู้อยู่ใต้บังคับบัญชาของผู้ใช้


รับข้อมูลผู้อยู่ใต้บังคับบัญชาของสมาชิกที่กำหนด

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


รับข้อมูลผู้จัดการของสมาชิกที่กำหนด

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

การดึงข้อความของสมาชิก


รับข้อมูลการสนทนาของสมาชิก โดยรวมถึงข้อความ ผู้ส่ง และไฟล์แนบ:

จำเป็นต้องใช้โทเค็นการผสานการทำงานแบบกำหนดเองที่มีสิทธิ์การอนุญาตอ่านข้อความทั้งหมด:

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


รับข้อมูล ID ของเธรดการสนทนาของสมาชิกตามเธรด:

จำเป็นต้องใช้โทเค็นการผสานการทำงานแบบกำหนดเองที่มีสิทธิ์การอนุญาตอ่านข้อความทั้งหมด:

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


รับข้อความสำหรับ ID ของเธรดที่กำหนดของผู้ใช้ที่กำหนด:

จำเป็นต้องใช้โทเค็นการผสานการทำงานแบบกำหนดเองที่มีสิทธิ์การอนุญาตอ่านข้อความทั้งหมด:

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


รับข้อมูลการสนทนาในหน้าบอท โดยรวมถึงข้อความและไฟล์แนบ:

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

นามแฝง /me จะชี้ไปยังหน้าบอทเมื่อใช้งานโทเค็นการผสานการทำงานแบบกำหนดเอง

ลบข้อความที่ต้องการในกล่องข้อความของสมาชิกโดยใช้โทเค็นการผสานการทำงานแบบกำหนดเอง:

จำเป็นต้องใช้โทเค็นการผสานการทำงานแบบกำหนดเองที่มีสิทธิ์การอนุญาตลบข้อความแชท

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

การลบข้อความจะลบเฉพาะข้อความจากมุมมองของสมาชิกที่ระบุในคำขอเท่านั้น หากต้องการลบข้อความให้หมดไป จะต้องลบมุมมองข้อความนั้นของสมาชิกแต่ละรายด้วย


รับข้อมูลวันที่และเวลาที่สมาชิกได้รับเชิญและขอรับสิทธิ์บัญชีของตนเอง:

จำเป็นต้องใช้โทเค็นการผสานการทำงานแบบกำหนดเองที่มีสิทธิ์การอนุญาตจัดการบัญชี:

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

ระบบจะแสดงช่องเหล่านี้ในกรณีที่สมาชิกได้รับเชิญหรือขอรับสิทธิ์บัญชีของตนเองแล้วเท่านั้น


รับข้อมูลวันที่และเวลาที่บัญชีของสมาชิกได้รับถูกปิดใช้งาน:

จำเป็นต้องใช้โทเค็นการผสานการทำงานแบบกำหนดเองที่มีสิทธิ์การอนุญาตจัดการบัญชี:

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

ระบบจะแสดงช่องเหล่านี้ในกรณีที่บัญชีของสมาชิกถูกปิดใช้งานแล้วเท่านั้น


นำผู้ใช้ออกจากระบบ Workplace

จำเป็นต้องใช้โทเค็นการเข้าถึงที่มีสิทธิ์การอนุญาตออกจากระบบ:

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


ตั้งค่ารูปโปรไฟล์

จำเป็นต้องใช้โทเค็นการเข้าถึงที่มีสิทธิ์การอนุญาตจัดการโปรไฟล์การทำงาน รองรับทั้ง URL ของไฟล์และการอัพโหลดไฟล์ในคำขอ

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


เพิ่มหมายเลขโทรศัพท์ของสมาชิก

จำเป็นต้องใช้โทเค็นการเข้าถึงที่มีสิทธิ์การอนุญาตจัดการโปรไฟล์การทำงาน

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


รับข้อมูลทักษะของสมาชิก

จำเป็นต้องใช้โทเค็นการเข้าถึงที่มีสิทธิ์การอนุญาตอ่านโปรไฟล์การทำงาน

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


เพิ่มทักษะ

จำเป็นต้องใช้โทเค็นการเข้าถึงที่มีสิทธิ์การอนุญาตจัดการโปรไฟล์การทำงาน

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


ลบทักษะออก

จำเป็นต้องใช้โทเค็นการเข้าถึงที่มีสิทธิ์การอนุญาตจัดการโปรไฟล์การทำงาน

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


รับข้อมูลเครื่องหมายของสมาชิก

จำเป็นต้องใช้โทเค็นการเข้าถึงที่มีสิทธิ์การอนุญาตอ่านโปรไฟล์การทำงาน

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


มอบเครื่องหมายที่มีในระบบให้แก่ผู้ใช้

จำเป็นต้องใช้โทเค็นการเข้าถึงที่มีสิทธิ์การอนุญาตจัดการเครื่องหมาย โปรดดูเอกสารประกอบเรื่องชุมชน เพื่อดูรายการเครื่องหมายที่มีอยู่ พร้อมด้วย ID ของเครื่องหมาย

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


มอบเครื่องหมายแบบกำหนดเองให้แก่ผู้ใช้

จำเป็นต้องใช้โทเค็นการเข้าถึงที่มีสิทธิ์การอนุญาตจัดการเครื่องหมาย โปรดดูเอกสารประกอบเรื่องชุมชน เพื่อดูรายการเครื่องหมายที่มีอยู่ พร้อมด้วย ID ของเครื่องหมาย โปรดทราบว่า # ใน URL จะต้องได้รับการเข้ารหัส URL

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


ปิดใช้งานสมาชิก

จำเป็นต้องใช้โทเค็นการเข้าถึงที่มีสิทธิ์การอนุญาตให้สิทธิ์บัญชีผู้ใช้

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


ลบสมาชิก

จำเป็นต้องใช้โทเค็นการเข้าถึงที่มีสิทธิ์การอนุญาตให้สิทธิ์บัญชีผู้ใช้

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

จะมีเฉพาะสมาชิกที่ยังไม่ได้ขอรับสิทธิ์เท่านั้นที่สามารถลบได้

รับข้อมูลสถานะบุคลากรหน้างานของผู้ใช้

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