Tác nhân RCS for Business giao tiếp với người dùng bằng cách gửi và nhận tin nhắn. Để gửi tin nhắn cho người dùng, tác nhân của bạn sẽ gửi yêu cầu tin nhắn đến API RCS Business Messaging. Một yêu cầu có thể bao gồm văn bản, thẻ thông tin chi tiết, tệp đa phương tiện và tệp PDF, Đề xuất câu trả lời và hành động được đề xuất.
Nền tảng RCS for Business sẽ trả về lỗi trong một số trường hợp để giúp bạn quản lý việc gửi tin nhắn:
- Nếu bạn gửi tin nhắn cho một người dùng có thiết bị không hỗ trợ RCS hoặc chưa bật RCS, thì nền tảng RCS for Business sẽ trả về lỗi
404 NOT_FOUND. Trong trường hợp này, bạn có thể cố gắng liên hệ với người dùng thông qua các phương thức dự phòng được xác định trong cơ sở hạ tầng của bạn. - Nếu bạn gửi tin nhắn cho người dùng RCS trên một mạng mà tác nhân của bạn chưa được ra mắt hoặc trên một mạng chưa bật lưu lượng truy cập RCS, thì nền tảng RCS for Business sẽ trả về lỗi
404 NOT_FOUND. - Nếu bạn gửi tin nhắn có các tính năng mà thiết bị của người dùng không hỗ trợ,
thì nền tảng RCS for Business sẽ trả về lỗi
400 INVALID_ARGUMENTvà không gửi tin nhắn của bạn.
Trong chiến lược nhắn tin đa kênh, tốt nhất bạn nên thu hồi những thông báo không được gửi sau một khoảng thời gian hợp lý và gửi chúng qua một kênh khác. Để tự động thu hồi thư vào một thời điểm được xác định trước, hãy đặt thời gian hết hạn của thư.
Người nhận đang ngoại tuyến
Nền tảng RCS for Business vẫn chấp nhận gửi tin nhắn nếu người nhận không kết nối mạng. Bạn nhận được phản hồi 200 OK, đồng thời nền tảng RCS cho Doanh nghiệp sẽ giữ lại tin nhắn và cố gắng gửi lại trong 30 ngày. Bạn không cần
yêu cầu RCS for Business gửi lại tin nhắn.
RCS for Business sẽ xoá mọi tin nhắn chưa được gửi sau 30 ngày kể từ ngày gửi.
Tuỳ thuộc vào trường hợp sử dụng của nhân viên hỗ trợ, bạn có thể muốn thu hồi tin nhắn chưa gửi trước thời gian chờ 30 ngày này. Việc thu hồi có thể ngăn người dùng ngoại tuyến nhận được thông báo đã lỗi thời khi họ kết nối mạng trở lại. Có nhiều cách để thu hồi tin nhắn:
- Gửi yêu cầu thu hồi để kích hoạt việc thu hồi.
- Đặt ngày hết hạn cho thông báo để tự động thu hồi thông báo vào thời điểm thích hợp.
Đặt ngày hết hạn cho tin nhắn
Tin nhắn của nhân viên hỗ trợ có cần được xử lý gấp không? Ví dụ: OTP chỉ có hiệu lực trong một khoảng thời gian ngắn. Ưu đãi trong thời gian có hạn sẽ hết hạn. Và lời nhắc cuộc hẹn sẽ không còn phù hợp sau ngày hẹn. Để đảm bảo thông báo luôn kịp thời và phù hợp, hãy đặt ngày hết hạn cho thông báo. Điều này có thể ngăn người dùng ngoại tuyến nhận được nội dung cũ khi họ kết nối mạng trở lại. Thời gian hết hạn cũng là một dấu hiệu tốt để gọi chiến lược nhắn tin dự phòng, nhờ đó người dùng nhận được thông tin họ cần đúng hạn.
Để đặt thời gian hết hạn của tin nhắn, hãy chỉ định một trong các trường sau trong tin nhắn của nhân viên hỗ trợ:
expireTime: Thời gian chính xác (theo giờ UTC) khi thông báo hết hạn.ttl(thời gian tồn tại): Khoảng thời gian trước khi thông báo hết hạn.
Để biết các lựa chọn về định dạng và giá trị, hãy xem AgentMessage.
Giá trị tối đa cho ttl và expireTime là 15 ngày sau khi gửi thông báo.
Giá trị tối thiểu cho ttl và expireTime là 6 giây sau khi gửi thông báo.
Đề xuất về cách đặt thời gian hết hạn của tin nhắn
Đối với tin nhắn xác thực (OTP): Hãy đặt
ttlthành 15 giây trở lên sau khi gửi tin nhắn để giảm đáng kể khả năng xảy ra tình huống tương tranh giữa việc gửi và thu hồi.Đối với tin nhắn giao dịch và tin nhắn quảng cáo: Đặt thời gian hết hạn dài hơn (ít nhất 60 giây hoặc từ vài phút đến vài giờ tuỳ thuộc vào trường hợp sử dụng) vì thiết bị cần thêm thời gian để quét tin nhắn và tải xuống hoặc xử lý nội dung đa phương tiện, đồng thời người dùng có thể bị mất kết nối trong thời gian ngắn (ví dụ: trong thang máy hoặc đường hầm).
Thời gian tồn tại (TTL) của một thông báo
Khi đặt TTL cho một tin nhắn RCS for Business, bạn chỉ định khoảng thời gian mà tin nhắn đó được coi là hợp lệ và có thể gửi được. Nếu tin nhắn không được gửi thành công đến thiết bị của người dùng trong khoảng thời gian TTL này, thì nền tảng RCS for Business sẽ tự động tìm cách thu hồi tin nhắn đó.
Khi bắt đầu thu hồi tin nhắn, bạn yêu cầu nền tảng RCS for Business ngừng gửi tin nhắn cụ thể đó. Tuy nhiên, hành động này chỉ ảnh hưởng đến những lần gửi trong tương lai. Nếu thiết bị của người dùng đã nhận được tin nhắn thành công, thì tin nhắn đó đang được xử lý và nền tảng RCS for Business không thể thu hồi tin nhắn khỏi thiết bị của người dùng.
Sau đây là những điều bạn cần biết về thông báo:
Tin nhắn được gửi trong TTL: Nếu thiết bị của người dùng kết nối mạng và nhận được tin nhắn trước khi TTL hết hạn, thì bạn sẽ nhận được thông báo
DELIVERED. Sẽ không có thông báo thu hồi nào được gửi vì thư đã được gửi thành công. Đây là trường hợp phổ biến nhất và nằm trong dự kiến.Tin nhắn không được gửi trước khi hết TTL: Nếu TTL hết hạn trước khi tin nhắn đến được thiết bị của người dùng (ví dụ: thiết bị không có mạng), thì nền tảng RCS for Business sẽ cố gắng thu hồi tin nhắn. Bạn sẽ nhận được thông báo
TTL_EXPIRATION_REVOKED, cho biết thư đã được xoá thành công khỏi hàng đợi gửi. Trong trường hợp này, người dùng sẽ không nhận được tin nhắn.
Đề xuất để xử lý các trường hợp hiếm gặp
Hệ thống của chúng tôi xử lý việc gửi tin nhắn RCS for Business và hết hạn TTL song song. Do đó, trong một số ít trường hợp, bạn có thể thấy thời gian thông báo không như mong đợi. Ví dụ: bạn có thể nhận được cả thông báo gửi và thông báo TTL hoặc có thể không nhận được thông báo nào.
Dưới đây là các đề xuất của chúng tôi về cách xử lý thông báo tin nhắn RCS for Business:
Thông báo
DELIVERED: Nếu bạn nhận được thông báoDELIVEREDcho một tin nhắn, thì điều này xác nhận rằng tin nhắn đã đến được người dùng. Bạn có thể yên tâm bỏ qua mọi thông báo TTL tiếp theo cho thông báo cụ thể đó.Thông báo
TTL_EXPIRATION_REVOKED: Nếu bạn nhận được thông báo TTL có trạng tháiTTL_EXPIRATION_REVOKED, thì tức là hệ thống RCS for Business ngừng gửi tin nhắn cụ thể đó. Bạn nên coi tin nhắn này là chưa được gửi và tiếp tục với chiến lược dự phòng nếu cần.Thông báo TTL có trạng thái khác: Nếu bạn nhận được thông báo TTL có trạng thái khác, thì điều này cho biết nỗ lực thu hồi không có kết quả.
- Đối với các tin nhắn quan trọng, chẳng hạn như mật khẩu một lần (OTP), hãy bắt đầu phương thức dự phòng.
- Đối với các thông báo không quan trọng, hãy quyết định xem có nên bắt đầu dự phòng hay không.
- Không có thông báo: Trong một số ít trường hợp, hệ thống có thể không gửi được thông báo TTL và ứng dụng cũng có thể không tạo được thông báo gửi. Đây là trường hợp cực kỳ hiếm gặp.
Đặt loại lưu lượng truy cập tin nhắn
API RBM có một trường messageTrafficType để phân loại tin nhắn.
Mặc dù trường hợp sử dụng của nhân viên hỗ trợ vẫn xác định hành vi của nhân viên hỗ trợ và quy tắc kinh doanh nào được áp dụng, nhưng messageTrafficType cho phép phân loại chi tiết hơn nội dung tin nhắn. Nhờ vậy, một nhân viên hỗ trợ có thể xử lý nhiều trường hợp sử dụng. Hiện tại, việc này không ảnh hưởng đến các trường hợp sử dụng hoặc quy tắc kinh doanh hiện có của nhân viên hỗ trợ.
Trường này không bắt buộc, nhưng bạn nên đặt ngay để không gặp lỗi khi trường này trở thành trường bắt buộc.
Để đặt loại lưu lượng truy cập tin nhắn, hãy chỉ định messageTrafficType thích hợp cho từng tin nhắn dựa trên nội dung của tin nhắn đó. Bảng sau đây liệt kê các loại lưu lượng truy cập được hỗ trợ và các trường hợp sử dụng tác nhân dự kiến. Mối liên kết này là hướng dẫn đề xuất về cách sử dụng dự kiến, chứ không phải là quy định hạn chế do API thực thi tại thời điểm này.
| Loại lưu lượng truy cập | Nội dung tin nhắn | Trường hợp sử dụng được đề xuất cho nhân viên hỗ trợ |
|---|---|---|
AUTHENTICATION |
Đối với tin nhắn xác thực. | OTP |
TRANSACTION |
Dành cho thông báo về các dịch vụ hoặc sản phẩm hiện có của người dùng. Ví dụ: thông tin xác nhận, biên lai thanh toán hoặc thông tin đặt chỗ. | Giao dịch hoặc Đa năng |
PROMOTION |
Dành cho các thông báo quảng bá như ưu đãi, chiết khấu, thông báo hoặc nội dung quảng bá khác. | Quảng cáo hoặc Đa năng |
SERVICEREQUEST |
Đối với các thông báo về dịch vụ mà người dùng đã yêu cầu rõ ràng. | OTP, Giao dịch, Quảng cáo hoặc Đa mục đích |
ACKNOWLEDGEMENT |
Đối với thư dùng để xác nhận hành động của người dùng, cụ thể là yêu cầu huỷ đăng ký. Thư này xác nhận rằng chúng tôi đã nhận được yêu cầu của người dùng và đang xử lý yêu cầu đó. | OTP, Giao dịch, Quảng cáo hoặc Đa mục đích |
Nếu bạn không đặt loại lưu lượng truy cập, hệ thống sẽ chỉ định loại mặc định cho trường hợp sử dụng của tác nhân.
| Trường hợp sử dụng của nhân viên hỗ trợ | Loại lưu lượng truy cập mặc định |
|---|---|
| OTP | AUTHENTICATION |
| Giao dịch | TRANSACTION |
| Quảng cáo | PROMOTION |
| Đa năng | MESSAGE_TRAFFIC_TYPE_UNSPECIFIED |
Tác nhân đa năng không có loại lưu lượng truy cập mặc định. Bạn nên đặt loại lưu lượng truy cập một cách rõ ràng cho từng thông báo dựa trên nội dung của thông báo đó. Nếu bạn không thay thế giá trị MESSAGE_TRAFFIC_TYPE_UNSPECIFIED, thì thông báo vẫn được chấp nhận và gửi đi mà không có thông tin phân loại kiểu cụ thể về loại lưu lượng truy cập.
Giới hạn kích thước thư
Kích thước tối đa của toàn bộ AgentMessage được chuyển đổi thành chuỗi là 250 KB. Phần văn bản của thông báo có giới hạn riêng là 3.072 ký tự.
Để tránh việc người dùng tiêu thụ dữ liệu ngoài dự kiến, kích thước tối đa của một tệp có thể gửi qua RCS for Business là 100 MiB và tổng kích thước của tất cả tệp đính kèm đa phương tiện và PDF trong một tin nhắn RCS for Business không được vượt quá 100 MiB. (1 MiB = 1.048.576 byte). Để biết thêm thông tin, hãy tham khảo bài viết về tệp nội dung nghe nhìn và tệp PDF.
Văn bản
Tin nhắn đơn giản nhất là tin nhắn văn bản. Tin nhắn văn bản phù hợp nhất để truyền đạt thông tin mà không cần hình ảnh, tương tác phức tạp hoặc phản hồi.
Ví dụ
Đoạn mã sau đây gửi một tin nhắn văn bản thuần tuý. Để biết các lựa chọn về định dạng và giá trị, hãy xem 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); });
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(); }
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')
C#
using RCSBusinessMessaging; … // Create an instance of the RBM API helper RbmApiHelper rbmApiHelper = new RbmApiHelper(credentialsFileLocation, projectId); rbmApiHelper.SendTextMessage( "Hello, world!", "+12223334444", );
Nội dung tin nhắn cơ bản – chuyển đổi SMS
Các nhà mạng đã ra mắt mô hình thanh toán để hỗ trợ việc chuyển tin nhắn SMS sang RCS for Business. Tin nhắn RCS for Business chứa tối đa 160 ký tự UTF-8 được gọi là Tin nhắn cơ bản.
Khi tạo yêu cầu gửi Tin nhắn cơ bản, hãy nhớ rằng các ký tự được tính là 1 byte (UTF-8). Nếu bạn gửi tin nhắn có chứa các ký tự đặc biệt như biểu tượng cảm xúc hoặc bộ ký tự nhiều byte, thì mỗi ký tự sẽ được tính là 2 đến 4 ký tự UTF-8 trở lên.
Nhập văn bản vào hộp để kiểm tra độ dài:
Nội dung tin nhắn văn bản và bản xem trước đường liên kết
Ứng dụng RCS có thể triển khai tính năng xem trước đường liên kết. Nếu một tin nhắn RCS for Business chỉ có văn bản chứa URL của một trang web có thẻ openGraph, thì ứng dụng có thể tạo bản xem trước (hình ảnh, tiêu đề, v.v.) để mang đến trải nghiệm phong phú hơn. Ví dụ: xem tin nhắn cơ bản có bản xem trước URL.
Xin lưu ý rằng ứng dụng RCS có thể cho phép người dùng tắt tính năng xem trước đường liên kết.
Mật khẩu một lần để xác minh người dùng
Bạn có thể sử dụng RCS cho Doanh nghiệp để gửi mật khẩu một lần (OTP) nhằm tự động xác minh người dùng bằng SMS Retriever API. Không có API chuyên dụng để đọc OTP đến qua RCS for Business.
Cách hoạt động trên Android
Đối với những ứng dụng Android đã đăng ký với SMS Retriever API, API này sẽ lắng nghe tin nhắn RCS for Business có định dạng chính xác. Tin nhắn này phải chứa cả OTP và một hàm băm duy nhất giúp xác định ứng dụng của bạn.
Khi nhận được tin nhắn RCS for Business có định dạng chính xác, SMS Retriever API sẽ xử lý tin nhắn đó giống như cách xử lý OTP qua SMS. Sau khi mã băm khớp với ứng dụng của bạn, OTP sẽ được trích xuất và chuyển tiếp đến ứng dụng để tự động xác minh người dùng.
- Tin nhắn văn bản mẫu của RCS for Business để xác minh người dùng:
Your code is <OTP><app hash>. - Ví dụ:
Your code is 123456 M8tue43FGT.
Để tìm hiểu thêm về SMS Retriever và các API liên quan, hãy xem tài liệu về SMS Retriever. Để biết thông tin chi tiết về quy trình tự động xác minh người dùng trong các ứng dụng đã đăng ký với SMS Retriever API, hãy xem sơ đồ quy trình này.
Cách hoạt động trên iOS
Đối với iOS, tính năng xử lý OTP tích hợp sẵn của hệ thống sẽ tự động phát hiện và đề xuất OTP của RCS for Business để tự động điền, giống như OTP của SMS. Bạn không cần phải tích hợp API cụ thể nào để ứng dụng iOS đọc OTP.
Tệp đa phương tiện và tệp PDF
Khi bạn gửi tin nhắn có hình ảnh, video, âm thanh hoặc tệp PDF, nhân viên hỗ trợ của bạn phải cung cấp một URL có thể truy cập công khai cho nội dung hoặc trực tiếp tải tệp lên.
Kích thước tối đa của một tệp có thể gửi là 100 MiB và tổng kích thước của tất cả tệp đính kèm đa phương tiện và PDF trong một tin nhắn không được vượt quá 100 MiB.
Nén và chuyển mã nội dung nghe nhìn
Nền tảng RCS for Business tự động chuyển mã và nén các tệp nội dung nghe nhìn (chẳng hạn như hình ảnh và video) trước khi gửi để đảm bảo các tệp đó tải nhanh và hoạt động tốt trên nhiều mạng và thiết bị.
Quá trình nén dựa trên chất lượng của nội dung nghe nhìn đầu vào chứ không chỉ dựa trên giới hạn kích thước tệp. Điều này có nghĩa là tệp có thể được nén ngay cả khi kích thước của tệp thấp hơn nhiều so với giới hạn tối đa 100 MiB. Các tiêu chuẩn chuyển mã thay đổi liên tục, vì vậy, không có giới hạn kích thước tệp cố định để xác định thời điểm bỏ qua quá trình chuyển mã. Thử nghiệm nhiều định dạng, kích thước và tỷ lệ nén nội dung nghe nhìn để tìm ra sự cân bằng tối ưu cho tải trọng của bạn.
Quy cách của hình thu nhỏ
Đối với tệp nội dung nghe nhìn, bạn cũng có thể chỉ định hình thu nhỏ cho phép người dùng xem trước nội dung trước khi nhấp vào. Đối với tệp âm thanh, tiện ích âm thanh mặc định được dùng làm phần giữ chỗ.
- Kích thước tệp tối đa của hình thu nhỏ là 100 kB. Để mang lại trải nghiệm tối ưu cho người dùng, bạn nên đặt kích thước tệp là 50 kB trở xuống.
- Tỷ lệ khung hình của hình thu nhỏ phải khớp với tỷ lệ của tệp gốc.
Lưu vào bộ nhớ đệm và quản lý URL
Nền tảng RCS for Business lưu tệp vào bộ nhớ đệm trong 60 ngày và API trả về một mã tệp mà tác nhân của bạn có thể đưa vào tin nhắn cho người dùng. Sau 60 ngày, RCS for Business sẽ xoá các tệp khỏi bộ nhớ đệm.
Khi chỉ định tệp theo URL, bạn nên đặt contentMessage.forceRefresh thành false. Việc đặt contentMessage.forceRefresh thành true sẽ buộc RCS for Business tìm nạp nội dung mới từ URL được chỉ định, ngay cả khi nội dung URL được lưu vào bộ nhớ đệm, điều này làm tăng thời gian gửi tin nhắn cho người dùng.
Ví dụ về URL của tệp
Mã sau đây sẽ gửi một hình ảnh. Để biết các lựa chọn về định dạng và giá trị, hãy xem 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); });
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(); }
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')
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");
Ngoài ra, bạn có thể tải nội dung nghe nhìn lên trước khi gửi nội dung đó trong tin nhắn bằng files.create.
Ví dụ về cách tải tệp lên
Đoạn mã sau đây tải một tệp video và một tệp hình thu nhỏ lên, sau đó gửi cả hai tệp trong một tin nhắn. Để biết các lựa chọn về định dạng và giá trị, hãy xem files.create và 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 JSONcurl -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 JSONcurl -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" } } }'
Các loại nội dung nghe nhìn được hỗ trợ
RCS for Business hỗ trợ các loại nội dung nghe nhìn sau đây. Đối với hình thu nhỏ, chỉ hỗ trợ image/jpeg, image/jpg, image/gif và image/png.
| Loại nội dung nghe nhìn | Loại tài liệu | Phần mở rộng | Hoạt động với thẻ thông tin chi tiết |
|---|---|---|---|
| application/ogg | Âm thanh OGG | .ogx | Không |
| application/pdf | Có (Chỉ dành cho Google Tin nhắn ở Ấn Độ) | ||
| audio/aac | Âm thanh AAC | .aac | Không |
| audio/mp3 | Âm thanh MP3 | .mp3 | Không |
| audio/mpeg | Âm thanh MPEG | .mpeg | Không |
| audio/mpg | Âm thanh MPG | .mp3 | Không |
| audio/mp4 | Âm thanh MP4 | .mp4 | Không |
| audio/mp4-latm | Âm thanh MP4-latm | .mp4 | Không |
| audio/3gpp | Âm thanh 3GPP | .3gp | Không |
| image/jpeg | JPEG | .jpeg, .jpg | Có |
| hình ảnh/gif | GIF | .gif | Có |
| hình ảnh/png | PNG | .png | Có |
| video/h263 | Video H263 | .h263 | Có |
| video/m4v | Video M4V | .m4v | Có |
| video/mp4 | Video MP4 | .mp4 | Có |
| video/mpeg4 | Video MPEG-4 | .mp4, .m4p | Có |
| video/mpeg | Video MPEG | .mpeg | Có |
| video/webm | Video WEBM | .webm | Có |
Nội dung đề xuất
Tác nhân của bạn gửi các đề xuất (câu trả lời được đề xuất và hành động được đề xuất) trong danh sách khối đề xuất hoặc trong thẻ thông tin chi tiết.
Câu trả lời đề xuất
Đề xuất câu trả lời hướng dẫn người dùng trong suốt cuộc trò chuyện bằng cách đưa ra những câu trả lời mà tác nhân của bạn biết cách phản hồi.
Khi người dùng nhấn vào một câu trả lời được đề xuất, nhân viên hỗ trợ của bạn sẽ nhận được một sự kiện chứa văn bản và dữ liệu phản hồi của câu trả lời. Trọng tải có tối đa 2048 ký tự.
Ví dụ
Đoạn mã sau đây gửi tin nhắn văn bản kèm theo hai Đề xuất câu trả lời. Để biết các lựa chọn về định dạng và giá trị, hãy xem 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); });
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(); }
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')
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 );
Hành động đề xuất
Hành động được đề xuất hướng dẫn người dùng thông qua các cuộc trò chuyện bằng cách tận dụng chức năng tích hợp sẵn trên thiết bị của họ. Nhân viên hỗ trợ có thể đề xuất người dùng quay số, mở một vị trí trên bản đồ, chia sẻ vị trí, mở URL hoặc tạo sự kiện trên lịch.
Đối với mỗi hành động được đề xuất, bạn có thể cung cấp một URL dự phòng (tối đa 2048 ký tự). URL này sẽ mở trong một cửa sổ trình duyệt mới nếu thiết bị của người dùng không hỗ trợ hành động được đề xuất.
Khi người dùng nhấn vào một hành động được đề xuất, nhân viên hỗ trợ của bạn sẽ nhận được một sự kiện chứa dữ liệu đăng lại của hành động đó.
Để biết các lựa chọn về định dạng và giá trị, hãy xem SuggestedAction.
Hiển thị đề xuất
Có hai cách để hiển thị nội dung đề xuất:
- Persistent: Các hành động được đề xuất hoặc câu trả lời được đề xuất xuất hiện bên trong bong bóng tin nhắn và được giữ cố định trong suốt cuộc trò chuyện.
- Tạm thời: Đề xuất xuất hiện bên ngoài bong bóng tin nhắn và biến mất khi cuộc trò chuyện tiếp tục.
Định dạng thông báo được hỗ trợ
- Đề xuất cố định: Hoạt động với tin nhắn văn bản độc lập và thẻ thông tin chi tiết.
- Đề xuất tạm thời: Hoạt động với tin nhắn văn bản độc lập, tin nhắn đa phương tiện và thẻ thông tin chi tiết.
Kết hợp các đề xuất
Bạn có thể kết hợp các đề xuất cố định và tạm thời trong cùng một tin nhắn hoặc thẻ thông tin chi tiết.
- Tin nhắn văn bản: Theo mặc định, các đề xuất chỉ mang tính tạm thời. Để giữ các hoạt động này bên trong bong bóng, bạn phải định cấu hình chúng ở trạng thái cố định.
- Thẻ thông tin chi tiết: Theo mặc định, các thẻ này hỗ trợ tối đa 4 đề xuất cố định. Sau đó, bạn có thể thêm các đề xuất tạm thời dưới dạng "danh sách khối" bên dưới thẻ.
Giới hạn đề xuất
Một tin nhắn văn bản hỗ trợ tổng cộng tối đa 11 đề xuất. Mọi đề xuất cố định mà bạn đưa vào đều được tính vào tổng giới hạn này. Ví dụ: nếu thêm 4 đề xuất cố định, bạn có thể thêm tối đa 7 đề xuất tạm thời.
| Loại đề xuất | Giới hạn | Vị trí xuất hiện |
|---|---|---|
| Liên tục | Tối đa 4 | Bên trong bong bóng tin nhắn |
| Tạm thời | Tối đa 11 | Bên ngoài bong bóng (dưới dạng khối) |
Giới hạn ký tự
Mỗi cụm từ đề xuất có tối đa 25 ký tự.
Tính minh bạch của URL trong các hành động được đề xuất
Để xây dựng lòng tin của người dùng, URL cơ bản sẽ hiển thị dưới dạng dòng văn bản thứ hai bên trong nút đề xuất cho hành động được đề xuất "Mở URL". Hành vi nhất quán này áp dụng cho tin nhắn văn bản độc lập, thẻ thông tin chi tiết và băng chuyền.
Ứng dụng được hỗ trợ cho tính năng đề xuất cố định
- Được hỗ trợ: Google Tin nhắn (phiên bản
20260225.00trở lên). - Không được hỗ trợ: Các phiên bản Google Tin nhắn cũ hơn
20260225.00, iOS và Samsung Messages.
Đề xuất trong thông báo hệ thống
Khi người dùng nhận được tin nhắn, Google Tin nhắn sẽ hiển thị đề xuất đủ điều kiện đầu tiên ngay trong thông báo hệ thống Android của họ. Người dùng có thể nhấn vào đề xuất này để gửi thư trả lời hoặc kích hoạt một hành động mà không cần mở ứng dụng.
Khi thiết kế thông báo, hãy lưu ý hành vi sau:
- Thứ tự rất quan trọng: Mỗi thông báo chỉ hiển thị một đề xuất. Để tối đa hoá mức độ tương tác, hãy đặt Đề xuất câu trả lời hoặc hành động được đề xuất có mức độ ưu tiên cao nhất ở đầu danh sách đề xuất.
- Hành động bị loại trừ: Hành động Chia sẻ vị trí không bao giờ xuất hiện trong thông báo hệ thống – người dùng phải mở cuộc trò chuyện để chia sẻ vị trí của họ.
Quay số
Hành động Quay số hướng dẫn người dùng quay số điện thoại do nhân viên hỗ trợ của bạn chỉ định.
Số điện thoại chỉ được chứa chữ số (0-9), dấu cộng (+), dấu hoa thị (*) và dấu thăng (#). Định dạng quốc tế E.164 (ví dụ: +14155555555) được hỗ trợ nhưng không bắt buộc. Tức là cả +14155555555 và 1011 đều là các mục hợp lệ.
Ví dụ
Mã sau đây gửi một hành động quay số. Để biết các lựa chọn về định dạng và giá trị, hãy xem 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); });
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(); }
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')
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 );
Xem một vị trí
Hành động Xem vị trí sẽ hiển thị một vị trí trong ứng dụng bản đồ mặc định của người dùng. Bạn có thể chỉ định vị trí theo vĩ độ và kinh độ hoặc bằng một cụm từ tìm kiếm dựa trên vị trí hiện tại của người dùng. Bạn cũng có thể đặt nhãn tuỳ chỉnh cho ghim xuất hiện trong ứng dụng bản đồ.
Ví dụ
Đoạn mã sau đây gửi một hành động xem vị trí. Để biết các lựa chọn về định dạng và giá trị, hãy xem 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); });
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(); }
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')
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 );
Chia sẻ vị trí
Hành động Chia sẻ vị trí cho phép người dùng chia sẻ vị trí với nhân viên hỗ trợ của bạn. Người dùng có thể chia sẻ vị trí hiện tại hoặc vị trí được chọn theo cách thủ công trong ứng dụng Maps.
Ví dụ
Mã sau đây sẽ gửi một hành động chia sẻ vị trí. Để biết các lựa chọn về định dạng và giá trị, hãy xem 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); });
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(); }
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')
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 );
Mở một URL
Thao tác Mở URL cho phép bạn hướng dẫn người dùng đến một trang web do tác nhân của bạn chỉ định. Theo mặc định, trang web sẽ mở trong trình duyệt của người dùng. Bạn cũng có thể đặt trang web mở trong một thành phần hiển thị web. Hãy xem phần Mở URL bằng WebView để biết thông tin chi tiết.
Chỉ có trong Google Tin nhắn
Hiển thị URL cơ bản: Để cải thiện tính minh bạch trong tin nhắn A2P, Google Tin nhắn sẽ hiển thị địa chỉ URL cơ bản trong các hành động được đề xuất "Mở URL". Thay đổi này ảnh hưởng đến các hành động được đề xuất trong thẻ thông tin chi tiết và băng chuyền thẻ thông tin chi tiết tiêu chuẩn.
Hiển thị biểu tượng ứng dụng cho đường liên kết trang web: Nếu người dùng đã định cấu hình một ứng dụng mặc định cho trang web, thì ứng dụng đó sẽ mở thay vì trình duyệt hoặc WebView và nút đề xuất sẽ hiển thị biểu tượng của ứng dụng. Để biểu tượng ứng dụng xuất hiện trong Google Tin nhắn, bạn cần cung cấp URL đầy đủ và trực tiếp. Nếu bạn sử dụng URL rút gọn, biểu tượng Mở URL mặc định sẽ xuất hiện.
Ví dụ
Mã sau đây gửi một hành động mở URL. Để biết các lựa chọn về định dạng và giá trị, hãy xem 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); });
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(); }
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')
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 );
Mở một URL bằng webview
Hành động Mở URL bằng WebView sẽ tải trang web được chỉ định bên trong ứng dụng nhắn tin bằng công cụ kết xuất của trình duyệt mặc định. Điều này cho phép người dùng tương tác với trang web mà không cần rời khỏi cuộc trò chuyện RCS for Business. Nếu thiết bị của người dùng không hỗ trợ WebView, thì trang web sẽ mở trong trình duyệt của người dùng. Để bật chế độ xem web, hãy xem OpenURLApplication.
Chế độ xem web có 3 chế độ hiển thị. Để biết các lựa chọn về định dạng và giá trị, hãy xem WebviewViewMode.
- Toàn màn hình: Trang web chiếm toàn bộ màn hình
- Nửa màn hình: Trang web chiếm một nửa màn hình
- Cao: Trang web chiếm 3/4 màn hình
Ví dụ
Mã sau đây gửi một hành động Mở URL bằng WebView. Để biết các lựa chọn về định dạng và giá trị, hãy xem 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; }
Tạo sự kiện trên lịch
Hành động Tạo sự kiện trên lịch sẽ mở ứng dụng lịch của người dùng và bắt đầu tạo một sự kiện mới có thông tin được chỉ định.
Bạn phải nhập tiêu đề sự kiện trên lịch. Thuộc tính này có tối đa 100 ký tự. Nội dung mô tả sự kiện trên lịch là không bắt buộc và có tối đa 500 ký tự.
Ví dụ
Mã sau đây gửi một hành động tạo sự kiện trên lịch. Để biết các lựa chọn về định dạng và giá trị, hãy xem 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); });
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(); }
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')
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 );
Danh sách khối đề xuất
Nhân viên hỗ trợ của bạn gửi danh sách khối đề xuất kèm theo tin nhắn để hướng dẫn người dùng thực hiện các hành động tiếp theo. Danh sách khối chỉ xuất hiện khi tin nhắn liên quan nằm ở cuối cuộc trò chuyện. Mọi tin nhắn tiếp theo trong cuộc trò chuyện (từ người dùng hoặc nhân viên hỗ trợ của bạn) đều sẽ ghi đè danh sách khối.
Các khối trong danh sách là Đề xuất câu trả lời và hành động được đề xuất.
Danh sách khối chứa tối đa 11 khối đề xuất và mỗi nhãn khối có thể có tối đa 25 ký tự.
Để biết các lựa chọn về định dạng và giá trị, hãy xem AgentContentMessage.
Thẻ thông tin chi tiết
Thẻ thông tin chi tiết kết hợp nội dung nghe nhìn, văn bản và các đề xuất tương tác vào một tin nhắn duy nhất. Thẻ là lựa chọn lý tưởng để trình bày thông tin liên quan (ví dụ: một sản phẩm có hình ảnh, tên và giá) và hướng dẫn người dùng thực hiện bước tiếp theo rõ ràng, chẳng hạn như đề xuất "Xem chi tiết".
Thẻ thông tin chi tiết có thể chứa những nội dung sau:
- Nội dung nghe nhìn (hình ảnh, ảnh GIF hoặc video)
- Văn bản tiêu đề
- Văn bản mô tả
- Đề xuất câu trả lời và hành động được đề xuất (tối đa 4)
Mỗi trường này là không bắt buộc, nhưng bạn phải đưa ít nhất một trong các trường từ 1 đến 3 vào thẻ thông tin chi tiết.
Bạn có thể gửi nhiều thẻ cùng lúc trong một băng chuyền cuộn ngang.
Xin lưu ý rằng tổng tải trọng cho một thẻ thông tin chi tiết là 250 KB.
Để biết thông tin kỹ thuật đầy đủ, hãy xem Tài liệu về thẻ thông tin chi tiết.
Chiều cao thẻ
Thẻ thông tin chi tiết mở rộng theo chiều dọc để phù hợp với nội dung. Thanh ứng dụng trên cùng có chiều cao tối thiểu là 112 DP và chiều cao tối đa là 344 DP. Nếu nội dung thẻ không đủ lớn để lấp đầy chiều cao tối thiểu của thẻ, thì thẻ sẽ mở rộng và lấp đầy chiều cao thừa bằng khoảng trắng.
Nội dung nghe nhìn trong thẻ thông tin chi tiết phải phù hợp với một trong ba chiều cao sau:
- Ngắn: 112 DP
- Trung bình: 168 DP
- Cao: 264 DP
Nếu nội dung nghe nhìn không vừa với kích thước trong thẻ theo chiều cao đã chọn, thì bản xem trước nội dung nghe nhìn sẽ được chọn bằng cách thu phóng và cắt nội dung nghe nhìn.
Ví dụ
Mã sau đây gửi một thẻ thông tin chi tiết có hình ảnh và câu trả lời được đề xuất. Để biết các lựa chọn về định dạng và giá trị, hãy xem 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); });
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(); }
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')
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");
Băng chuyền thẻ thông tin chi tiết
Băng chuyền kết hợp nhiều thẻ thông tin chi tiết, cho phép người dùng so sánh các mục và phản hồi từng mục riêng lẻ.
Băng chuyền có thể chứa tối thiểu 2 và tối đa 10 thẻ thông tin chi tiết. Thẻ thông tin chi tiết trong băng chuyền phải tuân thủ các yêu cầu chung về thẻ thông tin chi tiết đối với nội dung và chiều cao, như mô tả trong Tài liệu về thẻ thông tin chi tiết. Để biết thêm thông tin về bố cục và thông số kỹ thuật của băng chuyền, hãy xem Tài liệu về băng chuyền.
Ví dụ
Đoạn mã sau đây gửi một băng chuyền thẻ thông tin chi tiết. Để biết các lựa chọn về định dạng và giá trị, hãy xem 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); });
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(); }
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')
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);