Method: phones.agentMessages.delete

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

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

यह तरीका तुरंत 200 OK दिखाता है, भले ही मैसेज वापस लिया गया हो या नहीं.

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

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

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

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

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

पैरामीटर
name

string

"phone/{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

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

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

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

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

कामयाब रहने पर, जवाब का मुख्य हिस्सा खाली रहता है.

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

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

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

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