カスタムコネクタ(サービスプロバイダ)の設定

MoEngageは、Gupshup、Kaleyra、ICS、Sinch、およびTwilioとネイティブに統合されています。他のSMSサービスプロバイダーと統合したい場合は、MoEngageダッシュボードでカスタムコネクタ(サービスプロバイダー)として設定できます。

サービスプロバイダーを設定する

MoEngageダッシュボードでサービスプロバイダーを設定するには:

  1. 設定 -> チャネル -> SMS に移動します。
  2. 送信者設定 タブをクリックします。ここに、統合されたカスタムサービスプロバイダーのリストが表示されます。
  3. +送信者を追加 を右上隅でクリックします。送信者追加画面では、新しいカスタムサービスプロバイダーを追加するか、 設定されたサービスプロバイダーへの送信者。
  4. + カスタムサービスプロバイダーを追加 をクリックします。
  5. 一般的な詳細 画面に次の詳細を入力してください。
    分野 説明

    デフォルトとしてマーク

    このトグルをオンにすると、送信者を構成中のサービスプロバイダーのデフォルト送信者としてマークします。デフォルトとしてマークされている場合、この送信者はMoEngageからのすべてのSMSキャンペーンの送信に使用されますが、キャンペーン作成時に別の送信者を選択することもできます。

    サービスプロバイダー名

    このフィールドは、MoEngage ダッシュボードで設定しているサービスプロバイダーを識別し、一意である必要があります。ここにコネクタの名前を入力してください。

    送信者名

    このフィールドは送信者を識別します。ここに送信者の名前を入力してください。

    送信者タイプ

    送信者タイプは プロモーション または トランザクション のいずれかです。送信者をブランド情報の送信、取引の促進、ユーザーとのエンゲージメントに使用する場合は、送信者タイプをプロモーションとして選択します。送信者を取引に関するアラート、OTP、セキュリティ情報、またはトランザクションとして分類される情報の送信に使用する場合は、送信者タイプをトランザクションとして選択します。

    API URL

    このフィールドには、送信者にAPIリクエストを送信するために使用されるURLに関する情報が含まれています。この情報は、送信者のAPIドキュメントから取得できます。ここに送信者のAPIエンドポイントを入力してください。

    方法

    送信者のAPIドキュメントに記載されている仕様に従って、次のHTTPメソッドのいずれかを選択してください。

    • GET
    • POST
    • 削除

    :

    URLパラメーター

    このオプションを使用して、キーと値のペアとしてAPIに渡すURLパラメータを追加します。この情報は、送信者のAPIドキュメントから取得できます。例えば、API URL呼び出しがGETメソッドを使用する場合、APIキー、認証情報などのすべてのパラメータはURLパラメータとして渡されます。

    : GETおよびPOSTメソッドでは、属性をカスタマイズできます。 詳細については、 SMSキャンペーンコンテンツのパーソナライズ を参照してください。

    ヘッダー

    このオプションを使用して、キーと値のペアとしてAPIに渡すリクエストヘッダーを追加します。この情報は、送信者のAPIドキュメントから取得できます。例えば、認証ヘッダーやコンテンツタイプヘッダーが送信者のAPI仕様に応じてKVペアとして追加されます。

    : GETおよびPOSTメソッドでは、属性を個別に設定できます。 詳細については、refer to SMSキャンペーンコンテンツのパーソナライズ を参照してください。

    体型

    POSTメソッドがAPIリクエストの一部として情報を送信する際に、次のいずれかを選択してください。この情報は、送信者のAPIドキュメントに記載されています。

    • フォーム - このリクエストタイプにキーと値のペアを追加します。
    • JSON - このリクエストタイプにキーと値のペアを追加します。
    • - このリクエストタイプの リクエスト本文 を貼り付けます。

    注意 : このフィールドでフォームまたはJSONを選択すると、GETおよびPOSTメソッドに対して属性を個別に設定できます。 詳細については、 SMSキャンペーンコンテンツをパーソナライズする を参照してください。

    認証設定を有効にする

    コネクタリクエストが基本的な変更のないアクセストークンを含む場合、それらをキーと値のペアとしてヘッダーに追加するだけで済みます。

    コネクタリクエストがOAuth 2.0認証を含む場合、次の手順を実行してください:
    OAuth.png

    1. 認証設定を有効にする トグルをオンにします。
    2. 承認設定を選択 ドロップダウンリストから、OAuth設定を選択します。
      info

      情報


      MoEngageシステムで設定されたOAuth設定は、 設定 > 詳細設定 > 承認設定 で確認できます。詳細については、 OAuth 2.0 を参照してください。

      「アクティブ」ステータスの健康なOAuth設定を選択する必要があります。「失敗」ステータスのOAuth設定を選択すると、コネクタキャンペーンを作成できません。

    3. キー フィールドにはデフォルトで「Authorization」と入力されています。
    4. Prefix フィールドに、プレフィックスを入力します。選択したOAuth構成に追加されたプレフィックスの名前を入力できます。これらのプレフィックスを上書きして、独自のプレフィックスを作成することもできます。
    5. 再試行エラーコード フィールドに、応答が失敗した場合に再試行を開始するためのエラーコードを入力します。たとえば、MoEngage にコネクターキャンペーンの作成を再試行させるために、期限切れのエラーコードとしてエラーコード「400」を使用します。

    テストSMSを送信

    設定を確認するには、 テストSMSを送信 をクリックします。テストSMS送信画面には次のフィールドがあります:

    • 携帯番号 - ドロップダウンから国コードを選択し、テキストボックスに携帯番号を入力してください。テストSMSはこの番号に送信されます。
    • メッセージ - このフィールドはメッセージ本文を示します。

    テストSMSを送信します.gif

  6. テストが成功したら、設定を保存するには 保存 をクリックします。
情報

Note

リクエストパラメータ、ヘッダー、または本文を定義する際に、以下の値を指定された通りに設定してください。

  • Moesms_destinationとしての宛先番号キー
  • メッセージキーとしてのMoesms_message
  • DLT Template ID as Moesms_dltTemplateId (This is for clients operating in India)
  • キャンペーンIDとしてMoesms_campaignId(この属性はPOSTおよびGETメソッドで使用できますが、DELETEメソッドでは使用できません)。

APIリクエストをパーソナライズする

報告や分析の目的で、APIリクエストにパーソナライゼーションを追加できます。次のユーザー属性とキャンペーン属性を動的属性として渡すことができます。

  • ユーザー属性 : パーソナライゼーションダイアログボックスで利用可能なすべての属性。
  • キャンペーン属性 :
    • キャンペーンID
    • キャンペーン名
    • キャンペーンタグ
    • チーム名
    • テンプレートID
    • コネクタータイプ(プロモーションまたはトランザクショナル)
    • 作成者
    • キャンペーン作成時間
    • 公開時間
    • 最終更新日時
    • 最終更新者
    • キャンペーン配信タイプ
    • コンバージョン目標
    • コンバージョン目標属性
情報

情報

必要な属性をAPIのリクエストペイロードにマッピングできます。GETおよびPOSTメソッドに対応しています。いくつかの属性に対して複数の値を渡すこともできます。例えば、 キャンペーンタグ

以下のセクションの フィールドは、パーソナライズをサポートしています。

  • URLパラメータ
  • ヘッダー
  • 体型 ( フォーム JSON のみ)

6.png

パーソナライズを追加するには:

  1. 必要な フィールドに「@」と入力します。例えば、 URLパラメータ フィールドです。
    12.png
    パーソナライズのポップアップが表示されます。
    7.png
  2. データパーソナライゼーション タブで、 属性を選択 リストから必要な属性を選択します。例えば、 キャンペーンID
    9.png
  3. 置換テキスト フィールドに、ユーザー固有の値が解決できない場合に送信される標準文字列を入力します。
    10.png
    info

    情報


    SMSを送信する際、MoEngageはキャンペーンオブジェクトに含まれる属性の現在の置換文字列をサポートしています。

  4. 完了 」をクリックします。パーソナライズされた属性の動的な値が、送信者詳細ページの選択された値フィールドに表示されます。
    11.png
info

情報

  • 同様に、ユーザー属性を追加することができます。
  • 送信者設定を保存した後、メッセージの配信追跡を有効にすることができます。

配送追跡

配信追跡を使用すると、カスタムコネクタ(サービスプロバイダー)を使用して送信されたSMSメッセージの配信状況を追跡できます。配信追跡を有効にすると、メトリック - 配信済み , が表示され、メッセージがユーザーに配信されたかどうかを理解し、配信の失敗やエラーを分析するのに役立ちます。この情報を使用して、定期的に配信リストをクリーンアップ(以前の配信が失敗したユーザーを削除)することができます。これにより、繰り返し配信失敗が発生したユーザーへのSMSキャンペーンの送信を回避し、コストを節約できます。

コネクタ(サービスプロバイダー)の設定を初めて保存した後で、配送追跡情報を追加できます。

配達追跡を有効にする手順

配達追跡を有効にするには:

  1. SMS設定画面で新しく追加された送信者にカーソルを合わせ、三点リーダーのアイコンをクリックします。
  2. 編集 を選択します。 送信者の詳細 画面が開きます。
  3. 配達追跡を有効にするには、 次へ をクリックしてください。
  4. SMS配信の追跡 がオンになっています。オフにして配信追跡を無効にします。
  5. SMS配信追跡URLをコピーして、パートナーのダッシュボードのコールバックWebhook設定に貼り付けてください。MoEngageは、以下に示すように、SMS配信トラッキングURLの下でcustom_connectorIDと呼ばれるユニークな識別子を生成します。コネクタ内のすべての送信者は、同じ custom_connectorID と配信追跡URLを持ちます。

    SMS配信追跡URL
    https://api-0X.moengage.com/sms/dlr/custom/<custom_connectorID>
  6. 配信応答の属性/フィールドをマッピング

    配信応答からフィールドをマッピングするか、希望のオプションを選択して手動でフィールドをマッピングすることができます。このマッピングは、MoEngageがサービスプロバイダーの配信応答を理解するのに役立ちます。配信応答の属性をマッピングするには、次のオプションのいずれかを選択してください:

    1. 配信応答の属性をマッピング
    2. フィールドを手動でマッピング
    前のステップでSend a Test SMSを使用して設定をテストしていない場合は、 Send a test SMS をクリックして配信応答の属性をマッピングします。配信コールバック情報を受信するまでに最大15分かかることがあります。MoEngageがこの情報を受信すると、ダッシュボードに表示されます。
    フィールド名 説明

    送信応答のユニークIDを格納する属性

    このフィールドはリクエストを一意に識別します。このフィールドの値は、トランザクションまたはメッセージIDフィールドに存在する値と一致することが理想です。

    配信応答のユニーク配信IDフィールドを格納する属性

    このフィールドは、配信応答のユニーク識別子を格納します。このフィールドの値は送信応答の値と一致する必要があります。これにより、MoEngageは任意のSMSに対する配信応答を識別するのに役立ちます。

    配信ステータスを格納する属性

    このフィールドには送信されたSMSの配信ステータスが含まれています。これは、MoEngageによって Delivered メトリックを計算するために使用されます。

    配信ステータスの成功値

    これらの値は、SMSが正常に配信されたことを示します。このフィールドに記載されている値が応答の一部として受信された場合、メッセージを配信済みとしてマークします。応答で他の値が受信された場合は、デフォルトで失敗と見なされます。

    失敗理由を格納する属性

    このフィールドには、SMS配信が失敗した場合の失敗理由が含まれています。失敗理由はキャンペーン分析で確認できます。詳細については、 Failure Reasons を参照してください。

    配信応答からフィールドをマッピング フィールドを手動でマッピング

    配信応答からフィールドをマッピングするには:

    1. テストSMSを送信し、サービスプロバイダーからの応答を受信するには、Send a Test SMSをクリックします。MoEngageがこの情報を受信すると、ダッシュボードに表示されます。この応答からフィールドをマッピングできます。
    2. ドロップダウンは、配信応答から解析されたフィールド名で自動的に入力されます。次の画像は、送信されたサンプルSMSと配信応答を示しています。この応答からダッシュボードでのマッピングのためにドロップダウンが自動入力される様子も画像で説明されています。

    MapFieldsFromResponse.png

    配信応答の一意の識別子を保存します。このフィールドの値は、送信された応答の値と一致する必要があります。これにより、MoEngageは任意のSMSの配信応答を識別するのに役立ちます。

    配信ステータスを格納する属性

    このフィールドには、送信されたSMSの配信状況が含まれています。これは、MoEngageによって 配信済み メトリックを計算するために使用されます。

    配信ステータスの成功値

    これらの値は、SMSが正常に配信されたことを示しています。レスポンスの一部としてこのフィールドに記載されている値が受信された場合、メッセージは配信済みとマークされます。それ以外の値がレスポンスで受信された場合、デフォルトで失敗と見なされます。

    属性保存失敗の理由

    このフィールドには、SMS 配信が失敗したときの失敗理由が含まれています。失敗理由はキャンペーン分析で確認できます。詳細については、 失敗理由 を参照してください。

    配信応答からフィールドをマップする フィールドを手動でマッピング

    配信応答からフィールドをマッピングするには:

    1. テストSMSを送信して、サービスプロバイダーからの応答を受信するには、テストSMSを送信をクリックしてください。MoEngageがこの情報を受け取ると、ダッシュボードに表示されます。この応答からフィールドをマッピングできます。
    2. ドロップダウンは、配信応答から解析されたフィールド名で自動入力されます。次の画像は、送信されたサンプルSMSと配信応答を示しています。ダッシュボード上のマッピングのために、この応答からドロップダウンが自動的に入力される様子も画像に示されています。

  7. 配信応答がマッピングされたら、 保存 をクリックして配信コールバック設定を保存します。
info

注記

  • 配信コールバックはPOSTリクエストであり、JSONペイロードを受け入れます。
  • システムの使用を最適化し、コストを削減し、信頼性を高めるために、配信コールバック応答のペイロードサイズは150 KBを超えないようにしてください。応答がこの制限を超えると、MoEngageは413 Bad Requestエラーを送信します。この場合、ペイロードを小さくして応答を再送信することをお勧めします。このエラーが一貫して観察される場合は、ペイロード作成コードを更新することをMoEngageは推奨します。
  • MoEngageで配信追跡を設定できるのは、管理者とマネージャーのみです。

Next Steps

  1. SMSキャンペーンを作成します。
  2. SMSの頻度制限を設定する .
  3. 現在のサービスプロバイダーを設定します。

この記事は役に立ちましたか?
8人中4人がこの記事が役に立ったと言っています

How can we improve this article?