curl --request GET \
--url https://public-api.dev.workchats.com/v1/conversations/{id} \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://public-api.dev.workchats.com/v1/conversations/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://public-api.dev.workchats.com/v1/conversations/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"conversation": {
"id": "chn_c41a2b3c-4d5e-4f60-8a7b-9c0d1e2f3a4b",
"is_archived": false,
"is_member": true,
"is_private": true,
"member_count": 9,
"name": "sales-alerts",
"parent_id": "grp_6b0a1b2c-3d4e-4f50-8a6b-7c8d9e0f1a2b",
"topic": null,
"type": "private_channel"
},
"ok": true
}{
"error": {
"code": "token_revoked",
"message": "The token has been revoked."
},
"ok": false,
"request_id": "F7p0mJcXk3tq2x0AAAAB"
}{
"error": {
"code": "token_revoked",
"message": "The token has been revoked."
},
"ok": false,
"request_id": "F7p0mJcXk3tq2x0AAAAB"
}{
"error": {
"code": "token_revoked",
"message": "The token has been revoked."
},
"ok": false,
"request_id": "F7p0mJcXk3tq2x0AAAAB"
}{
"error": {
"code": "token_revoked",
"message": "The token has been revoked."
},
"ok": false,
"request_id": "F7p0mJcXk3tq2x0AAAAB"
}{
"error": {
"code": "token_revoked",
"message": "The token has been revoked."
},
"ok": false,
"request_id": "F7p0mJcXk3tq2x0AAAAB"
}{
"error": {
"code": "token_revoked",
"message": "The token has been revoked."
},
"ok": false,
"request_id": "F7p0mJcXk3tq2x0AAAAB"
}{
"error": {
"code": "token_revoked",
"message": "The token has been revoked."
},
"ok": false,
"request_id": "F7p0mJcXk3tq2x0AAAAB"
}Get a conversation
One group or named channel the bot is a member of, by id, as the list returns it. An archived group and its channels are returned with is_archived: true. A conversation the bot was never in, one in another workspace, a deleted one, and an announcement channel are all conversation_not_found. After the bot is removed it is not_in_conversation. Re-read a conversation here when a directory.changed callback names it. Needs conversations:read. Limited to 100 requests a minute per installation.
curl --request GET \
--url https://public-api.dev.workchats.com/v1/conversations/{id} \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://public-api.dev.workchats.com/v1/conversations/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://public-api.dev.workchats.com/v1/conversations/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"conversation": {
"id": "chn_c41a2b3c-4d5e-4f60-8a7b-9c0d1e2f3a4b",
"is_archived": false,
"is_member": true,
"is_private": true,
"member_count": 9,
"name": "sales-alerts",
"parent_id": "grp_6b0a1b2c-3d4e-4f50-8a6b-7c8d9e0f1a2b",
"topic": null,
"type": "private_channel"
},
"ok": true
}{
"error": {
"code": "token_revoked",
"message": "The token has been revoked."
},
"ok": false,
"request_id": "F7p0mJcXk3tq2x0AAAAB"
}{
"error": {
"code": "token_revoked",
"message": "The token has been revoked."
},
"ok": false,
"request_id": "F7p0mJcXk3tq2x0AAAAB"
}{
"error": {
"code": "token_revoked",
"message": "The token has been revoked."
},
"ok": false,
"request_id": "F7p0mJcXk3tq2x0AAAAB"
}{
"error": {
"code": "token_revoked",
"message": "The token has been revoked."
},
"ok": false,
"request_id": "F7p0mJcXk3tq2x0AAAAB"
}{
"error": {
"code": "token_revoked",
"message": "The token has been revoked."
},
"ok": false,
"request_id": "F7p0mJcXk3tq2x0AAAAB"
}{
"error": {
"code": "token_revoked",
"message": "The token has been revoked."
},
"ok": false,
"request_id": "F7p0mJcXk3tq2x0AAAAB"
}{
"error": {
"code": "token_revoked",
"message": "The token has been revoked."
},
"ok": false,
"request_id": "F7p0mJcXk3tq2x0AAAAB"
}Authorizations
Bot token (wc_bot_live_… or wc_bot_test_…) from the OAuth install
Path Parameters
Conversation id, grp_ or chn_ prefixed
Response
The conversation
One conversation.
A group (its main conversation, grp_) or a named channel in one (chn_) that the bot is a member of. A channel has its group's type and archived state.
Show child attributes
Show child attributes
{
"id": "chn_c41a2b3c-4d5e-4f60-8a7b-9c0d1e2f3a4b",
"is_archived": false,
"is_member": true,
"is_private": true,
"member_count": 9,
"name": "sales-alerts",
"parent_id": "grp_6b0a1b2c-3d4e-4f50-8a6b-7c8d9e0f1a2b",
"topic": null,
"type": "private_channel"
}
true