REST Resource: partners

  • This document defines the structure and fields for representing a Partner that is onboarded with a supported product, outlining their unique identifier, display name, and product capabilities.

  • Partners can support various products, including Business Messages and RCS Business Messaging, each with its own set of capabilities and webhook URL for message delivery.

  • Each Partner's product capabilities are detailed within the document, including fields like product, businessMessagesCapability, and rcsBusinessMessagingCapability.

  • The document includes optional fields for partners, such as the company name, list of contact emails, and a technical contact for business or technical communication, as well as a mandatory display name.

  • The document includes the methods to get the partner's information as well as update a partner's 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.