获取群组成员
Get group participants
OpenAPI
/api-reference/openapi/WTO-WA-API/group.yaml get /group/participants/{instanceName}
openapi: 3.0.4
info:
title: WTO - WTO WA API - Group
description: Main WTO WA API for WhatsApp
version: 2.3.7
servers:
- url: http://localhost:8080
description: Local development server
- url: https://api.wtocrm.com
description: Production server
- url: '{customUrl}'
description: Custom server
variables:
customUrl:
default: https://your-instance.com
description: Enter your server URL
security:
- ApiKeyAuth: []
paths:
/group/participants/{instanceName}:
get:
summary: Get Participants
description: Get group participants
parameters:
- $ref: '#/components/parameters/InstanceName'
- name: groupJid
in: query
required: true
description: WhatsApp group JID
schema:
type: string
responses:
'200':
description: Participants retrieved successfully
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: true
participants:
type: array
items:
type: object
example:
success: true
participants:
- id: [email protected]
isAdmin: true
isSuperAdmin: false
- id: [email protected]
isAdmin: false
isSuperAdmin: false
'400':
description: Bad Request (invalid data)
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
success: false
error:
code: BAD_REQUEST
message: Invalid request data
meta:
timestamp: '2024-01-15T10:30:00Z'
path: /group/participants/{instanceName}
method: GET
'401':
description: Unauthorized (invalid or missing token)
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
success: false
error:
code: UNAUTHORIZED
message: Invalid or missing API key
meta:
timestamp: '2024-01-15T10:30:00Z'
path: /group/participants/{instanceName}
method: GET
'403':
description: Forbidden (insufficient permissions)
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
success: false
error:
code: FORBIDDEN
message: Insufficient permissions to access participants
meta:
timestamp: '2024-01-15T10:30:00Z'
path: /group/participants/{instanceName}
method: GET
'404':
description: Not Found (resource not found)
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
success: false
error:
code: NOT_FOUND
message: Instance or group not found
meta:
timestamp: '2024-01-15T10:30:00Z'
path: /group/participants/{instanceName}
method: GET
'500':
description: Internal Server Error (server error)
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
success: false
error:
code: INTERNAL_SERVER_ERROR
message: An unexpected error occurred
meta:
timestamp: '2024-01-15T10:30:00Z'
path: /group/participants/{instanceName}
method: GET
components:
parameters:
InstanceName:
name: instanceName
in: path
required: true
description: WhatsApp instance name
schema:
type: string
example: my-instance
schemas:
ErrorResponse:
type: object
required:
- success
- error
properties:
success:
type: boolean
example: false
error:
type: object
required:
- code
- message
properties:
code:
type: string
message:
type: string
meta:
type: object
properties:
timestamp:
type: string
format: date-time
path:
type: string
method:
type: string
securitySchemes:
ApiKeyAuth:
type: apiKey
in: header
name: apikey
description: API Key for authentication (global or instance-specific)