Google Chat API
Stay organized with collections
Save and categorize content based on your preferences.
The Google Chat API lets you build Chat apps to integrate your services with Google Chat and manage Chat resources such as spaces, members, and messages.
Service: chat.googleapis.com
To call this service, we recommend that you use the Google-provided
client libraries
. 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://chat.googleapis.com
Methods
|
completeImport
|
POST /v1/{name=spaces/*}:completeImport
Completes the
import process
for the specified space and makes it visible to users.
|
create
|
POST /v1/spaces
Creates a named space.
|
delete
|
DELETE /v1/{name=spaces/*}
Deletes a named space.
|
findDirectMessage
|
GET /v1/spaces:findDirectMessage
Returns the existing direct message with the specified user.
|
get
|
GET /v1/{name=spaces/*}
Returns details about a space.
|
list
|
GET /v1/spaces
Lists spaces the caller is a member of.
|
patch
|
PATCH /v1/{space.name=spaces/*}
Updates a space.
|
search
|
GET /v1/spaces:search
|
setup
|
POST /v1/spaces:setup
Creates a space and adds specified users to it.
|
Methods
|
create
|
POST /v1/{parent=spaces/*}/members
Creates a human membership or app membership for the calling app.
|
delete
|
DELETE /v1/{name=spaces/*/members/*}
Deletes a membership.
|
get
|
GET /v1/{name=spaces/*/members/*}
Returns details about a membership.
|
list
|
GET /v1/{parent=spaces/*}/members
Lists memberships in a space.
|
patch
|
PATCH /v1/{membership.name=spaces/*/members/*}
Updates a membership.
|
Methods
|
create
|
POST /v1/{parent=spaces/*}/messages
Creates a message in a Google Chat space.
|
delete
|
DELETE /v1/{name=spaces/*/messages/*}
Deletes a message.
|
get
|
GET /v1/{name=spaces/*/messages/*}
Returns details about a message.
|
list
|
GET /v1/{parent=spaces/*}/messages
Lists messages in a space that the caller is a member of, including messages from blocked members and spaces.
|
patch
|
PATCH /v1/{message.name=spaces/*/messages/*}
Updates a message.
|
update
|
PUT /v1/{message.name=spaces/*/messages/*}
Updates a message.
|
Methods
|
get
|
GET /v1/{name=spaces/*/messages/*/attachments/*}
Gets the metadata of a message attachment.
|
Methods
|
create
|
POST /v1/{parent=spaces/*/messages/*}/reactions
Creates a reaction and adds it to a message.
|
delete
|
DELETE /v1/{name=spaces/*/messages/*/reactions/*}
Deletes a reaction to a message.
|
list
|
GET /v1/{parent=spaces/*/messages/*}/reactions
Lists reactions to a message.
|
Methods
|
get
|
GET /v1/{name=spaces/*/spaceEvents/*}
Returns an event from a Google Chat space.
|
list
|
GET /v1/{parent=spaces/*}/spaceEvents
Lists events from a Google Chat space.
|
Methods
|
getSpaceReadState
|
GET /v1/{name=users/*/spaces/*/spaceReadState}
Returns details about a user's read state within a space, used to identify read and unread messages.
|
updateSpaceReadState
|
PATCH /v1/{spaceReadState.name=users/*/spaces/*/spaceReadState}
Updates a user's read state within a space, used to identify read and unread messages.
|
Methods
|
getThreadReadState
|
GET /v1/{name=users/*/spaces/*/threads/*/threadReadState}
Returns details about a user's read state within a thread, used to identify read and unread messages.
|
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-05-22 UTC.
[{
"type": "thumb-down",
"id": "missingTheInformationINeed",
"label":"Missing the information I need"
},{
"type": "thumb-down",
"id": "tooComplicatedTooManySteps",
"label":"Too complicated / too many steps"
},{
"type": "thumb-down",
"id": "outOfDate",
"label":"Out of date"
},{
"type": "thumb-down",
"id": "samplesCodeIssue",
"label":"Samples / code issue"
},{
"type": "thumb-down",
"id": "otherDown",
"label":"Other"
}]
[{
"type": "thumb-up",
"id": "easyToUnderstand",
"label":"Easy to understand"
},{
"type": "thumb-up",
"id": "solvedMyProblem",
"label":"Solved my problem"
},{
"type": "thumb-up",
"id": "otherUp",
"label":"Other"
}]