Method: users.batchGet

उपयोगकर्ताओं की सूची के लिए, आरसीएस की सुविधा वाले फ़ोन नंबर मिलते हैं.

जवाब के तौर पर मिले पेलोड में, उन फ़ोन नंबर की सूची होती है जिन पर RCS की सुविधा चालू है. साथ ही, उन पर RCS for Business प्लैटफ़ॉर्म से संपर्क किया जा सकता है. यह सूची, चुने गए उपयोगकर्ताओं के लिए होती है. सिर्फ़ उन फ़ोन नंबरों की जानकारी दी जाएगी जिनके लिए, एजेंट को लॉन्च करने वाली कंपनी की आरसीएस सेवा चालू है.

जवाब के तौर पर मिले पेलोड में ऐसी वैल्यू भी होती हैं जिनका इस्तेमाल, फ़ोन नंबर की सूची की संभावित पहुंच का अनुमान लगाने के लिए किया जा सकता है. इससे कोई फ़र्क़ नहीं पड़ता कि एजेंट ने सुविधा लॉन्च की है या नहीं.

ज़्यादा से ज़्यादा 600 क्वेरी प्रति मिनट (क्यूपीएम).

एचटीटीपी अनुरोध

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

यह यूआरएल, gRPC ट्रांसकोडिंग सिंटैक्स का इस्तेमाल करता है.

अनुरोध का मुख्य भाग

अनुरोध के मुख्य हिस्से में, इस स्ट्रक्चर का डेटा शामिल होता है:

JSON के काेड में दिखाना 
{
  "users": [
    string
  ],
  "agentId": string
}
फ़ील्ड
users[]

string

उपयोगकर्ताओं के फ़ोन नंबर की सूची, E.164 फ़ॉर्मैट में.
agentId

string

ज़रूरी है. एजेंट का यूनीक आइडेंटिफ़ायर.

जवाब का मुख्य भाग

कारोबार के लिए आरसीएस की सुविधा का इस्तेमाल करने वाले उपयोगकर्ता की पहुंच से जुड़ा डेटा.

अगर एपीआई सही से जुड़ जाता है, ताे जवाब के मुख्य भाग में नीचे दिए गए स्ट्रक्चर शामिल होता है.

JSON के काेड में दिखाना 
{
  "reachableUsers": [
    string
  ],
  "totalRandomSampleUserCount": integer,
  "reachableRandomSampleUserCount": integer
}
फ़ील्ड
reachableUsers[]

string

उपयोगकर्ताओं के उन फ़ोन नंबरों की सूची जिन पर कारोबार के लिए आरसीएस की सुविधा के ज़रिए संपर्क किया जा सकता है. इसमें सिर्फ़ उन उपयोगकर्ताओं को शामिल किया जाता है जिनके लिए एजेंट लॉन्च किया गया है.
totalRandomSampleUserCount

integer

reachableUsers से चुने गए फ़ोन नंबर की संख्या. आम तौर पर, यह वैल्यू अनुरोध किए गए कुल फ़ोन नंबरों का ~75% होती है. अगर अनुरोध किए गए फ़ोन नंबरों की संख्या 500 से कम है, तो यह वैल्यू 0 होती है.
reachableRandomSampleUserCount

integer

यह मेट्रिक, रैंडम तरीके से चुनी गई सूची में मौजूद उन फ़ोन नंबर की संख्या दिखाती है जिन पर सभी कैरियर के ज़रिए आरसीएस की सुविधा उपलब्ध है. इससे कोई फ़र्क़ नहीं पड़ता कि एजेंट ने आरसीएस की सुविधा लॉन्च की है या नहीं. इस वैल्यू और totalRandomSampleUserCount के बीच के अनुपात से, उपयोगकर्ताओं की सूची के लिए संभावित पहुंच का अनुमान लगाया जा सकता है.

अनुमति पाने के लिंक

नीचे दिए गए OAuth के लिंक की ज़रूरत हाेती है:

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

ज़्यादा जानकारी के लिए, OAuth 2.0 Overview देखें.