วัตถุ

CompanyReference

ระบุบริษัทโดยไม่ซ้ำกัน

ชื่อช่อง ประเภทข้อมูล คำอธิบาย
companyId string เอาต์พุตเท่านั้น รหัสของบริษัทที่เซิร์ฟเวอร์กำหนด
vendor enum Samsung หรือ Google

บริษัท

แสดงบริษัท

ชื่อช่อง ประเภทข้อมูล คำอธิบาย
companyReference object(CompanyReference) ออบเจ็กต์อ้างอิงบริษัท
companyName string ชื่อบริษัท เช่น XYZ Corp แสดงต่อพนักงานของบริษัทในพอร์ทัลการตั้งค่าอุปกรณ์พร้อมใช้แบบรวมกลุ่ม
vendorParams map ฟิลด์เพิ่มเติมในคู่คีย์-ค่าที่ระบุผู้ให้บริการ

อุปกรณ์

อุปกรณ์ Android ที่ลงทะเบียนลงทะเบียน

ชื่อช่อง ประเภทข้อมูล คำอธิบาย
deviceId string เอาต์พุตเท่านั้น รหัสของอุปกรณ์ที่เซิร์ฟเวอร์กำหนด
deviceIdentifier object(DeviceIdentifier) รหัสฮาร์ดแวร์ที่ระบุอุปกรณ์ที่ผลิต
customer object(CompanyReference) รหัสบริษัทที่ระบุว่ากำหนดอุปกรณ์ให้บริษัทใด
orderNumber string หมายเลขคำสั่งซื้อ
vendorParams map ฟิลด์เพิ่มเติมในคู่คีย์-ค่าที่ระบุผู้ให้บริการ

DeviceIdentifier

ห่อหุ้มฮาร์ดแวร์และรหัสผลิตภัณฑ์เพื่อระบุอุปกรณ์ของผู้ผลิต

อุปกรณ์ Samsung ต้องมีช่องต่อไปนี้หนึ่งช่อง

  • IMEI
  • serialNumber
  • meid

ระบบจะไม่สนใจช่องอื่นๆ ทั้งหมด เช่น model

สำหรับอุปกรณ์ Android อื่นๆ ทั้งหมด

  • อุปกรณ์มือถือต้องใช้ imei และ manufacturer
  • อุปกรณ์ที่มีเฉพาะ Wi-Fi ต้องใช้ serialNumber, manufacturer และ model
ชื่อช่อง ประเภทข้อมูล คำอธิบาย
imei string หมายเลข IMEI ของอุปกรณ์ ตรวจสอบอินพุตแล้ว
serialNumber string หมายเลขซีเรียลของผู้ผลิตสำหรับอุปกรณ์ ค่านี้อาจไม่ซ้ำกันในอุปกรณ์รุ่นต่างๆ
meid string หมายเลข MEID ของอุปกรณ์
manufacturer string ชื่อผู้ผลิตอุปกรณ์ ตรงกับค่าในตัวของอุปกรณ์ที่แสดงผลจาก android.os.Build.MANUFACTURER ค่าที่อนุญาตแสดงอยู่ในผู้ผลิต
model string ชื่อรุ่นอุปกรณ์ ตรงกับค่าในตัวของอุปกรณ์ที่แสดงผลจาก android.os.Build.MODEL ค่าที่อนุญาตจะแสดงใน models

การดำเนินการ

ทรัพยากรนี้มีสถานะของการเรียก API แบบอะซิงโครนัส มี 4 อย่าง สถานะที่เป็นไปได้:

  • IN_PROGRESS: อยู่ระหว่างดำเนินการ
  • COMPLETE: ประมวลผลอุปกรณ์ทั้งหมดเรียบร้อยแล้ว
  • COMPLETE_WITH_ERRORS: ประมวลผลการดำเนินการแล้ว แต่เกิดข้อผิดพลาดบางอย่าง ข้อผิดพลาดทั้งหมดจะแสดงอยู่ในรายการ deviceErrors
  • FAILED: การดำเนินการล้มเหลวและไม่แสดงผล operationId
ชื่อช่อง ประเภทข้อมูล คำอธิบาย
operationId string รหัสการดำเนินการ ขึ้นต้นด้วย samsung/ หรือ google/ หากเว้นว่างไว้ state จะเป็น FAILED
operationType enum(operationType) ประเภทการดำเนินการ: CLAIM_DEVICES หรือ UNCLAIM_DEVICES
state enum(operationState) สถานะการดำเนินการ: IN_PROGRESS, COMPLETE, COMPLETE_WITH_ERRORS, FAILED
deviceErrors รายการของ object(DeviceOperationError) รายการข้อผิดพลาดในการดำเนินการของอุปกรณ์
vendorParams map ฟิลด์เพิ่มเติมในคู่คีย์-ค่าที่ระบุผู้ให้บริการ

DeviceOperationError

ข้อผิดพลาดเฉพาะอุปกรณ์ใน Operation ทรัพยากรแต่ละรายการจะมี deviceId และ deviceIdentifier เป็นคำขอที่เริ่มการดำเนินการ

ชื่อช่อง ประเภทข้อมูล คำอธิบาย
deviceId string เอาต์พุตเท่านั้น รหัสของอุปกรณ์ที่เซิร์ฟเวอร์กำหนด
deviceIdentifier object(DeviceIdentifier) รหัสฮาร์ดแวร์ที่ระบุอุปกรณ์ที่ผลิต
error object(Error) ข้อผิดพลาดในการดําเนินการของอุปกรณ์

CommonException

ข้อยกเว้นที่ API แบบซิงโครนัสทั้งหมดสามารถส่งได้

ชื่อพร็อพเพอร์ตี้ ค่า คำอธิบาย
error object(Error) ข้อผิดพลาดของการดำเนินการแบบซิงโครนัส

ข้อผิดพลาด

ออบเจ็กต์ที่มีรายละเอียดเกี่ยวกับข้อผิดพลาด

ชื่อพร็อพเพอร์ตี้ ค่า คำอธิบาย
code enum(ErrorCode) รหัสข้อผิดพลาด เช่น INVALID_REQUESET หรือ PERMISSION_DENIED
message string ข้อความแสดงข้อผิดพลาด
vendorMsg string คำอธิบายโดยละเอียดเกี่ยวกับข้อผิดพลาดจากผู้ให้บริการ
errorId string ตัวระบุข้อผิดพลาดภายใน
vendorParams map ฟิลด์เพิ่มเติมในคู่คีย์-ค่าที่ระบุผู้ให้บริการ

ErrorCode

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

ค่าแจกแจง คำอธิบาย
INVALID_PARAM_DEFAULT พารามิเตอร์อินพุตที่ไม่ถูกต้องที่ไม่ได้ระบุ โปรดดูรายละเอียดเพิ่มเติมที่ sellersMsg
INVALID_PAGE_TOKEN PageToken ที่ระบุไม่ถูกต้อง
INVALID_CUSTOMER_ID CustomerId ที่ระบุไม่ถูกต้อง
INVALID_DEVICE_IMEI IMEI ไม่ถูกต้อง
INVALID_DEVICE_MEID MEID ไม่ถูกต้อง
INVALID_DEVICE_SERIAL หมายเลขซีเรียลไม่ถูกต้อง
INVALID_OPERATION_ID OperationsId ที่ระบุไม่ถูกต้อง
INVALID_RESELLER_ID รหัสตัวแทนจำหน่ายที่ระบุไม่ถูกต้อง
INVALID_MANUFACTURER ผู้ผลิตที่ระบุไม่ถูกต้อง / ไม่รองรับ
INVALID_IDENTIFIER_SET ชุดของตัวระบุที่ระบุไม่เพียงพอต่อคำขอ ดูข้อมูลเพิ่มเติมเกี่ยวกับชุดตัวระบุที่อนุญาตได้ที่ DeviceIdentifier
INVALID_MODEL โมเดลที่ระบุไม่ถูกต้อง / ไม่รองรับ
INVALID_DEVICE_ID deviceId ที่ระบุไม่ถูกต้อง
INVALID_DEVICE ไม่มีอุปกรณ์ที่ระบุ นี่เป็นรหัสข้อผิดพลาดของ Samsung
DUPLICATE_DEVICE ก่อนหน้านี้มีการอ้างสิทธิ์อุปกรณ์กับลูกค้ารายเดียวกันแล้ว ไม่ต้องทำการแก้ไขใดๆ
DEVICE_UPLOAD_COUNT_EXCEEDED คำขอมีอุปกรณ์เพิ่มเติมตามจำนวนที่จำกัดไว้ (ปัจจุบันคือ 100k)
AUTHORIZATION_FAIL คุณไม่มีสิทธิ์เข้าถึงทรัพยากรที่ระบุ (เช่น อุปกรณ์ ลูกค้า) หรือไม่มีทรัพยากรดังกล่าว ดูรายละเอียดเพิ่มเติมที่ vendorMsg
INTERNAL_SERVER_ERROR ข้อผิดพลาดภายในเซิร์ฟเวอร์ที่ไม่ระบุ โปรดดูรายละเอียดเพิ่มเติมที่VendorMsg ทั้งนี้ คุณจะลองส่งคำขอเหล่านี้อีกครั้งได้ ทั้งนี้ขึ้นอยู่กับลักษณะของข้อผิดพลาดของเซิร์ฟเวอร์
NOT_IMPLEMENTED เซิร์ฟเวอร์ไม่สนับสนุนวิธีการส่งคำขอ