> ## Documentation Index
> Fetch the complete documentation index at: https://moengage.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# SMS 用カスタムコネクターの設定

> API の詳細設定、リクエストのパーソナライズ、接続テストをダッシュボード上で行い、カスタム SMS サービスプロバイダーを MoEngage に追加します。

<Info>
  カスタムコネクターは SMS チャネルでのみサポートされています。
</Info>

MoEngage ダッシュボードでカスタムコネクターを設定するには、以下の手順を実行します。

1. **Settings** -> **Channels** -> **SMS** に移動します。
2. **Sender Configuration** タブをクリックします。ここには、連携済みのサービスプロバイダーとカスタムサービスプロバイダーの一覧が表示されます。
3. 右上の **+Add Sender** をクリックします。Add Sender 画面では、新しいカスタムサービスプロバイダーを追加するか、設定済みのサービスプロバイダーに送信者を追加できます。
4. +**Add custom service provider** をクリックします。
5. **General Details** 画面で以下の詳細を入力します。
   | フィールド | 説明 | |
   | - | - | - |
   | **Mark as default** | このトグルをオンにすると、設定中のサービスプロバイダーのデフォルト送信者としてこの送信者を設定します。デフォルトに設定すると、キャンペーン作成時に別の送信者を選択しない限り、MoEngage から送信されるすべての SMS キャンペーンでこの送信者が使用されます。 | |
   | **Service provider name** | このフィールドは MoEngage ダッシュボードで設定するサービスプロバイダーを識別するもので、一意である必要があります。ここにコネクター名を入力します。 | |
   | **Sender name** | このフィールドは送信者を識別します。ここに送信者名を入力します。 | |
   | **Sender type** | 送信者タイプは **Promotional** または **Transactional** のいずれかです。ブランドに関する情報の送信、お得な情報のプロモーション、ユーザーとのエンゲージメントに送信者を使用する場合は、Promotional を選択します。取引に関するアラート、OTP、セキュリティ情報など、トランザクション性のある情報の送信に送信者を使用する場合は、Transactional を選択します。 | |
   | **API URL** | このフィールドには、送信者に API リクエストを送信する際に使用する URL の情報が含まれます。この情報は送信者の API ドキュメントから取得できます。ここに送信者の API エンドポイントを入力します。 | |
   | **Method** | 送信者の API ドキュメントに記載された仕様に従って、以下の HTTP メソッドのいずれかを選択します。<ul><li>GET</li><li>POST</li><li>DELETE</li></ul> **注**: <ul><li>各サービスプロバイダーには個別のドメインが必要です。</li><li>GET メソッドと POST メソッドでは、属性をパーソナライズできます。詳細については、[SMS キャンペーンコンテンツのパーソナライズ](/docs/ja/user-guide/campaigns-and-channels/sms-mms-and-rcs/sms/getting-started-with-sms/configure-custom-connector-for-sms#personalize-api-requests)を参照してください。</li></ul> | |
   | **URL Parameters** | このオプションを使用して、API に渡す URL パラメーターをキーと値のペアとして追加します。この情報は送信者の API ドキュメントから取得できます。たとえば、API URL の呼び出しで GET メソッドを使用する場合、API Key や Authorization などのすべてのパラメーターは URL パラメーターとして渡されます。<br /> 注: GET メソッドと POST メソッドでは、属性をパーソナライズできます。詳細については、[SMS キャンペーンコンテンツのパーソナライズ](/docs/ja/user-guide/campaigns-and-channels/sms-mms-and-rcs/sms/getting-started-with-sms/configure-custom-connector-for-sms#personalize-api-requests)を参照してください。 | |
   | **Headers** | このオプションを使用して、API に渡す URL パラメーターをキーと値のペアとして追加します。この情報は送信者の API ドキュメントから取得できます。たとえば、API URL の呼び出しで GET メソッドを使用する場合、API Key や Authorization などのすべてのパラメーターは URL パラメーターとして渡されます。注: GET メソッドと POST メソッドでは、属性をパーソナライズできます。詳細については、[SMS キャンペーンコンテンツのパーソナライズ](/docs/ja/user-guide/campaigns-and-channels/sms-mms-and-rcs/sms/getting-started-with-sms/configure-custom-connector-for-sms#personalize-api-requests)を参照してください。 | |
   | **Body Type** | API リクエストの一部として情報を送信するために POST メソッドを使用する場合は、以下のいずれかを選択します。この情報は送信者の API ドキュメントで確認できます。<ul><li>**Form**: このリクエストタイプではキーと値のペアを追加します。</li><li>**JSON:** このリクエストタイプではキーと値のペアを追加します。</li><li>**Raw**: このリクエストタイプではリクエストボディを貼り付けます。</li></ul> **注**: GET メソッドと POST メソッドで、このフィールドに Form または JSON を選択した場合、属性をパーソナライズできます。詳細については、[SMS キャンペーンコンテンツのパーソナライズ](/docs/ja/user-guide/campaigns-and-channels/sms-mms-and-rcs/sms/getting-started-with-sms/configure-custom-connector-for-sms#personalize-api-requests)を参照してください。 | |
   | **Enable authentication settings** | コネクターのリクエストで変化しない基本的なアクセストークンを使用する場合は、それをヘッダーにキーと値のペアとして追加するだけで済みます。<br /> コネクターのリクエストで OAuth 2.0 認証を使用する場合は、以下の手順を実行します。<br /><img src="https://mintcdn.com/moengage/S5VM4C7aiU6sct6c/images/OAuth.png?fit=max&auto=format&n=S5VM4C7aiU6sct6c&q=85&s=2207aab3d34718099c170c9d17b8a84e" alt="OAuth" title="OAuth" width="552" height="540" data-path="images/OAuth.png" /> <ol><li>**Enable authentication settings** トグルをオンにします。</li><li>**Select authorization setting** ドロップダウンリストから OAuth 設定を選択します。<br /><Info>                                     <ul><li>MoEngage システムで設定された OAuth 設定は、Settings > Advanced settings > Authorization configuration で確認できます。詳細については、[OAuth 2.0](/docs/ja/user-guide/settings/advanced-settings/authorization-configuration-with-oauth-20) を参照してください。 </li><li>"Active" ステータスの正常な OAuth 設定を選択する必要があります。"Failed" ステータスの OAuth 設定を選択すると、Connector キャンペーンを作成できません。</li></ul>                                                                 </Info></li><li>**Key** フィールドには、デフォルトで "Authorization" が入力されています。</li><li>**Prefix** フィールドにプレフィックスを入力します。選択した OAuth 設定で追加されたプレフィックスの名前を入力できます。また、これらのプレフィックスを上書きして独自のプレフィックスを作成することもできます。</li><li>**Reattempt error codes** フィールドに、失敗したレスポンスの場合に再試行を開始するエラーコードを入力します。たとえば、期限切れのエラーコードとして "400" を使用すると、Connector キャンペーンの作成を再試行するよう MoEngage に通知します。</li></ol> | |
   | **Send test SMS** | **Send test SMS** をクリックして設定を確認します。Send Test SMS 画面には以下のフィールドがあります。<ul><li>**Mobile Number**: ドロップダウンから国コードを選択し、テキストボックスに携帯電話番号を入力します。テスト SMS はこの番号に送信されます。</li><li>**Message**: このフィールドはメッセージ本文を表します。</li></ul> <img src="https://mintcdn.com/moengage/dLyLAwgfsm1v6_MY/images/moengage_86218f.png?s=0b4751f8485aa6e9be28c34c751a70f4" alt="Moengage 86218f" title="Moengage 86218f" width="1440" height="668" data-path="images/moengage_86218f.png" /> | |
6. テストが成功したら、**Save** をクリックして設定を保存します。

<Info>
  リクエストパラメーター、ヘッダー、またはボディを定義する際は、以下の値を指定どおりに設定します。

  * Destination Number Key を Moesms\_destination に設定
  * Message Key を Moesms\_message に設定
  * DLT Template ID を Moesms\_dltTemplateId に設定（インドで事業を行うクライアント向け）
  * Campaign ID を Moesms\_campaignId に設定（この属性は POST メソッドと GET メソッドで使用でき、DELETE メソッドでは使用できません）
</Info>

# API リクエストのパーソナライズ

レポートや分析の目的で、API リクエストにパーソナライズを追加できます。以下のユーザー属性とキャンペーン属性を動的属性として渡すことができます。

* **ユーザー属性**: Personalisation ダイアログボックスで利用可能なすべての属性。
* **キャンペーン属性**:
  * Campaign ID
  * Campaign name
  * Campaign tags
  * Team name
  * Template ID
  * Connector type（Promotional または Transactional）
  * Creator
  * Campaign creation time
  * Publish time
  * Last updated at
  * Last updated by
  * Campaign delivery type
  * Conversion goal
  * Conversion goal attribute

<Info>
  GET メソッドと POST メソッドでは、必要な属性を API のリクエストペイロードにマッピングできます。一部の属性には複数の値を渡すこともできます。例: *Campaign tags*。

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

  * **URL parameters**
  * **Headers**
  * **Body type**（**Form** と **JSON** のみ）

      <img src="https://mintcdn.com/moengage/UX7SFw6G5JwoHWFq/images/moengage_5ea3e0.png?fit=max&auto=format&n=UX7SFw6G5JwoHWFq&q=85&s=487fba831d3074289c941846bea92bc3" alt="6.png" width="1030" height="1168" data-path="images/moengage_5ea3e0.png" />
</Info>

パーソナライズを追加するには、以下の手順を実行します。

1. 対象の **Value** フィールドに "@" を入力します。例: **URL parameters** の下の **Value** フィールド。
   <img src="https://mintcdn.com/moengage/CaPmX0z_ys8cr0ms/images/moengage_08c352.png?fit=max&auto=format&n=CaPmX0z_ys8cr0ms&q=85&s=023366b0eba7e292dd28319a2a5898d8" alt="12.png" width="800" height="592" data-path="images/moengage_08c352.png" />
   **Personalization** ポップアップが表示されます。
   <img src="https://mintcdn.com/moengage/B1ZqBU-ISgaoSx_O/images/moengage_53084f.png?fit=max&auto=format&n=B1ZqBU-ISgaoSx_O&q=85&s=6ab68a6b6cbb87a2656a1f2b6f9f6009" alt="7.png" width="874" height="700" data-path="images/moengage_53084f.png" />
2. **Data personalization** タブの **Select attribute** リストで、必要な属性を選択します。例: *Campaign ID*。
   <img src="https://mintcdn.com/moengage/2kQqTYC5RUPSd8kI/images/moengage_3fd513.png?fit=max&auto=format&n=2kQqTYC5RUPSd8kI&q=85&s=bdc14bf9c5fc4315b2e424cd167fbc04" alt="9.png" width="872" height="700" data-path="images/moengage_3fd513.png" />
3. **Replace text** フィールドに、ユーザー固有の値を解決できない場合に送信する標準の文字列を入力します。
   <img src="https://mintcdn.com/moengage/7H2dU4CG2W0DQCPI/images/moengage_6f66a1.png?fit=max&auto=format&n=7H2dU4CG2W0DQCPI&q=85&s=a23b9ed9ba46de9754d54014d055d83e" alt="10.png" width="872" height="696" data-path="images/moengage_6f66a1.png" />
   <Info>
     SMS の送信時、MoEngage はキャンペーンオブジェクトに含まれる属性の現在の置換文字列をサポートします。
   </Info>
4. **Done** をクリックします。パーソナライズされた属性の動的な値が、Sender Details ページの選択した Value フィールドに表示されます。
   <img src="https://mintcdn.com/moengage/t9nft78wsoLTI2Nx/images/moengage_28f11b.png?fit=max&auto=format&n=t9nft78wsoLTI2Nx&q=85&s=b86753e06e529e70a4e51a56b74a58d9" alt="11.png" width="790" height="1166" data-path="images/moengage_28f11b.png" />

<Info>
  * 上記と同じ手順でユーザー属性を追加できます。
  * 送信者設定を保存した後、メッセージの配信トラッキングを有効にできます。
</Info>

# 配信トラッキング

配信トラッキングを使用すると、カスタムコネクター（サービスプロバイダー）を使用して送信された SMS メッセージの配信ステータスを追跡できます。配信トラッキングを有効にすると **Delivered** 指標が表示され、メッセージがユーザーに配信されたかどうかを把握し、配信の失敗やエラーを分析できます。この情報を使用して、配信リストを定期的にクリーンアップできます（過去の配信で失敗したユーザーを削除するなど）。これにより、配信失敗が繰り返されるユーザーへの SMS キャンペーン送信を避け、コストを削減できます。

配信トラッキング情報は、コネクター（サービスプロバイダー）の設定を初めて保存した後に追加できます。

### 配信トラッキングを有効にする手順

配信トラッキングを有効にするには、以下の手順を実行します。

1. SMS 設定画面で新しく追加した送信者にカーソルを合わせ、省略記号アイコンをクリックします。
2. **Edit** を選択します。**Sender Details** 画面が開きます。
3. **Next** をクリックして配信トラッキングを有効にします。
4. **Track sms delivery** トグルがオンになります。配信トラッキングを無効にするには、このトグルをオフにします。
5. SMS 配信トラッキング URL をコピーし、パートナーのダッシュボードのコールバック Webhook 設定に貼り付けます。MoEngage は、以下に示すように SMS 配信トラッキング URL の下に custom\_connectorID という一意の識別子を生成します。コネクター内のすべての送信者は、同じ custom\_connectorID と配信トラッキング URL を持ちます。
   SMS 配信トラッキング URL
   ```text theme={null}
   https://api-0X.moengage.com/sms/dlr/custom/<custom_connectorID>
   ```
6. **配信レスポンスの属性/フィールドをマッピングする**
   目的のオプションを選択して、配信レスポンスからフィールドをマッピングするか、手動でフィールドをマッピングできます。このマッピングにより、MoEngage はサービスプロバイダーの配信レスポンスを理解できます。配信レスポンスの属性をマッピングするには、以下のいずれかのオプションを選択します。

   1. **配信レスポンスの属性をマッピングする**
   2. **フィールドを手動でマッピングする**
      前の手順で Send a Test SMS を使用して設定をテストしていない場合は、**Send a test SMS** をクリックして配信レスポンスから属性をマッピングします。配信コールバック情報の受信には最大 15 分かかる場合があります。MoEngage がこの情報を受信すると、ダッシュボードに表示されます。
      \| フィールド名 | 説明 |
      \| --- | --- |
      \| **Attribute storing unique ID of the sent response** | このフィールドはリクエストを一意に識別します。このフィールドの値は、Transaction または msg ID フィールドの値と一致することが理想的です。 |
      \| **Attribute storing Unique delivery ID field of delivery response** | このフィールドには配信レスポンスの一意の識別子が格納されます。このフィールドの値は、送信レスポンスの値と一致する必要があります。これにより、MoEngage は任意の SMS の配信レスポンスを識別できます。 |
      \| **Attribute storing delivery status** | このフィールドには、送信された SMS の配信ステータスが含まれます。これは MoEngage が *Delivered* 指標を計算するために使用されます。 |
      \| **Success values for delivery status** | これらの値は、SMS が正常に配信されたことを示します。このフィールドに記載された値のいずれかがレスポンスの一部として受信された場合、メッセージは配信済みとしてマークされます。それ以外の値がレスポンスで受信された場合は、デフォルトで失敗とみなされます。ベンダーが配信コールバックで送信する正確な成功ステータス文字列（例: `SENT`）を入力してください。この値がベンダーの報告するステータスと一致しない場合、配信トラッキングが有効になっていても Delivered の数は 0 のままになります。 |
      \| **Attribute storing failure reason** | このフィールドには、SMS の配信が失敗した場合の失敗理由が含まれます。失敗理由はキャンペーン分析で確認できます。詳細については、[失敗理由](/docs/ja/user-guide/campaigns-and-channels/sms-mms-and-rcs/sms/analyze-sms-campaigns#error-breakdown)を参照してください。 |

   <Tabs>
     <Tab title="配信レスポンスからフィールドをマッピングする">
       配信レスポンスからフィールドをマッピングするには、以下の手順を実行します。

       1. **Send test SMS** をクリックしてテスト SMS を送信し、サービスプロバイダーからレスポンスを受信します。MoEngage がこの情報を受信すると、ダッシュボードに表示されます。このレスポンスからフィールドをマッピングできます。
       2. ドロップダウンには、配信レスポンスから解析されたフィールド名が自動入力されます。以下の画像は、送信されたサンプル SMS と配信レスポンスを示しています。ダッシュボード上でのマッピング用に、このレスポンスからドロップダウンが自動入力される様子も画像に示されています。\\
              <img src="https://mintcdn.com/moengage/vl5cQuPaKeqblz8O/images/moengage_8fbd3e.png?fit=max&auto=format&n=vl5cQuPaKeqblz8O&q=85&s=866dafec85340ef760633d2ba136e214" alt="MapFieldsFromResponse.png" width="1122" height="1324" data-path="images/moengage_8fbd3e.png" />
     </Tab>

     <Tab title="フィールドを手動でマッピングする">
       レスポンスのフィールドを手動でマッピングするには、このオプションを選択し、上の表に記載されたすべてのフィールドに詳細を入力します。入力する値については、カスタムコネクターの API ドキュメントを参照してください。

       <img src="https://mintcdn.com/moengage/geRh9DNA2GhPhrjA/images/moengage_f25a89.png?fit=max&auto=format&n=geRh9DNA2GhPhrjA&q=85&s=98b640fda4e2f8d04c302c74c236711e" alt="MapFieldsManually.png" width="1094" height="1478" data-path="images/moengage_f25a89.png" />
     </Tab>
   </Tabs>
7. 配信レスポンスのマッピングが完了したら、**Save** をクリックして配信コールバック設定を保存します。

<Info>
  * 配信コールバックは POST リクエストで、JSON ペイロードを受け付けます。
  * システム使用量の最適化、コスト削減、信頼性向上のため、配信コールバックのレスポンスペイロードのサイズは 150 KB を超えないようにしてください。レスポンスがこの制限を超えると、MoEngage は 413 Bad Request エラーを送信します。その場合は、ペイロードサイズを縮小してレスポンスを再送信することをお勧めします。このエラーが継続的に発生する場合は、ペイロード作成コードを更新することをお勧めします。
  * MoEngage で配信トラッキングを設定できるのは、Admin と Manager のみです。
  * 配信コールバックはメッセージごとに 1 件ずつ送信する必要があります。複数のメッセージを 1 回の呼び出しで報告する一括またはバッチのコールバックはサポートされていません。MoEngage はそのようなコールバックを 1 件の配信としてカウントするため、Delivered の数が実際より少なく報告されます。
</Info>

<Warning>
  配信トラッキングが有効になっているにもかかわらず Delivered の数が 0 のままであったり、少なすぎるように見える場合は、**Success values for delivery status** フィールドがベンダーの送信する正確な成功ステータスと一致していること、およびベンダーが一括コールバックではなくメッセージごとに 1 件の配信コールバックを送信していることを確認してください。
</Warning>

# 次のステップ

1. [SMS キャンペーンを作成する](/docs/ja/user-guide/campaigns-and-channels/sms-mms-and-rcs/sms/create-an-sms-campaign)
2. [SMS のフリークエンシーキャッピングを設定する](/docs/ja/user-guide/settings/channels/delivery-controls/frequency-capping)
3. [現在のサービスプロバイダーを設定する](/docs/ja/user-guide/campaigns-and-channels/sms-mms-and-rcs/sms/getting-started-with-sms/configure-an-sms-sender)