Method: users.batchGet

Mendapatkan nomor telepon yang mendukung RCS untuk daftar pengguna.

Payload yang ditampilkan berisi daftar nomor telepon yang mendukung RCS yang dapat dijangkau oleh platform RBM untuk pengguna yang ditentukan. Hanya nomor telepon dengan RCS yang diaktifkan untuk operator tempat agen diluncurkan yang akan ditampilkan.

Payload yang ditampilkan juga berisi nilai yang dapat digunakan untuk memperkirakan potensi jangkauan daftar nomor telepon, terlepas dari status peluncuran agen.

Maksimum 600 kueri per menit (QPM).

Permintaan HTTP

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

URL menggunakan sintaksis gRPC Transcoding.

Isi permintaan

Isi permintaan memuat data dengan struktur berikut:

Representasi JSON 
{
  "users": [
    string
  ],
  "agentId": string
}
Kolom
users[]

string

Daftar nomor telepon pengguna dalam format E.164.
agentId

string

Wajib. ID unik agen.

Isi respons

Respons dengan data pengguna jangkauan RBM.

Jika berhasil, isi respons memuat data dengan struktur berikut:

Representasi JSON 
{
  "reachableUsers": [
    string
  ],
  "totalRandomSampleUserCount": integer,
  "reachableRandomSampleUserCount": integer
}
Kolom
reachableUsers[]

string

Daftar nomor telepon pengguna yang dapat dihubungi RBM. Hanya menyertakan pengguna di operator tempat agen diluncurkan.
totalRandomSampleUserCount

integer

Jumlah nomor telepon yang dipilih secara acak dari reachableUsers. Biasanya, nilai ini adalah ~75% dari total nomor telepon yang diminta. Nilai ini adalah 0 jika jumlah nomor telepon yang diminta kurang dari 500.
reachableRandomSampleUserCount

integer

Jumlah nomor telepon dari daftar yang dipilih secara acak yang dapat dijangkau RCS di semua operator, terlepas dari status peluncuran agen. Rasio antara nilai ini dan totalRandomSampleUserCount dapat memperkirakan potensi jangkauan untuk daftar pengguna.

Cakupan otorisasi

Memerlukan cakupan OAuth berikut ini:

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

Untuk informasi selengkapnya, lihat Ringkasan OAuth 2.0.