设置在线状态
Set instance presence status
OpenAPI
/api-reference/openapi/WTO-WA-API/instance.yaml post /instance/setPresence/{instanceName}
openapi: 3.0.4
info:
title: WTO - WTO WA API - Instance
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:
/instance/setPresence/{instanceName}:
post:
summary: Set Presence
description: Set instance presence status
parameters:
- $ref: '#/components/parameters/InstanceName'
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- presence
properties:
presence:
type: string
enum:
- available
- unavailable
- composing
- recording
responses:
'200':
description: Presence updated
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: true
message:
type: string
example: Presence updated successfully
'400':
description: Bad Request (invalid data)
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
success: false
error:
code: BAD_REQUEST
message: Invalid input data
meta:
timestamp: '2024-01-15T10:30:00Z'
path: /instance/setPresence/{instanceName}
method: POST
'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 authentication token
meta:
timestamp: '2024-01-15T10:30:00Z'
path: /instance/setPresence/{instanceName}
method: POST
'403':
description: Forbidden (insufficient permissions)
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
success: false
error:
code: FORBIDDEN
message: Insufficient permissions to perform this action
meta:
timestamp: '2024-01-15T10:30:00Z'
path: /instance/setPresence/{instanceName}
method: POST
'404':
description: Not Found (resource not found)
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
success: false
error:
code: NOT_FOUND
message: Instance not found
meta:
timestamp: '2024-01-15T10:30:00Z'
path: /instance/setPresence/{instanceName}
method: POST
'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: /instance/setPresence/{instanceName}
method: POST
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)