REST Resource: brands.agents

Resource: Agent

A conversational entity that represents a brand.

JSON representation 
{
  "name": string,
  "displayName": string,
  "brandName": string,

  // 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.
}
Fields
name

string

The unique identifier of the agent.

Read-only. Defined by the platform.
displayName

string

Required. The name that the agent displays to users. Maximum 100 characters.

Not modifiable after agent verification.
brandName

string

Output only. The name of the brand associated with the agent.

Union field detail_info. Contains the fields required for the particular product.

Required. detail_info can be only one of the following:
rcsBusinessMessagingAgent

object (RcsBusinessMessagingAgent)

Detailed agent information for RCS Business Messaging.

RcsBusinessMessagingAgent

Agent information specifically related to RCS Business Messaging. For agent creation, it's recommended to provide at least one contact method (phone, email, or website) with a corresponding label. For agent launch, at least one phone or email contact with a corresponding label is required.

JSON representation 
{
  "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)
    },
    ...
  }
}
Fields
description

string

Required. Description of the agent that is visible to users. Maximum 100 characters. See Edit agent information for detailed requirements.
logoUri

string

Required. Publicly available URL of the logo for the agent. Maximum 50 KB.

Not modifiable after agent verification.
heroUri

string

Required. Publicly available URL of the hero image for the agent. Maximum 200 KB.

Not modifiable after agent verification.
phoneNumbers[]

object (PhoneEntry)

Phone numbers associated with the agent. Required if email is not provided.
emails[]

object (EmailEntry)

Email addresses associated with the agent. Required if phone number is not provided.
websites[]

object (WebEntry)

Optional. Websites associated with the agent. Maximum 3.
privacy

object (WebEntry)

Required. Privacy policy associated with the agent.
termsConditions

object (WebEntry)

Required. Terms and conditions associated with the agent.
color

string

Required. Theme color of the agent that is visible to users in hex format. For example, #FF6347.
billingConfig

object (RcsBusinessMessagingAgentBillingConfig)

Required. Billing configuration for the agent.
agentUseCase

enum (AgentUseCase)

Optional. Use case of bot.
hostingRegion

enum (HostingRegion)

Required. Hosting region for an agent.
partner

object (PartnerEntry)

Output only. Partner associated with the agent.
launchDetails

map (key: string, value: object (RcsBusinessMessagingRegionLaunch))

Output only. Launch details for the agent. Only populated for carriers, and only with the launch details related to the carrier making the call.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

PhoneEntry

A phone number associated with the agent.

JSON representation 
{
  "phoneNumber": {
    object (Phone)
  },
  "label": string
}
Fields
phoneNumber

object (Phone)

Required. Phone number in two possible formats: either the full E.164 format (for example, "+12223334444") or an unformatted local/toll-free phone number without '+', prefix, or country code (for example, "6502530000"). Note: emergency numbers are not allowed.
label

string

Required. Label for the phone number.

EmailEntry

An email associated with the agent.

JSON representation 
{
  "address": string,
  "label": string
}
Fields
address

string

Required. An email address.
label

string

Required. Label for the email address.

WebEntry

A web-based resource associated with the agent.

JSON representation 
{
  "uri": string,
  "label": string
}
Fields
uri

string

Required. A publicly accessible URI associated with the agent. Must use the HTTP or HTTPS protocol.
label

string

Required. Label for the URI.

RcsBusinessMessagingAgentBillingConfig

Billing configuration for the agent.

JSON representation 
{
  "billingCategory": enum (BillingCategory)
}
Fields
billingCategory

enum (BillingCategory)

Billing category for the agent.

BillingCategory

Supported billing categories.

Enums
BILLING_CATEGORY_UNSPECIFIED Category not specified.
CONVERSATIONAL_LEGACY Legacy category to support the billing configuration of existing agents.
CONVERSATIONAL Designed for longer, more complex sessions where the user and brand exchange a series of messages.
SINGLE_MESSAGE Replaces SMS with a richer messaging experience. Never billed as CONVERSATIONAL.
BASIC_MESSAGE Billing model is similar to SMS. Never billed as CONVERSATIONAL.

AgentUseCase

Agent use case types used in storage.

Enums
AGENT_USE_CASE_UNSPECIFIED Use case not specified.
TRANSACTIONAL Agents that send only essential, necessary and time-sensitive messages.
PROMOTIONAL Agents that send sales, marketing and promotional messages. Default type.
OTP Agents that only send one time passwords.
MULTI_USE Agents that have multiple use cases.

HostingRegion

Possible hosting regions for an agent, used for routing P2A messages to the regionalized server correctly.

Enums
HOSTING_REGION_UNSPECIFIED Unspecified hosting region.
NORTH_AMERICA North America.
EUROPE Europe.
ASIA_PACIFIC Asia Pacific.

PartnerEntry

Partner associated with the agent.

JSON representation 
{
  "partnerId": string,
  "displayName": string,
  "company": string
}
Fields
partnerId

string

Output only. Unique identifier for partner.
displayName

string

Output only. The name that will be displayed to businesses to associate partners for products. Should be unique among partners.
company

string

Output only. The public name of the company for the given partner. E.g. Twilio, HeyMarket etc.

RcsBusinessMessagingRegionLaunch

Details about RCS Business Messaging agent launch for each region.

JSON representation 
{
  "launchState": enum (LaunchState),
  "comment": string,
  "updateTime": string
}
Fields
launchState

enum (LaunchState)

The launch state for a region.
comment

string

Comment from the carrier.
updateTime

string (Timestamp format)

Last updated time.

Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

LaunchState

The launch state of an entity.

Enums
LAUNCH_STATE_UNSPECIFIED Unspecified state.
LAUNCH_STATE_UNLAUNCHED Entity is unlaunched.
LAUNCH_STATE_PENDING Launch in review.
LAUNCH_STATE_LAUNCHED Launched.
LAUNCH_STATE_REJECTED Launch is rejected.
LAUNCH_STATE_SUSPENDED Launch is suspended.
LAUNCH_STATE_PENDING_UNLAUNCH Unlaunch in review.
LAUNCH_STATE_INVALID_IN_GMB Launch is invalid because the associated Google My Business Listing doesn't support messaging. Reverifying in Google My Business automatically relaunches here. Only applicable for locations.

Methods

create

 Creates a new agent to represent a brand.

delete
(deprecated)

 Deprecated: agent deletion is deprecated.

get

 Get information about an agent.

getLaunch

 Gets the launch information for an agent.

getVerification

 Gets the verification information for an agent.

list

 Lists all the agents associated with a brand.

patch

 Updates information about an agent.

requestLaunch

 Begins the launch process for an agent.

requestVerification

 Submits business verification information for an agent.

updateLaunch

 Updates the launch information for an agent.

updateVerification

 Updates the verification state for an agent.