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 RCS for Business untuk pengguna yang ditentukan. Hanya nomor telepon yang mendukung RCS 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).

Penting: Metode users.batchGet memerlukan penggunaan endpoint regional. Permintaan harus berisi nomor telepon dari satu wilayah geografis. Mengirim nomor telepon dari beberapa wilayah dalam satu permintaan atau dikirim ke endpoint regional yang salah akan menghasilkan error 400 Bad Request.

Endpoint regional:

Permintaan HTTP

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

URL ini 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.

Semua nomor telepon dalam satu permintaan harus berasal dari wilayah geografis yang sama. Permintaan yang berisi nomor telepon dari beberapa wilayah atau dikirim ke endpoint regional yang salah akan gagal dengan error 400 Bad Request.
agentId

string

Wajib. ID unik agen.

Isi respons

Respons dengan data jangkauan pengguna untuk RCS for Business.

Jika berhasil, isi respons memuat data dengan struktur berikut:

Representasi JSON 
{
  "reachableUsers": [
    string
  ],
  "totalRandomSampleUserCount": integer,
  "reachableRandomSampleUserCount": integer,
  "reachableUsersMap": {
    string: {
      object (ReachableUsers)
    },
    ...
  }
}
Kolom
reachableUsers[]

string

Daftar nomor telepon pengguna yang dapat dijangkau oleh RCS for Business. 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 oleh RCS di semua operator, terlepas dari status peluncuran agen. Rasio antara nilai ini dan totalRandomSampleUserCount dapat memperkirakan potensi jangkauan untuk daftar pengguna.
reachableUsersMap

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

Hanya output. Peta ID operator ke daftar pengguna yang dapat dijangkau di operator tersebut. Kolom ini hanya diisi untuk nomor telepon AS.

Cakupan otorisasi

Memerlukan cakupan OAuth berikut:

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

Untuk mengetahui informasi selengkapnya, lihat OAuth 2.0 Overview.

ReachableUsers

Daftar pengguna yang dapat dijangkau di operator tertentu.

Representasi JSON 
{
  "reachableUsers": [
    string
  ]
}
Kolom
reachableUsers[]

string

Daftar pengguna yang dapat dijangkau di operator tertentu. Kolom ini hanya diisi untuk nomor telepon AS.