Business Messages API

  • The Business Messages API allows you to send and receive messages, create events, and manage customer satisfaction surveys within conversations.

  • Google provides client libraries and samples to facilitate interaction with the API, although you can also use your own libraries.

  • The service endpoint for the API is https://businessmessages.googleapis.com, and all API requests should be relative to this endpoint.

  • Key REST resources include conversations.events, conversations.messages, and conversations.surveys, offering functionalities like creating events, sending messages, and managing surveys.

  • You can find the Discovery Document at https://businessmessages.googleapis.com/$discovery/rest?version=v1 for machine-readable specifications of the API.

Service: businessmessages.googleapis.com

To call this service, we recommend that you use the Google-provided samples. If your application needs to use your own libraries to call this service, use the following information when you make the API requests.

Discovery document

A Discovery Document is a machine-readable specification for describing and consuming REST APIs. It is used to build client libraries, IDE plugins, and other tools that interact with Google APIs. One service may provide multiple discovery documents. This service provides the following discovery document:

Service endpoint

A service endpoint is a base URL that specifies the network address of an API service. One service might have multiple service endpoints. This service has the following service endpoint and all URIs below are relative to this service endpoint:

  • https://businessmessages.googleapis.com

REST Resource: v1.conversations.events

Methods
create POST /v1/{parent=conversations/*}/events
Creates an event in a conversation.

REST Resource: v1.conversations.messages

Methods
create POST /v1/{parent=conversations/*}/messages
Sends a message from an agent to a user.
updateReceipt PATCH /v1/{receipt.name=conversations/*/messages/*/receipt}
Sends a receipt for a message from an agent to a user.

REST Resource: v1.conversations.surveys

Methods
create POST /v1/{parent=conversations/*}/surveys
Creates a customer satisfaction survey in a conversation.