Method: phones.getCapabilities

उपयोगकर्ता की आरबीएम से जुड़ी क्षमताओं की जानकारी पाएं.

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

जिस एजेंट को लॉन्च नहीं किया गया है वह सिर्फ़ उन लोगों के लिए सुविधाओं का अनुरोध कर सकता है जो उस एजेंट को टेस्ट कर रहे हैं. अगर लॉन्च नहीं किया गया कोई एजेंट, नॉन-टेस्टर की क्षमताओं के लिए अनुरोध करता है, तो आरबीएम प्लैटफ़ॉर्म 403 PERMISSION_DENIED की जानकारी देता है.

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

GET https://rcsbusinessmessaging.googleapis.com/v1/{name=phones/*}/capabilities

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

पाथ के पैरामीटर

पैरामीटर
name

string

इस फ़ील्ड में "phones/{E.164}/capabilities" इस्तेमाल करने की अनुमति है. इसमें {E.164}, E.164 फ़ॉर्मैट में उपयोगकर्ता का फ़ोन नंबर है. उदाहरण के लिए, किसी ऐसे उपयोगकर्ता के लिए जिसके पास अमेरिका का फ़ोन नंबर +1-222-333-4444 है, उसका एंडपॉइंट https://rcsbusinessmessaging.googleapis.com/v1/phones/+12223334444/capabilities हैं.

क्वेरी पैरामीटर

पैरामीटर
requestId

string

अनुरोध का यूनीक आईडी, जिसे एजेंट असाइन करता है. यह एक यूयूआईडी होना चाहिए, जैसा कि https://tools.ietf.org/html/rfc4122 में बताया गया है. अगर अनुरोध आईडी उस आईडी से मेल खाता है जिसका इस्तेमाल एजेंट ने पिछले अनुरोध के लिए किया था, तो आरबीएम प्लैटफ़ॉर्म नए अनुरोध को अनदेखा कर देता है.
agentId

string

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

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

अनुरोध का मुख्य हिस्सा खाली होना चाहिए.

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

उपयोगकर्ता के हिसाब से, इस्तेमाल की जा सकने वाली सुविधाओं की सूची

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

जेएसओएन के काेड में दिखाना 
{
  "features": [
    enum (Feature)
  ]
}
फ़ील्ड
features[]

enum (Feature)

इस डिवाइस पर काम करने वाली आरबीएम सुविधाओं की सूची.

अनुमति देने के दायरे

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

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

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

सुविधा

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

Enums
FEATURE_UNSPECIFIED जानकारी नहीं दी गई.
REVOCATION सहमति रद्द करना. अगर उपयोगकर्ता सहमति रद्द करने की सुविधा देता है, तो आरबीएम प्लैटफ़ॉर्म से मैसेज डिलीवर होने से पहले एजेंट उस मैसेज को रद्द कर सकता है.
RICHCARD_STANDALONE स्टैंडअलोन रिच कार्ड.
ACTION_CREATE_CALENDAR_EVENT कैलेंडर इवेंट बनाने के लिए सुझाई गई कार्रवाई.
ACTION_DIAL नंबर डायल करने के लिए सुझाई गई कार्रवाई.
ACTION_OPEN_URL यूआरएल खोलने के लिए सुझाई गई कार्रवाई.
ACTION_SHARE_LOCATION स्थान शेयर करने के लिए सुझाई गई कार्रवाई.
ACTION_VIEW_LOCATION मैप ऐप्लिकेशन में किसी जगह की जानकारी देखने के लिए सुझाई गई कार्रवाई.