ส่งข้อความ

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

แพลตฟอร์ม RCS for Business จะแสดงข้อผิดพลาดในบางสถานการณ์เพื่อช่วย คุณจัดการการนำส่งข้อความ

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

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

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

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

RCS สำหรับธุรกิจจะลบข้อความที่นำส่งไม่สำเร็จหลังจากส่งไปแล้ว 30 วัน

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

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

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

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

  • expireTime: เวลาที่แน่นอนใน UTC เมื่อข้อความหมดอายุ
  • ttl(เวลาที่จะมีผล): ระยะเวลาก่อนที่ข้อความจะหมดอายุ

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

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

แม้ว่าจะไม่มีค่าต่ำสุด ttl และ expireTime แต่เราขอแนะนำให้รออย่างน้อย 10 วินาที หลังจากส่งข้อความเพื่อลดโอกาสในการ รับการแจ้งเตือนทั้งการเพิกถอนและการนำส่งอย่างมาก

Time to Live (TTL) สำหรับข้อความ

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

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

สิ่งที่จะเกิดขึ้นเกี่ยวกับการแจ้งเตือนมีดังนี้

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

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

คำแนะนำในการจัดการกรณีข้อยกเว้น

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

คำแนะนำในการจัดการการแจ้งเตือนข้อความ RCS for Business มีดังนี้

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

  • การแจ้งเตือน TTL_EXPIRATION_REVOKED: หากได้รับการแจ้งเตือน TTL ที่มีสถานะ TTL_EXPIRATION_REVOKED แสดงว่าระบบ RCS สำหรับธุรกิจ หยุดพยายามส่งข้อความนั้นแล้ว คุณควรถือว่าข้อความนี้ นำส่งไม่ได้ และดำเนินการตามกลยุทธ์สำรองหากจำเป็น

  • การแจ้งเตือน TTL ที่มีสถานะอื่นๆ: หากคุณได้รับการแจ้งเตือน TTL ที่มีสถานะอื่นๆ แสดงว่ามีความพยายามเพิกถอนที่ไม่สามารถสรุปได้

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

ตั้งค่าประเภทการรับส่งข้อความ

RBM API มีช่อง messageTrafficType สำหรับจัดหมวดหมู่ข้อความ แม้ว่ากรณีการใช้งานตัวแทนจะยังคงกำหนดลักษณะการทำงานของตัวแทนและกฎทางธุรกิจที่ใช้ messageTrafficType แต่ก็ช่วยให้จัดหมวดหมู่เนื้อหาข้อความได้ละเอียดยิ่งขึ้น ซึ่งจะช่วยให้ตัวแทนคนเดียวจัดการกรณีการใช้งานได้หลายกรณี การดำเนินการนี้ไม่ส่งผลกระทบต่อกรณีการใช้งานเอเจนต์หรือกฎทางธุรกิจที่มีอยู่ในขณะนี้

ฟิลด์นี้จะกรอกหรือไม่ก็ได้ แต่เราขอแนะนำให้ตั้งค่าตอนนี้เพื่อ ไม่ให้ได้รับข้อผิดพลาดเมื่อฟิลด์นี้กลายเป็นฟิลด์ที่ต้องกรอก

หากต้องการตั้งค่าประเภทการเข้าชมข้อความ ให้กำหนดmessageTrafficType ที่เหมาะสมสำหรับแต่ละข้อความตามเนื้อหา RCS for Business รองรับการเข้าชมประเภทต่อไปนี้

ประเภทการเข้าชม เนื้อหาข้อความ กรณีการใช้งานของตัวแทน
AUTHENTICATION สำหรับข้อความการตรวจสอบสิทธิ์ OTP
TRANSACTION สำหรับข้อความเกี่ยวกับบริการหรือผลิตภัณฑ์ที่มีอยู่ของผู้ใช้ เช่น การยืนยัน ใบเสร็จรับเงิน หรือรายละเอียดการจอง ธุรกรรมหรือการใช้งานหลายครั้ง
PROMOTION สำหรับข้อความโปรโมชัน เช่น ข้อเสนอ ส่วนลด ประกาศ หรือเนื้อหาส่งเสริมการขายอื่นๆ โปรโมชันหรือใช้ได้หลายครั้ง
SERVICEREQUEST สำหรับข้อความเกี่ยวกับบริการที่ผู้ใช้ขออย่างชัดเจน OTP, ธุรกรรม, โปรโมชัน หรือแบบใช้ได้หลายครั้ง
ACKNOWLEDGEMENT สำหรับข้อความที่ใช้เพื่อรับทราบการดำเนินการของผู้ใช้ โดยเฉพาะคำขอยกเลิกการสมัครรับอีเมล ซึ่งเป็นการยืนยันว่าเราได้รับคำขอของผู้ใช้และกำลังดำเนินการ OTP, ธุรกรรม, โปรโมชัน หรือแบบใช้ได้หลายครั้ง

หากไม่ได้ตั้งค่าประเภทการเข้าชม ระบบจะกำหนดประเภทเริ่มต้นสำหรับกรณีการใช้งานของตัวแทน

กรณีการใช้งานของตัวแทน ประเภทการเข้าชมเริ่มต้น
OTP AUTHENTICATION
ธุรกรรม TRANSACTION
โปรโมชัน PROMOTION
อเนกประสงค์ MESSAGE_TRAFFIC_TYPE_UNSPECIFIED

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

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

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

ขนาดสูงสุดของไฟล์ที่ส่งผ่าน RCS สำหรับธุรกิจได้คือ 100 MiB และขนาดรวมของไฟล์แนบสื่อและ PDF ทั้งหมดภายในข้อความ RCS สำหรับธุรกิจเดียวต้องไม่เกิน 100 MiB เพื่อป้องกันไม่ให้ผู้ใช้ใช้อินเทอร์เน็ตโดยไม่คาดคิด (1 MiB = 1,048,576 ไบต์) ดูข้อมูลเพิ่มเติมได้ที่ไฟล์สื่อและ PDF

ข้อความ

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

ตัวอย่าง

โค้ดต่อไปนี้จะส่งข้อความธรรมดา ดูตัวเลือกการจัดรูปแบบและค่าได้ที่ 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!"
  },
  "messageTrafficType": "PROMOTION"
}'

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 ไปยัง RCS for Business ข้อความ RCS for Business ที่มีอักขระ UTF-8 ไม่เกิน 160 ตัวเรียกว่าข้อความพื้นฐาน

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

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

เนื้อหาข้อความและตัวอย่างลิงก์

ไคลเอ็นต์ RCS อาจใช้ตัวอย่างลิงก์ หากข้อความ RCS สำหรับธุรกิจแบบข้อความเท่านั้นมี URL ของเว็บไซต์ที่มีแท็ก Open Graph ไคลเอ็นต์จะสร้างตัวอย่าง (รูปภาพ ชื่อ ฯลฯ) ได้ ซึ่งจะช่วยให้ได้รับประสบการณ์การใช้งานที่ดียิ่งขึ้น เช่น ดูข้อความพื้นฐานที่มีตัวอย่าง URL

โปรดทราบว่าไคลเอ็นต์ RCS อาจอนุญาตให้ผู้ใช้ปิดใช้ตัวอย่างลิงก์ได้

รหัสผ่านแบบครั้งเดียวสำหรับการยืนยันผู้ใช้

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

วิธีการทำงานสำหรับ Android

สำหรับแอป Android ที่ลงทะเบียนกับ SMS Retriever API แล้ว API จะ รอรับฟังข้อความ RCS สำหรับธุรกิจที่จัดรูปแบบอย่างถูกต้อง ข้อความนี้ต้องมีทั้ง OTP และแฮชที่ไม่ซ้ำกันซึ่งระบุแอปของคุณ

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

  • ตัวอย่างข้อความ RCS for Business สำหรับการยืนยันผู้ใช้: Your code is <OTP><app hash>.
  • ตัวอย่าง: Your code is 123456 M8tue43FGT.

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

วิธีการทำงานสำหรับ iOS

สำหรับ iOS การจัดการ OTP ในตัวของระบบจะตรวจหาและแนะนำ RCS สำหรับ OTP ของธุรกิจสำหรับการกรอกอัตโนมัติโดยอัตโนมัติ เช่นเดียวกับ OTP ทาง SMS ไม่จำเป็นต้องผสานรวม API ที่เฉพาะเจาะจงเพื่อให้แอป iOS อ่าน OTP

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

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

ขนาดสูงสุดของไฟล์ที่ส่งได้คือ 100 MiB และขนาดรวมของไฟล์แนบสื่อและ PDF ทั้งหมดภายในข้อความเดียวต้องไม่เกิน 100 MiB

ข้อกำหนดเฉพาะเกี่ยวกับภาพปก

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

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

การแคชและการจัดการ URL

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

เมื่อระบุไฟล์ด้วย URL แนวทางปฏิบัติแนะนำคือการตั้งค่า contentMessage.forceRefresh เป็น false การตั้งค่า contentMessage.forceRefresh เป็น true จะบังคับให้ RCS สำหรับธุรกิจดึงเนื้อหาใหม่จาก 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"
    }
  }
}'

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

RCS for Business รองรับสื่อประเภทต่อไปนี้ สำหรับภาพปก รองรับเฉพาะ image/jpeg, image/jpg, image/gif และ image/png

ประเภทสื่อ ประเภทเอกสาร ส่วนขยาย ใช้ได้กับการ์ดริชมีเดีย
application/ogg เสียง OGG .ogx ไม่
application/pdf PDF .pdf ได้ (สำหรับ Google Messages ในอินเดียเท่านั้น)
เสียง/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 ใช่
วิดีโอ/mp4 วิดีโอ MP4 .mp4 ใช่
video/mpeg4 วิดีโอ MPEG-4 .mp4, .m4p ใช่
วิดีโอ/mpeg วิดีโอ MPEG .mpeg ใช่
video/webm วิดีโอ WEBM .webm ใช่

คำแนะนำ

เอเจนต์จะส่งคำแนะนำ (การตอบกลับที่แนะนำและการดำเนินการที่แนะนำ) ในรายการชิปคำแนะนำ (คำแนะนำสูงสุด 11 รายการ) หรือในริชการ์ด (คำแนะนำสูงสุด 4 รายการ)

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

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

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

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

ตัวอย่าง

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

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

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

ดูตัวเลือกการจัดรูปแบบและค่าได้ที่ 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

แชร์ตำแหน่ง

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

ตัวอย่าง

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

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

เฉพาะใน Google Messages: หากผู้ใช้กำหนดค่าแอปเริ่มต้นสำหรับหน้าเว็บ แอปนั้นจะเปิดขึ้นแทนเบราว์เซอร์หรือ WebView และปุ่มคำแนะนำจะแสดงไอคอนของแอป หากต้องการให้ไอคอนแอปปรากฏใน Google Messages คุณต้องระบุ 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

เปิด URL ด้วย WebView

การดำเนินการเปิด URL ด้วย WebView จะโหลดหน้าเว็บที่ระบุ ภายในแอปรับส่งข้อความด้วยเครื่องมือการแสดงผลของเบราว์เซอร์เริ่มต้น ซึ่งช่วยให้ผู้ใช้โต้ตอบกับหน้าเว็บได้โดยไม่ต้องออกจากแชท RCS สำหรับธุรกิจ หากอุปกรณ์ของผู้ใช้ไม่รองรับ WebView หน้าเว็บจะเปิดในเบราว์เซอร์ของผู้ใช้แทน หากต้องการเปิดใช้ 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;
    }

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

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

ต้องระบุชื่อกิจกรรมในปฏิทิน โดยมีความยาวของอักขระได้สูงสุด 100 ตัว คำอธิบายกิจกรรมในปฏิทินเป็นข้อมูลที่ไม่บังคับและมีอักขระได้สูงสุด 500 ตัว

ตัวอย่าง

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

แต่ละช่องเหล่านี้ไม่บังคับ แต่ต้องรวมช่อง 1–3 อย่างน้อย 1 ช่องไว้ในการ์ดที่สมบูรณ์

คุณส่งการ์ดหลายใบพร้อมกันในภาพสไลด์ที่เลื่อนในแนวนอนได้

โปรดทราบว่าเพย์โหลดทั้งหมดสำหรับ Rich Card คือ 250 KB

ดูรายละเอียดทางเทคนิคทั้งหมดได้ที่เอกสารประกอบเกี่ยวกับริชการ์ด

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

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

ตัวอย่าง

โค้ดต่อไปนี้จะส่งภาพสไลด์ของ 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": {
      "carouselCard": {
        "cardWidth": "MEDIUM",
        "cardContents": [
          {
            "title": "Card #1",
            "description": "The description for card #1",
            "suggestions": [
              {
                "reply": {
                  "text": "Card #1",
                  "postbackData": "card_1"
                }
              }
            ],
            "media": {
              "height": "MEDIUM",
              "contentInfo": {
                "fileUrl": "https://storage.googleapis.com/welcome-bot-sample-images/200.jpg",
                "forceRefresh": false
              }
            }
          },
          {
            "title": "Card #2",
            "description": "The description for card #2",
            "suggestions": [
              {
                "reply": {
                  "text": "Card #2",
                  "postbackData": "card_2"
                }
              }
            ],
            "media": {
              "height": "MEDIUM",
              "contentInfo": {
                "fileUrl": "https://storage.googleapis.com/welcome-bot-sample-images/201.jpg",
                "forceRefresh": false
              }
            }
          }
        ]
      }
    }
  }
}'

Node.js

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

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

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

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

// Send the device the carousel card defined above
rbmApiHelper.sendCarouselCard(params, function(response) {
   console.log(response);
});
 โค้ดนี้เป็นข้อความที่ตัดตอนมาจากตัวแทนตัวอย่าง 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/welcome-bot-sample-images/200.jpg";

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

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

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

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

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

            // Send the carousel to the user
            rbmApiHelper.sendCarouselCards(cardContents, CardWidth.MEDIUM, "+12223334444");
        } catch(Exception e) {
            e.printStackTrace();
        }
 โค้ดนี้เป็นข้อความที่ตัดตอนมาจากตัวแทนตัวอย่าง 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/welcome-bot-sample-images/200.jpg';
card_image_2 = 'https://storage.googleapis.com/welcome-bot-sample-images/201.jpg';

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

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

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

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

# Send the device the carousel card defined above
carousel_card = messages.CarouselCard('MEDIUM', card_contents)
cluster = messages.MessageCluster().append_message(carousel_card)
cluster.send_to_msisdn('+12223334444')
 โค้ดนี้เป็นข้อความที่ตัดตอนมาจากตัวแทนตัวอย่าง 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/welcome-bot-sample-images/200.jpg";
string card2Image = "https://storage.googleapis.com/welcome-bot-sample-images/201.jpg";

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

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

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

// Send the carousel to the user
rbmApiHelper.SendCarouselCards(cardContents, CardWidth.MEDIUM, msisdn);
 โค้ดนี้เป็นข้อความที่ตัดตอนมาจากตัวแทนตัวอย่าง RBM
ถัดไป
เพิกถอนข้อความ