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

REST Resource: brands.agents

Ressource : Agent

Entité conversationnelle représentant une marque.

Représentation JSON

Représentation JSON
{ "name": string, "displayName": string, "brandName": string, "isArchived": boolean, // Union field `detail_info` can be only one of the following: "rcsBusinessMessagingAgent": { object (`RcsBusinessMessagingAgent`) } // End of list of possible types for union field `detail_info`. }

{
  "name": string,
  "displayName": string,
  "brandName": string,
  "isArchived": boolean,

  // Union field detail_info can be only one of the following:
  "rcsBusinessMessagingAgent": {
    object (RcsBusinessMessagingAgent)
  }
  // End of list of possible types for union field detail_info.
}

Champs
`name`	`string` Identifiant unique de l'agent. Lecture seule. Défini par la plate-forme.
`displayName`	`string` Obligatoire. Nom que l'agent affiche aux utilisateurs. 40 caractères maximum. Non modifiable après la validation de l'agent.
`brandName`	`string` Uniquement en sortie. Nom de la marque associée à l'agent.
`isArchived`	`boolean` Facultatif. Si la valeur est `true`, l'agent est archivé et n'est pas inclus dans les résultats de la liste par défaut.
Champ d'union `detail_info`. Contient les champs requis pour le produit concerné. Obligatoire. `detail_info` ne peut être qu'un des éléments suivants :
`rcsBusinessMessagingAgent`	`object (RcsBusinessMessagingAgent)` Informations détaillées sur l'agent pour RCS for Business.

RcsBusinessMessagingAgent

Informations sur l'agent spécifiques à RCS for Business. Pour créer un agent, nous vous recommandons de fournir au moins une méthode de contact (téléphone, e-mail ou site Web) avec le libellé correspondant. Pour lancer un agent, vous devez fournir au moins une méthode de contact (téléphone, adresse e-mail ou site Web) avec un libellé correspondant.

Représentation JSON

Représentation JSON
{ "description": string, "logoUri": string, "heroUri": string, "phoneNumbers": [ { object (`PhoneEntry`) } ], "emails": [ { object (`EmailEntry`) } ], "websites": [ { object (`WebEntry`) } ], "privacy": { object (`WebEntry`) }, "termsConditions": { object (`WebEntry`) }, "color": string, "billingConfig": { object (`RcsBusinessMessagingAgentBillingConfig`) }, "agentUseCase": enum (`AgentUseCase`), "hostingRegion": enum (`HostingRegion`), "partner": { object (`PartnerEntry`) }, "launchDetails": { string: { object (`RcsBusinessMessagingRegionLaunch`) }, ... }, "indiaPrincipalEntityId": string }

{
  "description": string,
  "logoUri": string,
  "heroUri": string,
  "phoneNumbers": [
    {
      object (PhoneEntry)
    }
  ],
  "emails": [
    {
      object (EmailEntry)
    }
  ],
  "websites": [
    {
      object (WebEntry)
    }
  ],
  "privacy": {
    object (WebEntry)
  },
  "termsConditions": {
    object (WebEntry)
  },
  "color": string,
  "billingConfig": {
    object (RcsBusinessMessagingAgentBillingConfig)
  },
  "agentUseCase": enum (AgentUseCase),
  "hostingRegion": enum (HostingRegion),
  "partner": {
    object (PartnerEntry)
  },
  "launchDetails": {
    string: {
      object (RcsBusinessMessagingRegionLaunch)
    },
    ...
  },
  "indiaPrincipalEntityId": string
}

Champs
`description`	`string` Obligatoire. Description de l'agent visible par les utilisateurs. 100 caractères au maximum. Pour connaître les exigences détaillées, consultez Modifier les informations sur l'agent.
`logoUri`	`string` Obligatoire. URL publique du logo de l'agent. 50 Ko maximum. Non modifiable après la validation de l'agent.
`heroUri`	`string` Obligatoire. URL accessible au public de l'image héros de l'agent. 200 Ko maximum Non modifiable après la validation de l'agent.
`phoneNumbers[]`	`object (PhoneEntry)` Facultatif. Numéros de téléphone associés à l'agent. Obligatoire si l'adresse e-mail et le site Web ne sont pas fournis.
`emails[]`	`object (EmailEntry)` Facultatif. Adresses e-mail associées à l'agent. Obligatoire si vous n'indiquez pas de numéro de téléphone ni de site Web.
`websites[]`	`object (WebEntry)` Facultatif. Sites Web associés à l'agent. Maximum 3. Obligatoire si vous ne fournissez pas de numéro de téléphone ni d'adresse e-mail.
`privacy`	`object (WebEntry)` Obligatoire. Règles de confidentialité associées à l'agent.
`termsConditions`	`object (WebEntry)` Obligatoire. Conditions d'utilisation associées à l'agent.
`color`	`string` Obligatoire. Couleur du thème de l'agent visible par les utilisateurs au format hexadécimal. Par exemple, #FF6347.
`billingConfig`	`object (RcsBusinessMessagingAgentBillingConfig)` Obligatoire. Configuration de la facturation pour l'agent.
`agentUseCase`	`enum (AgentUseCase)` Facultatif. Cas d'utilisation du bot.
`hostingRegion`	`enum (HostingRegion)` Obligatoire. Région d'hébergement d'un agent.
`partner`	`object (PartnerEntry)` Uniquement en sortie. Partenaire associé à l'agent.
`launchDetails`	`map (key: string, value: object (RcsBusinessMessagingRegionLaunch))` Uniquement en sortie. Informations sur le lancement de l'agent. Renseigné uniquement pour les opérateurs, et uniquement avec les informations de lancement liées à l'opérateur qui effectue l'appel.
`indiaPrincipalEntityId`	`string` Facultatif. Identifiant d'entité principale (PE ID) de l'entreprise associée à l'agent en Inde. Obligatoire si vous prévoyez de lancer l'agent en Inde.

PhoneEntry

Un numéro de téléphone associé à l'agent.

Représentation JSON
{ "phoneNumber": { object (`Phone`) }, "label": string }

Champs

Champs
`phoneNumber`	`object (Phone)` Obligatoire. Numéro de téléphone dans l'un des deux formats possibles : soit le format E.164 complet (par exemple, "+12223334444"), soit un numéro de téléphone local/sans frais non formaté sans "+", préfixe ni code pays (par exemple, "6502530000"). Remarque : Les numéros d'urgence ne sont pas autorisés.
`label`	`string` Obligatoire. Libellé du numéro de téléphone.

phoneNumber

object (Phone)

Obligatoire. Numéro de téléphone dans l'un des deux formats possibles : soit le format E.164 complet (par exemple, "+12223334444"), soit un numéro de téléphone local/sans frais non formaté sans "+", préfixe ni code pays (par exemple, "6502530000"). Remarque : Les numéros d'urgence ne sont pas autorisés.

label

string

Obligatoire. Libellé du numéro de téléphone.

EmailEntry

Adresse e-mail associée à l'agent.

Représentation JSON
{ "address": string, "label": string }

Champs

Champs
`address`	`string` Obligatoire. Adresse e-mail
`label`	`string` Obligatoire. Libellé de l'adresse e-mail.

address

string

Obligatoire. Adresse e-mail

label

string

Obligatoire. Libellé de l'adresse e-mail.

WebEntry

Ressource Web associée à l'agent.

Représentation JSON
{ "uri": string, "label": string }

Champs

Champs
`uri`	`string` Obligatoire. URI accessible au public associé à l'agent. Doit utiliser le protocole HTTP ou HTTPS.
`label`	`string` Obligatoire pour `websites`, facultatif dans les autres cas. Libellé de l'URI.

uri

string

Obligatoire. URI accessible au public associé à l'agent. Doit utiliser le protocole HTTP ou HTTPS.

label

string

Obligatoire pour websites, facultatif dans les autres cas. Libellé de l'URI.

RcsBusinessMessagingAgentBillingConfig

Configuration de la facturation pour l'agent.

Représentation JSON
{ "billingCategory": enum (`BillingCategory`) }

Champs

Champs
`billingCategory`	`enum (BillingCategory)` Catégorie de facturation de l'agent.

billingCategory

enum (BillingCategory)

Catégorie de facturation de l'agent.

BillingCategory

Catégories de facturation acceptées.

Enums
`BILLING_CATEGORY_UNSPECIFIED`	Catégorie non spécifiée.
`CONVERSATIONAL_LEGACY`	Catégorie ancienne permettant de prendre en charge la configuration de la facturation des agents existants. Utilisez `CONVERSATIONAL` à la place. Cet élément est obsolète.
`CONVERSATIONAL`	Conçues pour des sessions plus longues et plus complexes, au cours desquelles l'utilisateur et la marque échangent une série de messages.
`SINGLE_MESSAGE`	Remplace les SMS par une expérience de messagerie plus riche. Elles ne sont jamais facturées en tant que CONVERSATIONNELLES. Cet élément est obsolète.
`BASIC_MESSAGE`	Le modèle de facturation est semblable à celui des SMS. Elles ne sont jamais facturées en tant que CONVERSATIONNELLES. Cet élément est obsolète.
`NON_CONVERSATIONAL`	Représente une catégorie de facturation non conversationnelle, qui remplace les anciennes catégories SINGLE_MESSAGE et BASIC_MESSAGE. Cette option s'adresse aux agents qui communiquent principalement de manière unidirectionnelle (A2P).

AgentUseCase

Types de cas d'utilisation des agents dans le stockage.

Enums
`AGENT_USE_CASE_UNSPECIFIED`	Cas d'utilisation non spécifié.
`TRANSACTIONAL`	Agents qui n'envoient que des messages essentiels, nécessaires et urgents.
`PROMOTIONAL`	Agents qui envoient des messages commerciaux, marketing et promotionnels. Type par défaut.
`OTP`	Agents qui n'envoient que des mots de passe à usage unique.
`MULTI_USE`	Agents ayant plusieurs cas d'utilisation. Cela inclut les agents pour lesquels un cas d'utilisation est lancé immédiatement, tandis que le second est prévu pour une prochaine version. Pour en savoir plus, consultez la documentation sur l'utilisation multiple.

HostingRegion

Régions d'hébergement possibles pour un agent, utilisées pour acheminer correctement les messages P2A vers le serveur régionalisé.

Enums
`HOSTING_REGION_UNSPECIFIED`	Région d'hébergement non spécifiée.
`NORTH_AMERICA`	Amérique du Nord.
`EUROPE`	Europe.
`ASIA_PACIFIC`	Asie-Pacifique.

PartnerEntry

Partenaire associé à l'agent.

Représentation JSON
{ "partnerId": string, "displayName": string, "company": string }

Champs

Champs
`partnerId`	`string` Uniquement en sortie. Identifiant unique du partenaire.
`displayName`	`string` Uniquement en sortie. Nom qui sera affiché aux entreprises pour associer des partenaires à des produits. Doit être unique parmi les partenaires.
`company`	`string` Uniquement en sortie. Nom public de l'entreprise pour le partenaire concerné.

partnerId

string

Uniquement en sortie. Identifiant unique du partenaire.

displayName

string

Uniquement en sortie. Nom qui sera affiché aux entreprises pour associer des partenaires à des produits. Doit être unique parmi les partenaires.

company

string

Uniquement en sortie. Nom public de l'entreprise pour le partenaire concerné.

RcsBusinessMessagingRegionLaunch

Détails sur le lancement des agents RCS for Business pour chaque région.

Représentation JSON
{ "launchState": enum (`LaunchState`), "comment": string, "updateTime": string, "isHidden": boolean }

Champs
`launchState`	`enum (LaunchState)` État du lancement pour une région.
`comment`	`string` Commentaire du transporteur.
`updateTime`	`string (Timestamp format)` Heure de la dernière mise à jour. Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : `"2014-10-02T15:01:23Z"`, `"2014-10-02T15:01:23.045123456Z"` ou `"2014-10-02T15:01:23+05:30"`.
`isHidden`	`boolean` Facultatif. Indique si l'agent est marqué comme masqué pour le transporteur, ce qui affecte la visibilité des vues de la console et de l'API.

LaunchState

État de lancement d'une entité. Pour en savoir plus sur les transitions d'état de lancement autorisées pour les opérateurs et les partenaires, consultez Recevoir des événements.

Enums
`LAUNCH_STATE_UNSPECIFIED`	État non spécifié.
`LAUNCH_STATE_UNLAUNCHED`	L'entité n'a pas été lancée.
`LAUNCH_STATE_PENDING`	Lancement en cours d'examen.
`LAUNCH_STATE_LAUNCHED`	Lancé.
`LAUNCH_STATE_REJECTED`	Le lancement est refusé.
`LAUNCH_STATE_SUSPENDED`	Le lancement est suspendu.
`LAUNCH_STATE_PENDING_UNLAUNCH`	Obsolète : cet état n'est plus utilisé. L'annulation du lancement est en cours d'examen. Cet élément est obsolète.
`LAUNCH_STATE_INVALID_IN_GMB`	Obsolète : cet état n'est plus utilisé. Le lancement n'est pas valide, car la fiche Google My Business associée n'accepte pas la messagerie. La revalidation dans Google My Business relance automatiquement le processus ici. Uniquement applicable aux lieux. Cet élément est obsolète.

Méthodes
`create`	Crée un agent pour représenter une marque.
`delete (deprecated)`	Obsolète : la suppression d'agents est obsolète.
`get`	Obtenez des informations sur un agent.
`getLaunch`	Obtient les informations de lancement d'un agent.
`getVerification`	Obtient les informations de validation d'un agent.
`list`	Liste tous les agents associés à une marque.
`patch`	Met à jour les informations sur un agent.
`requestLaunch`	Lance le processus de lancement d'un agent.
`requestVerification`	Envoie les informations de validation de l'établissement pour un agent.
`updateLaunch`	Met à jour les informations de lancement d'un agent.
`updateVerification`	Met à jour l'état de validation d'un agent.

REST Resource: brands.agents

Ressource : Agent

RcsBusinessMessagingAgent

PhoneEntry

EmailEntry

WebEntry

RcsBusinessMessagingAgentBillingConfig

BillingCategory

AgentUseCase

HostingRegion

PartnerEntry

RcsBusinessMessagingRegionLaunch

LaunchState

Méthodes

`create`

`delete (deprecated)`

`get`

`getLaunch`

`getVerification`

`list`

`patch`

`requestLaunch`

`requestVerification`

`updateLaunch`

`updateVerification`

REST Resource: brands.agents Restez organisé à l'aide des collections Enregistrez et classez les contenus selon vos préférences.

Ressource : Agent

RcsBusinessMessagingAgent

PhoneEntry

EmailEntry

WebEntry

RcsBusinessMessagingAgentBillingConfig

BillingCategory

AgentUseCase

HostingRegion

PartnerEntry

RcsBusinessMessagingRegionLaunch

LaunchState

Méthodes

delete (deprecated)

REST Resource: brands.agents

`delete (deprecated)`