เรากำลังเลิกใช้งาน API ภายในองค์กร และหากต้องการรายละเอียดเพิ่มเติมและเรียนรู้วิธีย้ายไปใช้ API ระบบคลาวด์รุ่นใหม่ของเรา โปรดดูเอกสารการเลิกใช้งาน API ภายในองค์กรของเรา

ผู้ใช้

/v1/users

ใช้โหนด users เพื่อจัดการการยืนยันตัวตนและเข้าถึงไคลเอ็นต์ WhatsApp Business API ภายในองค์กร

ก่อนเริ่มต้น

ไคลเอ็นต์ WhatsApp Business API ภายในองค์กรมีบัญชีเริ่มต้น โดยชื่อผู้ใช้ของบัญชีคือ admin และมีรหัสผ่านว่า secret บัญชีนี้ไม่สามารถลบหรือนำออกจากระบบได้ คุณต้องเปลี่ยนรหัสผ่านของผู้ดูแลในทันที เนื่องจากเหตุผลด้านการรักษาความปลอดภัย

หากคุณลืมรหัสผ่าน โปรดติดต่อขอความช่วยเหลือโดยตรงในการรีเซ็ตรหัสผ่าน

ข้อจำกัด

  • เฉพาะบัญชี admin เท่านั้นที่สามารถสร้างหรือลบผู้ใช้ได้

คำแนะนำ

  • ใช้บัญชี admin เท่านั้นในการสร้างหรือลบผู้ใช้
  • สร้างบัญชีผู้ใช้เพื่อจัดการไคลเอ็นต์ WhatsApp Business API ภายในองค์กร

การสร้าง

หากคุณต้องการสร้างบัญชีให้แก่ผู้ใช้ในธุรกิจของคุณซึ่งสามารถเข้าถึง WhatsApp Business API ได้ ให้ส่งชื่อผู้ใช้และรหัสผ่านไปยังไคลเอ็นต์ WhatsApp Business API ภายในองค์กรโดยใช้ตำแหน่งข้อมูล /users ระบบจะตรวจสอบความถูกต้องของชื่อผู้ใช้และรหัสผ่าน แล้วสร้างบัญชีใหม่หากยังไม่มีบัญชีที่ใช้ชื่อผู้ใช้ดังกล่าว รหัสผ่านจะได้รับการดำเนินการด้วยการแฮชทางเดียวและจัดเก็บไว้ในไดรฟ์ข้อมูล ทั้ง username และ password เป็นพารามิเตอร์ที่จำเป็นต้องระบุ

ตัวอย่าง

หากต้องการสร้างผู้ใช้ ให้ส่งคำขอในลักษณะดังต่อไปนี้

POST /v1/users
Authorization: Bearer your-auth-token

{
  "username": "username",
  "password": "password"
}

หากส่งคำขอสำเร็จและสร้างบัญชีผู้ใช้แล้ว คุณจะได้รับรหัสสถานะ HTTP เป็น 201 Created และเพย์โหลดดังต่อไปนี้

{
  "users": [{
     "username": "username"
  }]
}

หากส่งคำขอไม่สำเร็จ คุณจะได้รับรหัสสถานะ HTTP พร้อมกับรหัสข้อผิดพลาด WhatsApp หากคุณส่งชื่อผู้ใช้ซ้ำ การตอบกลับที่บ่งบอกถึงข้อผิดพลาดจะมีลักษณะดังต่อไปนี้

{
  "errors": [{
    "code": 1014,
    "title": "Internal error",
    "details": "Unable to create user. Already exist?"
  }]
}

พารามิเตอร์

ชื่อคำอธิบาย

username

จำเป็นต้องระบุ

ต้องประกอบด้วยอักขระอย่างน้อย 4 ตัวและไม่เกิน 32 ตัว
สร้างเทมเพลตสำหรับ username เช่น ตัวอักษรตัวแรกของชื่อพร้อมกับนามสกุล เพื่อหลีกเลี่ยงการสร้างหลายบัญชีสำหรับบุคคลคนเดียวกัน

password

จำเป็นต้องระบุ

ต้องประกอบด้วยอักขระ 8 ถึง 64 ตัว และอักขระอย่างน้อยหนึ่งตัวจะต้องเป็นตัวพิมพ์ใหญ่ ตัวพิมพ์เล็ก ตัวเลข และอักขระพิเศษดังต่อไปนี้


!\/'"#$%&()*+-.,:;_<>=?@[]{}^`|~

Authorization

จำเป็นต้องระบุ

โทเค็นการยืนยันตัวตนสำหรับผู้ดูแลที่กำลังดำเนินการส่งคำขอ โปรดดูข้อมูลเพิ่มเติมในเอกสารประกอบเรื่องการเข้าสู่ระบบและการยืนยันตัวตน — โทเค็น

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

จุดเชื่อมโยงต่อไปนี้เชื่อมต่อกับโหนดนี้

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

/users/login

ใช้จุดเชื่อมโยงนี้เพื่อเข้าสู่ระบบของไคลเอ็นต์ WhatsApp Business API ภายในองค์กร

/users/logout

ใช้จุดเชื่อมโยงนี้เพื่อออกจากระบบของไคลเอ็นต์ WhatsApp Business API ภายในองค์กร

/users/{username}

ใช้จุดเชื่อมโยงนี้เพื่อเรียกใช้ อัพเดต หรือลบบัญชีผู้ใช้

ข้อผิดพลาดที่พบบ่อย

รหัสสถานะ HTTPสาเหตุ

400

  • รหัสผ่านสั้นเกินไป (อักขระน้อยกว่า 8 ตัว) หรือยาวเกินไป (อักขระมากกว่า 64 ตัว)
  • ชื่อผู้ใช้สั้นเกินไป (อักขระน้อยกว่า 4 ตัว) หรือยาวเกินไป (อักขระมากกว่า 32 ตัว)

ส่งคำขออีกครั้งด้วยชื่อผู้ใช้/รหัสผ่านที่มีความยาวเหมาะสม

403

คุณไม่ได้ใช้บัญชี admin ในการสร้างบัญชีผู้ใช้อยู่

500

ไม่สามารถสร้างบัญชีได้ อาจเป็นเพราะมีบัญชีดังกล่าวอยู่แล้ว

หากการตอบกลับมีข้อผิดพลาดอื่นๆ โปรดดูข้อมูลเพิ่มเติมจากแหล่งข้อมูลต่อไปนี้ ได้แก่ รหัสข้อผิดพลาดและรหัสสถานะ HTTP