すべてのプロダクト
Search

このプロダクト

    Chat App Message Service:WhatsApp メッセージを送信する

    ドキュメントセンター

    Chat App Message Service:WhatsApp メッセージを送信する

    最終更新日:Jan 21, 2025

    API の説明

    SendChatappMessage を呼び出して、WhatsApp メッセージを送信できます。

    この操作は、アカウントごとに 1 秒あたり最大 250 回呼び出すことができます。 1 秒あたりの呼び出し数が制限を超えると、速度制限がトリガーされます。 その結果、ビジネスに影響が出る可能性があります。 この操作を呼び出すときは、制限に注意することをお勧めします。

    デバッグ

    この操作は、OpenAPI エクスプローラーで呼び出すことができます。 OpenAPI エクスプローラーは、署名の値を自動的に計算し、さまざまな SDK の操作のサンプルコードを動的に生成します。

    承認情報

    この API では承認情報は開示されていません。

    リクエストパラメーター

    パラメーター

    タイプ

    必須

    説明

    例

    ChannelType

    string

    はい

    チャネルのタイプ。 パラメーターを whatsapp に設定します。

    whatsapp

    Type

    string

    はい

    メッセージタイプ。有効な値：

    • template：テンプレートメッセージ。 テンプレートメッセージは、Chat App Message Service コンソールで作成および承認されたテンプレートに基づいて送信されます。 テンプレートメッセージはいつでも送信できます。

    • message：カスタムメッセージ。 カスタム WhatsApp メッセージは、ユーザーから最後のメッセージを受信してから 24 時間以内にのみ、ユーザーに送信できます。

    template

    MessageType

    string

    いいえ

    メッセージの特定のタイプ。 Type が message に設定されている場合の有効な値：

    • text：テキストメッセージ。

    • image：画像メッセージ。

    • video：動画メッセージ。

    • audio：音声メッセージ。

    • document：ドキュメントメッセージ。

    • interactive：インタラクティブメッセージ。

    • contacts：連絡先メッセージ。

    • location：位置情報メッセージ。

    • sticker：スタンプメッセージ。

    • reaction：リアクションメッセージ。

    説明

    詳細については、「メッセージテンプレートのパラメーター」をご参照ください。

    text

    TemplateCode

    string

    いいえ

    メッセージテンプレートのコード。 このパラメーターは、Type パラメーターを template に設定した場合にのみ必須です。

    744c4b5c79c9432497a075bdfca3****

    Language

    string

    いいえ

    メッセージテンプレートで使用される言語。 このパラメーターは、Type パラメーターを template に設定した場合にのみ必須です。 言語コードの詳細については、「言語コード」をご参照ください。

    en

    From

    string

    はい

    メッセージ送信者の携帯電話番号。

    説明

    WhatsApp アカウントに登録され、Chat App Message Service コンソールで承認されている携帯電話番号を指定する必要があります。

    861360000****

    To

    string

    はい

    メッセージ受信者の携帯電話番号。

    861390000****

    TemplateParams

    object

    いいえ

    メッセージテンプレートの変数。

    string

    いいえ

    メッセージテンプレートに含まれる変数の値。 値は JSON 形式である必要があります。 テンプレートに変数が含まれている場合、このパラメーターは必須です。

    {"param1":"value1","param2":"value2"}

    Content

    string

    いいえ

    メッセージの内容。

    • messageType を text に設定した場合、text を指定する必要があり、Caption を指定することはできません。

    • messageType を image に設定した場合、Link を指定する必要があります。

    • messageType を video に設定した場合、Link を指定する必要があります。

    • messageType を audio に設定した場合、Link は必須で、Caption は無効です。

    • messageType を document に設定した場合、Link と FileName は必須で、Caption は無効です。

    • messageType を interactive に設定した場合、type と action を指定する必要があります。

    • messageType を contacts に設定した場合、name を指定する必要があります。

    • messageType を location に設定した場合、longitude と latitude を指定する必要があります。

    • messageType を sticker に設定した場合、Link を指定する必要があり、Caption と FileName は無効です。

    • messageType を reaction に設定した場合、messageId と emoji を指定する必要があります。

    {"text": "hello whatsapp", "link": "", "caption": "", "fileName": "" }

    Payload

    array

    いいえ

    ボタンのペイロード。

    string

    いいえ

    メッセージテンプレートのボタンのペイロード。

    payloadtext1,payloadtext2,payloadtext3

    FallBackId

    string

    いいえ

    フォールバックポリシーの ID。 Chat App Message Service コンソールでフォールバックポリシーを作成し、情報を表示できます。

    S_000001

    FallBackContent

    string

    いいえ

    フォールバックメッセージの内容。

    これはフォールバックメッセージです。

    CustSpaceId

    string

    いいえ

    RAM ユーザーのスペース ID。

    28251486512358****

    ContextMessageId

    string

    いいえ

    返信メッセージの ID。

    61851ccb2f1365b16aee****

    TaskId

    string

    いいえ

    タスク ID

    100000001

    FallBackDuration

    integer

    いいえ

    メッセージがクライアントに配信されたことを示すメッセージ受信確認が受信されない場合に、フォールバックメッセージが送信されるまでの期間を指定します。 このパラメーターを空のままにすると、メッセージの送信に失敗した場合、またはメッセージがクライアントに配信されなかったことを示すメッセージ受信確認が受信された場合にのみ、フォールバックメッセージが送信されます。

    単位：秒。 有効な値：60 ～ 43200。

    120

    FallBackRule

    string

    いいえ

    フォールバックルール。有効な値：

    • undelivered：メッセージがクライアントに配信されない場合、フォールバックがトリガーされます。 メッセージの送信時に、テンプレートパラメーターが検証されます。 パラメーターが検証に合格しなかった場合、メッセージは送信に失敗します。 テンプレートと電話番号が禁止されているかどうかは検証されません。 デフォルトでは、FallBackRule が空の場合、この値が使用されます。

    • sentFailed：変数を含むテンプレートパラメーターが検証に合格しなかった場合でも、フォールバックがトリガーされます。 channelType、type、messageType、to、および from パラメーターが検証に合格しなかった場合、フォールバックはトリガーされません。

    undelivered

    ProductAction

    object

    いいえ

    WhatsApp カタログメッセージまたは複数商品メッセージ（MPM）に含まれる商品に関する情報。

    ThumbnailProductRetailerId

    string

    いいえ

    商品の販売者 ID。

    S238SK

    Sections

    object []

    いいえ

    商品。 最大 30 個の商品と 10 個のカテゴリを追加できます。

    Title

    string

    いいえ

    商品のカテゴリ。

    Test

    ProductItems

    object []

    いいえ

    商品。

    ProductRetailerId

    string

    いいえ

    商品の販売者 ID。

    9I39E9E

    FlowAction

    object

    いいえ

    フローアクション。

    FlowToken

    string

    いいえ

    フロートークン。

    1122***

    FlowActionData

    object

    いいえ

    フローのデフォルトパラメーター。

    string

    いいえ

    フローのデフォルトパラメーター。

    {"name":"test"}

    レスポンスパラメーター

    パラメーター

    タイプ

    説明

    例

    object

    返されたデータ。

    RequestId

    string

    リクエストの ID。

    90E63D28-E31D-1EB2-8939-A94866411B2O

    Code

    string

    返されたステータスコード。

    • OK の値は、リクエストが成功したことを示します。

    • その他の値は、リクエストが失敗したことを示します。 詳細については、「エラーコード」をご参照ください。

    OK

    Message

    string

    返されたエラーメッセージ。

    指定されたリソースに対する操作がユーザーに許可されていません。

    MessageId

    string

    送信されたメッセージの ID。

    61851ccb2f1365b16aee****

    例

    成功レスポンスの例

    JSON 形式

    {
  "RequestId": "90E63D28-E31D-1EB2-8939-A94866*******",
  "Code": "OK",
  "Message": "User not authorized to operate on the specified resource.",
  "MessageId": "61851ccb2f1365b16aee****"
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    400

    Product.Unsubscript

    指定されたプロダクトをサブスクライブしていません。

    400

    Ram.PermissionDeny

    操作を実行する権限がありません。

    400

    System.LimitControl

    システムはフロー制御中です。

    400

    Unknown.ResourceOwnerId

    リソースは現在のユーザーに属していません。

    エラーコードの一覧については、サービスエラーコードをご覧ください。