Skip to content

chat.bsky.convo.getConvoAvailability

Lexicon Version: 1

Type: query

Get whether the requester and the other members can chat. If an existing convo is found for these members, it is returned.

Parameters:

NameTypeReq’dDescriptionConstraints
membersArray of stringMin Items: 1
Max Items: 10
Output:
  • Encoding: application/json
  • Schema:

Schema Type: object

NameTypeReq’dDescriptionConstraints
canChatboolean
convochat.bsky.convo.defs#convoView

{
"lexicon": 1,
"id": "chat.bsky.convo.getConvoAvailability",
"defs": {
"main": {
"type": "query",
"description": "Get whether the requester and the other members can chat. If an existing convo is found for these members, it is returned.",
"parameters": {
"type": "params",
"required": [
"members"
],
"properties": {
"members": {
"type": "array",
"minLength": 1,
"maxLength": 10,
"items": {
"type": "string",
"format": "did"
}
}
}
},
"output": {
"encoding": "application/json",
"schema": {
"type": "object",
"required": [
"canChat"
],
"properties": {
"canChat": {
"type": "boolean"
},
"convo": {
"type": "ref",
"ref": "chat.bsky.convo.defs#convoView"
}
}
}
}
}
}
}