go workwx

ไป-workwx (v2)

โครงการนี้ต้องการความช่วยเหลือจากคุณ!

 import (
    "github.com/xen0n/go-workwx/v2" // package workwx
)

SDK ไคลเอนต์ Work Weixin (หรือที่เรียกว่า Wechat Work) สำหรับ Golang ที่ได้รับการทดสอบการต่อสู้และค่อนข้างจริงจังกับประเภทของมัน

ดำเนินการผลิตตั้งแต่ปลายปี 2018 โดยพุชการแจ้งเตือนทุกประเภทในระบบภายในของ Qiniu อย่างน้อย 2 ระบบ

SDK ไคลเอนต์ WeChat ขององค์กร Golang ฉันได้ลองใช้ในสภาพแวดล้อมการใช้งานจริงและจริงจังกับประเภทต่างๆ มาก

นับตั้งแต่สิ้นปี 2018 เป็นต้นมา มีการใช้ระบบภายในอย่างน้อยสองระบบใน Qiniu มาจนถึงทุกวันนี้ โดยส่งการแจ้งเตือนและการเตือนภัยต่างๆ

TODO แปลเป็นภาษาอังกฤษในขณะนี้ เนื่องจากบริการที่ครอบคลุมในที่นี้ไม่พร้อมให้บริการนอกประเทศจีน (AFAIK)

คำเตือน

ไลบรารีเวอร์ชัน v2 นี้อาจยังมีการเปลี่ยนแปลง API ที่เข้ากันไม่ได้ เช่น การปรับเปลี่ยนชื่อฟิลด์ ชื่อเมธอด ฯลฯ โปรดทราบ จะไม่มีแท็กเวอร์ชัน v2 จนกว่าเราจะจัดการมุมที่ทราบทั้งหมดแล้ว

หากคุณพึ่งพาไลบรารีนี้ โปรดตอบกลับตั๋วติดตามเวอร์ชัน v2 หรือแสดงปฏิกิริยาอิโมติคอนเพื่อแสดงทัศนคติของคุณ! ขณะนี้ผู้เขียนดูแลโครงการนี้ในช่วงเวลาว่างและต้องการคำติชมจากคุณจริงๆ

ทำไมต้องล้ออีก?

ฉันจำเป็นต้องใช้ Go เพื่อใช้งานการพุชข้อความแบบง่ายๆ ในที่ทำงาน และฉันก็คิดที่จะค้นหาไลบรารีโอเพ่นซอร์ส อย่างไรก็ตาม คุณภาพของโค้ดของ WeChat Golang SDK สำหรับองค์กรโอเพ่นซอร์สเพียงตัวเดียวที่มีอยู่นั้นไม่ดี ฉันต้องเขียนด้วยตัวเอง

อัปเดต : ห้องสมุดนี้ถูกเขียนมานานแล้ว ตอนนี้ (2019.08) มีโครงการที่คล้ายกันสามหรือสี่โครงการ อย่างไรก็ตาม หลังจากดู "ผลิตภัณฑ์คู่แข่ง" เหล่านี้แล้ว ฉันพบว่าการออกแบบประเภท อินเทอร์เฟซสาธารณะ การประมวลผลโทเค็นการเข้าถึง ฯลฯ ของไลบรารีของฉันก็ถือว่าไม่แย่ เหตุใดผู้คนจึงชอบฮาร์ดโค้ดคำขอ Host ใช้ตัวแปรโกลบอล คลายแพ็กเพื่อคลายแพ็ก และแม้แต่เปิดเผยวิธีการภายใน

รุ่น Go ที่รองรับ

สาขา v2.x ของไลบรารีนี้รองรับ Go เวอร์ชันเสถียรล่าสุดเป็นอย่างน้อย ซึ่งปัจจุบันคือ go1.19 หากคุณต้องการใช้กับ Go เวอร์ชันก่อนหน้า โปรดย้ายไปที่เวอร์ชัน v1.x โค้ดที่นั่นยังรองรับ go1.17 เป็นอย่างน้อย

CI จะทำการทดสอบบน Go เวอร์ชันเสถียรปัจจุบันและเวอร์ชันเสถียรก่อนหน้าเท่านั้นที่สามารถรวม PR ได้เมื่อการทดสอบทั้งหมดผ่าน

หมายเหตุ: เนื่องจาก Go upstream มีการพัฒนาอย่างต่อเนื่อง เราจึงต้องมั่นใจว่าจะตามทันได้ในราคาถูก หาก go.mod ระบุว่าเวอร์ชัน Go ค่อนข้างต่ำ ซึ่งจะขัดขวางการทำงานซ้ำหรือการสร้างใหม่ของโปรเจ็กต์ เราจะไม่พิจารณาเป็นพิเศษในการล็อกผู้ใช้ดาวน์สตรีมของเวอร์ชัน Go เพื่อทำให้การอัพเกรดที่จำเป็นมากช้าลง หากคุณยังคงมีความต้องการดังกล่าว โปรดแจ้งปัญหาเพื่อการสื่อสาร

คุณสมบัติ

ชื่อแพ็คเกจสั้น
รองรับการครอบคลุมของ API Host ซึ่งสามารถใช้เพื่อบล็อกเกตเวย์หลายชั้น การดีบักชั่วคราว และความต้องการแปลกๆ อื่นๆ
รองรับการใช้ http.Client แบบกำหนดเอง
การประมวลผลโทเค็นการเข้าถึงมีความน่าเชื่อถือ
- คุณสามารถทำการเรียก API และโทเค็นการเข้าถึงจะถูกร้องขอโดยอัตโนมัติ
- คุณยังสร้างโทเค็นการเข้าถึงพื้นหลังด้วยโค้ดหนึ่งบรรทัดเพื่อรีเฟรช goroutine ได้ด้วย
- มาพร้อมกับการลองถอยกลับแบบเอ็กซ์โปเนนเชียล
ให้ความสำคัญกับประเภทและอินเทอร์เฟซสาธารณะอย่างจริงจัง
- อินเทอร์เฟซที่เปิดเผยต่อสาธารณะถูกย่อให้เล็กสุด ออบเจ็กต์ WorkwxApp ถูกสร้างขึ้นในสองขั้นตอน จากนั้นจึงใช้งานโดยตรง
- จงใจไม่เปิดเผยคำขออินเทอร์เฟซดั้งเดิมและประเภทการตอบกลับของ Enterprise WeChat
- ในอนาคต อาจมีการสร้างแพ็คเกจ lowlevel เพื่อแสดงอินเทอร์เฟซ API เปล่า แต่มีแนวโน้มว่าจะไม่ดำเนินการ
- แทนที่จะเป็นความหลากหลายเพื่อประโยชน์ของความหลากหลาย เราอยากจะทำซ้ำโค้ดภายใน SDK และรับรองว่าอินเทอร์เฟซเดียวและการดำเนินการประเภทเดียว โดยมีการจัดส่งแบบคงที่โดยผู้ใช้ดาวน์สตรีม
- โมเดลข้อมูลส่วนบุคคลได้รับการปรับหรือปรับปรุงใหม่ (เช่น UserInfo , Recipient ) เพื่อส่งเสริมสไตล์ Go แบบสำนวน
- เขา แทบ ไม่เคยก้าวข้ามอำนาจหรือ panic ของเขาเลยแม้แต่น้อย จำเป็นต้องซ่อมแซมสถานการณ์ที่มีอยู่บางส่วน
มาพร้อมกับโปรแกรมเบ็ดเตล็ดบรรทัดคำสั่ง workwxctl เพื่อช่วยในการดีบัก
- หากคุณไม่ชอบก็แจ้งปัญหาและแจ้งให้เราทราบว่าคุณคิดอย่างไร

สำหรับรายละเอียด โปรดดูเอกสาร godoc นอกจากนี้ยังมีตัวอย่างไว้เพื่อใช้อ้างอิงอีกด้วย

API ที่รองรับ

API การจัดการสมุดที่อยู่

API การติดต่อลูกค้า

API บริการลูกค้า WeChat

API การรับรองความถูกต้อง

รับการเข้าถึงข้อมูลระบุตัวตนของผู้ใช้

API การจัดการแอปพลิเคชัน

API การส่งข้อความ

ส่งข้อความแอพ
รับข้อความ
ส่งข้อความไปยังเซสชั่นการแชทเป็นกลุ่ม
- สร้างเซสชันการแชทกลุ่ม
- ปรับเปลี่ยนเซสชั่นการแชทกลุ่ม
- รับเซสชันการแชทเป็นกลุ่ม
- ข้อความพุชของแอปพลิเคชัน

ประเภทข้อความ

API การจัดการวัสดุ

อัปโหลดเนื้อหาชั่วคราว
อัปโหลดภาพถาวร
รับทรัพย์สินชั่วคราว
รับเนื้อหาเสียงที่มีความคมชัดสูง

โอเอ เอพีไอ

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

API การเก็บถาวรเนื้อหาเซสชัน

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

หมายเหตุ

เกี่ยวกับการส่งข้อความที่เป็นความลับ

ปัจจุบัน Markdown และข้อความประเภทอื่นๆ ไม่รองรับการส่งข้อความที่เป็นความลับ และจะมีการรายงานข้อผิดพลาดหากถูกบังคับให้ส่ง แล้วเหตุใดวิธีการส่งข้อความทั้งหมดจึงมีพารามิเตอร์ isSafe ?

ในด้านหนึ่ง ผู้ให้บริการ WeChat ระดับองค์กรมีแนวโน้มที่จะสนับสนุนการส่งข้อความประเภทอื่นๆ ที่เป็นความลับมากขึ้นในอนาคต และไม่ต้องการให้คอมไพล์รหัสไคลเอ็นต์ใหม่ในขณะนั้น ในทางกลับกัน การตอบกลับจะรายงาน ข้อผิดพลาดอยู่แล้ว และคุณจะไม่เก็บตรรกะนี้ไว้ ดังนั้นมันจะไม่มีการเปลี่ยนแปลง