Spaces:
Runtime error
Runtime error
File size: 14,052 Bytes
c099d87 2a792a5 c099d87 f7fe55b c099d87 2a792a5 c099d87 2a792a5 c099d87 f7fe55b c099d87 f5271f7 2a792a5 c099d87 2a792a5 f5271f7 2a792a5 c099d87 2a792a5 c099d87 2a792a5 c099d87 28b1128 f7fe55b c099d87 ba5de78 c099d87 ba5de78 c099d87 ba5de78 c099d87 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 | basePath: /api
definitions:
dto.AssignRoleRequest:
properties:
role:
type: string
user_id:
type: string
required:
- role
- user_id
type: object
dto.AuthResponse:
properties:
access_token:
type: string
success_msg:
type: string
user_id:
type: string
username:
type: string
type: object
dto.ConnectRequest:
type: object
dto.ConnectResponse:
properties:
account_id:
type: string
details:
type: string
message:
type: string
qr_code:
type: string
type: object
dto.ConnectionStatusResponse:
properties:
account_id:
type: string
jid:
type: string
status:
type: string
type: object
dto.ContactResponse:
properties:
full_name:
type: string
jid:
type: string
name:
type: string
phone_number:
type: string
push_name:
type: string
type: object
dto.CreateUserRequest:
properties:
password:
minLength: 6
type: string
role:
type: string
username:
type: string
required:
- password
- role
- username
type: object
dto.ErrorResponse:
properties:
errors: {}
message: {}
meta_data: {}
status:
type: string
type: object
dto.FetchContactsResponse:
properties:
account_id:
type: string
contacts:
items:
$ref: '#/definitions/dto.ContactResponse'
type: array
type: object
dto.LoginRequest:
properties:
password:
type: string
username:
type: string
required:
- password
- username
type: object
dto.MeResponse:
properties:
account_name:
type: string
is_active:
type: boolean
jid:
type: string
phone:
type: string
role:
type: string
user_id:
type: string
username:
type: string
type: object
dto.RegisterEnabledResponse:
properties:
register:
type: boolean
type: object
dto.RegisterRequest:
properties:
password:
minLength: 6
type: string
username:
minLength: 3
type: string
required:
- password
- username
type: object
dto.SendMessageRequest:
properties:
message:
example: Hello world
type: string
recipient:
example: "628123456789"
type: string
required:
- message
- recipient
type: object
dto.SendMessageResponse:
properties:
message_id:
type: string
status:
type: string
type: object
dto.SetRegistrationRequest:
properties:
enabled:
type: boolean
type: object
dto.UpdateUserRequest:
properties:
id:
type: string
password:
minLength: 6
type: string
role:
type: string
username:
type: string
required:
- id
type: object
dto.UserResponse:
properties:
created_at:
type: string
id:
type: string
role:
type: string
username:
type: string
type: object
info:
contact:
email: support@swagger.io
name: API Support
url: http://www.swagger.io/support
description: This is the API documentation for the Whatsapp Backend.
license:
name: Apache 2.0
url: http://www.apache.org/licenses/LICENSE-2.0.html
termsOfService: http://swagger.io/terms/
title: Whatsapp Backend API
version: "1.0"
paths:
/admin/create:
post:
consumes:
- application/json
description: Create a new user with specific role
parameters:
- description: Create User Request
in: body
name: request
required: true
schema:
$ref: '#/definitions/dto.CreateUserRequest'
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/dto.UserResponse'
"400":
description: Bad Request
schema:
$ref: '#/definitions/dto.ErrorResponse'
security:
- BearerAuth: []
summary: Create a new user (Admin)
tags:
- admin
/admin/delete:
post:
consumes:
- application/json
description: Delete a user by ID
parameters:
- description: User ID
in: query
name: id
required: true
type: string
produces:
- application/json
responses:
"200":
description: OK
security:
- BearerAuth: []
summary: Delete a user (Admin)
tags:
- admin
/admin/set_registration:
post:
consumes:
- application/json
description: Enable or disable user registration
parameters:
- description: Set Registration Request
in: body
name: request
required: true
schema:
$ref: '#/definitions/dto.SetRegistrationRequest'
responses:
"200":
description: OK
schema:
$ref: '#/definitions/dto.RegisterEnabledResponse'
security:
- BearerAuth: []
summary: Toggle registration enabled
tags:
- admin
/admin/update:
post:
consumes:
- application/json
description: Update user details
parameters:
- description: Update User Request
in: body
name: request
required: true
schema:
$ref: '#/definitions/dto.UpdateUserRequest'
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/dto.UserResponse'
"400":
description: Bad Request
schema:
$ref: '#/definitions/dto.ErrorResponse'
security:
- BearerAuth: []
summary: Update a user (Admin)
tags:
- admin
/auth/assign:
post:
consumes:
- application/json
description: Assign a role to a user
parameters:
- description: Assign Role Request
in: body
name: request
required: true
schema:
$ref: '#/definitions/dto.AssignRoleRequest'
produces:
- application/json
responses:
"200":
description: OK
"400":
description: Bad Request
schema:
$ref: '#/definitions/dto.ErrorResponse'
security:
- BearerAuth: []
summary: Assign Role (SuperAdmin)
tags:
- auth
/auth/login:
post:
consumes:
- application/json
description: Login a user with credentials
parameters:
- description: Login Request
in: body
name: request
required: true
schema:
$ref: '#/definitions/dto.LoginRequest'
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/dto.AuthResponse'
"400":
description: Bad Request
schema:
$ref: '#/definitions/dto.ErrorResponse'
summary: Login a user
tags:
- auth
/auth/logout:
post:
description: Logout the current user
responses:
"200":
description: OK
security:
- BearerAuth: []
summary: Logout a user
tags:
- auth
/auth/me:
get:
description: Get the profile of the currently logged-in user
responses:
"200":
description: OK
schema:
$ref: '#/definitions/dto.MeResponse'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/dto.ErrorResponse'
security:
- BearerAuth: []
summary: Get current user profile
tags:
- auth
/auth/refresh:
post:
description: Refresh the access token using the refresh token cookie
responses:
"200":
description: OK
schema:
$ref: '#/definitions/dto.AuthResponse'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/dto.ErrorResponse'
security:
- BearerAuth: []
summary: Refresh access token
tags:
- auth
/auth/register:
post:
consumes:
- application/json
description: Register a new user with the provided details
parameters:
- description: Register Request
in: body
name: request
required: true
schema:
$ref: '#/definitions/dto.RegisterRequest'
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/dto.AuthResponse'
"400":
description: Bad Request
schema:
$ref: '#/definitions/dto.ErrorResponse'
summary: Register a new user
tags:
- auth
/auth/register_enabled:
get:
description: Check if user registration is enabled
responses:
"200":
description: OK
schema:
$ref: '#/definitions/dto.RegisterEnabledResponse'
security:
- BearerAuth: []
summary: Check if registration is enabled
tags:
- auth
/chat/contacts:
get:
consumes:
- application/json
description: Fetch list of contacts from the connected WhatsApp account
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/dto.FetchContactsResponse'
"400":
description: Bad Request
schema:
$ref: '#/definitions/dto.ErrorResponse'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/dto.ErrorResponse'
security:
- BearerAuth: []
summary: Fetch WhatsApp contacts
tags:
- chat
/chat/send_img:
post:
consumes:
- multipart/form-data
description: Send an image to a WhatsApp number via file upload
parameters:
- description: Image file to send
in: formData
name: image
required: true
type: file
- description: Recipient phone number
example: "628123456789"
in: formData
name: recipient
required: true
type: string
- description: Image caption
in: formData
name: caption
type: string
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/dto.SendMessageResponse'
"400":
description: Bad Request
schema:
$ref: '#/definitions/dto.ErrorResponse'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/dto.ErrorResponse'
security:
- BearerAuth: []
summary: Send WhatsApp image
tags:
- chat
/chat/send_msg:
post:
consumes:
- application/json
description: Send a text message to a WhatsApp number
parameters:
- description: Send Message Request
in: body
name: request
required: true
schema:
$ref: '#/definitions/dto.SendMessageRequest'
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/dto.SendMessageResponse'
"400":
description: Bad Request
schema:
$ref: '#/definitions/dto.ErrorResponse'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/dto.ErrorResponse'
security:
- BearerAuth: []
summary: Send WhatsApp text message
tags:
- chat
/whatsapp/connect:
post:
consumes:
- application/json
description: Initiate a connection request for a new WhatsApp account. Returns
a QR code if not connected.
parameters:
- description: Connect Request
in: body
name: request
required: true
schema:
$ref: '#/definitions/dto.ConnectRequest'
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/dto.ConnectResponse'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/dto.ErrorResponse'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/dto.ErrorResponse'
security:
- BearerAuth: []
summary: Connect new WhatsApp account
tags:
- whatsapp
/whatsapp/socket:
get:
description: Upgrade HTTP connection to WebSocket for real-time updates
responses:
"101":
description: Switching Protocols
security:
- BearerAuth: []
summary: Connect to WebSocket
tags:
- whatsapp
/whatsapp/status:
get:
consumes:
- application/json
description: Get the current status of the WhatsApp connection
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/dto.ConnectionStatusResponse'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/dto.ErrorResponse'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/dto.ErrorResponse'
security:
- BearerAuth: []
summary: Get WhatsApp connection status
tags:
- whatsapp
securityDefinitions:
BearerAuth:
in: header
name: Authorization
type: apiKey
swagger: "2.0"
|