API 上の Viber ボット

Viber Botsメッセージを送信する前に、コンプライアンスとガイドラインとメッセージタイプの詳細に精通していることを確認してください。

ボット API

Viber ボット API を使用して、エンドユーザーにメッセージを送信します。

認証ガイドに従って、NTT CPaaS との接続をセキュリティで保護します。

送信メッセージ [#outbound-messages-bots-api]

API を介して次の種類のメッセージを送信できます。

テキスト
画像
ビデオ
ファイル
回転木馬
場所
接触
ステッカー
URL

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

メッセージ・オプション [#message-options-bots-api]

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

一括メッセージ [#bulk-messages-bots-api]

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

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

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

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-bots-api]

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

json

2 "validityPeriod": {

3 "amount": 30,

4 "timeUnit": "MINUTES"

5 }

SMS フェイルオーバー [#sms-failover-bots-api]

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

json

2 "smsFailover": {

3 "sender": "41793026726",

4 "text": "Failover message text",

5 "validityPeriod": {

6 "amount": 2,

7 "timeUnit": "HOURS"

8 }

9 }

プラットホーム [#platform-bots-api]

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

json

2 "platform": {

3 "entityId": "priorityCustomer",

4 "applicationId": "clientTestEnvironment"

5 }

Webhook (英語) [#webhooks-bots-api]

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

json

2 "webhooks": {

3 "delivery": {

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

5 },

6 }

受信メッセージ [#inbound-messages-bots-api]

受信メッセージは、双方向通信に API を使用するとリアルタイムで転送されます。メッセージは、NTT CPaaS ソリューションで Viber アカウントを設定したときに指定したエンドポイントに転送されます。

NTT CPaaS Web インターフェイスからのメッセージを API エンドポイントに転送できるようにするには、関連するアクセス許可を API エンドポイントに付与する必要があります。追加の承認ヘッダーを使用して、接続をセキュリティで保護します。

エンドユーザーから次の種類のメッセージを受信できます。

テキスト
画像
ビデオ
ファイル
オーディオ
場所
接触
ステッカー

レポート [#reports-bots-api]

メッセージが正常に送信されたら、送信されたメッセージのステータスを確認できます。次のレポートは、定義されたエンドポイントに転送されます。

配信レポート

配信レポートを URL にリアルタイムで転送できます。この機能を設定するには、NTT CPaaS アカウントマネージャーに URL を提供します。

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