REST Resource: partners

  • A Partner is defined as an entity onboarded with a supported product, identified by a unique name and a required display name.

  • Partner details include optional fields like company name, contact emails, and a technical contact with their name, email, and phone number.

  • Partners have product capabilities indicating the supported products, such as Business Messages or RCS for Business, each potentially requiring a webhook URL.

  • Supported products include Business Messages and RCS for Business, represented by enumerated values.

  • Methods available for partners include getting information about a partner and patching to update their information.

Resource: Partner

Partner that is onboarded with a supported product.

JSON representation 
{
  "name": string,
  "displayName": string,
  "productCapabilities": [
    {
      object (ProductCapability)
    }
  ],
  "company": string,
  "contactEmails": [
    string
  ],
  "technicalContact": {
    object (Contact)
  },
  "dialogflowServiceAccountEmail": string
}
Fields
name

string

Immutable. The unique identifier of the partner.

Defined by the platform.
displayName

string

Required. The display name of the partner.
productCapabilities[]

object (ProductCapability)

The product capabilities of the partner.
company

string

Optional. The company name of the partner.
contactEmails[]

string

Optional. The list of contact emails.
technicalContact

object (Contact)

Optional. The technical point of contact of the partner.
dialogflowServiceAccountEmail

string

Output only. Service account with access to the Dialogflow Client API role. This account is created by the platform and provides access to Dialogflow.

ProductCapability

The product capabilities that the partner supports.

JSON representation 
{
  "product": enum (Product),

  // Union field capabilities can be only one of the following:
  "businessMessagesCapability": {
    object (BusinessMessagesCapability)
  },
  "rcsBusinessMessagingCapability": {
    object (RcsBusinessMessagingCapability)
  }
  // End of list of possible types for union field capabilities.
}
Fields
product

enum (Product)

The product supported by the partner.
Union field capabilities. Capabilities for the partner. capabilities can be only one of the following:
businessMessagesCapability

object (BusinessMessagesCapability)

Business Messages capability.
rcsBusinessMessagingCapability

object (RcsBusinessMessagingCapability)

RCS for Business capability = 4;

Product

The products supported by Business Communications.

Enums
PRODUCT_UNSPECIFIED Unspecified product.
BUSINESS_MESSAGES Business Messages product.
RCS_BUSINESS_MESSAGING RCS for Business product.

BusinessMessagesCapability

Business Messages capabilities

JSON representation 
{
  "webhookUrl": string
}
Fields
webhookUrl

string

Required. The webhook URL where the messages are delivered.

RcsBusinessMessagingCapability

RCS for Business capabilities

JSON representation 
{
  "webhookUrl": string
}
Fields
webhookUrl

string

Required. The webhook URL where the messages are delivered.

Contact

Contact details

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

string

Name of the contact person.
email

string

Email of the contact person.
phoneNumber

object (Phone)

Phone number of the contact person.

Methods

get

 Get the information about the partner.

patch

 Updates the information for a partner.