We will be winding down Google Business Messages on July 31, 2024. Read more
here.
Business Messages API
Stay organized with collections
Save and categorize content based on your preferences.
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
| Methods |
create |
POST /v1/{parent=conversations/*}/events
Creates an event in a conversation. |
| 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. |
| Methods |
create |
POST /v1/{parent=conversations/*}/surveys
Creates a customer satisfaction survey in a conversation. |
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-11-14 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-11-14 UTC."],[[["\u003cp\u003eThe Business Messages API allows you to send and receive messages, create events, and manage customer satisfaction surveys within conversations.\u003c/p\u003e\n"],["\u003cp\u003eGoogle provides client libraries and samples to facilitate interaction with the API, although you can also use your own libraries.\u003c/p\u003e\n"],["\u003cp\u003eThe service endpoint for the API is \u003ccode\u003ehttps://businessmessages.googleapis.com\u003c/code\u003e, and all API requests should be relative to this endpoint.\u003c/p\u003e\n"],["\u003cp\u003eKey REST resources include conversations.events, conversations.messages, and conversations.surveys, offering functionalities like creating events, sending messages, and managing surveys.\u003c/p\u003e\n"],["\u003cp\u003eYou can find the Discovery Document at \u003ca href=\"https://businessmessages.googleapis.com/$discovery/rest?version=v1\"\u003ehttps://businessmessages.googleapis.com/$discovery/rest?version=v1\u003c/a\u003e for machine-readable specifications of the API.\u003c/p\u003e\n"]]],[],null,["# Business Messages API\n\nService: businessmessages.googleapis.com\n----------------------------------------\n\nTo call this service, we recommend that you use the Google-provided [samples](/business-communications/business-messages/resources/samples). If your application needs to use your own libraries to call this service, use the following information when you make the API requests.\n\n### Discovery document\n\nA [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) 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:\n\n- \u003chttps://businessmessages.googleapis.com/$discovery/rest?version=v1\u003e\n\n### Service endpoint\n\nA [service endpoint](https://cloud.google.com/apis/design/glossary#api_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:\n\n- `https://businessmessages.googleapis.com`\n\nREST Resource: [v1.conversations.events](/business-communications/business-messages/reference/rest/v1/conversations.events)\n---------------------------------------------------------------------------------------------------------------------------\n\n| Methods ||\n|----------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------|\n| [create](/business-communications/business-messages/reference/rest/v1/conversations.events/create) | `POST /v1/{parent=conversations/*}/events` Creates an event in a conversation. |\n\nREST Resource: [v1.conversations.messages](/business-communications/business-messages/reference/rest/v1/conversations.messages)\n-------------------------------------------------------------------------------------------------------------------------------\n\n| Methods ||\n|--------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------|\n| [create](/business-communications/business-messages/reference/rest/v1/conversations.messages/create) | `POST /v1/{parent=conversations/*}/messages` Sends a message from an agent to a user. |\n| [updateReceipt](/business-communications/business-messages/reference/rest/v1/conversations.messages/updateReceipt) | `PATCH /v1/{receipt.name=conversations/*/messages/*/receipt}` Sends a receipt for a message from an agent to a user. |\n\nREST Resource: [v1.conversations.surveys](/business-communications/business-messages/reference/rest/v1/conversations.surveys)\n-----------------------------------------------------------------------------------------------------------------------------\n\n| Methods ||\n|-----------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------|\n| [create](/business-communications/business-messages/reference/rest/v1/conversations.surveys/create) | `POST /v1/{parent=conversations/*}/surveys` Creates a customer satisfaction survey in a conversation. |"]]