forked from EvolutionAPI/evolution-api
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathswagger.yaml
More file actions
2777 lines (2757 loc) · 88.7 KB
/
swagger.yaml
File metadata and controls
2777 lines (2757 loc) · 88.7 KB
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
openapi: 3.0.0
info:
title: Evolution 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://evolution-api.com/whatsapp)
[](https://evolution-api.com/discord)
[](https://evolution-api.com/postman)
[](https://doc.evolution-api.com)
[](./LICENSE)
[](https://app.picpay.com/user/davidsongomes1998)
[](https://bmc.link/evolutionapi)
</div>
<div align="center"><img src="https://raw.githubusercontent.com/EvolutionAPI/evolution-api/main/public/images/cover.png"></div>
<font size='3'>
This project is based on the [evolution](https://github.com/code-chat-br/whatsapp-api). The original project is an implementation of [Baileys](https://github.com/WhiskeySockets/Baileys), serving as a Restful API service that controls WhatsApp functions.</br>
The code allows the creation of multiservice chats, service bots, or any other system that utilizes WhatsApp. The documentation provides instructions on how to set up and use the project, as well as additional information about its features and configuration options.
</font>
[](https://god.gw.postman.com/run-collection/26869335-5546d063-156b-4529-915f-909dd628c090?action=collection%2Ffork&source=rip_markdown&collection-url=entityId%3D26869335-5546d063-156b-4529-915f-909dd628c090%26entityType%3Dcollection%26workspaceId%3D339a4ee7-378b-45c9-b5b8-fd2c0a9c2442)
version: 1.8.2
contact:
name: DavidsonGomes
email: contato@agenciadgcode.com
url: https://img.shields.io/badge/license-GPL--3.0-orange
license:
name: GNU General Public License v3.0
url: https://github.com/EvolutionAPI/evolution-api/blob/main/LICENSE
servers: []
components:
securitySchemes:
apikeyAuth:
type: apiKey
in: header
name: apikey
bearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
security:
- bearerAuth: []
tags:
- name: Instance Controller
- name: Send Message Controller
- name: Chat Controller
- name: Group Controller
- name: Label Controller
- name: Profile Settings
- name: JWT
- name: Settings
- name: Webhook
- name: Websocket
- name: RabbitMQ
- name: Chatwoot
- name: Typebot
- name: Proxy
- name: Chama AI
paths:
/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).
token:
type: string
description: Token of the instance (optional).
qrcode:
type: boolean
description: QR Code of the instance (optional).
example:
instanceName: "exampleInstance"
token: "87F3F7D0-4B8A-45D0-8618-7399E4AD6469"
qrcode: true
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: "evolution"
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
profileStatus:
type: string
status:
type: string
serverUrl:
type: string
apikey:
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: "evolution"
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/restart/{instanceName}:
put:
tags:
- Instance Controller
summary: Instance Restart
parameters:
- name: instanceName
in: path
required: true
schema:
type: string
description: Connect to your instance.
example: "evolution"
responses:
"200":
description: Successful response
content:
application/json: {}
/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: "evolution"
security:
- apikeyAuth: []
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: "evolution"
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: "evolution"
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.
linkPreview:
type: boolean
description: Indicates whether to enable link preview.
quoted:
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 message was sent from the user.
id:
type: string
description: The ID of the original message.
message:
type: object
properties:
conversation:
type: string
description: The content of the quoted message.
mentions:
type: object
properties:
everyone:
type: boolean
description: Indicates whether to mention everyone.
mentioned:
type: array
items:
type: string
description: The phone numbers of the users to be mentioned.
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: "evolution"
responses:
"200":
description: Successful response
content:
application/json: {}
/message/sendStatus/{instanceName}:
post:
tags:
- Send Message Controller
summary: Send a status message.
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
statusMessage:
type: object
properties:
type:
type: string
enum: ["text", "image", "video", "audio"]
description: Type of the status message.
content:
type: string
description: The content of the status message.
backgroundColor:
type: string
description: The background color of the status message.
font:
type: integer
enum: [1, 2, 3, 4, 5]
description: The font of the status message.
allContacts:
type: boolean
description: Indicates whether to send the status message to all contacts.
statusJidList:
type: array
items:
type: string
description: The phone numbers of the users to whom the status message should be sent.
required:
- type
parameters:
- name: instanceName
in: path
required: true
schema:
type: string
description: The name of the instance to which the status message should be sent.
example: "evolution"
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.
linkPreview:
type: boolean
description: Indicates whether to enable link preview.
quoted:
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 message was sent from the user.
id:
type: string
description: The ID of the original message.
message:
type: object
properties:
conversation:
type: string
description: The content of the quoted message.
mentions:
type: object
properties:
everyone:
type: boolean
description: Indicates whether to mention everyone.
mentioned:
type: array
items:
type: string
description: The phone numbers of the users to be mentioned.
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: "evolution"
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 message.
presence:
type: string
enum: ["composing", "recording", "paused"]
description: Indicates the sender's action/status.
linkPreview:
type: boolean
description: Indicates whether to enable link preview.
quoted:
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 message was sent from the user.
id:
type: string
description: The ID of the original message.
message:
type: object
properties:
conversation:
type: string
description: The content of the quoted message.
mentions:
type: object
properties:
everyone:
type: boolean
description: Indicates whether to mention everyone.
mentioned:
type: array
items:
type: string
description: The phone numbers of the users to be mentioned.
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: "evolution"
responses:
"200":
description: Successful response
content:
application/json: {}
/message/sendSticker/{instanceName}:
post:
tags:
- Send Message Controller
summary: Send an sticker to a specified instance.
description: This endpoint allows users to share an sticker message.
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
number:
type: string
description: The recipient's phone number.
example: "1234567890"
stickerMessage:
type: object
properties:
image:
type: string
description: URL of the audio file to be sent.
required:
- image
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
- 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: "evolution"
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.
linkPreview:
type: boolean
description: Indicates whether to enable link preview.
quoted:
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 message was sent from the user.
id:
type: string
description: The ID of the original message.
message:
type: object
properties:
conversation:
type: string
description: The content of the quoted message.
mentions:
type: object
properties:
everyone:
type: boolean
description: Indicates whether to mention everyone.
mentioned:
type: array
items:
type: string
description: The phone numbers of the users to be mentioned.
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: "evolution"
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.
organization:
type: string
description: Organization of the contact.
email:
type: string
description: Email address of the contact.
url:
type: string
description: Url of the contact.
required:
- fullName
- wuid
- phoneNumber
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.
linkPreview:
type: boolean
description: Indicates whether to enable link preview.
quoted:
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 message was sent from the user.
id:
type: string
description: The ID of the original message.
message:
type: object
properties:
conversation:
type: string
description: The content of the quoted message.
mentions:
type: object
properties:
everyone:
type: boolean
description: Indicates whether to mention everyone.
mentioned:
type: array
items:
type: string
description: The phone numbers of the users to be mentioned.
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: "evolution"
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: "evolution"
responses:
"200":
description: Successful response
content:
application/json: {}
/message/sendPoll/{instanceName}:
post:
tags:
- Send Message Controller
summary: Send a poll to a specified instance.
description: This endpoint allows users to send a poll to a chat.
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
number:
type: string
description: The recipient's phone number.
example: "1234567890"
pollMessage:
type: object
properties:
name:
type: string
description: Name or title of the poll.
selectableCount:
type: integer
description: Number of selectable options.
values:
type: array
items:
type: string
description: The options of the poll.
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.
linkPreview:
type: boolean
description: Indicates whether to enable link preview.
quoted:
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 message was sent from the user.
id:
type: string
description: The ID of the original message.
message:
type: object
properties:
conversation:
type: string
description: The content of the quoted message.
mentions:
type: object
properties:
everyone:
type: boolean
description: Indicates whether to mention everyone.
mentioned:
type: array
items:
type: string
description: The phone numbers of the users to be mentioned.
parameters:
- name: instanceName
in: path
required: true
schema:
type: string
description: The name of the instance to which the poll should be sent.
example: "evolution"
responses:
"200":
description: Successful response
content:
application/json: {}
/message/sendList/{instanceName}:
post:
tags:
- Send Message Controller
summary: Send a list to a specified instance.
description: This endpoint allows users to send a list to a chat.
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
number:
type: string
options:
type: object
properties:
delay:
type: integer
presence:
type: string
listMessage:
type: object
properties:
title:
type: string
description:
type: string
footerText:
type: string
nullable: true
buttonText:
type: string
sections:
type: array
items:
type: object
properties:
title:
type: string
rows:
type: array
items:
type: object
properties:
title:
type: string
description:
type: string
rowId:
type: string
parameters:
- name: instanceName
in: path