リッチカードとカルーセルの送り方
このガイドでは、Vonage Messages APIを使用してリッチカードとカルーセルを送信する方法を説明します。さまざまなタイプのメッセージとそのコンポーネントの詳細については、以下を参照してください。 リッチカードとカルーセルの種類.
リッチカードを送る
リッチカードを使用すると、RCSユーザーに視覚的に魅力的なメッセージを送信できます。カードには、タイトル、テキスト、メディア(画像や動画など)、最大4つの返信候補やアクションを含めることができます。
前提条件
- アプリケーションでRCSメッセージングが有効になっています。以下を参照してください。 RCSを始める.
- ブランド、エージェント、API認証情報を設定しました。参照 RCSブランドおよび代理店ビルダーガイド.
リッチカードの要素を定義する
それぞれ card オブジェクトが含まれていなければならない:
title- カードのタイトル(200文字以内)text- 説明文(2000文字以内)media_url- 画像またはビデオの公開URL
オプションで追加することもできる:
media_height-SHORT,MEDIUMあるいはTALLmedia_description- アクセシビリティthumbnail_url- メディア読み込み中のプレースホルダ画像suggestions- インタラクティブな返信やアクションの提案
RCSパラメータの追加
RCSカード・メッセージには rcs オブジェクトを指定する:
card_orientation:VERTICALまたはHORIZONTALimage_alignment:LEFTまたはRIGHT(横長カードのみ)
メッセージを送る
Messages APIを使う POST エンドポイントにリッチカードをリクエストボディに含める。
単体のリッチカードメッセージの例です:
カルーセルを送る
リッチカードカルーセルでは、2~10枚のカードを1つのメッセージにまとめることができます。各カードは独自のメディアと提案を持つことができます。
各カードには、以下の内容が含まれていなければならない:
title- カードのタイトル(200文字以内)text- テキスト説明(最大2000文字)media_url- 画像またはビデオの公開URL
オプションのパラメータ(カード1枚につき):
media_height-SHORT,MEDIUMあるいはTALLmedia_description- アクセシビリティthumbnail_url- メディアのロード中に表示されるmedia_force_refresh- 強制リフレッシュするかどうかsuggestions- 4つまでの返信またはアクションの提案