लाइव चैट में मैसेज या पोल जोड़ा जा सकता है.
इस्तेमाल के सामान्य उदाहरण
अनुरोध
एचटीटीपी अनुरोध
POST https://www.googleapis.com/youtube/v3/liveChat/messages
अनुमति देना
इस अनुरोध के लिए, इनमें से कम से कम किसी एक दायरे का इस्तेमाल करके अनुमति लेना ज़रूरी है (पुष्टि करने और अनुमति देने के बारे में ज़्यादा पढ़ें).
दायरा |
---|
https://www.googleapis.com/auth/youtube |
https://www.googleapis.com/auth/youtube.force-ssl |
पैरामीटर
नीचे दी गई टेबल में ऐसे पैरामीटर दिए गए हैं जो इस क्वेरी के साथ काम करते हैं. सूची में दिए गए सभी पैरामीटर, क्वेरी पैरामीटर हैं.
पैरामीटर | ||
---|---|---|
ज़रूरी पैरामीटर | ||
part |
string part पैरामीटर दो मकसद पूरे करता है. यह उन प्रॉपर्टी की पहचान करता है जिन्हें राइट ऑपरेशन सेट करेगा. साथ ही, यह उन प्रॉपर्टी की भी पहचान करता है जिनमें एपीआई रिस्पॉन्स शामिल होगा. पैरामीटर की वैल्यू को snippet पर सेट करें. |
अनुरोध का मुख्य भाग
अनुरोध के मुख्य हिस्से में liveChatMessage संसाधन उपलब्ध कराएं. इस संसाधन के लिए आपको इन प्रॉपर्टी के लिए वैल्यू तय करनी होंगी
snippet.liveChatId
snippet.type
- इनमें से कोई एक विकल्प चुनें:textMessageEvent
याpollEvent
- अगर टाइप
textMessageEvent
है, तोsnippet.textMessageDetails.messageText
शामिल करें - अगर टाइप
pollEvent
है, तोsnippet.pollDetails
को इन वैल्यू के साथ शामिल करें:snippet.pollDetails.metadata.options.questionText
snippet.pollDetails.metadata.options.optionText
की सूची. आपको कम से कम दो और ज़्यादा से ज़्यादा पांच आइटम की सूची बनानी होगी. आइटम उसी क्रम में दिखाए जाते हैं जिस क्रम में वे सूची में जोड़े गए हैं.
जवाब
सही तरीके से काम करने पर, यह तरीका रिस्पॉन्स के मुख्य हिस्से में liveChatMessage संसाधन दिखाता है.
गड़बड़ियां
नीचे दी गई टेबल में उन गड़बड़ी के मैसेज की पहचान की गई है जिन्हें एपीआई इस तरीके का इस्तेमाल करने पर जवाब में लौटा सकता है. ज़्यादा जानकारी के लिए गड़बड़ी का मैसेज दस्तावेज़ देखें.
गड़बड़ी का टाइप | गड़बड़ी विवरण | ब्यौरा |
---|---|---|
forbidden (403) |
forbidden |
आपके पास बताया गया मैसेज बनाने के लिए ज़रूरी अनुमतियां नहीं हैं. |
forbidden (403) |
liveChatDisabled |
तय की गई लाइव चैट के मालिक ने बंद कर दिया है. इसका मतलब है कि उस चैट में मैसेज नहीं जोड़े जा सकते. |
forbidden (403) |
liveChatEnded |
बताई गई लाइव चैट अब लाइव नहीं है. |
invalidValue (400) |
messageTextInvalid |
संदेश टेक्स्ट (snippet.textMessageDetails.messageText ) मान्य नहीं है. |
notFound (404) |
liveChatNotFound |
एपीआई अनुरोध में बताई गई लाइव चैट मौजूद नहीं है. यह गड़बड़ी तब होती है, जब चैट के मालिक ने चैट को मिटा दिया हो. |
required (400) |
liveChatIdRequired |
liveChatMessage संसाधन में snippet.liveChatId प्रॉपर्टी का मान शामिल होना चाहिए और उसके लिए कोई वैल्यू तय की जानी चाहिए. |
required (400) |
messageTextRequired |
liveChatMessage संसाधन में snippet.textMessageDetails.messageText प्रॉपर्टी का मान शामिल होना चाहिए और उसके लिए कोई वैल्यू तय की जानी चाहिए. |
required (400) |
typeRequired |
liveChatMessage संसाधन में snippet.type प्रॉपर्टी का मान शामिल होना चाहिए और उसके लिए कोई वैल्यू तय की जानी चाहिए. पैरामीटर वैल्यू को text पर सेट करें |
required (400) |
preconditionCheckFailed |
पिन किया गया एक ऐक्टिव पोल पहले से मौजूद है. |
rateLimitExceeded |
rateLimitExceeded |
उपयोगकर्ता ने दी गई समयसीमा में बहुत ज़्यादा चैट मैसेज पोस्ट किए हैं. |
इसे आज़माएं!
इस एपीआई को कॉल करने के लिए, APIs Explorer का इस्तेमाल करें. साथ ही, एपीआई का अनुरोध और रिस्पॉन्स देखें.