ส่งข้อความ

ตัวแทน RBM จะสื่อสารกับผู้ใช้โดยการส่งและรับข้อความ หากต้องการส่งข้อความถึงผู้ใช้ ตัวแทนจะส่งคําขอข้อความไปยัง RCS Business Messaging API คำขอเดียวอาจมีข้อความ การ์ดริชมีเดีย รูปภาพ หรือวิดีโอ รวมถึงคำตอบที่แนะนำและการดำเนินการที่แนะนำ

หากคุณส่งข้อความถึงผู้ใช้ที่อุปกรณ์ไม่รองรับ RCS หรือไม่ได้เปิดใช้ RCS แพลตฟอร์ม RBM จะแสดงข้อผิดพลาด 404 ในกรณีนี้ คุณสามารถพยายามติดต่อผู้ใช้ผ่านเมธอดสำรองที่กําหนดไว้ในโครงสร้างพื้นฐาน

หากคุณส่งข้อความถึงผู้ใช้ RCS ในเครือข่ายที่ยังไม่ได้เปิดตัวตัวแทนของคุณ หรือในเครือข่ายที่ยังไม่ได้เปิดใช้การรับส่งข้อมูล RCS แพลตฟอร์ม RBM จะแสดงข้อผิดพลาด 403

หากคุณส่งข้อความที่มีฟีเจอร์ที่อุปกรณ์ของผู้ใช้ไม่รองรับ แพลตฟอร์ม RBM จะแสดงข้อผิดพลาดและไม่นำส่งข้อความ

ในฐานะที่เป็นส่วนหนึ่งของกลยุทธ์การรับส่งข้อความแบบหลายช่องทาง คุณควรเพิกถอนข้อความที่ยังไม่ได้นำส่งหลังจากผ่านไประยะเวลาหนึ่งแล้ว และส่งผ่านช่องทางอื่น หากต้องการเพิกถอนข้อความโดยอัตโนมัติตามเวลาที่กําหนดไว้ล่วงหน้า ให้ตั้งค่าการหมดอายุของข้อความ

ผู้รับออฟไลน์อยู่

แพลตฟอร์ม RBM จะยังคงยอมรับข้อความสำหรับการนำส่งหากผู้รับออฟไลน์อยู่ คุณจะได้รับการตอบกลับ 200 OK และแพลตฟอร์ม RBM จะเก็บข้อความไว้และพยายามนำส่งอีกครั้งเป็นเวลา 30 วัน คุณจึงไม่จำเป็นต้องขอให้ RBM ส่งข้อความอีกครั้ง

RBM จะลบข้อความที่ยังไม่ได้นำส่งหลังจากส่งไปแล้ว 30 วัน

คุณอาจต้องเพิกถอนข้อความที่ยังไม่ได้นำส่งก่อนหมดเวลา 30 วันนี้ ทั้งนี้ขึ้นอยู่กับ Use Case ของตัวแทน การเพิกถอนอาจป้องกันไม่ให้ผู้ใช้ออฟไลน์ได้รับข้อความที่ล้าสมัยเมื่อกลับมาออนไลน์ การเพิกถอนข้อความทำได้หลายวิธี ดังนี้

ตั้งค่าการหมดอายุของข้อความ

ข้อความของตัวแทนมีเวลาจำกัดหรือไม่ เช่น OTP จะใช้งานได้เพียงระยะเวลาสั้นๆ เท่านั้น ข้อเสนอที่มีเวลาจำกัดจะหมดอายุ และการช่วยเตือนการนัดหมายจะไม่มีผลหลังจากวันที่นัดหมาย ตั้งค่าการหมดอายุของข้อความเพื่อช่วยดูแลให้ข้อความมีความเกี่ยวข้องและทันท่วงที วิธีนี้จะช่วยป้องกันไม่ให้ผู้ใช้ออฟไลน์ได้รับเนื้อหาที่ล้าสมัยเมื่อกลับมาออนไลน์ การหมดอายุยังเป็นสัญญาณที่ดีในการเรียกใช้กลยุทธ์การรับส่งข้อความสำรองเพื่อให้ผู้ใช้ได้รับข้อมูลที่จําเป็นตรงเวลา

หากต้องการตั้งค่าการหมดอายุของข้อความ ให้ระบุช่องใดช่องหนึ่งต่อไปนี้ในข้อความของตัวแทน

  • expireTime: เวลาตามเขตเวลา UTC ที่ข้อความจะหมดอายุ
  • ttl(time to live): ระยะเวลาก่อนที่ข้อความจะหมดอายุ

ดูตัวเลือกการจัดรูปแบบและค่าได้ที่ AgentMessage

เมื่อข้อความหมดอายุ แพลตฟอร์ม RBM จะหยุดพยายามส่งข้อความนั้น และระบบจะเพิกถอนข้อความโดยอัตโนมัติ อย่างไรก็ตาม การดำเนินการนี้อาจไม่สำเร็จในบางกรณี เช่น API อาจทริกเกอร์การเพิกถอนขณะที่แพลตฟอร์ม RBM กำลังส่งข้อความ หากต้องการยืนยันว่ามีการเพิกถอนข้อความที่หมดอายุเรียบร้อยแล้วหรือไม่ RBM จะส่งเหตุการณ์การแจ้งเตือนไปยัง Webhook ของคุณ

ค่าสูงสุดสำหรับ ttl และ expireTime คือ 15 วันหลังจากส่งข้อความ

ขีดจำกัดขนาดข้อความ

ขนาดสูงสุดของ AgentMessage แบบสตริงทั้งหมดคือ 250 KB ริชการ์ดและสื่ออื่นๆ จะเป็นตัวกำหนดขีดจำกัดขนาดนี้ ส่วนข้อความของข้อความจะมีขีดจํากัดเป็น 3072 อักขระ

ขนาดไฟล์สูงสุดที่ส่งผ่าน RBM ได้คือ 100 MB ข้อความ RBM รายการเดียวจะแนบไฟล์ PDF หรือไฟล์สื่อได้เพียงไฟล์เดียว ดูข้อมูลเพิ่มเติมได้ที่ไฟล์สื่อและไฟล์ PDF

ข้อความ

ข้อความที่ง่ายที่สุดคือข้อความที่เป็นข้อความล้วน SMS เหมาะอย่างยิ่งสําหรับการสื่อสารข้อมูลโดยไม่ต้องใช้ภาพ การโต้ตอบที่ซับซ้อน หรือการตอบกลับ

ตัวอย่าง

โค้ดต่อไปนี้จะส่งข้อความธรรมดา ดูตัวเลือกการจัดรูปแบบและค่าได้ที่ phones.agentMessages.create

cURL

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!'
  }
}"

Node.js

// 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);
});
โค้ดนี้เป็นข้อความที่ตัดมาจากตัวอย่างตัวแทน RBM

Java

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();
}
โค้ดนี้เป็นข้อความที่ตัดมาจากตัวอย่างตัวแทน RBM

Python

# 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')
โค้ดนี้เป็นข้อความที่ตัดมาจากตัวอย่างตัวแทน RBM

C#

using RCSBusinessMessaging;
…

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

rbmApiHelper.SendTextMessage(
    "Hello, world!",
    "+12223334444",
);
โค้ดนี้เป็นข้อความที่ตัดมาจากตัวอย่างตัวแทน RBM

เนื้อหาข้อความพื้นฐาน - การแปลง SMS

ผู้ให้บริการได้เปิดตัวรูปแบบการเรียกเก็บเงินเพื่อรองรับการย้ายข้อความ SMS ไปยัง RBM ข้อความ RBM ที่มีอักขระ UTF-8 ไม่เกิน 160 ตัวเรียกว่าข้อความพื้นฐาน

เมื่อสร้างคําขอเพื่อส่งข้อความพื้นฐาน โปรดทราบว่าระบบจะนับอักขระเป็น 1 ไบต์ (UTF-8) หากคุณส่งข้อความที่มีอักขระพิเศษ เช่น อีโมจิหรือชุดอักขระแบบหลายไบต์ ระบบจะนับอักขระแต่ละตัวเป็นอักขระ UTF-8 2 ตัว

ป้อนข้อความบางส่วนในช่องเพื่อตรวจสอบความยาว

รหัสผ่านที่สามารถใช้งานได้เพียงครั้งเดียวสำหรับการยืนยันผู้ใช้

คุณสามารถใช้ RBM เพื่อส่งรหัสผ่านแบบใช้ครั้งเดียว (OTP) สำหรับการยืนยันผู้ใช้โดยอัตโนมัติด้วย SMS Retriever API ดูข้อมูลเพิ่มเติมเกี่ยวกับ SMS Retriever และ API ที่เกี่ยวข้องได้ที่เอกสารประกอบเกี่ยวกับ SMS Retriever โปรดดูรายละเอียดเกี่ยวกับการยืนยันผู้ใช้โดยอัตโนมัติในแอปที่ลงทะเบียนกับ SMS Retriever API ที่แผนภาพขั้นตอนการทำงานนี้

ในระหว่างกระบวนการยืนยัน SMS Retriever API จะรอรับข้อความ RBM ข้อความนี้ต้องมี OTP และแฮชที่ระบุแอป หลังจากที่ระบบจับคู่แฮชกับแอปแล้ว ระบบจะดึงข้อมูล OTP และส่งต่อไปยังแอปเพื่อยืนยันผู้ใช้โดยอัตโนมัติ

ตัวอย่าง SMS ของ RBM สำหรับการยืนยันผู้ใช้คือ รหัสของคุณคือ <OTP> <app hash>

ตัวอย่างเช่น Your code is 123456 M8tue43FGT.

ไฟล์สื่อและ PDF

เมื่อคุณส่งข้อความที่มีรูปภาพ วิดีโอ เสียง หรือไฟล์ PDF ตัวแทนต้องระบุ URL ที่เข้าถึงได้แบบสาธารณะสำหรับเนื้อหาหรืออัปโหลดไฟล์โดยตรง สำหรับไฟล์สื่อ คุณยังระบุภาพขนาดย่อที่ช่วยให้ผู้ใช้ดูตัวอย่างเนื้อหาก่อนที่จะคลิกได้ด้วย สำหรับไฟล์เสียง ระบบจะใช้วิดเจ็ตเสียงเริ่มต้นเป็นตัวยึดตำแหน่ง

แพลตฟอร์ม RBM จะแคชไฟล์ไว้ 60 วัน และ API จะแสดงรหัสไฟล์ที่ตัวแทนของคุณใส่ไว้ในข้อความถึงผู้ใช้ได้ หลังจากผ่านไป 60 วัน RBM จะนําไฟล์ออกจากแคช

เมื่อระบุไฟล์ตาม URL แนวทางปฏิบัติแนะนำคือให้ตั้งค่า contentMessage.forceRefresh เป็น false การตั้งค่า contentMessage.forceRefresh เป็น true จะบังคับให้ RBM ดึงข้อมูลเนื้อหาใหม่จาก URL ที่ระบุ แม้ว่าระบบจะแคชเนื้อหา URL ไว้แล้วก็ตาม ซึ่งจะเพิ่มเวลาในการนำส่งข้อความให้แก่ผู้ใช้

ดูแนวทางปฏิบัติแนะนำสำหรับคำแนะนำและขีดจำกัดขนาดไฟล์

ตัวอย่าง URL ของไฟล์

โค้ดต่อไปนี้จะส่งรูปภาพ ดูตัวเลือกการจัดรูปแบบและค่าได้ที่ AgentContentMessage

cURL

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'
    }
  }
}"

Node.js

// 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);
});
โค้ดนี้เป็นข้อความที่ตัดมาจากตัวอย่างตัวแทน RBM

Java

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();
}
โค้ดนี้เป็นข้อความที่ตัดมาจากตัวอย่างตัวแทน RBM

Python

# 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')
โค้ดนี้เป็นข้อความที่ตัดมาจากตัวอย่างตัวแทน RBM

C#

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");
โค้ดนี้เป็นข้อความที่ตัดมาจากตัวอย่างตัวแทน RBM

หรือจะอัปโหลดสื่อก่อนส่งในข้อความด้วย files.create ก็ได้

ตัวอย่างการอัปโหลดไฟล์

โค้ดต่อไปนี้จะอัปโหลดไฟล์วิดีโอและไฟล์ภาพขนาดย่อ จากนั้นจะส่งทั้ง 2 ไฟล์ในข้อความ ดูตัวเลือกการจัดรูปแบบและค่าได้ที่ files.create และ AgentContentMessage

cURL

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'
   }
  }
}"

ประเภทสื่อที่รองรับ

RBM รองรับสื่อประเภทต่อไปนี้

ประเภทสื่อ ประเภทเอกสาร ส่วนขยาย ใช้ได้กับการ์ดริชมีเดีย
application/ogg เสียง OGG .ogx ไม่
application/pdf PDF .pdf ไม่
เสียง/AAC เสียง AAC .aac ไม่
audio/mp3 เสียง MP3 .mp3 ไม่
audio/mpeg เสียง MPEG .mpeg ไม่
audio/mpg เสียง MPG .mp3 ไม่
audio/mp4 เสียง MP4 .mp4 ไม่
audio/mp4-latm เสียง MP4-latm .mp4 ไม่
audio/3gpp เสียง 3GPP .3gp ไม่
image/jpeg JPEG .jpeg, .jpg ใช่
image/gif GIF .gif ใช่
image/png PNG .png ใช่
video/h263 วิดีโอ H263 .h263 ใช่
video/m4v วิดีโอ M4V .m4v ใช่
video/mp4 วิดีโอ MP4 .mp4 ใช่
video/mpeg4 วิดีโอ MPEG-4 .mp4, .m4p ใช่
video/mpeg วิดีโอ MPEG .mpeg ใช่
video/webm วิดีโอ WEBM .webm ใช่

คำตอบที่แนะนำ

คำตอบที่แนะนำจะแนะนำผู้ใช้ตลอดการสนทนาโดยให้คำตอบที่ตัวแทนของคุณทราบวิธีโต้ตอบ ตัวแทนจะส่งคำตอบที่แนะนำในรายการชิปคำแนะนำหรือในการ์ดริชมีเดีย

เมื่อผู้ใช้แตะการตอบที่แนะนำ ตัวแทนของคุณจะได้รับเหตุการณ์ที่มีข้อความและการตอบกลับของข้อมูลการรายงานผล Conversion

คำตอบที่แนะนำมีอักขระได้สูงสุด 25 ตัว

ตัวอย่าง

โค้ดต่อไปนี้จะส่งข้อความพร้อมคำตอบที่แนะนำ 2 รายการ ดูตัวเลือกการจัดรูปแบบและค่าได้ที่ SuggestedReply

cURL

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'
        }
      }
    ]
  }
}"

Node.js

// 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);
});
โค้ดนี้เป็นข้อความที่ตัดมาจากตัวอย่างตัวแทน RBM

Java

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();
}
โค้ดนี้เป็นข้อความที่ตัดมาจากตัวอย่างตัวแทน RBM

Python

# 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')
โค้ดนี้เป็นข้อความที่ตัดมาจากตัวอย่างตัวแทน RBM

C#

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
);
โค้ดนี้เป็นข้อความที่ตัดมาจากตัวอย่างตัวแทน RBM

การดำเนินการที่แนะนำ

การดําเนินการที่แนะนําจะแนะนําผู้ใช้ในการสนทนาโดยใช้ฟังก์ชันการทำงานในตัวของอุปกรณ์ ตัวแทนสามารถแนะนําให้ผู้ใช้โทรหาหมายเลข เปิดสถานที่บนแผนที่ แชร์สถานที่ เปิด URL หรือสร้างกิจกรรมในปฏิทิน ตัวแทนจะส่งการดำเนินการที่แนะนำในรายการชิปคำแนะนำหรือในการ์ดริชมีเดีย

เมื่อผู้ใช้แตะการดําเนินการที่แนะนํา ตัวแทนของคุณจะได้รับเหตุการณ์ที่มีข้อมูลการรายงานผล Conversion ของการดําเนินการ

การดำเนินการที่แนะนำมีอักขระได้สูงสุด 25 ตัว

ดูตัวเลือกการจัดรูปแบบและค่าได้ที่ SuggestedAction

กดหมายเลขโทรศัพท์

การดําเนินการโทรจะแนะนําให้ผู้ใช้โทรหาหมายเลขโทรศัพท์ที่ตัวแทนระบุ หมายเลขโทรศัพท์ใช้ได้เฉพาะตัวเลข (0-9), เครื่องหมายบวก (+), เครื่องหมายดอกจัน (*) และเครื่องหมายตัวเลข (#) ระบบรองรับรูปแบบสากล E.164 (เช่น +14155555555) แต่ไม่จำเป็นต้องใช้ กล่าวคือ ทั้ง +14155555555 และ 1011 เป็นรายการที่ถูกต้อง

ตัวอย่าง

โค้ดต่อไปนี้จะส่งการดําเนินการโทร ดูตัวเลือกการจัดรูปแบบและค่าได้ที่ DialAction

cURL

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'
          }
        }
      }
    ]
  }
}"

Node.js

// 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);
});
โค้ดนี้เป็นข้อความที่ตัดมาจากตัวอย่างตัวแทน RBM

Java

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();
}
โค้ดนี้เป็นข้อความที่ตัดมาจากตัวอย่างตัวแทน RBM

Python

# 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')
โค้ดนี้เป็นข้อความที่ตัดมาจากตัวอย่างตัวแทน RBM

C#

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
);
โค้ดนี้เป็นข้อความที่ตัดมาจากตัวอย่างตัวแทน RBM

ดูสถานที่

การดําเนินการดูตําแหน่งจะแสดงตําแหน่งในแอปแผนที่เริ่มต้นของผู้ใช้ คุณสามารถระบุตําแหน่งตามละติจูดและลองจิจูด หรือจะระบุด้วยการค้นหาตามตําแหน่งปัจจุบันของผู้ใช้ก็ได้ นอกจากนี้ คุณยังตั้งค่าป้ายกำกับที่กำหนดเองสำหรับหมุดที่แสดงในแอปแผนที่ได้ด้วย

ตัวอย่าง

โค้ดต่อไปนี้จะส่งการดําเนินการดูตําแหน่ง ดูตัวเลือกการจัดรูปแบบและค่าได้ที่ ViewLocationAction

cURL

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'
          }
        }
      }
    ]
  }
}"

Node.js

// 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);
});
โค้ดนี้เป็นข้อความที่ตัดมาจากตัวอย่างตัวแทน RBM

Java

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();
}
โค้ดนี้เป็นข้อความที่ตัดมาจากตัวอย่างตัวแทน RBM

Python

# 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')
โค้ดนี้เป็นข้อความที่ตัดมาจากตัวอย่างตัวแทน RBM

C#

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
);
โค้ดนี้เป็นข้อความที่ตัดมาจากตัวอย่างตัวแทน RBM

แชร์ตำแหน่ง

การดําเนินการแชร์ตําแหน่งช่วยให้ผู้ใช้ส่งตําแหน่งไปยังตัวแทนของคุณได้ ตำแหน่งที่ผู้ใช้ระบุไม่จำเป็นต้องเป็นตำแหน่งของผู้ใช้

ตัวอย่าง

โค้ดต่อไปนี้จะส่งการดําเนินการแชร์ตําแหน่ง ดูตัวเลือกการจัดรูปแบบและค่าได้ที่ ShareLocationAction

cURL

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': {}
        }
      }
    ]
  }
}"

Node.js

// 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);
});
โค้ดนี้เป็นข้อความที่ตัดมาจากตัวอย่างตัวแทน RBM

Java

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();
}
โค้ดนี้เป็นข้อความที่ตัดมาจากตัวอย่างตัวแทน RBM

Python

# 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')
โค้ดนี้เป็นข้อความที่ตัดมาจากตัวอย่างตัวแทน RBM

C#

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
);
โค้ดนี้เป็นข้อความที่ตัดมาจากตัวอย่างตัวแทน RBM

เปิด URL

การดำเนินการ OpenURL ช่วยให้คุณนำผู้ใช้ไปยังหน้าเว็บที่ระบุโดยตัวแทนได้ โดยค่าเริ่มต้น หน้าเว็บจะเปิดในเบราว์เซอร์ของผู้ใช้ หากผู้ใช้กําหนดค่าแอปเริ่มต้นสําหรับหน้าเว็บไว้ แอปนั้นจะเปิดแทน ในกรณีนี้ ไอคอนบนปุ่มการดำเนินการที่แนะนำจะเป็นไอคอนของแอป

การดำเนินการ OpenURL ยังรองรับ WebView ที่ผสานรวมด้วย โปรดดูเปิด URL ด้วย WebView

ตัวอย่าง

โค้ดต่อไปนี้จะส่งการดําเนินการเปิด URL ดูตัวเลือกการจัดรูปแบบและค่าได้ที่ OpenUrlAction

cURL

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'
          }
        }
      }
    ]
  }
}"

Node.js

// 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);
});
โค้ดนี้เป็นข้อความที่ตัดมาจากตัวอย่างตัวแทน RBM

Java


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();
}
โค้ดนี้เป็นข้อความที่ตัดมาจากตัวอย่างตัวแทน RBM

Python

# 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')
โค้ดนี้เป็นข้อความที่ตัดมาจากตัวอย่างตัวแทน RBM

C#

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
);
โค้ดนี้เป็นข้อความที่ตัดมาจากตัวอย่างตัวแทน RBM

เปิด URL ด้วย WebView

การดําเนินการ "เปิด URL ด้วยเว็บวิว" จะโหลดหน้าเว็บที่ระบุภายในแอปรับส่งข้อความด้วยเครื่องมือแสดงผลของเบราว์เซอร์เริ่มต้น ซึ่งช่วยให้ผู้ใช้โต้ตอบกับหน้าเว็บได้โดยไม่ต้องออกจากการสนทนา RBM หากต้องการเปิดใช้ WebView โปรดดู OpenURLApplication

WebView มีโหมดการแสดงผล 3 โหมด ดูตัวเลือกการจัดรูปแบบและค่าได้ที่ WebviewViewMode

  • เต็ม: หน้าเว็บแสดงเต็มหน้าจอ
  • ครึ่งหน้าจอ: หน้าเว็บแสดงครึ่งหนึ่งของหน้าจอ
  • สูง: เว็บเพจกินพื้นที่ 3 ใน 4 ของหน้าจอ

ตัวอย่าง

โค้ดต่อไปนี้จะส่ง URL ที่เปิดอยู่พร้อมการดําเนินการของ WebView ดูตัวเลือกการจัดรูปแบบและค่าได้ที่ OpenURLAction

cURL

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"
         }
       }
     }
   ]
 }
}'

Java

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;
    }

สร้างกิจกรรมปฏิทิน

การดำเนินการสร้างกิจกรรมในปฏิทินจะเปิดแอปปฏิทินของผู้ใช้และเริ่มสร้างกิจกรรมใหม่ด้วยข้อมูลที่ระบุ

ตัวอย่าง

โค้ดต่อไปนี้จะส่งการดําเนินการสร้างกิจกรรมในปฏิทิน ดูตัวเลือกการจัดรูปแบบและค่าได้ที่ CreateCalendarEventAction

cURL

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'
          }
        }
      }
    ]
  }
}"

Node.js

// 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);
});
โค้ดนี้เป็นข้อความที่ตัดมาจากตัวอย่างตัวแทน RBM

Java


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();
}
โค้ดนี้เป็นข้อความที่ตัดมาจากตัวอย่างตัวแทน RBM

Python

# 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')
โค้ดนี้เป็นข้อความที่ตัดมาจากตัวอย่างตัวแทน RBM

C#

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
);
โค้ดนี้เป็นข้อความที่ตัดมาจากตัวอย่างตัวแทน RBM

เขียนข้อความ

การดำเนินการเขียนจะเปิดแอปรับส่งข้อความของผู้ใช้เพื่อให้ผู้ใช้ส่งข้อความไปยังหมายเลขโทรศัพท์ที่กำหนดไว้ล่วงหน้าได้ เช่น หมายเลขฝ่ายสนับสนุนลูกค้า

การดำเนินการเขียนมี 3 ประเภท ดูตัวอย่างภาพได้ที่หัวข้อเขียนข้อความ เสียง หรือวิดีโอ

  • เขียน SMS: เปิดแอปรับส่งข้อความพร้อมข้อความที่กรอกไว้ล่วงหน้าเพื่อให้ผู้ใช้ส่ง
  • เขียนข้อความเสียง: เปิดแอปรับส่งข้อความและเปิดใช้งานไมโครโฟนเพื่อให้ผู้ใช้บันทึกเสียงได้
  • เขียนข้อความวิดีโอ: เปิดแอปรับส่งข้อความและเปิดกล้องเพื่อให้ผู้ใช้บันทึกวิดีโอได้

ตัวอย่าง

โค้ดต่อไปนี้จะส่งการดําเนินการเขียน ดูตัวเลือกการจัดรูปแบบและค่าได้ที่ ComposeAction

cURL

  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': 'Compose a text message',
          'postbackData': 'postback_data_123',
          'composeAction': {
            'composeTextMessage': {
              'phoneNumber': '+15556667777'
              'text': 'Draft to go into the send message text field.'
            }
          }
        }
      },{
        'action': {
          'text': 'Compose an audio message',
          'postbackData': 'postback_data_456',
          'composeAction': {
            'composeRecordingMessage': {
              'phoneNumber': '+15556667777'
              'type': 'ACTION_TYPE_AUDIO'
            }
          }
        }
      },{
        'action': {
          'text': 'Compose a video message',
          'postbackData': 'postback_data_789',
          'composeAction': {
            'composeRecordingMessage': {
              'phoneNumber': '+15556667777'
              'type': 'ACTION_TYPE_VIDEO'
            }
          }
        }
      }
    ]
  }
}"

Node.js

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

// Define a compose suggested action
let suggestions = [
   {
      action: {
         text: 'Compose a text message',
         postbackData: 'postback_data_123',
         'composeAction': {
            'composeTextMessage': {
               'phoneNumber': '+15556667777'
               'text': 'Draft to go into the send message text field.'
            }
         }
      }
   },{
      action: {
         text: 'Compose an audio message',
         postbackData: 'postback_data_456',
         'composeAction': {
            'composeRecordingMessage': {
               'phoneNumber': '+15556667777'
               'type': 'ACTION_TYPE_AUDIO'
            }
         }
      }
   },{
      action: {
         text: 'Compose a video message',
         postbackData: 'postback_data_789',
         'composeAction': {
            'composeRecordingMessage': {
               'phoneNumber': '+15556667777'
               'type': 'ACTION_TYPE_VIDEO'
            }
         }
      }
   }
];

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);
});

Java

import com.google.api.services.rcsbusinessmessaging.v1.model.ComposeAction;
import com.google.api.services.rcsbusinessmessaging.v1.model.ComposeRecordingMessage;
import com.google.api.services.rcsbusinessmessaging.v1.model.ComposeTextMessage;
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 compose text suggested action
   Suggestion composeTextSuggestion =  getComposeTextAction()
   suggestions.add(composeTextSuggestion);

   // creating compose audio suggested action
   Suggestion composeAudioSuggestion =  getComposeAudioAction()
   suggestions.add(composeAudioSuggestion);


   // Send simple text message with the suggestion action
   rbmApiHelper.sendTextMessage(
      "Hello, world!",
      "+12223334444",
      suggestions
   );
} catch(Exception e) {
   e.printStackTrace();
}

 /**
   * Creates a compose text suggested action.
   * @return A suggestion object for a compose text action.
 */
 private Suggestion getComposeTextAction() {
        // creating a compose text suggested action
        ComposeTextMessage message = new ComposeTextMessage();
        message.setPhoneNumber("+12223334444");
        message.setText("Draft to go into the send message text field.");
        ComposeAction composeAction = new ComposeAction();
        composeAction.setComposeTextMessage(message);

        // creating a suggested action based on a compose text action
        SuggestedAction suggestedAction = new SuggestedAction();
        suggestedAction.setText("Send a text message");
        suggestedAction.setPostbackData("postback_data_123");
        suggestedAction.setComposeAction(composeAction);

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

        return suggestion;
    }

    /**
     * Creates a compose audio suggested action.
     * @return A suggestion object for a compose audio action.
    */
    private Suggestion getComposeAudioAction() {
        // creating a compose audio suggested action
        ComposeRecordingMessage message = new ComposeRecordingMessage();
        message.setPhoneNumber("+12223334444");
        message.setType("ACTION_TYPE_AUDIO");
        ComposeAction composeAction = new ComposeAction();
        composeAction.setComposeRecordingMessage(message);

        // creating a suggested action based on a compose text action
        SuggestedAction suggestedAction = new SuggestedAction();
        suggestedAction.setText("Send an audio message");
        suggestedAction.setPostbackData("postback_data_456");
        suggestedAction.setComposeAction(composeAction);

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

        return suggestion;
    }

Python

  # 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.ComposeTextMessageAction(
          'Send a text message',
          'postback_data_123',
          '+15556667777',
          '')
      messages.ComposeRecordingMessageAction(
          'Send an audio message',
          'postback_data_456',
          '+15556667777',
          'ACTION_TYPE_AUDIO')
  
  ]

  # 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')

C#

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

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

  // Create a compose text suggested action
  ComposeTextMessage composeTextMessage = new ComposeTextMessage{
      PhoneNumber = "+15556667777"
      Text = "Draft to go into the send message text field."
  };

  ComposeAction composeAction = new ComposeAction
  {
      ComposeTextMessage = composeTextMessage
  };

  // Creating a suggested action based on a compose action
  SuggestedAction suggestedAction = new SuggestedAction
  {
      Text = "Send a text message",
      PostbackData = "postback_data_123",
      ComposeAction = composeAction
  };

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

  List suggestions = new List
  {
      suggestion
  };

  rbmApiHelper.SendTextMessage(
      "Hello, world!",
      "+12223334444",
      suggestions
  );

รายการชิปคำแนะนำ

ตัวแทนจะส่งรายการชิปคำแนะนำพร้อมข้อความเพื่อแนะนำการดำเนินการต่อของผู้ใช้ รายการชิปจะแสดงเฉพาะเมื่อข้อความที่เกี่ยวข้องอยู่ที่ด้านล่างของการสนทนา ข้อความต่อๆ มาในการสนทนา (จากผู้ใช้หรือตัวแทนของคุณ) จะเขียนทับรายการชิป

ชิปในรายการคือการตอบกลับที่แนะนำและการดำเนินการที่แนะนำ

รายการชิปมีชิปคำแนะนำได้สูงสุด 11 รายการ และป้ายกำกับชิปแต่ละรายการมีอักขระได้สูงสุด 25 ตัว

ดูตัวเลือกการจัดรูปแบบและค่าได้ที่ AgentContentMessage

การ์ดริชมีเดีย

คุณควรส่งการ์ดริชมีเดียเมื่อต้องการส่งข้อมูล สื่อ หรือคำแนะนำที่เกี่ยวข้องเป็นจำนวนมาก การ์ดริชมีเดียช่วยให้ตัวแทนส่งข้อมูลหลายหน่วยในข้อความเดียวได้

การ์ดริชมีเดียอาจมีรายการต่อไปนี้

  • รูปภาพหรือวิดีโอ
  • ข้อความชื่อ
  • ข้อความคำอธิบาย
  • รายการการตอบกลับที่แนะนำและการดําเนินการที่แนะนํา (สูงสุด 4 รายการ)

การ์ดริชมีเดียอาจมีรายการที่ระบุไว้ทั้งหมด แต่ต้องมีรูปภาพ วิดีโอ หรือชื่ออย่างน้อย 1 รายการจึงจะใช้งานได้ การ์ดริชมีเดียมีการดำเนินการที่แนะนำหรือการตอบกลับที่แนะนำได้สูงสุด 4 รายการ โดยจะต้องไม่มีการดำเนินการและการตอบที่แนะนำรวมอยู่ในการ์ดเดียว

ตัวแทนสามารถส่งการ์ดริชมีเดียหลายรายการพร้อมกันในภาพสไลด์ของการ์ดริชมีเดีย

ขนาดสูงสุดของเพย์โหลดการ์ดริชมีเดียคือ 250 KB ดูแนวทางปฏิบัติแนะนำสำหรับคำแนะนำและขีดจำกัดขนาดไฟล์สื่อ

ความสูงของการ์ด

การ์ดจะขยายในแนวตั้งเพื่อให้พอดีกับเนื้อหา การ์ดริชมีจุดสูงสุด 112 DP และจุดต่ำสุด 344 DP หากเนื้อหาของการ์ดมีขนาดเล็กเกินกว่าที่จะเติมเต็มความสูงขั้นต่ำของการ์ด การ์ดจะขยายและเติมความสูงส่วนเกินด้วยพื้นที่ว่าง

สื่อในการ์ดริชมีเดียต้องมีขนาดความสูงอย่างใดอย่างหนึ่งต่อไปนี้

  • สั้น: 112 DP
  • กลาง: 168 DP
  • สูง: 264 DP

หากสื่อไม่พอดีกับขนาดภายในการ์ดตามความสูงที่เลือก ระบบจะเลือกตัวอย่างสื่อโดยการซูมและครอบตัดสื่อ

ตัวอย่าง

โค้ดต่อไปนี้จะส่งการ์ดริชมีเดียที่มีรูปภาพและคำตอบที่แนะนำ ดูตัวเลือกการจัดรูปแบบและค่าได้ที่ RichCard

cURL

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'
              }
            }
          ]
        }
      }
    }
  }
}"

Node.js

// 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);
});
โค้ดนี้เป็นข้อความที่ตัดมาจากตัวอย่างตัวแทน RBM

Java

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();
}
โค้ดนี้เป็นข้อความที่ตัดมาจากตัวอย่างตัวแทน RBM

Python

# 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')
โค้ดนี้เป็นข้อความที่ตัดมาจากตัวอย่างตัวแทน RBM

C#

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");
โค้ดนี้เป็นข้อความที่ตัดมาจากตัวอย่างตัวแทน RBM

ภาพสไลด์ของ Rich Card

เมื่อคุณต้องการแสดงตัวเลือกหลายรายการให้ผู้ใช้เลือก ให้ใช้ภาพสไลด์ของการ์ดริชมีเดีย ภาพสไลด์จะแสดงการ์ดริชมีเดียหลายรายการต่อกัน ซึ่งช่วยให้ผู้ใช้เปรียบเทียบรายการต่างๆ และแสดงความรู้สึกต่อแต่ละรายการแยกกันได้

ภาพสไลด์อาจมีการ์ดริชมีเดียอย่างน้อย 2 รายการและไม่เกิน 10 รายการ การ์ดริชมีเดียภายในภาพสไลด์ต้องเป็นไปตามข้อกําหนดทั่วไปของการ์ดริชมีเดียสำหรับเนื้อหาและความสูง

ขนาดสูงสุดของเพย์โหลดภาพสไลด์ของการ์ดริชมีเดียคือ 250 KB ดูแนวทางปฏิบัติแนะนำสำหรับคำแนะนำและขีดจำกัดขนาดไฟล์สื่อ

เช่นเดียวกับการ์ดริชมีเดีย ปัจจัยหลายอย่าง (เช่น ความละเอียดของหน้าจอ ความหนาแน่นของพิกเซล และค่ากําหนดของผู้ใช้) จะส่งผลต่อลักษณะที่การ์ดปรากฏต่อผู้ใช้ปลายทาง อย่างไรก็ตาม ในภาพสไลด์ ความสูงของการ์ด 2-3 ใบแรกจะเป็นตัวกำหนดความสูงของการ์ดทั้งหมดในภาพสไลด์ และความสูงของการ์ดจะส่งผลต่อการตัดชื่อ คำอธิบาย และคำแนะนํา

หากอุปกรณ์แสดงองค์ประกอบทั้งหมดของการ์ดไม่ได้เนื่องจากข้อจํากัดในการแสดงผลหรือความสูงของการ์ด RBM จะตัดการ์ดออกจนกว่าจะแสดงในอุปกรณ์ได้โดยใช้ตรรกะต่อไปนี้

  1. ย่อคำอธิบายให้เหลือ 1 บรรทัด
  2. ย่อชื่อให้เหลือ 1 บรรทัด
  3. ละเว้นคำแนะนำที่ไม่พอดีกับการ์ด โดยเริ่มจากท้ายรายการที่กําหนด
  4. ละเว้นคำอธิบาย
  5. ละเว้นชื่อ

โปรดตั้งชื่อและคำอธิบายให้สั้นที่สุดเพื่อหลีกเลี่ยงการตัดให้สั้นลง สำหรับสื่อแนวตั้ง ให้ใช้ชื่อและคําอธิบายหรือคําแนะนํารายการเดียว สําหรับสื่อกลาง ให้ใช้คําแนะนําไม่เกิน 2 รายการ สำหรับสื่อแบบสั้น ให้ใช้คําแนะนําได้สูงสุด 3 รายการ หากต้องการใส่คําแนะนํา 4 รายการ อย่าใส่สื่อในการ์ด

การ์ดแต่ละใบควรมีขนาดและความยาวของเนื้อหาใกล้เคียงกัน และหากจําเป็น ให้ใส่การ์ดขนาดใหญ่ไว้ด้านหน้าของภาพสไลด์เพื่อหลีกเลี่ยงการถูกตัดในการ์ดต่อๆ ไป

ตัวอย่าง

รหัสต่อไปนี้จะส่งภาพสไลด์ของการ์ดริชมีเดีย ดูตัวเลือกการจัดรูปแบบและค่าได้ที่ RichCard

cURL

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/kitchen-sink-sample-images/cute-dog.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/kitchen-sink-sample-images/elephant.jpg',
                'forceRefresh': 'false'
              }
            }
          }
        ]
      }
    }
  }
}"

Node.js

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

// Images for the carousel cards
let card1Image = 'https://storage.googleapis.com/kitchen-sink-sample-images/cute-dog.jpg';
let card2Image = 'https://storage.googleapis.com/kitchen-sink-sample-images/elephant.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);
});
โค้ดนี้เป็นข้อความที่ตัดมาจากตัวอย่างตัวแทน RBM

Java

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/kitchen-sink-sample-images/cute-dog.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/kitchen-sink-sample-images/elephant.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();
        }
โค้ดนี้เป็นข้อความที่ตัดมาจากตัวอย่างตัวแทน RBM

Python

# 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/kitchen-sink-sample-images/cute-dog.jpg';
card_image_2 = 'https://storage.googleapis.com/kitchen-sink-sample-images/elephant.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')
โค้ดนี้เป็นข้อความที่ตัดมาจากตัวอย่างตัวแทน RBM

C#

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/kitchen-sink-sample-images/cute-dog.jpg";
string card2Image = "https://storage.googleapis.com/kitchen-sink-sample-images/elephant.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);
โค้ดนี้เป็นข้อความที่ตัดมาจากตัวอย่างตัวแทน RBM
ก่อนหน้า
อุปกรณ์สำหรับทดสอบ
ถัดไป
เพิกถอนข้อความ