Controlli delle funzionalità

Per verificare se il dispositivo di un utente è compatibile con RCS e in grado di comunicare con un agente RBM, puoi richiedere le funzionalità del dispositivo. L'identificazione delle funzionalità supportate da un dispositivo, se presenti, consente all'agente di personalizzare la conversazione in base alle funzionalità del dispositivo ed evitare di presentare interazioni difficili o impossibili da completare per l'utente.

Se il dispositivo di un utente non è in grado di ricevere messaggi RCS, puoi comunicare con l'utente tramite altri servizi, come gli SMS.

Invia un controllo delle funzionalità

Il seguente codice invia un controllo delle funzionalità e attende una risposta. Per le opzioni di formattazione e valore, consulta getCapabilities.

cURL

curl -X GET "https://REGION-rcsbusinessmessaging.googleapis.com/v1/phones/PHONE_NUMBER/capabilities?requestId=REQUEST_ID&agentId=AGENT_ID" \
-H "Content-Type: application/json" \
-H "User-Agent: curl/rcs-business-messaging" \
-H "`oauth2l header --json PATH_TO_SERVICE_ACCOUNT_KEY rcsbusinessmessaging`"

Node.js

// Reference to RBM API helper
const rbmApiHelper = require('@google/rcsbusinessmessaging');

// Send a capability check to the device
rbmApiHelper.checkCapability('+12223334444', function(response) {
   // Print capabilities of the device
   console.log(response);
});
Questo codice è un estratto di un agente di esempio RBM.

Java

import com.google.rbm.RbmApiHelper;
…

// Create an instance of the RBM API helper
RbmApiHelper rbmApiHelper = new RbmApiHelper();

// Check the capabilities of the device
boolean capability = rbmApiHelper.getCapability("+12223334444");
Questo codice è un estratto di un agente di esempio RBM.

Python

# Reference to RBM Python client helper
from rcs_business_messaging import rbm_service

# Send the tester invite to a device
response = rbm_service.make_cap_request('+12223334444')
Questo codice è un estratto di un agente RBM di esempio.

C#

using RCSBusinessMessaging;
…

// Create an instance of the RBM API helper
RbmApiHelper rbmApiHelper = new RbmApiHelper(credentialsFileLocation,
                                             projectId);

// Register the device as a tester
Capabilities capabilities = rbmApiHelper.GetCapability("+12223334444");
Questo codice è un estratto di un agente RBM di esempio.

Risposta della funzionalità

Dopo aver eseguito un controllo della capacità, la piattaforma RBM restituisce un elenco in formato JSON di funzionalità supportate dal dispositivo specificato.

{
  "features": [
    "REVOCATION",
    "RICHCARD_STANDALONE",
    "RICHCARD_CAROUSEL",
    "ACTION_CREATE_CALENDAR_EVENT",
    "ACTION_DIAL",
    "ACTION_OPEN_URL",
    "ACTION_SHARE_LOCATION",
    "ACTION_VIEW_LOCATION",
  ]
}

Se invii un controllo delle funzionalità a un utente non raggiungibile da RBM, ad esempio se il suo dispositivo non supporta RCS, la piattaforma RBM restituisce un errore 404.

Se invii un controllo delle funzionalità a un utente RCS su una rete in cui il tuo agente non è ancora stato lanciato, la piattaforma RBM restituisce un errore 403.

Controlli collettivi delle funzionalità

Per stimare il numero di utenti raggiungibili tramite RBM, esegui un controllo collettivo delle funzionalità. I controlli collettivi indicano se un numero di telefono è raggiungibile, ma non le funzionalità supportate da un numero di telefono.

Puoi specificare fino a 10.000 numeri di telefono per controllo collettivo delle funzionalità. Per controllare più numeri, esegui più controlli. Usa lo Script per il controllo collettivo delle funzionalità per utilizzare i file CSV come formato di input.

I controlli collettivi delle funzionalità hanno un massimo di 600 query al minuto (QPM).

I controlli delle funzionalità collettive restituiscono un elenco dei numeri che l'agente può raggiungere sulle compagnie in cui è stato lanciato, nonché stime del numero totale di utenti raggiungibili su tutte le compagnie. Vedi Risposta controllo capacità collettiva.

Stima degli utenti raggiungibili totali

Mentre le risposte del controllo collettivo includono un elenco di numeri di telefono immediatamente raggiungibili tramite gli operatori lanciati dall'agente (reachableUsers), le risposte includono anche due valori che possono aiutarti a stimare il numero totale di utenti raggiungibili tramite tutti gli operatori.

Quando l'agente esegue un controllo collettivo delle capacità di oltre 500 numeri di telefono, RBM campiona in modo casuale circa il 75% di questi numeri per controllare tutti gli operatori (segnalato in totalRandomSampleUserCount). RBM restituisce anche il conteggio dei numeri raggiungibili RBM del campione casuale, indipendentemente dallo stato di lancio dell'operatore (reachableRandomSampleUserCount). Dividendo reachableRandomSampleUserCount per totalRandomSampleUserCount, puoi stimare la percentuale di numeri che l'agente potrebbe raggiungere se fosse stato lanciato su tutti gli operatori.

Ad esempio, se specifichi 5000 numeri di telefono nel controllo delle funzionalità collettive e la RBM esegue il campionamento casuale di circa il 75% dei numeri specificati,totalRandomSampleUserCount potrebbe essere 3750. Se reachableRandomSampleUserCount è 3000, l'80% dei numeri campionati era raggiungibile.

Il test di campioni casuali può portare a variazioni nelle percentuali. Per tenere conto degli effetti del campionamento casuale, esegui controlli collettivi delle funzionalità con un numero maggiore di numeri di telefono. Puoi anche eseguire controlli con gli stessi batch di numeri più volte e poi calcolare la media dei risultati per normalizzare il comportamento del campionamento casuale.

Inviare un controllo delle funzionalità collettive

Il seguente codice invia un controllo delle funzionalità collettive e attende una risposta. Per le opzioni di formattazione e valore, consulta users.batchGet.

I numeri di telefono devono essere nel formato E.164. Ad esempio, "+12223334444".

cURL

curl -X POST "https://REGION-rcsbusinessmessaging.googleapis.com/v1/users:batchGet?agentId=AGENT_ID \
-H "Content-Type: application/json" \
-H "User-Agent: curl/rcs-business-messaging" \
-H "`oauth2l header --json PATH_TO_SERVICE_ACCOUNT_KEY rcsbusinessmessaging`" \
-d '{
  "users": [
    "PHONE_NUMBER",
  ]
}'

Node.js

// Reference to RBM API helper
const rbmApiHelper = require('@google/rcsbusinessmessaging');

// Specify phone numbers
let phoneNumbers = ['+12223334444', '+12223334444'];

// Perform a bulk capability check
rbmApiHelper.getUsers(phone_numbers, function(response) {
   // Print the bulk capability check response
   console.log(response);
});
Questo codice utilizza l'agente RBM di esempio.

Java

import com.google.rbm.RbmApiHelper;
…

// Create an instance of the RBM API helper
RbmApiHelper rbmApiHelper = new RbmApiHelper();

// Perform a bulk capability check
BatchGetUsersResponse batchGetUsersResponse = rbmApiHelper.getUsers(Arrays.asList("+12223334444", "+12223334444"));
Questo codice utilizza l'agente RBM di esempio.

Python

# Reference to RBM Python client helper
from rcs_business_messaging import rbm_service

# Perform a bulk capability check
response = rbm_service.make_batch_cap_request(['+12223334444', '+12223334444'])
Questo codice utilizza l'agente campione RBM.

C#

using RCSBusinessMessaging;
…

// Create an instance of the RBM API helper
RbmApiHelper rbmApiHelper = new RbmApiHelper(credentialsFileLocation,
                                             projectId);

// Perform a bulk capability check
BatchGetUsersResponse batchGetUsersResponse = rbmApiHelper.GetUsers(new List({"+12223334444", "+12223334444"}));
Questo codice utilizza l'agente di sample RBM.

Risposta al controllo delle funzionalità collettive

Dopo aver eseguito un controllo collettivo delle capacità, RBM restituisce una risposta in formato JSON.

{
  "reachableUsers": [
    "PHONE_NUMBER"
  ],
  "totalRandomSampleUserCount": "COUNT_OF_SAMPLE",
  "reachableRandomSampleUserCount": "REACHABLE_FROM_SAMPLE"
}
Campo Descrizione
reachableUsers Un elenco di utenti raggiungibili sugli operatori avviati dall'agente.
totalRandomSampleUserCount Il conteggio di un campione casuale di numeri specificati. In genere circa il 75% dei numeri specificati.
reachableRandomSampleUserCount Il numero di numeri del campione random che sono raggiungibili tramite RBM su tutti gli operatori, indipendentemente da su quali operatori è stato lanciato l'agente.

Strumento: script di controllo delle funzionalità collettive

Lo script Bulk Capability Check Script (Accedi per scaricarlo) esegue controlli collettivi delle funzionalità utilizzando i file CSV come formati di input e output. Lo script analizza il file CSV dei MSISDN e utilizza l'SDK RBM per verificare le funzionalità di ogni dispositivo elencato.

Una macchina virtuale con 2 CPU e 4 GB di RAM che esegue lo script con 500 thread può raggiungere circa 1000 QPS, ma il QPS complessivo dipende dalla macchina utilizzata, dal paese dei dispositivi, dalla configurazione regionale dell'agente e dall'endpoint dell'API utilizzato.

Prerequisiti

Prima di utilizzare lo strumento per eseguire un controllo collettivo delle funzionalità, ottieni quanto segue:

  • Il percorso di un file CSV con MSISDN su cui eseguire i controlli delle capacità
  • Il percorso della chiave dell'account di servizio dell'agente sulla tua macchina di sviluppo

Inoltre, è necessario installare il seguente software sulla macchina di sviluppo:

Configura

  1. Sulla macchina di sviluppo, scarica ed estrai lo script Script di controllo delle funzionalità collettive (accedi per scaricarlo).
  2. Segui i passaggi descritti nel file README.

Eseguire un controllo collettivo

  1. In un terminale, vai alla directory principale dello script.
  2. Esegui questi comandi:

    export MAVEN_OPTS="-Xms1024m -Xmx3000m"
    mvn compile && mvn exec:java -Dexec.args="AGENT_ID INPUT_FILE OUTPUT_FILE NUM_OF_THREADS START_INDEX END_INDEX"
    

    Sostituisci le variabili con i valori che hai identificato.

    Sostituisci Con Esempio
    AGENT_ID ID dell'agente RCS Business Messaging welcome-bot
    INPUT_FILE Il percorso del file CSV di input. input.csv
    OUTPUT_FILE Il percorso del file CSV di output. output.csv
    NUM_OF_THREADS Il numero di thread da dedicare ai controlli delle funzionalità. 500
    START_INDEX (Facoltativo) Il valore nel file CSV per il quale iniziare i controlli. 5
    END_INDEX (Facoltativo) Il valore nel file CSV dopo il quale interrompere i controlli. 500
  3. Al termine dello script, apri il file CSV di output per visualizzare i risultati.