Google uses AI technology to translate content into your preferred language. AI translations can contain errors.

Gérer les agents avec l'API RBM Operations

Le workflow RBM de base pour les opérateurs consiste à examiner les informations sur les nouveaux agents et à approuver ou refuser leur autorisation de lancement sur le réseau de l'opérateur et d'envoyer des messages à leurs abonnés.

Les extraits de code de cette page proviennent de nos exemples JavaScript et Curl.

Lister tous les agents envoyés à un opérateur

L'opérateur peut obtenir la liste de tous les agents que les développeurs ont envoyés pour être lancés sur son réseau.

Node.js

const businessCommunicationsApiHelper =
  require('@google/rbm-businesscommunications');

const privateKey =
  require('../../resources/businesscommunications-service-account-credentials.json');

businessCommunicationsApiHelper.initBusinessCommunucationsApi(privateKey);

// Retrieve all agents targeting the carrier
businessCommunicationsApiHelper.listAgents('brands/-').then((response) => {
  console.log('Current agents are:');
  console.log(JSON.stringify(response.data, null, 2));
}).catch((err) => {
  console.log(err);
});

cURL

curl -v "https://businesscommunications.googleapis.com/v1/brands/-/agents" \
  -H "Content-Type: application/json" \
  -H "User-Agent: curl/business-messaging" \
  -H "`oauth2l header --json serviceAccount.json businesscommunications`"

La marque est définie sur -, car elle n'est pas obligatoire lors de la récupération d'une liste de tous les agents.

Ce code renvoie la liste de tous les agents envoyés pour être lancés chez l'opérateur :

{
  "agents": [
    {
      "name": "brands/40bd963f-ff92-425c-b273-8f0892d2d017/agents/my_new_agent_4fpd1psz_agent",
      "displayName": "My new agent",
      "rcsBusinessMessagingAgent": {
        "description": "This is the agent description that will be displayed in the Agent info tab in Messages",
        "logoUri": "https://agent-logos.storage.googleapis.com/_/kt90w53vzw2QSxK6PG1uCeJf",
        "heroUri": "https://agent-logos.storage.googleapis.com/_/kt90vzob74GQcfeHoEQbVRTP",
        "phoneNumbers": [
          {
            "phoneNumber": {
              "number": "+12223334444"
            },
            "label": "Call support"
          }
        ],
        "privacy": {
          "uri": "https://policies.google.com/privacy",
          "label": "Our privacy policy"
        },
        "termsConditions": {
          "uri": "https://policies.google.com/terms",
          "label": "Our Terms and Conditions"
        },
        "color": "#0B78D0",
        "billingConfig": {
          "billingCategory": "NON_CONVERSATIONAL"
        },
        "agentUseCase": "MULTI_USE",
        "hostingRegion": "NORTH_AMERICA",
        "partner": {
          "partnerId": "unique-identifier-for-my-partner",
          "displayName": "My partner",
          "company": "Public name of the company for my partner"
        }
      }
    },
    {
      "name": "brands/40bd963f-ff92-425c-b273-8f0892d2d017/agents/my_new_agent_7jo0trhw_agent",
      "displayName": "My second agent",
      "rcsBusinessMessagingAgent": {
        "description": "Another agent description",
        "logoUri": "https://agent-logos.storage.googleapis.com/_/kt90w53vzw2QSxK6PG1uCeJf",
        "heroUri": "https://agent-logos.storage.googleapis.com/_/kt90vzob74GQcfeHoEQbVRTP",
        "phoneNumbers": [
          {
            "phoneNumber": {
              "number": "+12228885768"
            },
            "label": "Call support"
          }
        ],
        "privacy": {
          "uri": "https://policies.google.com/privacy",
          "label": "Our privacy policy"
        },
        "termsConditions": {
          "uri": "https://policies.google.com/terms",
          "label": "Our Terms and Conditions"
        },
        "color": "#0B78D0",
        "billingConfig": {
          "billingCategory": "CONVERSATIONAL"
        },
        "agentUseCase": "PROMOTIONAL",
        "hostingRegion": "NORTH_AMERICA",
        "partner": {
          "partnerId": "unique-identifier-for-my-partner",
          "displayName": "My partner",
          "company": "Public name of the company for my partner"
        }
      }
    }
  ]
}

Les résultats peuvent être récupérés une page à la fois. Pour en savoir plus, consultez la documentation de référence de l'API.

Obtenir des informations sur la validation d'un agent

L'opérateur peut obtenir l'état de la validation de la marque d'un agent. Pour en savoir plus, consultez brands.agents.getVerification.

Node.js

  const businessCommunicationsApiHelper =
    require('@google/rbm-businesscommunications');
  const privateKey =
    require('../../resources/businesscommunications-service-account-credentials.json');
  businessCommunicationsApiHelper.initBusinessCommunucationsApi(privateKey);
  businessCommunicationsApiHelper.getAgentVerification(agents[0].name).then((response) => {
  }).catch((err) => {
    console.log(err);
  });

cURL

  curl -v "https://businesscommunications.googleapis.com/v1/brands/-/agents/AGENT ID/verification" \
    -H "Content-Type: application/json" \
    -H "User-Agent: curl/business-messaging" \
    -H "`oauth2l header --json serviceAccount.json businesscommunications`"

L'appelant n'a pas nécessairement besoin du nom complet de l'agent, y compris du nom de la marque. Seul l'ID de l'agent (avant @rbm.goog) est obligatoire, le nom de la marque étant défini sur -.

Ce code renvoie l'état de validation et les informations sur le partenaire :

{
  "name": "brands/40bd963f-ff92-425c-b273-8f0892d2d017/agents/my_new_agent_ciymyd2b_agent/verification",
  "verificationState": "VERIFICATION_STATE_UNVERIFIED",
  "agentVerificationContact": {
    "partnerName": "John Doe",
    "partnerEmailAddress": "john.doe@gmail.com",
    "brandContactName": "Bob",
    "brandContactEmailAddress": "bob@brand.com",
    "brandWebsiteUrl": "https://www.brand.com"
  }
}

Obtenir l'état de lancement et le questionnaire d'un agent

L'opérateur peut obtenir l'état de lancement actuel d'un agent et le questionnaire de lancement du développeur.

Node.js

const businessCommunicationsApiHelper =
  require('@google/rbm-businesscommunications');

const privateKey =
  require('../../resources/businesscommunications-service-account-credentials.json');

businessCommunicationsApiHelper.initBusinessCommunucationsApi(privateKey);

businessCommunicationsApiHelper.getAgentLaunch(agents[0].name).then((response) => {
  console.log('Launch details are:');
  console.log(JSON.stringify(response.data, null, 2));
}).catch((err) => {
  console.log(err);
});

cURL

curl -v "https://businesscommunications.googleapis.com/v1/brands/-/agents/AGENT ID/launch" \
  -H "Content-Type: application/json" \
  -H "User-Agent: curl/business-messaging" \
  -H "`oauth2l header --json serviceAccount.json businesscommunications`"

Ce code renvoie les informations de lancement :

{
  "name": "brands/8b5c7f80-b025-486b-bc8a-2d0797559711/agents/my-agent-demo/launch",
  "rcsBusinessMessaging": {
    "questionnaire": {
      "contacts": [
        {
          "name": "John Doe",
          "title": "Mr",
          "email": "johndoe@developer.com"
        }
      ],
      "optinDescription": "Messages are sent to known MSISDNs",
      "triggerDescription": "We respond to any interaction",
      "interactionsDescription": "Simple conversations with a chatbot",
      "optoutDescription": "User sends stop"
    },
    "launchDetails": {
      "/v1/regions/thecarrier": {
        "launchState": "LAUNCH_STATE_LAUNCHED",
        "updateTime": "2023-02-20T15:10:36.528669Z"
      }
    }
  }
}

Rechercher la définition d'un agent

L'opérateur peut récupérer les informations d'un agent à l'aide de son identifiant unique (name).

Node.js

const businessCommunicationsApiHelper =
  require('@google/rbm-businesscommunications');

const privateKey =
  require('../../resources/businesscommunications-service-account-credentials.json');

businessCommunicationsApiHelper.initBusinessCommunucationsApi(privateKey);

businessCommunicationsApiHelper.getAgent(agent[0].name).then((response) => {
  console.log('Agent details are:');
  console.log(JSON.stringify(response.data, null, 2));
}).catch((err) => {
  console.log(err);
});

cURL

curl -v "https://businesscommunications.googleapis.com/v1/brands/-/agents/AGENT ID" \
  -H "Content-Type: application/json" \
  -H "User-Agent: curl/business-messaging" \
  -H "`oauth2l header --json serviceAccount.json businesscommunications`"

Ce code renvoie les informations de l'agent :

{
  "name": "brands/40bd963f-ff92-425c-b273-8f0892d2d017/agents/my_new_agent_4fpd1psz_agent",
  "displayName": "My new agent",
  "rcsBusinessMessagingAgent": {
    "description": "This is the agent description that will be displayed in the Agent info tab in Messages",
    "logoUri": "https://agent-logos.storage.googleapis.com/_/kt90w53vzw2QSxK6PG1uCeJf",
    "heroUri": "https://agent-logos.storage.googleapis.com/_/kt90vzob74GQcfeHoEQbVRTP",
    "phoneNumbers": [
      {
        "phoneNumber": {
          "number": "+12223334444"
        },
        "label": "Call support"
      }
    ],
    "privacy": {
      "uri": "https://policies.google.com/privacy",
      "label": "Our privacy policy"
    },
    "termsConditions": {
      "uri": "https://policies.google.com/terms",
      "label": "Our Terms and Conditions"
    },
    "color": "#0B78D0",
    "billingConfig": {
      "billingCategory": "NON_CONVERSATIONAL"
    },
    "agentUseCase": "MULTI_USE",
    "hostingRegion": "NORTH_AMERICA",
    "partner": {
      "partnerId": "unique-identifier-for-my-partner",
      "displayName": "My partner",
      "company": "Public name of the company for my partner"
    }
  }
}

Modifier l'état de lancement d'un agent

Un opérateur peut modifier l'état de lancement d'un agent et inclure un commentaire expliquant la raison de ce changement.

Remarque : Les exigences concernant le champ comment varient en fonction de l'action :

Facultatif : Approbations de lancement.
Obligatoire : Refus, suspensions et demandes d'annulation de lancement.

Piste d'audit : Vous pouvez éventuellement inclure le acting_party paramètre de requête pour spécifier l'adresse e-mail ou l'identifiant de la personne qui effectue l'action. Cela permet de s'assurer que le champ ID utilisateur des journaux d'historique identifie correctement la personne au lieu d'être défini par défaut sur "Appel d'API".

Ce commentaire est envoyé au développeur dans un e-mail, visible dans l'historique de l'agent des consoles d'administration et RCS for Business, et inclus dans les notifications AgentLaunchEvent webhook. Cette livraison s'applique à toutes les mises à jour d'état.

L'état doit être modifié comme suit :

LAUNCH_STATE_PENDING vers LAUNCH_STATE_LAUNCHED ou LAUNCH_STATE_REJECTED
LAUNCH_STATE_LAUNCHED vers LAUNCH_STATE_SUSPENDED
LAUNCH_STATE_SUSPENDED vers LAUNCH_STATE_LAUNCHED ou LAUNCH_STATE_UNLAUNCHED

Node.js

const businessCommunicationsApiHelper =
  require('@google/rbm-businesscommunications');

const privateKey =
  require('../../resources/businesscommunications-service-account-credentials.json');

businessCommunicationsApiHelper.initBusinessCommunucationsApi(privateKey);

businessCommunicationsApiHelper
	.updateAgentLaunchState(agentId, 'LAUNCH_STATE_LAUNCHED').then((response) => {
		console.log('Updated launch details are:');
		console.log(JSON.stringify(response.data, null, 2));
	});

cURL

curl -v -X PATCH "https://businesscommunications.googleapis.com/v1/brands/-/agents/AGENT ID/launch?acting_party=user@example.com" \
  -H "Content-Type: application/json" \
  -H "User-Agent: curl/business-messaging" \
  -H "`oauth2l header --json serviceAccount.json businesscommunications`" \
  -d "{
    'rcsBusinessMessaging': {
      'launchDetails': {
        '': {
          'launchState': 'LAUNCH_STATE_LAUNCHED',
        }
      }
    }
  }"

Ce code renvoie les informations de lancement mises à jour avec l'état de lancement modifié :

{
  "name": "brands/40bd963f-ff92-425c-b273-8f0892d2d017/agents/my_new_agent_4fpd1psz_agent/launch",
  "rcsBusinessMessaging": {
    "questionnaire": {
      "contacts": [
        {
          "name": "John Doe",
          "title": "Contact manager",
          "email": "john.doe@gmail.com"
        }
      ],
      "optinDescription": "Users accepted our terms of service online.",
      "triggerDescription": "We are reaching pre-registered users",
      "interactionsDescription": "This agent sends notifications and processes suggested replies.",
      "optoutDescription": "Reply stop and we stop.",
      "agentAccessInstructions": "This is a simple agent that reaches registered users.",
      "videoUris": [
        "https://www.google.com/a/video"
      ],
      "screenshotUris": [
        "https://www.google.com/a/screenshot"
      ]
    },
    "launchDetails": {
      "/v1/regions/thecarrier": {
        "launchState": "LAUNCH_STATE_REJECTED",
        "comment": "We don't have a billing contract in place with you.", // Note: The field is optional only for launch approval; otherwise, required.
        "updateTime": "2023-04-28T15:22:10.221191Z"
      }
    }
  }
}

Masquer ou afficher des agents

Pour maintenir un espace de travail propre et organisé, vous pouvez masquer les agents qui ne sont plus utilisés sur votre réseau. Le masquage d'un agent le supprime des résultats de découverte d'API par défaut.

Le masquage est une modification qui n'affecte que la visibilité. Il n'affecte que la vue de votre opérateur spécifique et n'a pas d'impact sur l'état de l'agent pour le partenaire ou d'autres opérateurs. Vous pouvez afficher un agent à tout moment pour rétablir sa visibilité et continuer à le gérer.

Pour vous assurer que les agents actifs ne sont pas supprimés accidentellement de la vue, les règles suivantes s'appliquent :

Éligibilité : Vous ne pouvez masquer que les agents qui sont inactifs sur votre réseau : Suspendu ou Refusé.
Restrictions : Vous ne pouvez pas masquer un agent si son état de lancement sur votre réseau est Lancé ou En attente. Si vous tentez de masquer un tel agent, la requête sera rejetée avec une erreur FAILED_PRECONDITION.

Modifier l'état de masquage

Pour masquer ou afficher le lancement d'un agent pour votre opérateur, utilisez la méthode setAgentLaunchVisibility sur la ressource de lancement. Pour masquer, définissez le booléen isHidden sur true, et pour afficher, définissez-le sur false.

Méthode : POST /v1/brands/{brandId}/agents/{agentId}/launch:setAgentLaunchVisibility

curl -v -X POST "https://businesscommunications.googleapis.com/v1/brands/$BRAND_ID/agents/$AGENT_ID/launch:setAgentLaunchVisibility" \
  -H "Content-Type: application/json" \
  -H "User-Agent: curl/business-messaging" \
  -H "$(oauth2l header --json serviceAccount.json businesscommunications)" \
  --data '{
    "name": "brands/$BRAND_ID/agents/$AGENT_ID/launch",
    "isHidden": true
  }'

{
  "name": "brands/8b5c7f80-b025-486b-bc8a-2d0797559711/agents/my-agent-demo/launch",
  "rcsBusinessMessaging": {
    "questionnaire": {
      "contacts": [
        {
          "name": "John Doe",
          "title": "Mr",
          "email": "johndoe@developer.com"
        }
      ],
      "optinDescription": "Messages are sent to known MSISDNs",
      "triggerDescription": "We respond to any interaction",
      "interactionsDescription": "Simple conversations with a chatbot",
      "optoutDescription": "User sends stop"
    },
    "launchDetails": {
      "/v1/regions/thecarrier": {
        "launchState": "LAUNCH_STATE_SUSPENDED",
        "updateTime": "2026-02-20T15:10:36.528669Z",
        "isHidden": true
      }
    }
  }
}

Lister les agents avec des filtres

Par défaut, la méthode list exclut les agents masqués par votre opérateur. Pour les inclure dans vos résultats, utilisez le paramètre includeHidden.

Supprimer un agent

Pour des raisons de sécurité, les agents RBM ne peuvent plus être supprimés. Pour obtenir de l'aide, contactez l'équipe d'assistance RCS for Business.

Gérer les agents avec l'API RBM Operations Restez organisé à l'aide des collections Enregistrez et classez les contenus selon vos préférences.

Lister tous les agents envoyés à un opérateur

Node.js

cURL

Obtenir des informations sur la validation d'un agent

Node.js

cURL

Obtenir l'état de lancement et le questionnaire d'un agent

Node.js

cURL

Rechercher la définition d'un agent

Node.js

cURL

Modifier l'état de lancement d'un agent

Node.js

cURL

Masquer ou afficher des agents

Modifier l'état de masquage

Lister les agents avec des filtres

Supprimer un agent

Gérer les agents avec l'API RBM Operations