วัตถุ

ข้อมูลอ้างอิงบริษัท

ระบุบริษัทแต่ละแห่ง

ชื่อช่อง ประเภทข้อมูล คำอธิบาย
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 ต้องมีช่องต่อไปนี้ 1 ช่อง

  • 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 ค่าที่อนุญาตจะแสดงอยู่ในโมเดล

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

ทรัพยากรนี้มีสถานะการเรียก 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 ช่องอื่นๆ ในคู่คีย์-ค่าที่ระบุโดยผู้ให้บริการ

ข้อผิดพลาดเกี่ยวกับอุปกรณ์

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

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

ข้อยกเว้นทั่วไป

ข้อยกเว้นที่ API แบบพร้อมกันทั้งหมดส่งได้

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

ข้อผิดพลาด

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

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

รหัสข้อผิดพลาด

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

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