Method: phones.agentMessages.delete

एजेंट के भेजे गए मैसेज को रद्द करता है, लेकिन अभी तक डिलीवर नहीं हुआ.

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

इस तरीके से तुरंत 200 OK मिलते हैं, चाहे मैसेज को सफलतापूर्वक निरस्त किया गया हो या नहीं.

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

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

DELETE https://rcsbusinessmessaging.googleapis.com/v1/{name=phones/*/agentMessages/*}

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

पाथ पैरामीटर

पैरामीटर
name

string

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

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

पैरामीटर
agentId

string

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

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

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

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

अगर एपीआई सही से जुड़ जाता है, तो रिस्पॉन्स बॉडी में खाली JSON ऑब्जेक्ट होता है.

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

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

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

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