ส่งข้อความ

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

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

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

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

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

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

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

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

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

ตั้งวันหมดอายุของข้อความ

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

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

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

สำหรับตัวเลือกการจัดรูปแบบและค่า โปรดดู AgentMessage

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

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

ข้อความ

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

ตัวอย่าง

รหัสต่อไปนี้จะส่งข้อความธรรมดา สำหรับการจัดรูปแบบและค่า ตัวเลือก โปรดดูที่ 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 ที่มีจำนวนไม่เกิน 160 อักขระ UTF-8 เรียกว่าข้อความพื้นฐาน

เมื่อสร้างคำขอเพื่อส่งข้อความพื้นฐาน โปรดทราบว่าอักขระดังกล่าว จะนับเป็น 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 และส่งต่อไปยัง เพื่อใช้ยืนยันผู้ใช้โดยอัตโนมัติ

นี่คือตัวอย่างข้อความ RBM สำหรับการยืนยันผู้ใช้: รหัสของคุณคือ <OTP> <แฮชของแอป>

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

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

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

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

ดูแนวทางปฏิบัติแนะนำ เพื่อดูคำแนะนำและขีดจำกัดของขนาดไฟล์

ตัวอย่าง 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

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

โค้ดต่อไปนี้จะอัปโหลดไฟล์วิดีโอและไฟล์ภาพขนาดย่อ จากนั้นจะส่งทั้งไฟล์วิดีโอ ในข้อความ สำหรับตัวเลือกการจัดรูปแบบและค่า โปรดดู 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 ไม่ได้
เสียง/mp3 เสียง MP3 .mp3 ไม่ได้
เสียง/mpeg เสียง MPEG .mpeg ไม่ได้
เสียง/mpg เสียง MPG .mp3 ไม่ได้
เสียง/mp4 เสียง MP4 .mp4 ไม่ได้
เสียง/mp4-latm เสียง MP4 ละติน .mp4 ไม่ได้
เสียง/3gpp เสียง 3GPP .3gp ไม่ได้
image/jpeg JPEG .jpeg, .jpg ใช่
image/gif GIF .gif ใช่
image/png PNG .png ใช่
วิดีโอ/H263 วิดีโอ H263 .h263 ใช่
วิดีโอ/m4v วิดีโอ M4V .m4v ใช่
วิดีโอ/MP4 วิดีโอ MP4 .mp4 ใช่
วิดีโอ/Mpeg4 วิดีโอ MPEG-4 .mp4, .m4p ใช่
วิดีโอ/Mpeg วิดีโอ MPEG .mpeg ใช่
วิดีโอ/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

ดูตำแหน่ง

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

ตัวอย่าง

โค้ดต่อไปนี้จะส่งการดำเนินการตำแหน่งของข้อมูลพร็อพเพอร์ตี้ สำหรับการจัดรูปแบบและค่า ตัวเลือก โปรดดูที่ 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

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

ตัวอย่าง

โค้ดต่อไปนี้จะส่งการดำเนินการ 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

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

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

ตัวอย่าง

โค้ดต่อไปนี้จะส่งการดำเนินการสร้างกิจกรรมในปฏิทิน สำหรับการจัดรูปแบบและ ตัวเลือกมูลค่า โปรดดู 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

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

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

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

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

สำหรับตัวเลือกการจัดรูปแบบและค่า โปรดดู AgentContentMessage

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

เมื่อคุณต้องการส่งข้อมูล สื่อ หรือ คุณควรส่ง Rich Card Rich Card ช่วยให้ตัวแทนของคุณส่ง ข้อมูลหลายหน่วยในข้อความเดียว

Rich Card สามารถมีสิ่งต่อไปนี้

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

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

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

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

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

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

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

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

ตัวอย่าง

โค้ดต่อไปนี้จะส่ง Rich Card ที่มีรูปภาพและคำแนะนำ คำตอบ สำหรับตัวเลือกการจัดรูปแบบและค่า โปรดดู 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 ใบ สมบูรณ์ การ์ดในภาพสไลด์ต้องเป็นไปตามข้อกำหนดทั่วไปสำหรับ Rich Card สำหรับ เนื้อหาและความสูง

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

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

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

ให้ตั้งชื่อและคำอธิบายให้สั้นที่สุดเท่าที่จะทำได้เพื่อหลีกเลี่ยงการตัดข้อความ สำหรับคนสูง สื่อ ให้ใช้ชื่อและคำอธิบาย หรือคำแนะนำ 1 รายการ สำหรับขนาดกลาง สื่อ ใช้คำแนะนำได้สูงสุด 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

ขนาดข้อความสูงสุด

ขนาดสูงสุดของข้อความที่ส่งในข้อความ RBM ได้คือ 256kb ช่วงเวลานี้ รวมข้อความที่ประกอบขึ้นเป็นเพย์โหลด JSON เมื่อส่งแบบมีโครงสร้าง ข้อความ

ขนาดสูงสุดของไฟล์ที่สามารถส่งผ่าน RBM ได้คือ 200 MB

ข้อความ RBM 1 ข้อความสามารถแนบไฟล์สื่อได้เพียงไฟล์เดียวเท่านั้น

ก่อนหน้า
ตั้งค่าอุปกรณ์ทดสอบ
ถัดไป
เพิกถอนข้อความ