Method: users.batchGet

Bir kullanıcı listesi için RCS'nin etkinleştirildiği telefon numaralarını alır.

Döndürülen yük, belirtilen kullanıcılar için RCS for Business platformu üzerinden erişilebilen, RCS özellikli telefon numaralarının listesini içerir. Yalnızca aracının başlatıldığı operatörde RCS etkinleştirilmiş telefon numaraları döndürülür.

Döndürülen yük, aracının lansman durumundan bağımsız olarak bir telefon numarası listesinin potansiyel erişimini tahmin etmek için kullanılabilecek değerleri de içerir.

Dakikada en fazla 600 sorgu (QPM).

Önemli: users.batchGet yöntemi, bölgesel uç noktaların kullanılmasını gerektirir. İstekler, tek bir coğrafi bölgedeki telefon numaralarını içermelidir. Tek bir istekte birden fazla bölgeden telefon numarası göndermek veya yanlış bölgesel uç noktaya göndermek 400 Bad Request hatasına neden olur.

Bölgesel uç noktalar:

HTTP isteği

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

URL, gRPC Kod Dönüştürme söz dizimini kullanır.

İstek metni

İstek içeriği aşağıdaki yapıyla birlikte verileri içerir:

JSON gösterimi 
{
  "users": [
    string
  ],
  "agentId": string
}
Alanlar
users[]

string

Kullanıcıların telefon numaralarının E.164 biçimindeki listesi.

Tek bir istekteki tüm telefon numaraları aynı coğrafi bölgeye ait olmalıdır. Birden fazla bölgeden telefon numarası içeren veya yanlış bölgesel uç noktaya gönderilen istekler 400 Bad Request hatasıyla başarısız olur.
agentId

string

Zorunlu. Temsilcinin benzersiz tanımlayıcısı.

Yanıt metni

İşletmeler için RCS'ye yönelik kullanıcı erişilebilirliği verilerini içeren yanıt.

Başarılı olursa yanıt metni aşağıdaki yapıyla birlikte verileri içerir:

JSON gösterimi 
{
  "reachableUsers": [
    string
  ],
  "totalRandomSampleUserCount": integer,
  "reachableRandomSampleUserCount": integer,
  "reachableUsersMap": {
    string: {
      object (ReachableUsers)
    },
    ...
  }
}
Alanlar
reachableUsers[]

string

İşletmeler için RCS'nin ulaşabileceği kullanıcıların telefon numaralarının listesi. Yalnızca temsilcinin başlatıldığı operatörlerdeki kullanıcıları içerir.
totalRandomSampleUserCount

integer

reachableUsers arasından rastgele seçilen telefon numaralarının sayısı. Genellikle bu değer, istenen toplam telefon numaralarının yaklaşık% 75'idir. İstenen telefon numaralarının sayısı 500'den azsa bu değer 0 olur.
reachableRandomSampleUserCount

integer

Temsilcinin kullanıma sunulma durumundan bağımsız olarak, rastgele seçilen listedeki ve tüm operatörlerde RCS'ye ulaşılabilen telefon numaralarının sayısı. Bu değer ile totalRandomSampleUserCount arasındaki oran, bir kullanıcı listesinin potansiyel erişimini yaklaşık olarak belirleyebilir.
reachableUsersMap

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

Yalnızca çıkış. Operatör kimliğinin, söz konusu operatörde ulaşılabilir kullanıcıların listesiyle eşlemesi. Bu alan yalnızca ABD telefon numaraları için doldurulur.

Yetkilendirme kapsamları

Aşağıdaki OAuth kapsamını gerektirir:

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

Daha fazla bilgi için OAuth 2.0 Overview sayfasına bakın.

ReachableUsers

Belirli bir operatördeki ulaşılabilir kullanıcıların listesi.

JSON gösterimi 
{
  "reachableUsers": [
    string
  ]
}
Alanlar
reachableUsers[]

string

Belirli bir operatördeki ulaşılabilir kullanıcıların listesi. Bu alan yalnızca ABD telefon numaraları için doldurulur.