forked from code-chat-br/whatsapp-api
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathswagger.yaml
1374 lines (1359 loc) · 45.2 KB
/
swagger.yaml
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
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# ┌──────────────────────────────────────────────────────────────────────────────┐
# │ @author jrCleber │
# │ @filename main.ts │
# │ Developed by: Cleber Wilson │
# │ Creation date: Aug 13, 2023 │
# │ Contact: [email protected] │
# ├──────────────────────────────────────────────────────────────────────────────┤
# │ @copyright © Cleber Wilson 2022. All rights reserved. │
# │ Licensed under the Apache License, Version 2.0 │
# │ │
# │ @license "https://github.com/code-chat-br/whatsapp-api/blob/main/LICENSE" │
# │ │
# │ You may not use this file except in compliance with the License. │
# │ You may obtain a copy of the License at │
# │ │
# │ http://www.apache.org/licenses/LICENSE-2.0 │
# │ │
# │ Unless required by applicable law or agreed to in writing, software │
# │ distributed under the License is distributed on an "AS IS" BASIS, │
# │ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. │
# │ │
# │ See the License for the specific language governing permissions and │
# │ limitations under the License. │
# │ │
# ├──────────────────────────────────────────────────────────────────────────────┤
# │ @important │
# │ For any future changes to the code in this file, it is recommended to │
# │ contain, together with the modification, the information of the developer │
# │ who changed it and the date of modification. │
# └──────────────────────────────────────────────────────────────────────────────┘
openapi: 3.0.0
info:
title: CodeChat - WhatsApp API
description: |
</br>
<hr style="height: 5px;background: #007500;margin: 20px 0;box-shadow: 0px 3px 5px 0px rgb(204 204 204);">
<div align="center">
[](https://t.me/codechatBR)
[](https://chat.whatsapp.com/HyO8X8K0bAo0bfaeW8bhY5)
[](https://github.com/code-chat-br/whatsapp-api/blob/main/LICENSE)
[](https://app.picpay.com/user/cleber.wilson.oliveira)
</div>
<div align="center"><img src="https://raw.githubusercontent.com/code-chat-br/whatsapp-api/main/public/images/cover.png"></div>
<font size='3'>
CodeChat is an advanced WhatsApp integration API that seamlessly merges the popularity of WhatsApp with modern business applications. With comprehensive features, the CodeChat API empowers businesses to expand their digital presence, reach customers more directly, and provide personalized and efficient support, all through the world's most widely used messaging platform.
The CodeChat API opens doors to more effective and engaging business communication, offering a modern approach to customer support, direct marketing, and real-time interactions. By combining WhatsApp's popularity with the functionality of the CodeChat API, businesses can build stronger and more authentic relationships with their customers, generating lasting satisfaction and loyalty.
</font>
[](https://www.postman.com/codechat/workspace/codechat-whatsapp-api/api/fbe06c7b-7647-4c71-81ee-841f5b2e90d8?action=share&creator=14064846)
version: 1.2.6
contact:
name: jrCleber
email: [email protected]
url: https://www.apache.org/licenses/LICENSE-2.0
license:
name: Apache License - Version 2.0, January 2004
url: https://www.exemplo.com/licenca
servers: []
components:
securitySchemes:
apikeyAuth:
type: apiKey
in: header
name: apikey
bearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
security:
- bearerAuth: []
tags:
- name: Instance Controller
- name: Instance Controller > Views
- name: Send Message Controller
- name: Chat Controller
- name: Group Controller
- name: JWT
- name: Webhook
paths:
/instance/qrcode/{instanceName}:
get:
tags:
- Instance Controller > Views
summary: QrCode
parameters:
- name: instanceName
in: path
description: Name of the instance for which the QR Code needs to be fetched.
required: true
schema:
type: string
example: 'codechat'
responses:
'200':
description: Successful response
content:
application/html: {}
/instance/create:
post:
tags:
- Instance Controller
summary: Create Instance
requestBody:
content:
application/json:
schema:
type: object
properties:
instanceName:
type: string
description: Name of the instance (optional).
example:
instanceName: 'exampleInstance'
security:
- apikeyAuth: []
responses:
'200':
description: Successful response
content:
application/json: {}
/instance/fetchInstances:
get:
tags:
- Instance Controller
summary: Fetch Instances
security:
- apikeyAuth: []
parameters:
- name: instanceName
in: query
schema:
type: string
description: Retrieve one or all instances (optional).
example: 'codechat'
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: array
items:
type: object
properties:
instance:
type: object
properties:
instanceName:
type: string
owner:
type: string
profileName:
type: string
profilePictureUrl:
type: string
auth:
type: object
properties:
jwt:
type: string
/instance/connect/{instanceName}:
get:
tags:
- Instance Controller
summary: Instance Connect
parameters:
- name: instanceName
in: path
required: true
schema:
type: string
description: Connect to your instance.
example: 'codechat'
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
properties:
code:
type: string
base64:
type: string
description: The QR Code as a string.
/instance/reload/{instanceName}:
get:
tags:
- Instance Controller
summary: Instance Reload
parameters:
- name: instanceName
in: path
required: true
schema:
type: string
description: Reload to your instance.
example: 'codechat'
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
properties:
instance:
type: string
state:
type: string
statusReason:
type: string
/instance/connectionState/{instanceName}:
get:
tags:
- Instance Controller
summary: Connection Status
parameters:
- name: instanceName
in: path
required: true
schema:
type: string
description: Check the connection state of your instance.
example: 'codechat'
responses:
'200':
description: Successful response
content:
application/json: {}
/instance/logout/{instanceName}:
delete:
tags:
- Instance Controller
summary: Logout Instance
parameters:
- name: instanceName
in: path
required: true
schema:
type: string
description: Logout from your instance.
example: 'codechat'
responses:
'200':
description: Successful response
content:
application/json: {}
/instance/delete/{instanceName}:
delete:
tags:
- Instance Controller
summary: Delete Instance
parameters:
- name: instanceName
in: path
required: true
schema:
type: string
description: Delete your instance.
example: 'codechat'
responses:
'200':
description: Successful response
content:
application/json: {}
/message/sendText/{instanceName}:
post:
tags:
- Send Message Controller
summary: Send a text message to a specified instance.
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
number:
type: string
description: The recipient's phone number.
example: '1234567890'
textMessage:
type: object
properties:
text:
type: string
description: The content of the text message.
example: 'Hello, World!'
options:
type: object
properties:
delay:
type: integer
description: Delay time before sending the message.
presence:
type: string
enum: ['composing', 'recording', 'paused']
description: Indicates the sender's action/status.
required:
- number
- textMessage
parameters:
- name: instanceName
in: path
required: true
schema:
type: string
description: The name of the instance to which the message should be sent.
example: 'codechat'
responses:
'200':
description: Successful response
content:
application/json: {}
/message/sendMedia/{instanceName}:
post:
tags:
- Send Message Controller
summary: Send a media message (image, video, document, audio) to a specified instance.
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
number:
type: string
description: The recipient's phone number.
example: '1234567890'
mediaMessage:
type: object
properties:
mediatype:
type: string
enum: ['image', 'document', 'video', 'audio']
description: Type of the media content.
fileName:
type: string
description: Name of the media file (optional).
caption:
type: string
description: Caption to accompany the media.
media:
type: string
description: URL of the media content.
required:
- mediatype
- media
options:
type: object
properties:
delay:
type: integer
description: Delay time before sending the message.
presence:
type: string
enum: ['composing', 'recording', 'paused']
description: Indicates the sender's action/status.
parameters:
- name: instanceName
in: path
required: true
schema:
type: string
description: The name of the instance to which the media message should be sent.
example: 'codechat'
responses:
'200':
description: Successful response
content:
application/json: {}
/message/sendMediaFile/{instanceName}:
post:
tags:
- Send Message Controller
summary: Send a media file (image, video, document, audio) directly to a specified instance.
requestBody:
required: true
content:
multipart/form-data:
schema:
type: object
properties:
number:
type: string
description: The recipient's phone number.
example: '1234567890'
caption:
type: string
description: Caption to accompany the media (optional).
attachment:
type: string
format: binary
description: The media file to be sent.
mediatype:
type: string
enum: ['image', 'document', 'video', 'audio']
description: Type of the media content.
presence:
type: string
enum: ['composing', 'recording', 'paused']
description: Indicates the sender's action/status (optional).
delay:
type: integer
description: Delay time before sending the message (optional).
required:
- number
- attachment
- mediatype
parameters:
- name: instanceName
in: path
required: true
schema:
type: string
description: The name of the instance to which the media file should be sent.
example: 'codechat'
responses:
'200':
description: Successful response
content:
application/json: {}
/message/sendLocation/{instanceName}:
post:
tags:
- Send Message Controller
summary: Send a location to a specified instance.
description: This endpoint allows users to share a location message.
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
number:
type: string
description: The recipient's phone number.
example: '1234567890'
locationMessage:
type: object
properties:
name:
type: string
description: Name or title of the location.
address:
type: string
description: Detailed address of the location.
latitude:
type: number
description: Latitude of the location.
format: float
longitude:
type: number
description: Longitude of the location.
format: float
options:
type: object
properties:
delay:
type: integer
description: Delay time before sending the message.
presence:
type: string
enum: ['composing', 'recording', 'paused']
description: Indicates the sender's action/status.
required:
- number
- locationMessage.latitude
- locationMessage.longitude
parameters:
- name: instanceName
in: path
required: true
schema:
type: string
description: The name of the instance to which the location should be sent.
example: 'codechat'
responses:
'200':
description: Successful response
content:
application/json: {}
/message/sendContact/{instanceName}:
post:
tags:
- Send Message Controller
summary: Send contact details to a specified instance.
description: This endpoint allows users to share one or multiple contact details.
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
number:
type: string
description: The recipient's phone number.
example: '1234567890'
contactMessage:
type: array
items:
type: object
properties:
fullName:
type: string
description: Full name of the contact.
wuid:
type: string
description: Unique identifier for the contact.
phoneNumber:
type: string
description: Phone number of the contact.
required:
- fullName
- wuid
- phoneNumber
options:
type: object
properties:
delay:
type: integer
description: Delay time before sending the contact.
presence:
type: string
enum: ['composing', 'recording', 'paused']
description: Indicates the sender's action/status.
required:
- number
parameters:
- name: instanceName
in: path
required: true
schema:
type: string
description: The name of the instance to which the contacts should be sent.
example: 'codechat'
responses:
'200':
description: Successful response
content:
application/json: {}
/message/sendReaction/{instanceName}:
post:
tags:
- Send Message Controller
summary: Send a reaction to a specified instance.
description: This endpoint allows users to send a reaction to a message.
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
reactionMessage:
type: object
properties:
key:
type: object
properties:
remoteJid:
type: string
description: The ID of the recipient of the original message.
fromMe:
type: boolean
description: Indicates if the reaction was sent from the user.
id:
type: string
description: The ID of the original message.
reaction:
type: string
maxLength: 1
description: Reaction character (e.g., emoji).
required:
- key.remoteJid
- key.fromMe
- key.id
- reaction
parameters:
- name: instanceName
in: path
required: true
schema:
type: string
description: The name of the instance to which the reaction should be sent.
example: 'codechat'
responses:
'200':
description: Successful response
content:
application/json: {}
/message/sendWhatsAppAudio/{instanceName}:
post:
tags:
- Send Message Controller
summary: Send an audio message via WhatsApp to a specified instance.
description: This endpoint allows users to share an audio message.
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
number:
type: string
description: The recipient's phone number.
example: '1234567890'
audioMessage:
type: object
properties:
audio:
type: string
description: URL of the audio file to be sent.
required:
- audio
options:
type: object
properties:
delay:
type: integer
description: Delay time before sending the audio message.
required:
- number
- audioMessage.audio
parameters:
- name: instanceName
in: path
required: true
schema:
type: string
description: The name of the instance to which the audio should be sent.
example: 'codechat'
responses:
'200':
description: Successful response
content:
application/json: {}
/message/sendWhatsAppAudioFile/{instanceName}:
post:
tags:
- Send Message Controller
summary: Upload and send a WhatsApp audio file to a specified instance.
description: This endpoint allows users to upload and send an audio file via WhatsApp.
requestBody:
required: true
content:
multipart/form-data:
schema:
type: object
properties:
number:
type: string
description: The recipient's phone number.
example: '1234567890'
attachment:
type: string
description: Audio file to be sent.
format: binary
delay:
type: integer
description: Delay time before sending the audio message.
example: 5
required:
- number
- attachment
parameters:
- name: instanceName
in: path
required: true
schema:
type: string
description: The name of the instance to which the reaction should be sent.
example: 'codechat'
responses:
'200':
description: Successful response
content:
application/json: {}
/chat/whatsappNumbers/{instanceName}:
post:
tags:
- Chat Controller
summary: Provide a list of WhatsApp numbers associated with a given instance.
description: This endpoint returns information on the WhatsApp numbers associated with the specified instance.
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
numbers:
type: array
items:
type: string
description: WhatsApp phone number.
example:
- '1234567890'
required:
- numbers
parameters:
- name: instanceName
in: path
required: true
schema:
type: string
description: The name of the instance to which the reaction should be sent.
example: 'codechat'
responses:
'200':
description: Successful response
content:
application/json: {}
/chat/markMessageAsRead/{instanceName}:
put:
tags:
- Chat Controller
summary: Mark specific messages as read for a given instance.
description: This endpoint allows users to mark messages as read for a particular instance.
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
readMessages:
type: array
items:
type: object
properties:
remoteJid:
type: string
description: ID of the recipient of the message.
fromMe:
type: boolean
description: Indicates if the message was sent from the user.
id:
type: string
description: Unique ID of the message.
required:
- remoteJid
- fromMe
- id
required:
- readMessages
parameters:
- name: instanceName
in: path
required: true
schema:
type: string
description: The name of the instance to which the reaction should be sent.
example: 'codechat'
responses:
'200':
description: Successful response
content:
application/json: {}
/chat/archiveChat/{instanceName}:
put:
tags:
- Chat Controller
summary: Archive specific chats for a given instance.
description: This endpoint allows users to archive specific chats based on the last message.
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
lastMessage:
type: object
properties:
key:
type: object
properties:
remoteJid:
type: string
description: ID of the recipient of the last message.
fromMe:
type: boolean
description: Indicates if the last message was sent from the user.
id:
type: string
description: Unique ID of the last message.
required:
- remoteJid
- fromMe
- id
archive:
type: boolean
description: Indicates whether to archive the chat.
example: true
required:
- lastMessage
- archive
parameters:
- name: instanceName
in: path
required: true
schema:
type: string
description: The name of the instance to which the reaction should be sent.
example: 'codechat'
responses:
'200':
description: Successful response
content:
application/json: {}
/chat/deleteMessageForEveryone/{instanceName}:
delete:
tags:
- Chat Controller
summary: Delete a message for everyone in a given instance.
description: This endpoint allows users to delete a message for everyone in the chat.
parameters:
- name: instanceName
in: path
required: true
schema:
type: string
description: The name of the instance to which the reaction should be sent.
example: 'codechat'
responses:
'200':
description: Successful response
content:
application/json: {}
/chat/fetchProfilePictureUrl/{instanceName}:
post:
tags:
- Chat Controller
summary: Retrieve the profile picture URL of a specific number.
description: This endpoint fetches the profile picture URL associated with the given phone number for the specified instance.
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
number:
type: string
description: WhatsApp phone number whose profile picture URL needs to be fetched.
required:
- number
parameters:
- name: instanceName
in: path
required: true
schema:
type: string
description: The name of the instance to which the reaction should be sent.
example: 'codechat'
responses:
'200':
description: Successful response
content:
application/json: {}
/chat/findContacts/{instanceName}:
post:
tags:
- Chat Controller
summary: Retrieve contact details using an ID.
description: This endpoint retrieves contact details associated with the given ID for the specified instance.
requestBody:
content:
application/json:
schema:
type: object
properties:
where:
type: object
properties:
id:
type: string
description: Unique ID of the contact to be fetched.
required:
- id
parameters:
- name: instanceName
in: path
required: true
schema:
type: string
description: The name of the instance to which the reaction should be sent.
example: 'codechat'
responses:
'200':
description: Successful response
content:
application/json: {}
/chat/getBase64FromMediaMessage/{instanceName}:
post:
tags:
- Chat Controller
summary: Convert media message content to Base64.
description: '**[Deprecated]** This endpoint retrieves the Base64 representation of the content of a media message for the specified instance.'
deprecated: true
requestBody:
content:
application/json:
schema:
type: object
properties:
key:
type: object
properties:
id:
type: string
description: Unique ID of the media message to be converted.
required:
- id
parameters:
- name: instanceName
in: path
required: true
schema:
type: string
description: The name of the instance to which the reaction should be sent.
example: 'codechat'
responses:
'200':
description: Successful response
content:
application/json: {}
/chat/retrieverMediaMessage/{instanceName}:
post:
tags:
- Chat Controller
summary: Retriever Media Message.
description: This endpoint retrieves a media file from a given instance.
requestBody:
content:
application/json:
schema:
type: object
properties:
key:
type: object
properties:
id:
type: string
description: Unique ID of the media message to be converted.
required:
- id
parameters:
- name: instanceName
in: path
required: true
schema:
type: string
description: The name of the instance to which the reaction should be sent.
example: 'codechat'
responses:
'200':
description: Successful response
content:
application/octet-stream: {}
/chat/findMessages/{instanceName}:
post:
tags:
- Chat Controller
summary: Search for messages based on specific criteria.
description: This endpoint retrieves messages that match the provided criteria for the specified instance.
requestBody:
content:
application/json:
schema:
type: object
properties:
where:
type: object
properties:
key:
type: object
properties:
remoteJid:
type: string
description: ID of the recipient of the message.
fromMe: