Method: users.batchGet

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

เพย์โหลดที่ส่งคืนจะมีรายการหมายเลขโทรศัพท์ที่เปิดใช้ RCS ซึ่งแพลตฟอร์ม RCS สำหรับธุรกิจเข้าถึงได้สำหรับผู้ใช้ที่ระบุ ระบบจะแสดงเฉพาะหมายเลขโทรศัพท์ที่เปิดใช้ 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

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

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

การตอบกลับพร้อมข้อมูลความสามารถในการเข้าถึงผู้ใช้สำหรับ RCS สำหรับธุรกิจ

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

การแสดง JSON 
{
  "reachableUsers": [
    string
  ],
  "totalRandomSampleUserCount": integer,
  "reachableRandomSampleUserCount": integer,
  "reachableUsersMap": {
    string: {
      object (ReachableUsers)
    },
    ...
  }
}
ช่อง
reachableUsers[]

string

รายชื่อหมายเลขโทรศัพท์ของผู้ใช้ที่ RCS for Business ติดต่อได้ รวมเฉพาะผู้ใช้ในผู้ให้บริการที่เปิดตัวเอเจนต์
totalRandomSampleUserCount

integer

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

integer

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

map (key: string, value: object (ReachableUsers))

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

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

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

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

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

ReachableUsers

รายชื่อผู้ใช้ที่เข้าถึงได้ในผู้ให้บริการรายหนึ่งๆ

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

string

รายชื่อผู้ใช้ที่เข้าถึงได้ในผู้ให้บริการรายหนึ่งๆ ช่องนี้จะแสดงข้อมูลสำหรับหมายเลขโทรศัพท์ในสหรัฐอเมริกาเท่านั้น