Method: users.batchGet

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

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

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

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

अहम जानकारी: users.batchGet तरीके के लिए, देश/इलाके के हिसाब से बने एंडपॉइंट का इस्तेमाल करना ज़रूरी है. अनुरोधों में, किसी एक भौगोलिक इलाके के फ़ोन नंबर शामिल होने चाहिए. किसी एक अनुरोध में, एक से ज़्यादा इलाकों के फ़ोन नंबर भेजने या गलत एंडपॉइंट पर भेजने पर, 400 Bad Request गड़बड़ी दिखेगी.

देश/इलाके के हिसाब से बने एंडपॉइंट:

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

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

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

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

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

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

string

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

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

string

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

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

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

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

JSON फ़ॉर्मैट में दिखाया गया है 
{
  "reachableUsers": [
    string
  ],
  "totalRandomSampleUserCount": integer,
  "reachableRandomSampleUserCount": integer,
  "reachableUsersMap": {
    string: {
      object (ReachableUsers)
    },
    ...
  }
}
फ़ील्ड
reachableUsers[]

string

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

integer

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

integer

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

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

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

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

नीचे दिए गए OAuth अनुमति की ज़रूरत हाेती है:

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

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

ReachableUsers

किसी खास ऑपरेटर पर, संपर्क किए जा सकने वाले उपयोगकर्ताओं की सूची.

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

string

किसी खास ऑपरेटर पर, संपर्क किए जा सकने वाले उपयोगकर्ताओं की सूची. यह फ़ील्ड, सिर्फ़ अमेरिका के फ़ोन नंबरों के लिए भरा जाता है.