Method: users.batchGet

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

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

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

ज़्यादा से ज़्यादा 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 देखें.