Method: users.batchGet

Lấy số điện thoại có hỗ trợ RCS cho danh sách người dùng.

Tải trọng được trả về chứa danh sách số điện thoại có hỗ trợ RCS mà nền tảng RCS for Business có thể liên hệ với người dùng được chỉ định. Chỉ những số điện thoại đã bật RCS cho nhà mạng mà bạn khởi chạy tác nhân mới được trả về.

Tải trọng được trả về cũng chứa các giá trị có thể dùng để ước tính phạm vi tiếp cận tiềm năng của một danh sách số điện thoại, bất kể trạng thái ra mắt của tác nhân.

Tối đa 600 truy vấn mỗi phút (QPM).

Quan trọng: Phương thức users.batchGet yêu cầu sử dụng các điểm cuối theo khu vực. Các yêu cầu phải chứa số điện thoại của một khu vực địa lý duy nhất. Việc gửi số điện thoại từ nhiều khu vực trong một yêu cầu hoặc gửi đến điểm cuối khu vực không chính xác sẽ dẫn đến lỗi 400 Bad Request.

Điểm cuối theo khu vực:

Yêu cầu HTTP

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

URL sử dụng cú pháp Chuyển mã gRPC.

Nội dung yêu cầu

Nội dung yêu cầu chứa dữ liệu với cấu trúc sau:

Biểu diễn dưới dạng JSON 
{
  "users": [
    string
  ],
  "agentId": string
}
Trường
users[]

string

Danh sách số điện thoại của người dùng ở định dạng E.164.

Tất cả số điện thoại trong một yêu cầu phải thuộc cùng một khu vực địa lý. Những yêu cầu chứa số điện thoại của nhiều khu vực hoặc được gửi đến điểm cuối khu vực không chính xác sẽ gặp lỗi 400 Bad Request.
agentId

string

Bắt buộc. Giá trị nhận dạng riêng biệt của nhân viên.

Nội dung phản hồi

Phản hồi bằng dữ liệu về khả năng tiếp cận người dùng cho RCS cho Doanh nghiệp.

Nếu thành công, phần nội dung phản hồi sẽ chứa dữ liệu có cấu trúc sau:

Biểu diễn dưới dạng JSON 
{
  "reachableUsers": [
    string
  ],
  "totalRandomSampleUserCount": integer,
  "reachableRandomSampleUserCount": integer,
  "reachableUsersMap": {
    string: {
      object (ReachableUsers)
    },
    ...
  }
}
Trường
reachableUsers[]

string

Danh sách số điện thoại của người dùng mà RCS cho Doanh nghiệp có thể liên hệ. Chỉ bao gồm những người dùng sử dụng nhà mạng mà nhân viên hỗ trợ được ra mắt.
totalRandomSampleUserCount

integer

Số lượng số điện thoại được chọn ngẫu nhiên từ reachableUsers. Thông thường, giá trị này bằng khoảng 75% tổng số điện thoại được yêu cầu. Giá trị này là 0 nếu số lượng số điện thoại được yêu cầu nhỏ hơn 500.
reachableRandomSampleUserCount

integer

Số lượng số điện thoại trong danh sách được chọn ngẫu nhiên có thể sử dụng RCS trên tất cả các nhà mạng, bất kể trạng thái ra mắt của tác nhân. Tỷ lệ giữa giá trị này và totalRandomSampleUserCount có thể ước tính phạm vi tiếp cận tiềm năng cho một danh sách người dùng.
reachableUsersMap

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

Chỉ có đầu ra. Mối liên kết giữa mã nhận dạng nhà mạng với danh sách người dùng có thể liên hệ trên nhà mạng đó. Trường này chỉ được điền sẵn cho số điện thoại ở Hoa Kỳ.

Phạm vi uỷ quyền

Yêu cầu phạm vi OAuth sau:

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

Để biết thêm thông tin, hãy xem OAuth 2.0 Overview.

ReachableUsers

Danh sách người dùng có thể liên hệ trên một nhà mạng cụ thể.

Biểu diễn dưới dạng JSON 
{
  "reachableUsers": [
    string
  ]
}
Trường
reachableUsers[]

string

Danh sách người dùng có thể liên hệ trên một nhà mạng cụ thể. Trường này chỉ được điền sẵn cho số điện thoại ở Hoa Kỳ.