Method: users.batchGet

इसमें कई लोगों के लिए आरसीएस की सुविधा वाले फ़ोन नंबर मिलते हैं.

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

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

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

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

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

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

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

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

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

string

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

string

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

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

आरबीएम से ऐक्सेस किए जा सकने वाले उपयोगकर्ता के डेटा से मिला रिस्पॉन्स.

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

जेएसओएन के काेड में दिखाना 
{
  "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 की खास जानकारी देखें.