返信用インジケータ

返信インジケータは、相手がメッセージを見て返信の準備を始めたことを知らせる会話シグナルです。一般的に3つのアニメーションドットとして表示される返信インジケータは、不確実性を減らし、やり取りをより自然で応答的なものにすることで、会話体験を向上させます。

返信インジケータは現在Whatsappでのみ利用可能です。
返信インジケータは、テキストや音声メモなど、さまざまな形式で表示することができます。テキストによる返信はタイピングインジケーターと呼ばれます。

返信インジケータは、返信メッセージが送信されたとき、または25秒経過したときのどちらか早いほうに、自動的に解除されます。ユーザーエクスペリエンスの低下を避けるため、返信インジケータは返信が予想される場合にのみ送信してください。

受信メッセージのウェブフックを受信したら message_uuid に:

  • としてマークする readそして
  • 相手に返信インジケータを表示する

このアプローチにより、返信指標は常に文脈に沿ったタイムリーなものであり、会話中の特定のメッセージに結びつけられる。

返信インジケータを表示するには、次のようにして特定されるメッセー ジ・リソースにPATCHリクエストを送る。 message_uuid.

リクエストだ:

  • はメッセージのステータスを read
  • を含む。 replying_indicator インジケータが表示されるかどうか、またどのような種類のレスポンスが準備されているかを制御するオブジェクト。

リクエスト体制

curl -X PATCH "${GEOSPECIFIC_MESSAGES_API_URL}/${MESSAGES_MESSAGE_ID}" \
  -H "Authorization: Bearer $JWT" \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -d '{
    "status": "read",
    "replying_indicator": {
      "show": "true",
      "type": "text"
    }
  }'
フィールド 説明
status メッセージの状態を更新する。返信インジケータを有効にするには、read に設定する必要があります。
replying_indicator.show 返信インジケータを有効または無効にする。
replying_indicator.type 用意されている応答のタイプ(例えばテキスト)を示す。

地域固有のAPIエンドポイント

Messages APIは、地域固有のベースURLから利用できます。アプリケーションがプロビジョニングされている地域に対応するエンドポイントを使用する必要があります:

  • アジア太平洋(APAC): https://api-ap.vonage.com/v1
  • ヨーロッパ(EU): https://api-eu.vonage.com/v1
  • アメリカ(米国): https://api-us.vonage.com/v1

例としては ${GEOSPECIFIC_MESSAGES_API_URL} はこれらのベースURLの1つを表す。返信インジケータを表示するには、顧客のメッセージUUIDで識別されるメッセージ・リソースに

PATCH
リクエストを送信します(message_uuid).この UUID は、受信メッセージのウェブフックのペイロードで提供されます。

メッセージID エンドポイント

メッセージのUUIDは /messages リソースのパス。例えば

https://api-us.vonage.com/v1/messages/3ca4b881-3e11-46bd-b491-76740a62639a

このUUIDは、あなたが既読としてマークし、応答している顧客の受信メッセージを一意に識別します。

応答

成功した場合

{
  "success"true
}