API経由のカカオトーク

NTT CPaaSは、専用APIを通じてカカオトークをサポートしています。

NTT CPaaS Kakao Alim API: 顧客ベースに通知メッセージを送信します。通信用のテンプレートを登録したら、カカオアリムAPIメッセージメソッドを使用してリクエストを作成して送信します。
NTT CPaaS Kakao Sangdam API: 顧客とのリアルタイムの会話を設定し、ライブエージェントサポートを提供し、エージェントが最高のカスタマーサービスを提供できるようにします。
NTT CPaaS カカオブランドメッセージ API: カカオブランドメッセージ API を使用して、プロモーションコンテンツを配信し、カスタマイズされたメッセージで顧客を引き付けます。この API を使用すると、企業はフレンドトークメッセージの送信、プロモーションコードの共有、限定オファーの提供、動的なキャンペーンの作成を行って、認知度を高め、売上を促進し、顧客ロイヤルティを育むことができます。

追加機能の恩恵を受けたい場合に備えて、送信リクエストに補足オプションを追加することを忘れないでください。

メッセージ・オプション

追加のメッセージオプションを API 要求に適用できます。

一括メッセージ [#bulk-messages-message-options]

1 つの API リクエストで複数のテキストメッセージまたはメッセージテンプレートを送信できます。

メッセージのスケジューリング [#scheduling-messages-message-options]

すべての通信をスケジュールできます。開始日、時刻、タイムゾーンを設定できます。この機能は、夜間に顧客の邪魔をしたくない場合や、最適なコンバージョンのために特定の期間にのみメッセージを送信したい場合に便利です。

json

2 "SendAt": 2015-07-07T17:00:00.000+01:00

追加のスケジュールオプションは、送信速度制限を設定することです。たとえば、メッセージを一括送信して、より長い期間にわたってメッセージを配信する場合、送信速度を制限できます。この機能は、ディスパッチされたメッセージに埋め込まれた行動喚起に受信者が反応することが予想される場合に役立ちます。そうすることで、エンドユーザーからの応答の流入でシステムやエージェントを圧倒することを回避し、運用上の負担を回避できます。定期的に送信される**メッセージの数(量)**を設定できます。使用可能な時間単位は、分、時間、日です。

json

2 "sendingSpeedLimit": {

3 "amount": 30,

4 "timeUnit": "HOUR"

5 }

また、メッセージを配信しない特定のメッセージ配信期間を設定することもできます。開始時刻(時/分)、終了時刻(時/分)、曜日を設定できます。時刻は UTC タイムゾーンで表されます。

json

2 "deliveryTimeWindow": {

3 "days": [

4 "MONDAY",

5 "TUESDAY",

6 "WEDNESDAY",

7 "THURSDAY",

8 "FRIDAY",

9 "SATURDAY",

10 "SUNDAY"

11 ],

12 "from": {

13 "hour": 6,

14 "minute": 0

15 },

16 "to": {

17 "hour": 15,

18 "minute": 30

19 }

20 }

有効期間 [#validity-period-message-options]

メッセージには、システムがメッセージの配信を試みる特定の期間があります。たとえば、オーディエンスにメッセージを送信するときに、一部のユーザーが携帯電話をオフにしている場合、システムは有効期間が経過するまでこれらのユーザーへの配信を再試行します。デフォルトおよび最大有効期間は 48 時間です。要求ごとに設定する必要はありません。より短い期間を設定する場合は、有効期間で定義する必要があります。使用可能な時間単位は、秒、分、時間です。デフォルト値は minutes です。

json

2 "validityPeriod": {

3 "amount": 30,

4 "timeUnit": "MINUTES"

5 }

SMS フェイルオーバー [#sms-failover-message-options]

定義された期間内にカカオアリムのメッセージが終了ユーザー届かない場合に備えてSMSオプションへのフェイルオーバーを追加します。また、SMSメッセージの有効期間を設定することもできます。

json

2 "smsFailover": {

3 "sender": "41793026726",

4 "text": "Failover message text",

5 "validityPeriod": {

6 "amount": 2,

7 "timeUnit": "HOURS"

8 }

9 }

プラットホーム [#platform-message-options]

カカオAPIはCPaaS Xとシームレスに連携します。これにより、ニーズに合った方法で構成とリソースをより柔軟に管理できます。CPaaS Xの詳細については、CPaaS Xドキュメントを参照してください。

json

2 "platform": {

3 "entityId": "priorityCustomer",

4 "applicationId": "clientTestEnvironment"

5 }

Webhook (英語) [#webhooks-message-options]

webhooks > delivery > url パラメータオプションは、ユーザーがAPI応答を受信するURLを設定できるようにする場合に使用します。API 要求の Webhook パラメーターの下に URL を定義します。

json

2 "webhooks": {

3 "delivery": {

4 "url": "https://www.example.com/kakaotalk"

5 },

6 }

URL の短縮と追跡 [#url-shortening-tracking-message-options]

カカオブランドメッセージメッセージは、URL短縮および追跡機能をサポートしています。これにより、カカオブランドメッセージAPI を介して短縮URLを送信し、そのパフォーマンスを監視できるため、顧客エンゲージメントとインタラクションに関するより良い洞察が可能になります。メッセージ本文と Open URL CTA ボタンでリンクを追跡できます。

この機能は、ブロードキャストを使用している場合にも利用できます。

この機能を有効にするには、次の手順を実行します。

URL の短縮とトラッキングを有効にする:
- API リクエストで、shortenUrl パラメータと trackClicks パラメータを true に設定します。
カスタムドメインとトラッキング URL を構成する:
- 短縮 URL にブランディングを反映させる場合は、customDomain パラメーターを使用して、登録済みのカスタムドメインを定義します。以前にカスタムドメインを登録していることを確認します。
- コールバックサーバーでクリックレポートを受信するには、trackingUrlを指定します。提供されない場合、追跡データには他の方法でアクセスできる場合があります。
プロトコルの削除:
- 必要に応じて、removeProtocol を true に設定して、プロトコルを削除して URL をさらに短縮します (例: https://)。

json

1 "options": {

2 "tracking": {

3 "shortenUrl": true,

4 "trackClicks": true,

5 "trackingUrl": "https://example.com/click-report",

6 "removeProtocol": true,

7 "customDomain": "example.com"

8 }

9 }

受信メッセージ

着信メッセージは、カカオサンダムを双方向通信に使用すると、リアルタイムで転送されます。

配信レポート

この方法では、送信されたカカオアリムメッセージの1回限りの配信レポートを取得できます。

エンドポイントは、次の場所で定義されます。

プラットフォーム内のアカウントレベルの設定
(オプション)webhooks>delivery>メッセージのAPIリクエストのurlパラメータ。このエンドポイントを定義しない場合、レポートはプラットフォームで定義されているエンドポイントに転送されます