conversationsMembers
Retrieve members of a conversation.
Details
- Method:
GET - Path:
/conversations.members - Operation ID:
conversations_members
Parameters
{
"token": {
"description": "Authentication token. Requires scope: `conversations:read`",
"required": false,
"location": "query",
"type": "string"
},
"channel": {
"description": "ID of the conversation to retrieve members for",
"required": false,
"location": "query",
"type": "string"
},
"limit": {
"description": "The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the users list hasn't been reached.",
"required": false,
"location": "query",
"type": "string"
},
"cursor": {
"description": "Paginate through collections of data by setting the `cursor` parameter to a `next_cursor` attribute returned by a previous request's `response_metadata`. Default value fetches the first \"page\" of the collection. See [pagination](/docs/pagination) for more detail.",
"required": false,
"location": "query",
"type": "string"
}
}Response Schema
{
"additionalProperties": false,
"description": "Schema for successful response conversations.members method",
"properties": {
"members": {
"items": {
"pattern": "^[UW][A-Z0-9]{2,}$",
"title": "User ID",
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"ok": {
"enum": [
true
],
"title": "default success response",
"type": "boolean"
},
"response_metadata": {
"additionalProperties": false,
"properties": {
"next_cursor": {
"type": "string"
}
},
"required": [
"next_cursor"
],
"type": "object"
}
},
"required": [
"ok",
"members",
"response_metadata"
],
"title": "conversations.members success schema",
"type": "object"
}Usage
from ocp_agent import OCPAgent
agent = OCPAgent()
await agent.register_api('slack')
# Call this tool
result = await agent.call_tool('conversationsMembers', {
# Add required parameters here
})