Business Messages API

  • Use Google-provided samples or your own libraries to call the businessmessages.googleapis.com service.

  • A Discovery Document is available at https://businessmessages.googleapis.com/$discovery/rest?version=v1 for machine-readable API specifications.

  • The service endpoint for API requests is https://businessmessages.googleapis.com.

  • The v1.conversations.events resource supports creating events using a POST request.

  • The v1.conversations.messages resource supports sending messages (create) and sending message receipts (updateReceipt) using POST and PATCH requests respectively.

  • The v1.conversations.surveys resource supports creating customer satisfaction surveys using a POST request.

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.