Method: users.batchGet

รับหมายเลขโทรศัพท์ที่เปิดใช้ RCS สำหรับรายชื่อผู้ใช้

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

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

สูงสุด 600 คำค้นหาต่อนาที (QPM)

คำขอ HTTP

POST https://rcsbusinessmessaging.googleapis.com/v1/users:batchGet

URL ใช้ไวยากรณ์การแปลง gRPC

เนื้อความของคำขอ

เนื้อความของคำขอมีข้อมูลซึ่งมีโครงสร้างดังต่อไปนี้

การแสดง JSON 
{
  "users": [
    string
  ],
  "agentId": string
}
ช่อง
users[]

string

รายการหมายเลขโทรศัพท์ของผู้ใช้ในรูปแบบ E.164
agentId

string

ต้องระบุ ตัวระบุที่ไม่ซ้ำกันของตัวแทน

เนื้อหาการตอบกลับ

ตอบกลับพร้อมข้อมูลผู้ใช้สำหรับการเข้าถึงของ RBM

หากทำสำเร็จ เนื้อหาการตอบกลับจะมีข้อมูลซึ่งมีโครงสร้างดังต่อไปนี้

การแสดง JSON 
{
  "reachableUsers": [
    string
  ],
  "totalRandomSampleUserCount": integer,
  "reachableRandomSampleUserCount": integer
}
ช่อง
reachableUsers[]

string

รายการหมายเลขโทรศัพท์ของผู้ใช้ที่ RBM สามารถเข้าถึงได้ รวมเฉพาะผู้ใช้ในผู้ให้บริการที่มีการเปิดใช้งานตัวแทนเท่านั้น
totalRandomSampleUserCount

integer

จำนวนหมายเลขโทรศัพท์ที่สุ่มเลือกจาก reachableUsers โดยปกติแล้วค่านี้จะอยู่ที่ประมาณ 75% ของหมายเลขโทรศัพท์ทั้งหมดที่ขอ ค่านี้จะเป็น 0 หากจำนวนหมายเลขโทรศัพท์ที่ขอน้อยกว่า 500
reachableRandomSampleUserCount

integer

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

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth ต่อไปนี้

  • https://www.googleapis.com/auth/rcsbusinessmessaging

ดูข้อมูลเพิ่มเติมได้ที่ OAuth 2.0 Overview