मैसेज भेजें

RCS for Business एजेंट संदेश भेजकर और प्राप्त करके उपयोगकर्ताओं से संवाद करते हैं। उपयोगकर्ताओं को संदेश भेजने के लिए, आपका एजेंट RCS Business Messaging API को संदेश अनुरोध भेजता है। एक ही अनुरोध में टेक्स्ट , रिच कार्ड , मीडिया और PDF फ़ाइलें , सुझाए गए उत्तर और सुझाए गए कार्य शामिल हो सकते हैं।

आरसीएस फॉर बिजनेस प्लेटफॉर्म कुछ स्थितियों में त्रुटियां लौटाता है ताकि आपको संदेश वितरण को प्रबंधित करने में मदद मिल सके:

  • यदि आप किसी ऐसे उपयोगकर्ता को संदेश भेजते हैं जिसका डिवाइस RCS को सपोर्ट नहीं करता या जिसमें RCS सक्षम नहीं है, तो RCS फॉर बिजनेस प्लेटफॉर्म 404 NOT_FOUND त्रुटि लौटाता है। इस स्थिति में, आप अपने इंफ्रास्ट्रक्चर में परिभाषित फॉलबैक विधियों के माध्यम से उपयोगकर्ता तक पहुंचने का प्रयास कर सकते हैं।
  • यदि आप किसी ऐसे नेटवर्क पर आरसीएस उपयोगकर्ता को संदेश भेजते हैं जहां आपका एजेंट अभी तक लॉन्च नहीं हुआ है, या ऐसे नेटवर्क पर जिसने आरसीएस ट्रैफ़िक को सक्षम नहीं किया है, तो आरसीएस फॉर बिजनेस प्लेटफ़ॉर्म 404 नॉट_फाउंड त्रुटि लौटाता है।
  • यदि आप ऐसा संदेश भेजते हैं जिसमें ऐसी सुविधाएं हैं जिनका उपयोगकर्ता का डिवाइस समर्थन नहीं करता है, तो RCS for Business प्लेटफॉर्म 400 INVALID_ARGUMENT त्रुटि लौटाता है और आपका संदेश डिलीवर नहीं करता है।

आपकी मल्टी-चैनल मैसेजिंग रणनीति के हिस्से के रूप में, उचित समय के बाद डिलीवर न होने वाले संदेशों को रद्द करना और उन्हें किसी अन्य चैनल के माध्यम से भेजना सबसे अच्छा है। पूर्वनिर्धारित समय पर संदेशों को स्वचालित रूप से रद्द करने के लिए, संदेश समाप्ति तिथि निर्धारित करें।

प्राप्तकर्ता ऑफ़लाइन है

RCS for Business प्लेटफॉर्म तब भी संदेश स्वीकार कर लेता है जब प्राप्तकर्ता ऑफ़लाइन हो। आपको 200 OK प्रतिक्रिया प्राप्त होती है, और RCS for Business प्लेटफॉर्म संदेश को रोककर 30 दिनों तक पुनः भेजने का प्रयास करता है। RCS for Business से संदेश को दोबारा भेजने का अनुरोध करने की आवश्यकता नहीं है।

RCS for Business, भेजे गए संदेशों को भेजने के 30 दिन बाद तक डिलीवर न हो पाने वाले सभी संदेशों को हटा देता है।

आपके एजेंट के उपयोग के आधार पर, आप 30 दिनों की समय सीमा से पहले किसी अप्राप्त संदेश को रद्द करना चाह सकते हैं। रद्द करने से ऑफ़लाइन उपयोगकर्ताओं को वापस ऑनलाइन आने पर पुराना संदेश प्राप्त होने से रोका जा सकता है। संदेश रद्द करने के कई तरीके हैं:

संदेश की समय सीमा निर्धारित करें

क्या आपके एजेंट का संदेश समयबद्ध है? उदाहरण के लिए, OTP केवल थोड़े समय के लिए ही मान्य होते हैं। सीमित समय के ऑफ़र समाप्त हो जाते हैं। और अपॉइंटमेंट रिमाइंडर अपॉइंटमेंट की तारीख के बाद प्रासंगिक नहीं रहते। संदेशों को समय पर और प्रासंगिक बनाए रखने के लिए, संदेश की समय सीमा निर्धारित करें। इससे ऑफ़लाइन उपयोगकर्ताओं को वापस ऑनलाइन आने पर पुरानी सामग्री प्राप्त होने से रोका जा सकता है। समय सीमा समाप्त होने पर आप अपनी वैकल्पिक संदेश रणनीति को सक्रिय कर सकते हैं, जिससे उपयोगकर्ताओं को आवश्यक जानकारी समय पर मिल जाती है।

संदेश की समय सीमा निर्धारित करने के लिए, एजेंट संदेश में निम्नलिखित फ़ील्ड में से किसी एक को निर्दिष्ट करें:

  • expireTime : UTC में वह सटीक समय जब संदेश समाप्त हो जाता है।
  • ttl (टाइम टू लिव): संदेश के समाप्त होने से पहले का समय।

फॉर्मेटिंग और वैल्यू विकल्पों के लिए, AgentMessage देखें।

ttl और expireTime का अधिकतम मान संदेश जमा करने के बाद 15 दिन है।

हालांकि ttl और expireTime कोई न्यूनतम मान निर्धारित नहीं है, फिर भी संदेश जमा करने के कम से कम 10 सेकंड बाद का समय निर्धारित करने की सलाह दी जाती है ताकि निरस्तीकरण और डिलीवरी दोनों की सूचना प्राप्त होने की संभावना को काफी हद तक कम किया जा सके।

संदेश के लिए जीने का समय (TTL)

जब आप RCS for Business संदेश के लिए TTL सेट करते हैं, तो आप यह निर्दिष्ट करते हैं कि संदेश को कितने समय तक वैध और डिलीवर करने योग्य माना जाना चाहिए। यदि संदेश इस TTL अवधि के भीतर उपयोगकर्ता के डिवाइस पर सफलतापूर्वक डिलीवर नहीं होता है, तो RCS for Business प्लेटफ़ॉर्म स्वचालित रूप से इसे रद्द करने का प्रयास करता है।

जब आप संदेश निरस्तीकरण शुरू करते हैं, तो आप RCS for Business प्लेटफ़ॉर्म से उस विशिष्ट संदेश की डिलीवरी का प्रयास बंद करने का अनुरोध करते हैं। हालाँकि, यह कार्रवाई केवल भविष्य के डिलीवरी प्रयासों को प्रभावित करती है। यदि उपयोगकर्ता के डिवाइस ने पहले ही संदेश सफलतापूर्वक प्राप्त कर लिया है, तो संदेश संसाधित हो रहा है, और RCS for Business प्लेटफ़ॉर्म उपयोगकर्ता के डिवाइस से संदेश को निरस्त नहीं कर सकता है।

नोटिफिकेशन के संबंध में आपको क्या उम्मीद करनी चाहिए, यह यहां बताया गया है:

  • समय सीमा के भीतर संदेश पहुंचा: यदि उपयोगकर्ता का डिवाइस समय सीमा समाप्त होने से पहले ऑनलाइन हो जाता है और संदेश प्राप्त कर लेता है, तो आपको DELIVERED सूचना प्राप्त होगी। कोई निरस्तीकरण सूचना नहीं भेजी जाएगी, क्योंकि संदेश सफलतापूर्वक पहुंचा दिया गया था। यह सबसे सामान्य और अपेक्षित स्थिति है।

  • टीटीएल समाप्त होने से पहले संदेश डिलीवर नहीं हुआ: यदि संदेश उपयोगकर्ता के डिवाइस तक पहुंचने से पहले टीटीएल समाप्त हो जाता है (उदाहरण के लिए, डिवाइस ऑफ़लाइन है), तो आरसीएस फॉर बिजनेस प्लेटफ़ॉर्म संदेश को रद्द करने का प्रयास करता है। आपको एक TTL_EXPIRATION_REVOKED सूचना प्राप्त होती है, जो यह दर्शाती है कि संदेश को डिलीवरी क्यू से सफलतापूर्वक हटा दिया गया है। इस स्थिति में, उपयोगकर्ता को संदेश प्राप्त नहीं होगा।

विषम परिस्थितियों से निपटने के लिए अनुशंसाएँ

हमारा सिस्टम RCS फॉर बिजनेस मैसेज डिलीवरी और TTL एक्सपायरी को समानांतर रूप से प्रोसेस करता है। इस वजह से, बहुत कम मामलों में, आपको ऐसे अपवाद देखने को मिल सकते हैं जहां नोटिफिकेशन का समय अप्रत्याशित हो। उदाहरण के लिए, आपको डिलीवरी और TTL दोनों नोटिफिकेशन मिल सकते हैं या आपको दोनों में से कोई भी नहीं मिल सकता है।

आरसीएस फॉर बिजनेस मैसेज नोटिफिकेशन को संभालने के लिए हमारी सिफारिशें यहां दी गई हैं:

  • DELIVERED सूचना: यदि आपको किसी संदेश के लिए ' DELIVERED सूचना प्राप्त होती है, तो यह पुष्टि करता है कि संदेश उपयोगकर्ता तक पहुँच गया है। आप उस विशिष्ट संदेश के लिए बाद में आने वाली किसी भी 'समय सीमा' सूचना को अनदेखा कर सकते हैं।

  • TTL_EXPIRATION_REVOKED सूचना: यदि आपको TTL_EXPIRATION_REVOKED स्थिति वाली TTL सूचना प्राप्त होती है, तो इसका अर्थ है कि RCS for Business सिस्टम उस विशिष्ट संदेश को भेजने का प्रयास करना बंद कर देता है। आपको इस संदेश को डिलीवर न हुआ मानकर, यदि आवश्यक हो, तो अपनी वैकल्पिक रणनीति के साथ आगे बढ़ना चाहिए।

  • किसी अन्य स्थिति के साथ टीटीएल अधिसूचना: यदि आपको किसी अन्य स्थिति के साथ टीटीएल अधिसूचना प्राप्त होती है, तो यह एक असफल निरस्तीकरण प्रयास को इंगित करता है।

    • महत्वपूर्ण संदेशों, जैसे कि एक बार उपयोग किए जाने वाले पासवर्ड (ओटीपी), के लिए अपनी बैकअप विधि शुरू करें।
    • गैर-महत्वपूर्ण संदेशों के लिए, यह तय करें कि फ़ॉलबैक शुरू करना है या नहीं।
  • सूचनाएं प्राप्त न होना: कुछ दुर्लभ मामलों में, सिस्टम TTL सूचना भेजने में विफल हो सकता है और क्लाइंट भी डिलीवरी सूचना उत्पन्न करने में विफल हो सकता है। यह एक अत्यंत दुर्लभ स्थिति है।

संदेश ट्रैफ़िक प्रकार सेट करें

RBM API में संदेशों को वर्गीकृत करने के लिए एक messageTrafficType फ़ील्ड शामिल है। एजेंट के व्यवहार और लागू होने वाले व्यावसायिक नियमों को एजेंट उपयोग मामलों द्वारा परिभाषित किया जाता है, लेकिन messageTrafficType संदेश सामग्री का अधिक विस्तृत वर्गीकरण करने की अनुमति देता है। अंततः, इससे एक ही एजेंट कई उपयोग मामलों को संभाल सकता है। वर्तमान में मौजूदा एजेंट उपयोग मामलों या व्यावसायिक नियमों पर इसका कोई प्रभाव नहीं पड़ेगा।

यह फ़ील्ड वैकल्पिक है, लेकिन यह अनुशंसा की जाती है कि आप इसे अभी सेट कर दें ताकि फ़ील्ड अनिवार्य होने पर आपको कोई त्रुटि न मिले।

संदेश ट्रैफ़िक प्रकार निर्धारित करने के लिए, प्रत्येक संदेश की सामग्री के आधार पर उपयुक्त messageTrafficType निर्दिष्ट करें। RCS for Business निम्नलिखित ट्रैफ़िक प्रकारों का समर्थन करता है।

ट्रैफ़िक प्रकार संदेश की सामग्री एजेंट उपयोग मामला
AUTHENTICATION प्रमाणीकरण संदेशों के लिए। ओटीपी
TRANSACTION उपयोगकर्ता की मौजूदा सेवाओं या उत्पादों से संबंधित संदेशों के लिए। उदाहरण के लिए: पुष्टिकरण, भुगतान रसीदें या बुकिंग विवरण। लेनदेनात्मक या बहुउपयोग
PROMOTION ऑफ़र, छूट, घोषणाएँ या अन्य प्रचार सामग्री जैसे प्रचार संदेशों के लिए। प्रचार या बहुउपयोग
SERVICEREQUEST उन सेवाओं के बारे में संदेशों के लिए जिनका उपयोगकर्ता ने स्पष्ट रूप से अनुरोध किया है। ओटीपी, लेनदेन संबंधी, प्रचार संबंधी या बहु-उपयोग संबंधी
ACKNOWLEDGEMENT उपयोगकर्ता की कार्रवाई की पुष्टि करने के लिए भेजे जाने वाले संदेश – विशेष रूप से सदस्यता रद्द करने के अनुरोध के लिए। यह पुष्टि करता है कि उपयोगकर्ता का अनुरोध प्राप्त हो गया है और उस पर कार्रवाई की जा रही है। ओटीपी, लेनदेन संबंधी, प्रचार संबंधी या बहु-उपयोग संबंधी

यदि कोई ट्रैफ़िक प्रकार निर्धारित नहीं किया गया है, तो सिस्टम एजेंट के उपयोग के मामले के लिए डिफ़ॉल्ट प्रकार निर्दिष्ट करता है।

एजेंट उपयोग मामला डिफ़ॉल्ट ट्रैफ़िक प्रकार
ओटीपी AUTHENTICATION
लेन-देन संबंधी TRANSACTION
प्रोमोशनल PROMOTION
बहुउपयोग MESSAGE_TRAFFIC_TYPE_UNSPECIFIED

मल्टी-यूज़ एजेंट्स के लिए कोई डिफ़ॉल्ट ट्रैफ़िक प्रकार नहीं होता है। आपको प्रत्येक संदेश के लिए उसकी सामग्री के आधार पर ट्रैफ़िक प्रकार स्पष्ट रूप से सेट करना होगा। यदि आप MESSAGE_TRAFFIC_TYPE_UNSPECIFIED मान को नहीं बदलते हैं, तो त्रुटि उत्पन्न होगी।

संदेश आकार सीमाएँ

स्ट्रिंग में परिवर्तित किए गए एजेंटमैसेज का अधिकतम आकार 250 केबी है। संदेश के टेक्स्ट भाग की अपनी सीमा 3072 अक्षर है।

उपयोगकर्ताओं के लिए अप्रत्याशित डेटा खपत को रोकने के लिए, RCS for Business के माध्यम से भेजी जा सकने वाली फ़ाइल का अधिकतम आकार 100 MiB है, और एक ही RCS for Business संदेश में सभी मीडिया और PDF अटैचमेंट का कुल संयुक्त आकार 100 MiB से अधिक नहीं होना चाहिए। (1 MiB = 1,048,576 बाइट्स)। अधिक जानकारी के लिए, मीडिया और PDF फ़ाइलें देखें।

मूलपाठ

सबसे सरल संदेश टेक्स्ट से बने होते हैं। टेक्स्ट संदेश बिना किसी दृश्य, जटिल संवाद या प्रतिक्रिया की आवश्यकता के जानकारी संप्रेषित करने के लिए सबसे उपयुक्त होते हैं।

उदाहरण

निम्नलिखित कोड एक साधारण टेक्स्ट संदेश भेजता है। फ़ॉर्मेटिंग और मान विकल्पों के लिए, phones.agentMessages.create देखें।

कर्ल

curl -X POST "https://REGION-rcsbusinessmessaging.googleapis.com/v1/phones/PHONE_NUMBER/agentMessages?messageId=MESSAGE_ID&agentId=AGENT_ID" \
-H "Content-Type: application/json" \
-H "User-Agent: curl/rcs-business-messaging" \
-H "`oauth2l header --json PATH_TO_SERVICE_ACCOUNT_KEY rcsbusinessmessaging`" \
-d '{
  "contentMessage": {
    "text": "Hello, world!"
  },
  "messageTrafficType": "PROMOTION"
}'

नोड.जेएस

// Reference to RBM API helper
const rbmApiHelper = require('@google/rcsbusinessmessaging');

let params = {
   messageText: 'Hello, world!',
   msisdn: '+12223334444',
};

// Send a simple message to the device
rbmApiHelper.sendMessage(params, function(response) {
   console.log(response);
});
यह कोड एक आरबीएम सैंपल एजेंट का अंश है।

जावा

import com.google.rbm.RbmApiHelper;


try {
   // Create an instance of the RBM API helper
   RbmApiHelper rbmApiHelper = new RbmApiHelper();

   // Send simple text message to user
   rbmApiHelper.sendTextMessage(
      "Hello, world!",
      "+12223334444"
   );
} catch(Exception e) {
   e.printStackTrace();
}
यह कोड एक आरबीएम सैंपल एजेंट का अंश है।

पायथन

# Reference to RBM Python client helper and messaging object structure
from rcs_business_messaging import rbm_service
from rcs_business_messaging import messages

# Create a simple RBM text message
message_text = messages.TextMessage('Hello, world!')

# Send text message to the device
messages.MessageCluster().append_message(message_text).send_to_msisdn('+12223334444')
यह कोड एक आरबीएम सैंपल एजेंट का अंश है।

सी#

using RCSBusinessMessaging;


// Create an instance of the RBM API helper
RbmApiHelper rbmApiHelper = new RbmApiHelper(credentialsFileLocation,
                                             projectId);

rbmApiHelper.SendTextMessage(
    "Hello, world!",
    "+12223334444",
);
यह कोड एक आरबीएम सैंपल एजेंट का अंश है।

मूल संदेश सामग्री - एसएमएस का रूपांतरण

टेलीकॉम कंपनियों ने एसएमएस संदेशों को आरसीएस फॉर बिजनेस में स्थानांतरित करने के लिए बिलिंग मॉडल पेश किए हैं। आरसीएस फॉर बिजनेस संदेश में अधिकतम 160 यूटीएफ-8 अक्षर होते हैं और इसे बेसिक मैसेज कहा जाता है।

बेसिक मैसेज भेजने के लिए रिक्वेस्ट बनाते समय, ध्यान रखें कि कैरेक्टर को 1 बाइट (UTF-8) के रूप में गिना जाता है। यदि आप इमोजी या मल्टी-बाइट कैरेक्टर सेट जैसे विशेष कैरेक्टर वाला मैसेज भेजते हैं, तो प्रत्येक कैरेक्टर को 2-4 UTF-8 कैरेक्टर या उससे अधिक के रूप में गिना जाता है।

इसकी लंबाई जांचने के लिए बॉक्स में कुछ टेक्स्ट दर्ज करें:

RCS क्लाइंट लिंक प्रीव्यू लागू कर सकते हैं। यदि किसी टेक्स्ट-आधारित RCS फॉर बिजनेस संदेश में ओपनग्राफ टैग वाली वेबसाइट का URL शामिल है, तो क्लाइंट एक प्रीव्यू (छवि, शीर्षक आदि) जेनरेट कर सकता है, जिससे उपयोगकर्ता को बेहतर अनुभव मिलेगा। उदाहरण के लिए, URL प्रीव्यू के साथ एक बेसिक संदेश देखें।

ध्यान रखें कि आरसीएस क्लाइंट उपयोगकर्ता को लिंक पूर्वावलोकन को अक्षम करने की अनुमति दे सकता है।

उपयोगकर्ता सत्यापन के लिए एक बार इस्तेमाल होने वाले पासवर्ड

आप एसएमएस रिट्रीवर एपीआई का उपयोग करके स्वचालित उपयोगकर्ता सत्यापन के लिए आरसीएस फॉर बिजनेस से वन-टाइम पासवर्ड (ओटीपी) भेज सकते हैं। आरसीएस फॉर बिजनेस के माध्यम से आने वाले ओटीपी को पढ़ने के लिए कोई समर्पित एपीआई उपलब्ध नहीं है।

एंड्रॉइड के लिए यह कैसे काम करता है

एसएमएस रिट्रीवर एपीआई के साथ पंजीकृत एंड्रॉइड ऐप्स के लिए, एपीआई सही प्रारूप में आरसीएस फॉर बिजनेस संदेश की प्रतीक्षा करता है। इस संदेश में ओटीपी और आपके ऐप की पहचान करने वाला एक अद्वितीय हैश दोनों होने चाहिए।

जब सही फॉर्मेट में RCS for Business मैसेज प्राप्त होता है, तो SMS रिट्रीवर API इसे SMS OTP की तरह ही प्रोसेस करता है। हैश का आपके ऐप से मिलान होने के बाद, OTP को निकालकर स्वचालित उपयोगकर्ता सत्यापन के लिए आपके ऐप पर भेज दिया जाता है।

  • उपयोगकर्ता सत्यापन के लिए सैंपल आरसीएस फॉर बिजनेस टेक्स्ट मैसेज: Your code is <OTP><app hash>.
  • उदाहरण: Your code is 123456 M8tue43FGT.

एसएमएस रिट्रीवर और संबंधित एपीआई के बारे में अधिक जानने के लिए, एसएमएस रिट्रीवर दस्तावेज़ देखें। एसएमएस रिट्रीवर एपीआई के साथ पंजीकृत ऐप्स में स्वचालित उपयोगकर्ता सत्यापन के बारे में विवरण के लिए, यह फ़्लो डायग्राम देखें।

iOS के लिए यह कैसे काम करता है

iOS के लिए, सिस्टम का अंतर्निहित OTP हैंडलिंग फ़ंक्शन SMS OTP की तरह ही RCS for Business OTP को स्वचालित रूप से पहचानता है और ऑटो-फिल के लिए सुझाव देता है। OTP पढ़ने के लिए iOS ऐप को किसी विशिष्ट API इंटीग्रेशन की आवश्यकता नहीं है।

मीडिया और पीडीएफ फाइलें

जब आप किसी छवि, वीडियो, ऑडियो या पीडीएफ फाइल के साथ संदेश भेजते हैं, तो आपके एजेंट को सामग्री के लिए सार्वजनिक रूप से सुलभ यूआरएल प्रदान करना होगा या सीधे फाइल अपलोड करनी होगी।

भेजी जा सकने वाली फ़ाइल का अधिकतम आकार 100 MiB है, और एक ही संदेश में सभी मीडिया और PDF अटैचमेंट का कुल संयुक्त आकार 100 MiB से अधिक नहीं होना चाहिए।

मीडिया संपीड़न और ट्रांसकोडिंग

आरसीएस फॉर बिजनेस प्लेटफॉर्म मीडिया फाइलों (जैसे कि इमेज और वीडियो) को भेजने से पहले स्वचालित रूप से ट्रांसकोड और कंप्रेस करता है ताकि यह सुनिश्चित हो सके कि वे तेजी से लोड हों और विभिन्न नेटवर्क और डिवाइसों पर अच्छी तरह से काम करें।

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

थंबनेल विनिर्देश

मीडिया फ़ाइलों के लिए, आप एक थंबनेल छवि भी निर्दिष्ट कर सकते हैं जिससे उपयोगकर्ता क्लिक करने से पहले सामग्री का पूर्वावलोकन कर सकें। ऑडियो फ़ाइलों के लिए, डिफ़ॉल्ट ऑडियो विजेट का उपयोग प्लेसहोल्डर के रूप में किया जाता है।

  • थंबनेल फ़ाइल का अधिकतम आकार 100 केबी है। बेहतर उपयोगकर्ता अनुभव के लिए, हम इसे 50 केबी या उससे कम रखने की सलाह देते हैं।
  • थंबनेल का आस्पेक्ट रेशियो मूल फ़ाइल के रेशियो से मेल खाना चाहिए।

कैशिंग और यूआरएल प्रबंधन

RCS for Business प्लेटफॉर्म 60 दिनों तक फाइलों को कैश में स्टोर करता है, और API एक फाइल ID लौटाता है जिसे आपका एजेंट उपयोगकर्ताओं को भेजे जाने वाले संदेशों में शामिल कर सकता है। 60 दिनों के बाद, RCS for Business कैश से फाइलों को हटा देता है।

URL द्वारा फ़ाइलें निर्दिष्ट करते समय, contentMessage.forceRefresh को false पर सेट करना सर्वोत्तम अभ्यास है। contentMessage.forceRefresh को true पर सेट करने से RCS for Business निर्दिष्ट URL से नई सामग्री लाने के लिए बाध्य हो जाता है, भले ही URL सामग्री कैश में संग्रहीत हो, जिससे उपयोगकर्ताओं के लिए संदेश वितरण समय बढ़ जाता है।

फ़ाइल URL उदाहरण

निम्नलिखित कोड एक छवि भेजता है। फ़ॉर्मेटिंग और मान विकल्पों के लिए, AgentContentMessage देखें।

कर्ल

curl -X POST "https://REGION-rcsbusinessmessaging.googleapis.com/v1/phones/PHONE_NUMBER/agentMessages?messageId=MESSAGE_ID&agentId=AGENT_ID" \
-H "Content-Type: application/json" \
-H "User-Agent: curl/rcs-business-messaging" \
-H "`oauth2l header --json PATH_TO_SERVICE_ACCOUNT_KEY rcsbusinessmessaging`" \
-d '{
  "contentMessage": {
    "contentInfo": {
      "fileUrl": "http://www.google.com/logos/doodles/2015/googles-new-logo-5078286822539264.3-hp2x.gif",
      "forceRefresh": false
    }
  }
}'

नोड.जेएस

// Reference to RBM API helper
const rbmApiHelper = require('@google/rcsbusinessmessaging');

let params = {
   fileUrl: 'http://www.google.com/logos/doodles/2015/googles-new-logo-5078286822539264.3-hp2x.gif',
   msisdn: '+12223334444',
};

// Send an image/video to a device
rbmApiHelper.sendMessage(params, function(response) {
   console.log(response);
});
यह कोड एक आरबीएम सैंपल एजेंट का अंश है।

जावा

import com.google.api.services.rcsbusinessmessaging.v1.model.AgentContentMessage;
import com.google.api.services.rcsbusinessmessaging.v1.model.AgentMessage;
import com.google.rbm.RbmApiHelper;


try {
   // Create an instance of the RBM API helper
   RbmApiHelper rbmApiHelper = new RbmApiHelper();

   String fileUrl = "http://www.google.com/logos/doodles/2015/googles-new-logo-5078286822539264.3-hp2x.gif";

   // create media only message
   AgentContentMessage agentContentMessage = new AgentContentMessage();
   agentContentMessage.setContentInfo(new ContentInfo().setFileUrl(fileUrl));

   // attach content to message
   AgentMessage agentMessage = new AgentMessage();
   agentMessage.setContentMessage(agentContentMessage);

   rbmApiHelper.sendAgentMessage(agentMessage, "+12223334444");
} catch(Exception e) {
   e.printStackTrace();
}
यह कोड एक आरबीएम सैंपल एजेंट का अंश है।

पायथन

# Reference to RBM Python client helper and messaging object structure
from rcs_business_messaging import rbm_service
from rcs_business_messaging import messages

# Create media file attachment
file_message = messages.FileMessage('http://www.google.com/logos/doodles/2015/googles-new-logo-5078286822539264.3-hp2x.gif')

messages.MessageCluster().append_message(file_message).send_to_msisdn('+12223334444')
यह कोड एक आरबीएम सैंपल एजेंट का अंश है।

सी#

using Google.Apis.RCSBusinessMessaging.v1.Data;
using RCSBusinessMessaging;


// Create an instance of the RBM API helper
RbmApiHelper rbmApiHelper = new RbmApiHelper(credentialsFileLocation,
                                                 projectId);

string fileUrl = "http://www.google.com/logos/doodles/2015/googles-new-logo-5078286822539264.3-hp2x.gif";

// Create content info with the file url
ContentInfo contentInfo = new ContentInfo
{
    FileUrl = fileUrl
};

// Attach content info to a message
AgentContentMessage agentContentMessage = new AgentContentMessage
{
    ContentInfo = contentInfo,
};

// Attach content to message
AgentMessage agentMessage = new AgentMessage
{
    ContentMessage = agentContentMessage
};

rbmApiHelper.SendAgentMessage(agentMessage, "+12223334444");
यह कोड एक आरबीएम सैंपल एजेंट का अंश है।

वैकल्पिक रूप से, आप files.create का उपयोग करके संदेश में भेजने से पहले मीडिया अपलोड कर सकते हैं।

फ़ाइल अपलोड का उदाहरण

निम्नलिखित कोड एक वीडियो फ़ाइल और एक थंबनेल फ़ाइल अपलोड करता है, फिर दोनों फ़ाइलों को एक संदेश में भेजता है। फ़ॉर्मेटिंग और मान विकल्पों के लिए, files.create और AgentContentMessage देखें।

कर्ल

curl -X POST "https://REGION-rcsbusinessmessaging.googleapis.com/upload/v1/files?agentId=AGENT_ID" \
-H "Content-Type: video/mp4" \
-H "User-Agent: curl/rcs-business-messaging" \
-H "`oauth2l header --json PATH_TO_SERVICE_ACCOUNT_KEY rcsbusinessmessaging`" \
--upload-file "FULL_PATH_TO_VIDEO_MEDIA_FILE"

# Capture server-specified video file name from response body JSON


curl -X POST "https://REGION-rcsbusinessmessaging.googleapis.com/upload/v1/files?agentId=AGENT_ID" \
-H "Content-Type: image/jpeg" \
-H "User-Agent: curl/rcs-business-messaging" \
-H "`oauth2l header --json PATH_TO_SERVICE_ACCOUNT_KEY rcsbusinessmessaging`" \
--upload-file "FULL_PATH_TO_THUMBNAIL_MEDIA_FILE"

# Capture server-specified image file name from response body JSON


curl -X POST "https://REGION-rcsbusinessmessaging.googleapis.com/v1/phones/PHONE_NUMBER/agentMessages?messageId=MESSAGE_ID&agentId=AGENT_ID" \
-H "Content-Type: application/json" \
-H "User-Agent: curl/rcs-business-messaging" \
-H "`oauth2l header --json PATH_TO_SERVICE_ACCOUNT_KEY rcsbusinessmessaging`" \
-d '{
  "contentMessage": {
    "uploadedRbmFile": {
      "fileName": "SERVER-SPECIFIED_VIDEO_FILE_NAME",
      "thumbnailName": "SERVER-SPECIFIED_THUMBNAIL_FILE_NAME"
    }
  }
}'

समर्थित मीडिया प्रकार

RCS for Business निम्नलिखित मीडिया प्रकारों का समर्थन करता है। थंबनेल के लिए, केवल image/jpeg, image/jpg, image/gif और image/png समर्थित हैं।

मीडिया प्रकार दस्तावेज़ प्रकार विस्तार रिच कार्ड के साथ काम करता है
एप्लिकेशन/ओजीजी ओजीजी ऑडियो .ogx नहीं
आवेदन/पीडीएफ पीडीएफ .पीडीएफ हां (केवल भारत में Google संदेशों के लिए)
ऑडियो/एएसी एएसी ऑडियो .एएसी नहीं
ऑडियो/एमपी3 एमपी3 ऑडियो .mp3 नहीं
ऑडियो/एमपीईजी एमपीईजी ऑडियो .mpeg नहीं
ऑडियो/एमपीजी एमपीजी ऑडियो .mp3 नहीं
ऑडियो/एमपी4 एमपी4 ऑडियो .mp4 नहीं
ऑडियो/mp4-latm MP4-latm ऑडियो .mp4 नहीं
ऑडियो/3जीपीपी 3GPP ऑडियो .3gp नहीं
छवि/जेपीईजी जेपीईजी .jpeg, .jpg हाँ
छवि/जीआईएफ जीआईएफ .gif हाँ
छवि/पीएनजी पीएनजी .png हाँ
वीडियो/h263 H263 वीडियो .h263 हाँ
वीडियो/एम4वी एम4वी वीडियो .m4v हाँ
वीडियो/एमपी4 एमपी4 वीडियो .mp4 हाँ
वीडियो/mpeg4 एमपीईजी-4 वीडियो .mp4, .m4p हाँ
वीडियो/एमपीईजी एमपीईजी वीडियो .mpeg हाँ
वीडियो/वेबएम वेबम वीडियो .वेबम हाँ

सुझाव

आपका एजेंट सुझाव चिप सूचियों या रिच कार्डों में सुझाव (सुझाए गए उत्तर और सुझाए गए कार्य) भेजता है।

सुझाए गए उत्तर

सुझाए गए उत्तर उपयोगकर्ताओं को बातचीत के दौरान मार्गदर्शन प्रदान करते हैं, जिससे उन्हें ऐसे जवाब मिल जाते हैं जिन पर आपका एजेंट प्रतिक्रिया देना जानता है।

जब कोई उपयोगकर्ता सुझाए गए उत्तर पर टैप करता है, तो आपके एजेंट को एक इवेंट प्राप्त होता है जिसमें उत्तर का टेक्स्ट और पोस्टबैक डेटा होता है । पेलोड में अधिकतम 2048 अक्षर हो सकते हैं।

उदाहरण

निम्नलिखित कोड दो सुझाए गए उत्तरों के साथ टेक्स्ट भेजता है। फ़ॉर्मेटिंग और मान विकल्पों के लिए, SuggestedReply देखें।

कर्ल

curl -X POST "https://REGION-rcsbusinessmessaging.googleapis.com/v1/phones/PHONE_NUMBER/agentMessages?messageId=MESSAGE_ID&agentId=AGENT_ID" \
-H "Content-Type: application/json" \
-H "User-Agent: curl/rcs-business-messaging" \
-H "`oauth2l header --json PATH_TO_SERVICE_ACCOUNT_KEY rcsbusinessmessaging`" \
-d '{
  "contentMessage": {
    "text": "Hello, world!",
    "suggestions": [
      {
        "reply": {
          "text": "Suggestion #1",
          "postbackData": "suggestion_1"
        }
      },
      {
        "reply": {
          "text": "Suggestion #2",
          "postbackData": "suggestion_2"
        }
      }
    ]
  }
}'

नोड.जेएस

// Reference to RBM API helper
const rbmApiHelper = require('@google/rcsbusinessmessaging');

let suggestions = [
   {
      reply: {
         'text': 'Suggestion #1',
         'postbackData': 'suggestion_1',
      },
   },
   {
      reply: {
         'text': 'Suggestion #2',
         'postbackData': 'suggestion_2',
      },
   },
];

let params = {
   messageText: 'Hello, world!',
   msisdn: '+12223334444',
   suggestions: suggestions,
};

// Send a simple message with suggestion chips to the device
rbmApiHelper.sendMessage(params, function(response) {
   console.log(response);
});
यह कोड एक आरबीएम सैंपल एजेंट का अंश है।

जावा

import com.google.api.services.rcsbusinessmessaging.v1.model.Suggestion;
import com.google.rbm.RbmApiHelper;
import com.google.rbm.SuggestionHelper;


try {
   // Create an instance of the RBM API helper
   RbmApiHelper rbmApiHelper = new RbmApiHelper();

   // Create suggestions for chip list
   List<Suggestion> suggestions = new ArrayList<Suggestion>();
   suggestions.add(
      new SuggestionHelper("Suggestion #1", "suggestion_1").getSuggestedReply());

   suggestions.add(
      new SuggestionHelper("Suggestion #2", "suggestion_2").getSuggestedReply());

   // Send simple text message to user
   rbmApiHelper.sendTextMessage(
      "Hello, world!",
      "+12223334444",
      suggestions
   );
} catch(Exception e) {
   e.printStackTrace();
}
यह कोड एक आरबीएम सैंपल एजेंट का अंश है।

पायथन

# Reference to RBM Python client helper and messaging object structure
from rcs_business_messaging import rbm_service
from rcs_business_messaging import messages

# Create text message to send to user
text_msg = messages.TextMessage('Hello, world!')
cluster = messages.MessageCluster().append_message(text_msg)

# Append suggested replies for the message to send to the user
cluster.append_suggestion_chip(messages.SuggestedReply('Suggestion #1', 'reply:suggestion_1'))
cluster.append_suggestion_chip(messages.SuggestedReply('Suggestion #2', 'reply:suggestion_2'))

# Send a simple message with suggestion chips to the device
cluster.send_to_msisdn('+12223334444')
यह कोड एक आरबीएम सैंपल एजेंट का अंश है।

सी#

using Google.Apis.RCSBusinessMessaging.v1.Data;
using RCSBusinessMessaging;


// Create an instance of the RBM API helper
RbmApiHelper rbmApiHelper = new RbmApiHelper(credentialsFileLocation,
                                             projectId);

List<Suggestion> suggestions = new List<Suggestion>
{
   // Create suggestion chips
   new SuggestionHelper("Suggestion #1", "suggestion_1").SuggestedReply(),
   new SuggestionHelper("Suggestion #2", "suggestion_2").SuggestedReply()
};

// Send simple text message with suggestions to user
rbmApiHelper.SendTextMessage(
    "Hello, world!",
    "+12223334444",
   suggestions
);
यह कोड एक आरबीएम सैंपल एजेंट का अंश है।

सुझावित गतिविधियां

सुझाए गए एक्शन, उपयोगकर्ताओं को उनके डिवाइस की अंतर्निहित कार्यक्षमता का उपयोग करके बातचीत में मार्गदर्शन करते हैं। आपका एजेंट उपयोगकर्ताओं को कोई नंबर डायल करने, मानचित्र पर कोई स्थान खोलने, स्थान साझा करने, यूआरएल खोलने या कैलेंडर इवेंट बनाने का सुझाव दे सकता है।

प्रत्येक सुझाए गए एक्शन के लिए, आप चाहें तो एक फ़ॉलबैक URL (अधिकतम 2048 अक्षर) प्रदान कर सकते हैं। यदि उपयोगकर्ता का डिवाइस सुझाए गए एक्शन को सपोर्ट नहीं करता है, तो यह URL एक नई ब्राउज़र विंडो में खुलेगा।

जब कोई उपयोगकर्ता सुझाए गए एक्शन पर टैप करता है, तो आपके एजेंट को एक इवेंट प्राप्त होता है जिसमें एक्शन का पोस्टबैक डेटा होता है

फॉर्मेटिंग और वैल्यू विकल्पों के लिए, SuggestedAction देखें।

सुझाव प्रदर्शन

सुझाव प्रदर्शित करने के दो तरीके हैं:

  • स्थायी : सुझाए गए कार्य या उत्तर जो संदेश बबल के अंदर प्रदर्शित होते हैं और पूरी बातचीत के दौरान स्थिर रहते हैं।
  • क्षणिक : ये सुझाव संदेश के बुलबुले के बाहर प्रदर्शित होते हैं और बातचीत जारी रहने पर गायब हो जाते हैं।

समर्थित संदेश प्रारूप

  • लगातार दिए जाने वाले सुझाव: स्टैंडअलोन टेक्स्ट मैसेज और रिच कार्ड के साथ काम करें।
  • अस्थायी सुझाव: स्टैंडअलोन टेक्स्ट संदेशों, मीडिया संदेशों और रिच कार्ड के साथ काम करें।

सुझावों को संयोजित करें

आप एक ही संदेश या रिच कार्ड में स्थायी और अस्थायी सुझावों को मिला सकते हैं।

  • टेक्स्ट मैसेज: सुझाव डिफ़ॉल्ट रूप से अस्थायी होते हैं। उन्हें स्थायी बनाए रखने के लिए, आपको उन्हें स्थायी के रूप में कॉन्फ़िगर करना होगा।
  • रिच कार्ड: ये डिफ़ॉल्ट रूप से अधिकतम चार स्थायी सुझावों का समर्थन करते हैं। आप कार्ड के नीचे "चिप सूची" के रूप में अस्थायी सुझाव भी जोड़ सकते हैं।

सुझाव सीमाएँ

एक टेक्स्ट मैसेज में कुल मिलाकर अधिकतम 11 सुझाव हो सकते हैं। आपके द्वारा शामिल किए गए सभी स्थायी सुझाव इस कुल सीमा में गिने जाएंगे। उदाहरण के लिए, यदि आप 4 स्थायी सुझाव शामिल करते हैं, तो आप अधिकतम 7 अस्थायी सुझाव जोड़ सकते हैं।

सुझाव प्रकार आप LIMIT जहां वे दिखाई देते हैं
ज़िद्दी चार तक संदेश बबल के अंदर
क्षणिक अधिकतम 11 बुलबुले के बाहर (जैसे चिप्स)

अक्षरों की सीमा

प्रत्येक सुझाव अधिकतम 25 अक्षरों का हो सकता है।

सुझाए गए कार्यों में URL पारदर्शिता

उपयोगकर्ताओं का विश्वास जीतने के लिए, "ओपन ए यूआरएल" सुझाए गए कार्यों के लिए सुझाव बटन के अंदर दूसरी पंक्ति में मूल यूआरएल प्रदर्शित किया जाता है। यह एक समान व्यवहार स्टैंडअलोन टेक्स्ट संदेशों, रिच कार्ड और कैरोसेल में लागू होता है।

ग्राहकों को निरंतर सुझावों के लिए सहायता प्रदान की।

  • समर्थित: गूगल मैसेज (संस्करण 20260225.00 या बाद का)।
  • समर्थित नहीं: Google Messages के 20260225.00 से पहले के संस्करण, iOS और Samsung Messages।

एक नंबर डायल करें

डायल बटन दबाने पर उपयोगकर्ता को एजेंट द्वारा निर्दिष्ट फ़ोन नंबर डायल करना होता है। फ़ोन नंबर में केवल अंक ( 0-9 ), प्लस चिह्न ( + ), तारा चिह्न ( * ) और संख्या चिह्न ( # ) शामिल हो सकते हैं। E.164 अंतर्राष्ट्रीय प्रारूप (उदाहरण के लिए, +14155555555 ) समर्थित है, लेकिन अनिवार्य नहीं है। यानी, +14155555555 और 1011 दोनों ही मान्य प्रविष्टियाँ हैं।

उदाहरण

निम्नलिखित कोड डायल एक्शन भेजता है। फ़ॉर्मेटिंग और वैल्यू विकल्पों के लिए, DialAction देखें।

कर्ल

curl -X POST "https://REGION-rcsbusinessmessaging.googleapis.com/v1/phones/PHONE_NUMBER/agentMessages?messageId=MESSAGE_ID&agentId=AGENT_ID" \
-H "Content-Type: application/json" \
-H "User-Agent: curl/rcs-business-messaging" \
-H "`oauth2l header --json PATH_TO_SERVICE_ACCOUNT_KEY rcsbusinessmessaging`" \
-d '{
  "contentMessage": {
    "text": "Hello, world!",
    "suggestions": [
      {
        "action": {
          "text": "Call",
          "postbackData": "postback_data_1234",
          "fallbackUrl": "https://www.google.com/contact/",
          "dialAction": {
            "phoneNumber": "+15556667777"
          }
        }
      }
    ]
  }
}'

नोड.जेएस

// Reference to RBM API helper
const rbmApiHelper = require('@google/rcsbusinessmessaging');

// Define a dial suggested action
let suggestions = [
   {
      action: {
         text: 'Call',
         postbackData: 'postback_data_1234',
         dialAction: {
            phoneNumber: '+15556667777'
         }
      }
   },
];

let params = {
   messageText: 'Hello, world!',
   msisdn: '+12223334444',
   suggestions: suggestions,
};

// Send a simple message with a dial suggested action
rbmApiHelper.sendMessage(params, function(response) {
   console.log(response);
});
यह कोड एक आरबीएम सैंपल एजेंट का अंश है।

जावा

import com.google.api.services.rcsbusinessmessaging.v1.model.DialAction;
import com.google.api.services.rcsbusinessmessaging.v1.model.SuggestedAction;
import com.google.api.services.rcsbusinessmessaging.v1.model.Suggestion;
import com.google.rbm.RbmApiHelper;


try {
   // Create an instance of the RBM API helper
   RbmApiHelper rbmApiHelper = new RbmApiHelper();

   // Create suggestions for chip list
   List<Suggestion> suggestions = new ArrayList<Suggestion>();

   // creating a dial suggested action
   DialAction dialAction = new DialAction();
   dialAction.setPhoneNumber("+15556667777");

   // creating a suggested action based on a dial action
   SuggestedAction suggestedAction = new SuggestedAction();
   suggestedAction.setText("Call");
   suggestedAction.setPostbackData("postback_data_1234");
   suggestedAction.setDialAction(dialAction);

   // attaching action to a suggestion
   Suggestion suggestion = new Suggestion();
   suggestion.setAction(suggestedAction);

   suggestions.add(suggestion);

   // Send simple text message with the suggestion action
   rbmApiHelper.sendTextMessage(
      "Hello, world!",
      "+12223334444",
      suggestions
   );
} catch(Exception e) {
   e.printStackTrace();
}
यह कोड एक आरबीएम सैंपल एजेंट का अंश है।

पायथन

# Reference to RBM Python client helper and messaging object structure
from rcs_business_messaging import rbm_service
from rcs_business_messaging import messages

# Create a dial suggested action
suggestions = [
      messages.DialAction('Call', 'reply:postback_data_1234', '+15556667777')
]

# Create text message to send to user
text_msg = messages.TextMessage('Hello, world!')
cluster = messages.MessageCluster().append_message(text_msg)

# Append suggestions for the message to send to the user
for suggestion in suggestions:
    cluster.append_suggestion_chip(suggestion)

# Send a simple message with suggested action to the device
cluster.send_to_msisdn('+12223334444')
यह कोड एक आरबीएम सैंपल एजेंट का अंश है।

सी#

using Google.Apis.RCSBusinessMessaging.v1.Data;
using RCSBusinessMessaging;


// Create an instance of the RBM API helper
RbmApiHelper rbmApiHelper = new RbmApiHelper(credentialsFileLocation,
                                                 projectId);

// Create a dial an agent suggested action
DialAction dialAction = new DialAction
{
    PhoneNumber = "+15556667777"
};

// Creating a suggested action based on a dial action
SuggestedAction suggestedAction = new SuggestedAction
{
    Text = "Call",
    PostbackData = "postback_data_1234",
    DialAction = dialAction
};

// Attach action to a suggestion
Suggestion suggestion = new Suggestion
{
    Action = suggestedAction
};

List<Suggestion> suggestions = new List<Suggestion>
{
    suggestion
};

rbmApiHelper.SendTextMessage(
    "Hello, world!",
    "+12223334444",
    suggestions
);
यह कोड एक आरबीएम सैंपल एजेंट का अंश है।

किसी स्थान को देखें

'स्थान देखें' क्रिया उपयोगकर्ता के डिफ़ॉल्ट मानचित्र ऐप में स्थान प्रदर्शित करती है। आप अक्षांश और देशांतर के आधार पर या उपयोगकर्ता के वर्तमान स्थान के आधार पर क्वेरी का उपयोग करके स्थान निर्दिष्ट कर सकते हैं। आप मानचित्र ऐप में प्रदर्शित होने वाले पिन के लिए एक कस्टम लेबल भी सेट कर सकते हैं।

उदाहरण

निम्नलिखित कोड व्यू लोकेशन एक्शन भेजता है। फ़ॉर्मेटिंग और वैल्यू विकल्पों के लिए, ViewLocationAction देखें।

कर्ल

curl -X POST "https://REGION-rcsbusinessmessaging.googleapis.com/v1/phones/PHONE_NUMBER/agentMessages?messageId=MESSAGE_ID&agentId=AGENT_ID" \
-H "Content-Type: application/json" \
-H "User-Agent: curl/rcs-business-messaging" \
-H "`oauth2l header --json PATH_TO_SERVICE_ACCOUNT_KEY rcsbusinessmessaging`" \
-d '{
  "contentMessage": {
    "text": "Hello, world!",
    "suggestions": [
      {
        "action": {
          "text": "View map",
          "postbackData": "postback_data_1234",
          "fallbackUrl": "https://www.google.com/maps/@37.4220188,-122.0844786,15z",
          "viewLocationAction": {
            "latLong": {
              "latitude": "37.4220188",
              "longitude": "-122.0844786"
            },
            "label": "Googleplex"
          }
        }
      }
    ]
  }
}'

नोड.जेएस

// Reference to RBM API helper
const rbmApiHelper = require('@google/rcsbusinessmessaging');

// Define a view location suggested action
let suggestions = [
   {
      action: {
         text: 'View map',
         postbackData: 'postback_data_1234',
         viewLocationAction: {
            latLong: {
               latitude: 37.4220188,
               longitude: -122.0844786
            },
            label: 'Googleplex'
         }
      }
   },
];

let params = {
   messageText: 'Hello, world!',
   msisdn: '+12223334444',
   suggestions: suggestions,
};

// Send a simple message with a view location suggested action
rbmApiHelper.sendMessage(params, function(response) {
   console.log(response);
});
यह कोड एक आरबीएम सैंपल एजेंट का अंश है।

जावा

import com.google.api.services.rcsbusinessmessaging.v1.model.ViewLocationAction;
import com.google.api.services.rcsbusinessmessaging.v1.model.SuggestedAction;
import com.google.api.services.rcsbusinessmessaging.v1.model.Suggestion;
import com.google.rbm.RbmApiHelper;


try {
   // Create an instance of the RBM API helper
   RbmApiHelper rbmApiHelper = new RbmApiHelper();

   // Create suggestions for chip list
   List<Suggestion> suggestions = new ArrayList<Suggestion>();

   // creating a view location suggested action
   ViewLocationAction viewLocationAction = new ViewLocationAction();
   viewLocationAction.setQuery("Googleplex, Mountain View, CA");

   // creating a suggested action based on a view location action
   SuggestedAction suggestedAction = new SuggestedAction();
   suggestedAction.setText("View map");
   suggestedAction.setPostbackData("postback_data_1234");
   suggestedAction.setViewLocationAction(viewLocationAction);

   // attaching action to a suggestion
   Suggestion suggestion = new Suggestion();
   suggestion.setAction(suggestedAction);

   suggestions.add(suggestion);

   // Send simple text message with the suggestion action
   rbmApiHelper.sendTextMessage(
      "Hello, world!",
      "+12223334444",
      suggestions
   );
} catch(Exception e) {
   e.printStackTrace();
}
यह कोड एक आरबीएम सैंपल एजेंट का अंश है।

पायथन

# Reference to RBM Python client helper and messaging object structure
from rcs_business_messaging import rbm_service
from rcs_business_messaging import messages

# Create a view location suggested action
suggestions = [
      messages.ViewLocationAction('View map',
            'reply:postback_data_1234',
            query='Googleplex, Mountain View, CA')
]

# Create text message to send to user
text_msg = messages.TextMessage('Hello, world!')
cluster = messages.MessageCluster().append_message(text_msg)

# Append suggestions for the message to send to the user
for suggestion in suggestions:
    cluster.append_suggestion_chip(suggestion)

# Send a simple message with suggested action to the device
cluster.send_to_msisdn('+12223334444')
यह कोड एक आरबीएम सैंपल एजेंट का अंश है।

सी#

using Google.Apis.RCSBusinessMessaging.v1.Data;
using RCSBusinessMessaging;


// Create an instance of the RBM API helper
RbmApiHelper rbmApiHelper = new RbmApiHelper(credentialsFileLocation,
                                                 projectId);

// create an view location action
ViewLocationAction viewLocationAction = new ViewLocationAction
{
    Query = "Googleplex Mountain View, CA"
};

// Attach the view location action to a suggested action
SuggestedAction suggestedAction = new SuggestedAction
{
    ViewLocationAction = viewLocationAction,
    Text = "View map",
    PostbackData = "postback_data_1234"
};

// Attach the action to a suggestion object
Suggestion suggestion = new Suggestion
{
    Action = suggestedAction
};

List<Suggestion> suggestions = new List<Suggestion>
{
    suggestion
};

rbmApiHelper.SendTextMessage(
    "Hello, world!",
    "+12223334444",
    suggestions
);
यह कोड एक आरबीएम सैंपल एजेंट का अंश है।

स्थान साझा करें

'स्थान साझा करें' विकल्प उपयोगकर्ता को आपके एजेंट के साथ अपना स्थान साझा करने की अनुमति देता है। उपयोगकर्ता या तो अपना वर्तमान स्थान साझा कर सकता है या मैप्स ऐप से मैन्युअल रूप से चयनित स्थान साझा कर सकता है।

उदाहरण

निम्नलिखित कोड शेयर लोकेशन एक्शन भेजता है। फ़ॉर्मेटिंग और वैल्यू विकल्पों के लिए, ShareLocationAction देखें।

कर्ल

curl -X POST "https://REGION-rcsbusinessmessaging.googleapis.com/v1/phones/PHONE_NUMBER/agentMessages?messageId=MESSAGE_ID&agentId=AGENT_ID" \
-H "Content-Type: application/json" \
-H "User-Agent: curl/rcs-business-messaging" \
-H "`oauth2l header --json PATH_TO_SERVICE_ACCOUNT_KEY rcsbusinessmessaging`" \
-d '{
  "contentMessage": {
    "text": "Hello, world!",
    "suggestions": [
      {
        "action": {
          "text": "Share your location",
          "postbackData": "postback_data_1234",
          "shareLocationAction": {}
        }
      }
    ]
  }
}'

नोड.जेएस

// Reference to RBM API helper
const rbmApiHelper = require('@google/rcsbusinessmessaging');

// Define a share location suggested action
let suggestions = [
   {
      action: {
         text: 'Share your location',
         postbackData: 'postback_data_1234',
         shareLocationAction: {
         }
      }
   },
];

let params = {
   messageText: 'Hello, world!',
   msisdn: '+12223334444',
   suggestions: suggestions,
};

// Send a simple message with a share location suggested action
rbmApiHelper.sendMessage(params, function(response) {
   console.log(response);
});
यह कोड एक आरबीएम सैंपल एजेंट का अंश है।

जावा

import com.google.api.services.rcsbusinessmessaging.v1.model.ShareLocationAction;
import com.google.api.services.rcsbusinessmessaging.v1.model.SuggestedAction;
import com.google.api.services.rcsbusinessmessaging.v1.model.Suggestion;
import com.google.rbm.RbmApiHelper;


try {
   // Create an instance of the RBM API helper
   RbmApiHelper rbmApiHelper = new RbmApiHelper();

   // Create suggestions for chip list
   List<Suggestion> suggestions = new ArrayList<Suggestion>();

   // creating a share location suggested action
   ShareLocationAction shareLocationAction = new ShareLocationAction();

   // creating a suggested action based on a share location action
   SuggestedAction suggestedAction = new SuggestedAction();
   suggestedAction.setText("Share location");
   suggestedAction.setPostbackData("postback_data_1234");
   suggestedAction.setShareLocationAction(shareLocationAction);

   // attaching action to a suggestion
   Suggestion suggestion = new Suggestion();
   suggestion.setAction(suggestedAction);

   suggestions.add(suggestion);

   // Send simple text message with the suggestion action
   rbmApiHelper.sendTextMessage(
      "Hello, world!",
      "+12223334444",
      suggestions
   );
} catch(Exception e) {
   e.printStackTrace();
}
यह कोड एक आरबीएम सैंपल एजेंट का अंश है।

पायथन

# Reference to RBM Python client helper and messaging object structure
from rcs_business_messaging import rbm_service
from rcs_business_messaging import messages

# Create a share location suggested action
suggestions = [
      messages.ShareLocationAction('Share location',
            'reply:postback_data_1234')
]

# Create text message to send to user
text_msg = messages.TextMessage('Hello, world!')
cluster = messages.MessageCluster().append_message(text_msg)

# Append suggestions for the message to send to the user
for suggestion in suggestions:
    cluster.append_suggestion_chip(suggestion)

# Send a simple message with suggested action to the device
cluster.send_to_msisdn('+12223334444')
यह कोड एक आरबीएम सैंपल एजेंट का अंश है।

सी#

using Google.Apis.RCSBusinessMessaging.v1.Data;
using RCSBusinessMessaging;


// Create an instance of the RBM API helper
RbmApiHelper rbmApiHelper = new RbmApiHelper(credentialsFileLocation,
                                                 projectId);

// Create a share location action
ShareLocationAction shareLocationAction = new ShareLocationAction();

// Attach the share location action to a suggested action
SuggestedAction suggestedAction = new SuggestedAction
{
    ShareLocationAction = shareLocationAction,
    Text = "Share location",
    PostbackData = "postback_data_1234"
};

// Attach the action to a suggestion object
Suggestion suggestion = new Suggestion
{
    Action = suggestedAction
};

List<Suggestion> suggestions = new List<Suggestion>
{
    suggestion
};

rbmApiHelper.SendTextMessage(
    "Hello, world!",
    "+12223334444",
    suggestions
);
यह कोड एक आरबीएम सैंपल एजेंट का अंश है।

एक URL खोलें

ओपन यूआरएल एक्शन आपको अपने एजेंट द्वारा निर्दिष्ट वेब पेज पर उपयोगकर्ताओं को निर्देशित करने की सुविधा देता है। डिफ़ॉल्ट रूप से, वेब पेज उपयोगकर्ता के ब्राउज़र में खुलता है। आप वेब पेज को वेबव्यू में खोलने के लिए भी सेट कर सकते हैं। विवरण के लिए वेबव्यू के साथ यूआरएल खोलें देखें।

केवल Google संदेशों में

मूल URL प्रदर्शित करना : A2P मैसेजिंग में पारदर्शिता बढ़ाने के लिए, Google Messages 'ओपन ए URL' के सुझाए गए विकल्पों में मूल URL पता प्रदर्शित करता है। यह बदलाव स्टैंडर्ड रिच कार्ड और रिच कार्ड कैरोसेल में सुझाए गए विकल्पों पर लागू होता है।

एक रिच कार्ड जिसमें 'वेबसाइट देखें' का सुझाव दिया गया है और उसके नीचे URL प्रदर्शित है।
दृश्यमान अंतर्निहित यूआरएल

वेब लिंक के लिए ऐप आइकन डिस्प्ले : यदि किसी उपयोगकर्ता ने वेब पेज के लिए कोई डिफ़ॉल्ट ऐप कॉन्फ़िगर किया है, तो ब्राउज़र या वेबव्यू के बजाय वह ऐप खुलता है, और सुझाव बटन पर ऐप का आइकन दिखाई देता है। Google Messages में ऐप आइकन दिखाने के लिए, आपको पूरा, सीधा URL देना होगा। यदि आप छोटा URL इस्तेमाल करते हैं, तो डिफ़ॉल्ट 'URL खोलें' आइकन दिखाई देगा।

सुझाव बटन में ऐप आइकन।
सुझाव बटन में ऐप आइकन
उदाहरण

निम्नलिखित कोड एक ओपन यूआरएल एक्शन भेजता है। फ़ॉर्मेटिंग और वैल्यू विकल्पों के लिए, OpenUrlAction देखें।

कर्ल

curl -X POST "https://REGION-rcsbusinessmessaging.googleapis.com/v1/phones/PHONE_NUMBER/agentMessages?messageId=MESSAGE_ID&agentId=AGENT_ID" \
-H "Content-Type: application/json" \
-H "User-Agent: curl/rcs-business-messaging" \
-H "`oauth2l header --json PATH_TO_SERVICE_ACCOUNT_KEY rcsbusinessmessaging`" \
-d '{
  "contentMessage": {
    "text": "Hello, world!",
    "suggestions": [
      {
        "action": {
          "text": "Open Google",
          "postbackData": "postback_data_1234",
          "openUrlAction": {
            "url": "https://www.google.com"
          }
        }
      }
    ]
  }
}'

नोड.जेएस

// Reference to RBM API helper
const rbmApiHelper = require('@google/rcsbusinessmessaging');

// Define an open URL suggested action
let suggestions = [
   {
      action: {
         text: 'Open Google',
         postbackData: 'postback_data_1234',
         openUrlAction: {
            url: 'https://www.google.com'
         }
      }
   },
];

let params = {
   messageText: 'Hello, world!',
   msisdn: '+12223334444',
   suggestions: suggestions,
};

// Send a simple message with an open URL suggested action
rbmApiHelper.sendMessage(params, function(response) {
   console.log(response);
});
यह कोड एक आरबीएम सैंपल एजेंट का अंश है।

जावा

import com.google.api.services.rcsbusinessmessaging.v1.model.OpenUrlAction;
import com.google.api.services.rcsbusinessmessaging.v1.model.SuggestedAction;
import com.google.api.services.rcsbusinessmessaging.v1.model.Suggestion;
import com.google.rbm.RbmApiHelper;


try {
   // Create an instance of the RBM API helper
   RbmApiHelper rbmApiHelper = new RbmApiHelper();

   // Create suggestions for chip list
   List<Suggestion> suggestions = new ArrayList<Suggestion>();

   // creating an open url suggested action
   OpenUrlAction openUrlAction = new OpenUrlAction();
   openUrlAction.setUrl("https://www.google.com");

   // creating a suggested action based on an open url action
   SuggestedAction suggestedAction = new SuggestedAction();
   suggestedAction.setText("Open Google");
   suggestedAction.setPostbackData("postback_data_1234");
   suggestedAction.setOpenUrlAction(openUrlAction);

   // attaching action to a suggestion
   Suggestion suggestion = new Suggestion();
   suggestion.setAction(suggestedAction);

   suggestions.add(suggestion);

   // Send simple text message with the suggestion action
   rbmApiHelper.sendTextMessage(
      "Hello, world!",
      "+12223334444",
      suggestions
   );
} catch(Exception e) {
   e.printStackTrace();
}
यह कोड एक आरबीएम सैंपल एजेंट का अंश है।

पायथन

# Reference to RBM Python client helper and messaging object structure
from rcs_business_messaging import rbm_service
from rcs_business_messaging import messages

# Create an open url suggested action
suggestions = [
      messages.OpenUrlAction('Open Google',
            'reply:postback_data_1234',
            'https://www.google.com')
]

# Create text message to send to user
text_msg = messages.TextMessage('Hello, world!')
cluster = messages.MessageCluster().append_message(text_msg)

# Append suggestions for the message to send to the user
for suggestion in suggestions:
    cluster.append_suggestion_chip(suggestion)

# Send a simple message with suggested action to the device
cluster.send_to_msisdn('+12223334444')
यह कोड एक आरबीएम सैंपल एजेंट का अंश है।

सी#

using Google.Apis.RCSBusinessMessaging.v1.Data;
using RCSBusinessMessaging;


// Create an instance of the RBM API helper
RbmApiHelper rbmApiHelper = new RbmApiHelper(credentialsFileLocation,
                                                 projectId);

// Create an open url action
OpenUrlAction openUrlAction = new OpenUrlAction
{
    Url = "https://www.google.com"
};

// Attach the open url action to a suggested action
SuggestedAction suggestedAction = new SuggestedAction
{
    OpenUrlAction = openUrlAction,
    Text = "Open Google",
    PostbackData = "postback_data_1234"
};

// Attach the action to a suggestion object
Suggestion suggestion = new Suggestion
{
    Action = suggestedAction
};

List<Suggestion> suggestions = new List<Suggestion>
{
    suggestion
};

rbmApiHelper.SendTextMessage(
    "Hello, world!",
    "+12223334444",
    suggestions
);
यह कोड एक आरबीएम सैंपल एजेंट का अंश है।

वेबव्यू का उपयोग करके एक यूआरएल खोलें

वेबव्यू के साथ URL खोलें विकल्प निर्दिष्ट वेब पेज को आपके डिफ़ॉल्ट ब्राउज़र के रेंडरिंग इंजन के साथ मैसेजिंग ऐप के अंदर लोड करता है। इससे उपयोगकर्ता RCS फॉर बिज़नेस वार्तालाप छोड़े बिना वेब पेज के साथ इंटरैक्ट कर सकता है। यदि उपयोगकर्ता का डिवाइस वेबव्यू को सपोर्ट नहीं करता है, तो वेब पेज उपयोगकर्ता के ब्राउज़र में खुलता है। वेबव्यू को सक्षम करने के लिए, OpenURLApplication देखें।

वेबव्यू में तीन डिस्प्ले मोड होते हैं। फ़ॉर्मेटिंग और वैल्यू विकल्पों के लिए, WebviewViewMode देखें।

  • पूर्ण: वेब पेज पूरी स्क्रीन पर दिखाई देता है
  • आधा: वेब पेज स्क्रीन का आधा हिस्सा घेरता है
  • लंबा: वेब पेज स्क्रीन के तीन चौथाई हिस्से को कवर करता है।
उदाहरण

निम्नलिखित कोड वेबव्यू एक्शन के साथ एक ओपन यूआरएल भेजता है। फ़ॉर्मेटिंग और वैल्यू विकल्पों के लिए, OpenURLAction देखें।

कर्ल

curl -X POST "https://REGION-rcsbusinessmessaging.googleapis.com/v1/phones/PHONE_NUMBER/agentMessages?messageId=MESSAGE_ID&agentId=AGENT_ID" \
-H "Content-Type: application/json" \
-H "User-Agent: curl/rcs-business-messaging" \
-H "`oauth2l header --json PATH_TO_SERVICE_ACCOUNT_KEY rcsbusinessmessaging`" \
-d '{
 "contentMessage": {
   "text": "Hello, world!",
   "suggestions": [
     {
       "action": {
         "text": "Open Google",
         "postbackData": "postback_data_1234",
         "openUrlAction": {
           "url": "https://www.google.com",
           "application": "WEBVIEW",
           "webviewViewMode": "FULL",
           "description": "Accessibility description"
         }
       }
     }
   ]
 }
}'

जावा

import com.google.api.services.rcsbusinessmessaging.v1.model.OpenUrlAction;
import com.google.api.services.rcsbusinessmessaging.v1.model.SuggestedAction;
import com.google.api.services.rcsbusinessmessaging.v1.model.Suggestion;
import com.google.rbm.RbmApiHelper;

  
try {
  
   String URL = "https://www.google.com";
  
   // Create an instance of the RBM API helper
   RbmApiHelper rbmApiHelper = new RbmApiHelper();
  
   // Create suggestions for chip list
   List<Suggestion> suggestions = new ArrayList<Suggestion>();

   // Create suggestion to view webpage in full mode
   Suggestion viewInFullMode =  getUrlActionInWebview(URL, "FULL")
   suggestions.add(viewInFullMode);
  
   // create suggestion to view webpage in half mode
   Suggestion viewInHalfMode =  getUrlActionInWebview(URL, "HALF")
   suggestions.add(viewInHalfMode);
     
   // create suggestion to view webpage in tall mode
   Suggestion viewInTallMode =  getUrlActionInWebview(URL, "TALL")
   suggestions.add(viewInTallMode);
     
   // Send simple text message with the suggested action
   rbmApiHelper.sendTextMessage(
      "Hello, world!",
      "+12223334444",
      suggestions
   );
} catch(Exception e) {
   e.printStackTrace();
}

  /**
    * Creates a suggested action to open URL in webview.
    *
    * @return a suggestion object for an open URL in webview action .
    */
    private Suggestion getUrlActionInWebview(String url,
                                             String viewMode) {
      // create an open url action
      OpenUrlAction openUrlAction = new OpenUrlAction();
      openUrlAction.setUrl(url);
      openUrlAction.setApplication("WEBVIEW");
      openUrlAction.setWebviewViewMode(viewMode);
      openUrlAction.setDescription("Accessibility description");
     
      // attach the open url action to a suggested action
      SuggestedAction suggestedAction = new SuggestedAction();
      suggestedAction.setOpenUrlAction(openUrlAction);
      suggestedAction.setText('display_text');
      suggestedAction.setPostbackData('postback_data_123');
     
      // attach the action to a suggestion object
      Suggestion suggestion = new Suggestion();
      suggestion.setAction(suggestedAction);
     
      return suggestion;
    }

कैलेंडर इवेंट बनाएं

'कैलेंडर इवेंट बनाएं' क्रिया उपयोगकर्ता के कैलेंडर ऐप को खोलती है और निर्दिष्ट जानकारी के साथ एक नया इवेंट बनाना शुरू करती है।

कैलेंडर इवेंट का शीर्षक अनिवार्य है। यह अधिकतम 100 अक्षरों का हो सकता है। कैलेंडर इवेंट का विवरण वैकल्पिक है और अधिकतम 500 अक्षरों का हो सकता है।

उदाहरण

निम्नलिखित कोड एक कैलेंडर इवेंट बनाने की क्रिया भेजता है। फ़ॉर्मेटिंग और मान विकल्पों के लिए, CreateCalendarEventAction देखें।

कर्ल

curl -X POST "https://REGION-rcsbusinessmessaging.googleapis.com/v1/phones/PHONE_NUMBER/agentMessages?messageId=MESSAGE_ID&agentId=AGENT_ID" \
-H "Content-Type: application/json" \
-H "User-Agent: curl/rcs-business-messaging" \
-H "`oauth2l header --json PATH_TO_SERVICE_ACCOUNT_KEY rcsbusinessmessaging`" \
-d '{
  "contentMessage": {
    "text": "Hello, world!",
    "suggestions": [
      {
        "action": {
          "text": "Save to calendar",
          "postbackData": "postback_data_1234",
          "fallbackUrl": "https://www.google.com/calendar",
          "createCalendarEventAction": {
            "startTime": "2020-06-30T19:00:00Z",
            "endTime": "2020-06-30T20:00:00Z",
            "title": "My calendar event",
            "description": "Description of the calendar event"
          }
        }
      }
    ]
  }
}'

नोड.जेएस

// Reference to RBM API helper
const rbmApiHelper = require('@google/rcsbusinessmessaging');

// Define a create calendar event suggested action
let suggestions = [
   {
      action: {
         text: 'Save to calendar',
         postbackData: 'postback_data_1234',
         createCalendarEventAction: {
            startTime: '2020-06-30T19:00:00Z',
            endTime: '2020-06-30T20:00:00Z',
            title: 'My calendar event',
            description: 'Description of the calendar event',
         },
      }
   },
];

let params = {
   messageText: 'Hello, world!',
   msisdn: '+12223334444',
   suggestions: suggestions,
};

// Send a simple message with a create calendar event suggested action
rbmApiHelper.sendMessage(params, function(response) {
   console.log(response);
});
यह कोड एक आरबीएम सैंपल एजेंट का अंश है।

जावा

import com.google.api.services.rcsbusinessmessaging.v1.model.CreateCalendarEventAction;
import com.google.api.services.rcsbusinessmessaging.v1.model.SuggestedAction;
import com.google.api.services.rcsbusinessmessaging.v1.model.Suggestion;
import com.google.rbm.RbmApiHelper;


try {
   // Create an instance of the RBM API helper
   RbmApiHelper rbmApiHelper = new RbmApiHelper();

   // Create suggestions for chip list
   List<Suggestion> suggestions = new ArrayList<Suggestion>();

   // creating a create calendar event suggested action
   CreateCalendarEventAction createCalendarEventAction = new CreateCalendarEventAction();
   calendarEventAction.setTitle("My calendar event");
   calendarEventAction.setDescription("Description of the calendar event");
   calendarEventAction.setStartTime("2020-06-30T19:00:00Z");
   calendarEventAction.setEndTime("2020-06-30T20:00:00Z");

   // creating a suggested action based on a create calendar event action
   SuggestedAction suggestedAction = new SuggestedAction();
   suggestedAction.setText("Save to calendar");
   suggestedAction.setPostbackData("postback_data_1234");
   suggestedAction.setCreateCalendarEventAction(createCalendarEventAction);

   // attaching action to a suggestion
   Suggestion suggestion = new Suggestion();
   suggestion.setAction(suggestedAction);

   suggestions.add(suggestion);

   // Send simple text message with the suggestion action
   rbmApiHelper.sendTextMessage(
      "Hello, world!",
      "+12223334444",
      suggestions
   );
} catch(Exception e) {
   e.printStackTrace();
}
यह कोड एक आरबीएम सैंपल एजेंट का अंश है।

पायथन

# Reference to RBM Python client helper and messaging object structure
from rcs_business_messaging import rbm_service
from rcs_business_messaging import messages

# Create a calendar event suggested action
suggestions = [
      messages.CreateCalendarEventAction('Save to Calendar',
                             'reply:postback_data_1234',
                             '2020-06-30T19:00:00Z',
                             '2020-06-30T20:00:00Z',
                             'My calendar event',
                             'Description of the calendar event')

]

# Create text message to send to user
text_msg = messages.TextMessage('Hello, world!')
cluster = messages.MessageCluster().append_message(text_msg)

# Append suggestions for the message to send to the user
for suggestion in suggestions:
    cluster.append_suggestion_chip(suggestion)

# Send a simple message with suggested action to the device
cluster.send_to_msisdn('+12223334444')
यह कोड एक आरबीएम सैंपल एजेंट का अंश है।

सी#

using Google.Apis.RCSBusinessMessaging.v1.Data;
using RCSBusinessMessaging;


// Create an instance of the RBM API helper
RbmApiHelper rbmApiHelper = new RbmApiHelper(credentialsFileLocation,
                                                 projectId);

// Create a calendar event action
CreateCalendarEventAction calendarEventAction = new CreateCalendarEventAction
{
    Title = "My calendar event",
    Description = "Description of the calendar event",
    StartTime = "2020-06-30T19:00:00Z",
    EndTime = "2020-06-30T20:00:00Z"
};

// Attach the calendar event action to a suggested action
SuggestedAction suggestedAction = new SuggestedAction
{
    CreateCalendarEventAction = calendarEventAction,
    Text = "Save to calendar",
    PostbackData = "postback_data_1234"
};

// Attach the action to a suggestion object
Suggestion suggestion = new Suggestion
{
    Action = suggestedAction
};

List<Suggestion> suggestions = new List<Suggestion>
{
    suggestion
};

rbmApiHelper.SendTextMessage(
    "Hello, world!",
    "+12223334444",
    suggestions
);
यह कोड एक आरबीएम सैंपल एजेंट का अंश है।

सुझाव चिप सूची

आपका एजेंट उपयोगकर्ताओं को आगे की कार्रवाई के लिए मार्गदर्शन देने हेतु संदेशों के साथ सुझाव चिप सूचियाँ भेजता है। चिप सूची केवल तभी प्रदर्शित होती है जब संबंधित संदेश वार्तालाप के अंत में होता है। वार्तालाप में आने वाले कोई भी बाद के संदेश (चाहे उपयोगकर्ता द्वारा भेजे गए हों या आपके एजेंट द्वारा) चिप सूची को ओवरराइट कर देते हैं।

सूची में मौजूद चिप्स सुझाए गए उत्तर और सुझाए गए कार्य हैं।

चिप सूचियों में अधिकतम 11 सुझाव चिप्स हो सकते हैं, और प्रत्येक चिप लेबल में अधिकतम 25 अक्षर हो सकते हैं।

फॉर्मेटिंग और वैल्यू विकल्पों के लिए, AgentContentMessage देखें।

रिच कार्ड

रिच कार्ड मीडिया, टेक्स्ट और इंटरैक्टिव सुझावों को एक ही संदेश में संयोजित करते हैं। ये संबंधित जानकारी प्रस्तुत करने (उदाहरण के लिए, किसी उत्पाद को उसकी छवि, नाम और कीमत के साथ) और उपयोगकर्ताओं को "विवरण देखें" जैसे स्पष्ट अगले चरण के सुझाव के साथ मार्गदर्शन करने के लिए आदर्श हैं।

एक रिच कार्ड में निम्नलिखित चीजें हो सकती हैं:

इनमें से प्रत्येक फ़ील्ड वैकल्पिक है, लेकिन फ़ील्ड 1-3 में से कम से कम एक को रिच कार्ड में शामिल किया जाना चाहिए।

एक साथ कई कार्डों को क्षैतिज रूप से स्क्रॉल करने वाले कैरोसेल में भेजा जा सकता है।

ध्यान दें कि रिच कार्ड के लिए कुल पेलोड 250 केबी है।

संपूर्ण तकनीकी जानकारी के लिए, रिच कार्ड दस्तावेज़ देखें।

कार्ड की ऊंचाई

रिच कार्ड अपनी सामग्री के अनुसार लंबवत रूप से फैलते हैं। इनकी न्यूनतम ऊंचाई 112 डीपी और अधिकतम ऊंचाई 344 डीपी होती है। यदि कार्ड की सामग्री न्यूनतम ऊंचाई के लिए पर्याप्त बड़ी नहीं है, तो कार्ड फैलकर अतिरिक्त ऊंचाई को खाली स्थान से भर देता है।

रिच कार्ड में मीडिया को तीन ऊंचाइयों में से किसी एक में फिट होना चाहिए:

  • संक्षिप्त: 112 डीपी
  • माध्यम: 168 डीपी
  • ऊंचाई: 264 डीपी

यदि मीडिया चयनित ऊंचाई के अनुसार कार्ड के आयामों में फिट नहीं होता है, तो मीडिया का पूर्वावलोकन ज़ूम करके और मीडिया को क्रॉप करके चुना जाता है।

उदाहरण

निम्नलिखित कोड एक छवि और सुझाए गए उत्तरों के साथ एक रिच कार्ड भेजता है। फ़ॉर्मेटिंग और मान विकल्पों के लिए, RichCard देखें।

कर्ल

curl -X POST "https://REGION-rcsbusinessmessaging.googleapis.com/v1/phones/PHONE_NUMBER/agentMessages?messageId=MESSAGE_ID&agentId=AGENT_ID" \
-H "Content-Type: application/json" \
-H "User-Agent: curl/rcs-business-messaging" \
-H "`oauth2l header --json PATH_TO_SERVICE_ACCOUNT_KEY rcsbusinessmessaging`" \
-d '{
  "contentMessage": {
    "richCard": {
      "standaloneCard": {
        "thumbnailImageAlignment": "RIGHT",
        "cardOrientation": "VERTICAL",
        "cardContent": {
          "title": "Hello, world!",
          "description": "RBM is awesome!",
          "media": {
            "height": "TALL",
            "contentInfo":{
              "fileUrl": "http://www.google.com/logos/doodles/2015/googles-new-logo-5078286822539264.3-hp2x.gif",
              "forceRefresh": false
            }
          },
          "suggestions": [
            {
              "reply": {
                "text": "Suggestion #1",
                "postbackData": "suggestion_1"
              }
            },
            {
              "reply": {
                "text": "Suggestion #2",
                "postbackData": "suggestion_2"
              }
            }
          ]
        }
      }
    }
  }
}'

नोड.जेएस

// Reference to RBM API helper
const rbmApiHelper = require('@google/rcsbusinessmessaging');

// Suggested replies to be used in the card
let suggestions = [
   {
      reply: {
         'text': 'Suggestion #1',
         'postbackData': 'suggestion_1',
      },
   },
   {
      reply: {
         'text': 'Suggestion #2',
         'postbackData': 'suggestion_2',
      },
   },
];

// Image to be displayed by the card
let imageUrl = 'http://www.google.com/logos/doodles/2015/googles-new-logo-5078286822539264.3-hp2x.gif';

// Definition of the card parameters
let params = {
   messageText: 'Hello, world!',
   messageDescription: 'RBM is awesome!',
   msisdn: '+12223334444',
   suggestions: suggestions,
   imageUrl: imageUrl,
   height: 'TALL',
};

// Send rich card to device
rbmApiHelper.sendRichCard(params, function(response) {
   console.log(response);
});
यह कोड एक आरबीएम सैंपल एजेंट का अंश है।

जावा

import com.google.api.services.rcsbusinessmessaging.v1.model.StandaloneCard;
import com.google.api.services.rcsbusinessmessaging.v1.model.Suggestion;
import com.google.rbm.cards.CardOrientation;
import com.google.rbm.cards.MediaHeight;
import com.google.rbm.RbmApiHelper;
import com.google.rbm.SuggestionHelper;


try {
   // Create an instance of the RBM API helper
   RbmApiHelper rbmApiHelper = new RbmApiHelper();

   // Create suggestions for chip list
   List<Suggestion> suggestions = new ArrayList<Suggestion>();
   suggestions.add(
      new SuggestionHelper("Suggestion #1", "suggestion_1").getSuggestedReply());

   suggestions.add(
      new SuggestionHelper("Suggestion #2", "suggestion_2").getSuggestedReply());

   String imageUrl = "http://www.google.com/logos/doodles/2015/googles-new-logo-5078286822539264.3-hp2x.gif";

   // Create a standalone rich card to send to the user
   StandaloneCard standaloneCard = rbmApiHelper.createStandaloneCard(
       "Hello, world!",
       "RBM is awesome!",
       imageUrl,
       MediaHeight.MEDIUM,
       CardOrientation.VERTICAL,
       suggestions
   );

   rbmApiHelper.sendStandaloneCard(standaloneCard, "+12223334444");
} catch(Exception e) {
   e.printStackTrace();
}
यह कोड एक आरबीएम सैंपल एजेंट का अंश है।

पायथन

# Reference to RBM Python client helper and messaging object structure
from rcs_business_messaging import rbm_service
from rcs_business_messaging import messages

# Suggested replies to be used in the card
suggestions = [
      messages.SuggestedReply('Suggestion #1', 'reply:suggestion_1'),
      messages.SuggestedReply('Suggestion #2', 'reply:suggestion_2')
]

# Image to be displayed by the card
image_url = 'http://www.google.com/logos/doodles/2015/googles-new-logo-5078286822539264.3-hp2x.gif';

# Define rich card structure
rich_card = messages.StandaloneCard('VERTICAL',
                                    'Hello, world!',
                                    'RBM is awesome!',
                                    suggestions,
                                    image_url,
                                    None,
                                    None,
                                    'MEDIUM')

# Append rich card and send to the user
cluster = messages.MessageCluster().append_message(rich_card)
cluster.send_to_msisdn('+12223334444')
यह कोड एक आरबीएम सैंपल एजेंट का अंश है।

सी#

using Google.Apis.RCSBusinessMessaging.v1.Data;
using RCSBusinessMessaging;
using RCSBusinessMessaging.Cards;


// Create an instance of the RBM API helper
RbmApiHelper rbmApiHelper = new RbmApiHelper(credentialsFileLocation,
                                             projectId);

List<Suggestion> suggestions = new List<Suggestion>
{
   // Create suggestion chips
   new SuggestionHelper("Suggestion #1", "suggestion_1").SuggestedReply(),
   new SuggestionHelper("Suggestion #2", "suggestion_2").SuggestedReply()
};

string imageUrl = "http://www.google.com/logos/doodles/2015/googles-new-logo-5078286822539264.3-hp2x.gif";

// Create rich card with suggestions
StandaloneCard standaloneCard = rbmApiHelper.CreateStandaloneCard(
   "Hello, world!",
   "RBM is awesome",
   imageUrl,
   MediaHeight.TALL,
   CardOrientation.VERTICAL,
   suggestions
);

// Send rich card to user
rbmApiHelper.SendStandaloneCard(standaloneCard, "+12223334444");
यह कोड एक आरबीएम सैंपल एजेंट का अंश है।

रिच कार्ड कैरोसेल

कैरोसेल कई रिच कार्डों को एक साथ जोड़ते हैं, जिससे उपयोगकर्ता वस्तुओं की तुलना कर सकते हैं और प्रत्येक पर व्यक्तिगत रूप से प्रतिक्रिया दे सकते हैं।

कैरोसेल में कम से कम दो और अधिकतम दस रिच कार्ड हो सकते हैं। कैरोसेल के भीतर रिच कार्ड को सामग्री और ऊंचाई के लिए सामान्य रिच कार्ड आवश्यकताओं का पालन करना होगा, जैसा कि रिच कार्ड दस्तावेज़ में वर्णित है। कैरोसेल लेआउट और विशिष्टताओं के बारे में अधिक जानकारी के लिए, कैरोसेल दस्तावेज़ देखें।

उदाहरण

निम्नलिखित कोड रिच कार्ड कैरोसेल भेजता है। फ़ॉर्मेटिंग और वैल्यू विकल्पों के लिए, RichCard देखें।

कर्ल

curl -X POST "https://REGION-rcsbusinessmessaging.googleapis.com/v1/phones/PHONE_NUMBER/agentMessages?messageId=MESSAGE_ID&agentId=AGENT_ID" \
-H "Content-Type: application/json" \
-H "User-Agent: curl/rcs-business-messaging" \
-H "`oauth2l header --json PATH_TO_SERVICE_ACCOUNT_KEY rcsbusinessmessaging`" \
-d '{
  "contentMessage": {
    "richCard": {
      "carouselCard": {
        "cardWidth": "MEDIUM",
        "cardContents": [
          {
            "title": "Card #1",
            "description": "The description for card #1",
            "suggestions": [
              {
                "reply": {
                  "text": "Card #1",
                  "postbackData": "card_1"
                }
              }
            ],
            "media": {
              "height": "MEDIUM",
              "contentInfo": {
                "fileUrl": "https://storage.googleapis.com/welcome-bot-sample-images/200.jpg",
                "forceRefresh": false
              }
            }
          },
          {
            "title": "Card #2",
            "description": "The description for card #2",
            "suggestions": [
              {
                "reply": {
                  "text": "Card #2",
                  "postbackData": "card_2"
                }
              }
            ],
            "media": {
              "height": "MEDIUM",
              "contentInfo": {
                "fileUrl": "https://storage.googleapis.com/welcome-bot-sample-images/201.jpg",
                "forceRefresh": false
              }
            }
          }
        ]
      }
    }
  }
}'

नोड.जेएस

// Reference to RBM API helper
const rbmApiHelper = require('@google/rcsbusinessmessaging');

// Images for the carousel cards
let card1Image = 'https://storage.googleapis.com/welcome-bot-sample-images/200.jpg';
let card2Image = 'https://storage.googleapis.com/welcome-bot-sample-images/201.jpg';

// Define the card contents for a carousel with two cards, each with one suggested reply
let cardContents = [
   {
      title: 'Card #1',
      description: 'The description for card #1',
      suggestions: [
         {
            reply: {
               text: 'Card #1',
               postbackData: 'card_1',
            }
         }
      ],
      media: {
         height: 'MEDIUM',
         contentInfo: {
            fileUrl: card1Image,
            forceRefresh: false,
         },
      },
   },
   {
      title: 'Card #2',
      description: 'The description for card #2',
      suggestions: [
         {
            reply: {
               text: 'Card #2',
               postbackData: 'card_2',
            }
         }
      ],
      media: {
         height: 'MEDIUM',
         contentInfo: {
            fileUrl: card2Image,
            forceRefresh: false,
         },
      },
   },
];

// Definition of carousel card
let params = {
   msisdn: '+12223334444',
   cardContents: cardContents,
};

// Send the device the carousel card defined above
rbmApiHelper.sendCarouselCard(params, function(response) {
   console.log(response);
});
यह कोड एक आरबीएम सैंपल एजेंट का अंश है।

जावा

import com.google.api.services.rcsbusinessmessaging.v1.model.CardContent;
import com.google.api.services.rcsbusinessmessaging.v1.model.Suggestion;
import com.google.rbm.cards.CardOrientation;
import com.google.rbm.cards.CardWidth;
import com.google.rbm.cards.MediaHeight;
import com.google.rbm.RbmApiHelper;
import com.google.rbm.SuggestionHelper;


try {
            // Create an instance of the RBM API helper
            RbmApiHelper rbmApiHelper = new RbmApiHelper();

            List cardContents = new ArrayList();

            // Images for the carousel cards
            String card1Image = "https://storage.googleapis.com/welcome-bot-sample-images/200.jpg";

            // Create suggestions for first carousel card
            List card1Suggestions = new ArrayList();
            card1Suggestions.add(
                new SuggestionHelper("Card #1", "card_1"));

            cardContents.add(
                new StandaloneCardHelper(
                    "Card #1",
                    "The description for card #1",
                    card1Image,
                    card1Suggestions)
                    .getCardContent(MediaHeight.SHORT)
            );

            // Images for the carousel cards
            String card2Image = "https://storage.googleapis.com/welcome-bot-sample-images/201.jpg";

            // Create suggestions for second carousel card
            List card2Suggestions = new ArrayList();
            card2Suggestions.add(
                new SuggestionHelper("Card #2", "card_2"));

            cardContents.add(
                new StandaloneCardHelper(
                    "Card #2",
                    "The description for card #2",
                    card2Image,
                    card2Suggestions)
                    .getCardContent(MediaHeight.SHORT)
            );

            // Send the carousel to the user
            rbmApiHelper.sendCarouselCards(cardContents, CardWidth.MEDIUM, "+12223334444");
        } catch(Exception e) {
            e.printStackTrace();
        }
यह कोड एक आरबीएम सैंपल एजेंट का अंश है।

पायथन

# Reference to RBM Python client helper and messaging object structure
from rcs_business_messaging import rbm_service
from rcs_business_messaging import messages

# Images for the carousel cards
card_image_1 = 'https://storage.googleapis.com/welcome-bot-sample-images/200.jpg';
card_image_2 = 'https://storage.googleapis.com/welcome-bot-sample-images/201.jpg';

# Suggested replies to be used in the cards
suggestions1 = [
      messages.SuggestedReply('Card #1', 'reply:card_1')
]

suggestions2 = [
      messages.SuggestedReply('Card #2', 'reply:card_2')
]

# Define the card contents for a carousel with two cards,
# each with one suggested reply
card_contents = []
card_contents.append(messages.CardContent('Card #1',
                                          'The description for card #1',
                                          card_image_1,
                                          'MEDIUM',
                                          suggestions1))

card_contents.append(messages.CardContent('Card #2',
                                          'The description for card #2',
                                          card_image_2,
                                          'MEDIUM',
                                          suggestions2))

# Send the device the carousel card defined above
carousel_card = messages.CarouselCard('MEDIUM', card_contents)
cluster = messages.MessageCluster().append_message(carousel_card)
cluster.send_to_msisdn('+12223334444')
यह कोड एक आरबीएम सैंपल एजेंट का अंश है।

सी#

using Google.Apis.RCSBusinessMessaging.v1.Data;
using RCSBusinessMessaging;
using RCSBusinessMessaging.Cards;


// Create an instance of the RBM API helper
RbmApiHelper rbmApiHelper = new RbmApiHelper(credentialsFileLocation,
                                             projectId);

// Image references to be used in the carousel cards
string card1Image = "https://storage.googleapis.com/welcome-bot-sample-images/200.jpg";
string card2Image = "https://storage.googleapis.com/welcome-bot-sample-images/201.jpg";

// Suggestion chip lists to be used in carousel cards
List<Suggestion> suggestions1 = new List<Suggestion>
{
   new SuggestionHelper("Card #1", "card_1").SuggestedReply()
};

List<Suggestion> suggestions2 = new List<Suggestion>
{
   new SuggestionHelper("Card #2", "card_2").SuggestedReply()
};

// Create the card content for the carousel
List<CardContent> cardContents = new List<CardContent>
{
   // Add items as card content
   new StandaloneCardHelper(
                    "Card #1",
                    "The description for card #1",
                    card1Image,
                    suggestions1).GetCardContent(),
   new StandaloneCardHelper(
                    "Card #2",
                    "The description for card #2",
                    card2Image,
                    suggestions2).GetCardContent()
};

// Send the carousel to the user
rbmApiHelper.SendCarouselCards(cardContents, CardWidth.MEDIUM, msisdn);
यह कोड एक आरबीएम सैंपल एजेंट का अंश है।