エージェントをリリースするまでは、指定したテストデバイスとのみ通信できます。これにより、エージェントを内部でテストして、エンドユーザーが誤って早期アクセスすることを防ぐことができます。
RBM エージェントと通信するには、テストデバイスで RCS が有効になっている必要があります。一部の Android デバイスでは、RCS がデフォルトで有効になっていないことに注意してください。デバイスの RCS ステータスを確認するには、デバイスの RCS ステータスを確認するをご覧ください。
エージェントは 1 日あたり最大 20 件のテスター招待を送信できます。招待の合計上限は 200 件です。
デバイスの RCS ステータスを確認する
- メッセージ アプリで、[メッセージの設定] に移動します。
- [RCS チャット] をタップします。[RCS チャット] が見つからない場合は、[チャット機能] をタップしてください。
- [ステータス] の値を見つけます。
デバイスで RCS が有効になっていない場合は、メッセージ アプリと Carrier Services アプリのプレリリース版でデバイスを構成して RCS を有効にします。
デバイスで RCS が有効になっている場合は、テスターの招待を送信できます。デバイスが招待を承諾すると、未公開のエージェントとのメッセージのやり取りを開始できます。
デバイスで RCS を有効にする
Android デバイスで RCS を有効にするには、メッセージ アプリで RCS チャットをオンにします。
デバイスで RCS が有効になったら、テスターの招待状を送信できます。
テスターの招待を送信する
RCS 対応デバイスをテスターとして招待するには、テスター招待を送信します。デバイスが招待を承認すると、エージェントはデバイスにメッセージ、イベント、リクエストを送信できます。
デバイスで RCS が有効になっていない場合、テスターの招待に返信していない場合、または招待を拒否した場合、エージェントがデバイスとの通信を試みると 403 PERMISSION_DENIED エラーが発生します。
コンソール
Business Communications デベロッパー コンソールでテスターの招待状を送信するには:
- Business Communications デベロッパー コンソールを開き、RBM Google アカウントでログインして、エージェントをクリックします。
- 左側のメニューで [デバイス] を選択します。
- デバイスの電話番号（国コードと市外局番も含む）を入力して、テストデバイスのリストにテストデバイスを追加します。複数の電話番号を追加する場合は、電話番号をカンマで区切って入力してください。
デバイスがリストに追加されると、招待状が送信されます。ユーザーのデバイスに招待メッセージが表示され、ユーザーは招待を承諾または辞退できます。
[テストデバイスのリスト] には、エージェントのテストに招待した各デバイスのテスター招待ステータスが表示されます。
API
RBM Management API を使用してテスターの招待を送信するには:
次のコードを使用します。書式設定と値のオプションについては、
testersをご覧ください。
cURL
curl -X POST "https://businesscommunications.googleapis.com/v1/testers" \
-H "Content-Type: application/json" \
-H "User-Agent: curl/rcs-business-messaging" \
-H "`oauth2l header --json PATH_TO_SERVICE_ACCOUNT_KEY businesscommunications`" \
-d '{"phone_number": "PHONE_NUMBER", "agentId": "AGENT_ID"}'Node.js
// Reference to RBM API helper const rbmApiHelper = require('@google/rcsbusinessmessaging'); // Send the tester invite to the device rbmApiHelper.sendTesterInvite('+12223334444', function(response) { console.log(response); });
Java
import com.google.rbm.RbmApiHelper; … try { // Create an instance of the RBM API helper RbmApiHelper rbmApiHelper = new RbmApiHelper(); // Register the device as a tester rbmApiHelper.registerTester("+12223334444"); } catch(Exception e) { e.printStackTrace(); }
Python
# Reference to RBM Python client helper from rcs_business_messaging import rbm_service # Send the tester invite to a device rbm_service.invite_tester('+12223334444')
C#
using RCSBusinessMessaging; … // Create an instance of the RBM API helper RbmApiHelper rbmApiHelper = new RbmApiHelper(credentialsFileLocation, projectId); // Register the device as a tester rbmApiHelper.RegisterTester("+12223334444");
200 件を超える招待を送信すると、RBM プラットフォームはレスポンスで 429 RESOURCE_EXHAUSTED エラーコードを返します。
テスターの招待状を再送信する
必要に応じて、テスターの招待を再送信できます。結果は、デバイスの現在の招待ステータスによって異なります。
| デバイスのステータス | 結果 |
PENDING
|
テスターの招待状がデバイスに送信されます。 |
ACCEPTED
|
テスターの招待がデバイスに送信されず、デバイスの ACCEPTED ステータスが維持されます。 |
DECLINED
|
テスターの招待が拒否されました。招待を再送信する前に、まずテストデバイスを削除する必要があります。それ以外の場合、リクエストは失敗します。 |
デバイスがテスターの招待を承諾すると、そのデバイスはエージェントの指定されたテストデバイスになります。デバイスにメッセージ、イベント、機能チェックを送信して、エージェントの機能とワークフローをテストできます。
テストデバイスの招待ステータスを取得する
テスターを招待すると、テスターはデバイスで招待を承諾または辞退できます。デバイスの招待ステータスについて API をクエリできます。
コンソール
Business Communications Developer Console でテストデバイスの招待ステータスを取得するには:
- Business Communications デベロッパー コンソールを開き、RBM Google アカウントでログインして、エージェントをクリックします。
- 左側のメニューで [デバイス] を選択します。
- デバイスの電話番号（国コードと市外局番も含む）を入力して、テストデバイスのリストにテストデバイスを追加します。複数の電話番号を追加する場合は、電話番号をカンマで区切って入力してください。
テストデバイスがリストに追加されると、[ステータス] 列でステータスを確認できます。
API
RBM Management API を使用してテストデバイスの招待ステータスを取得するには:
次のコードを使用します。書式設定と値のオプションについては、
testersをご覧ください。
cURL
curl -X GET "https://businesscommunications.googleapis.com/v1/testers/PHONE_NUMBER?agentId=AGENT_ID" \ -H "Content-Type: application/json" \ -H "User-Agent: curl/rcs-business-messaging" \ -H "`oauth2l header --json PATH_TO_SERVICE_ACCOUNT_KEY businesscommunications`"
すべてのテストデバイスのステータスを取得する
テスターとして招待したすべてのデバイスの招待ステータスをクエリできます。
コンソール
Business Communications Developer Console で、すべてのテストデバイスの招待ステータスを確認するには:
- Business Communications デベロッパー コンソールを開き、RBM Google アカウントでログインして、エージェントをクリックします。
- 左側のメニューで [デバイス] を選択します。
- デバイスの電話番号（国コードと市外局番も含む）を入力して、テストデバイスのリストにテストデバイスを追加します。複数の電話番号を追加する場合は、電話番号をカンマで区切って入力してください。
テストデバイスがリストに追加されると、[ステータス] 列でステータスを確認できます。
API
RBM Management API を使用してすべてのテストデバイスの招待ステータスを確認するには:
次のコードを使用します。書式設定と値のオプションについては、
testersをご覧ください。
cURL
curl -X GET "https://businesscommunications.googleapis.com/v1/testers?agentId=AGENT_ID" \ -H "Content-Type: application/json" \ -H "User-Agent: curl/rcs-business-messaging" \ -H "`oauth2l header --json PATH_TO_SERVICE_ACCOUNT_KEY businesscommunications`"
テストデバイスを削除する
テストデバイスを削除すると、そのデバイスは未リリースのエージェントからメッセージを受信できなくなります。RBM プラットフォームでは、テストデバイスに転送中または保存されているエージェントから送信されたメッセージは削除されません。
コンソール
Business Communications Developer Console でテストデバイスを削除するには:
- Business Communications デベロッパー コンソールを開き、RBM Google アカウントでログインして、エージェントをクリックします。
- 左側のメニューで [デバイス] を選択します。
- [テストデバイスのリスト] でデバイスを選択し、 メニューをクリックします。
- [デバイスを削除] をクリックします。
API
RBM Management API を使用してテストデバイスを削除するには:
次のコードを使用します。書式設定と値のオプションについては、
testersをご覧ください。
cURL
curl -X DELETE "https://businesscommunications.googleapis.com/v1/testers/PHONE_NUMBER?agentId=AGENT_ID" \ -H "Content-Type: application/json" \ -H "User-Agent: curl/rcs-business-messaging" \ -H "`oauth2l header --json PATH_TO_SERVICE_ACCOUNT_KEY businesscommunications`"