-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathZ-API Collection.postman_collection.json
More file actions
6707 lines (6707 loc) · 193 KB
/
Z-API Collection.postman_collection.json
File metadata and controls
6707 lines (6707 loc) · 193 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
{
"info": {
"_postman_id": "c6d36a93-7db4-4fc2-ba6f-ca7f01fda9aa",
"name": "Z-API Collection",
"description": "Link da documentação completa: [https://developer.z-api.io/](https://developer.z-api.io/)\n\n## Z-API - Asas para sua imaginação!\n\n**Z-API** foi desenvolvido por **programadores para programadores**, por isso prezamos pela simplicidade e objetividade de tudo que nos propomos a fazer, sendo assim chega de conversa fiada e **Let's Bora!**\n\n## Mas o que é Z-API\n\nVocê provavelmente já deve saber, mas vamos reafirmar!\n\n**Z-API** é um serviço RestFul que provê uma API que permite que você interaja com seu Whatsapp através uma API simples e intuitiva, além de webhooks para te avisar sobre interações com seu número.",
"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json",
"_exporter_id": "39368987"
},
"item": [
{
"name": "Instance",
"item": [
{
"name": "Meu perfil",
"item": [
{
"name": "Atualizar nome do perfil",
"request": {
"method": "PUT",
"header": [
{
"key": "Client-Token",
"value": "{{CLIENT_TOKEN}}",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"value\": \"Vinicius\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{BASE_URL}}/instances/{{INSTANCE_ID}}/token/{{INSTANCE_TOKEN}}/profile-name",
"host": [
"{{BASE_URL}}"
],
"path": [
"instances",
"{{INSTANCE_ID}}",
"token",
"{{INSTANCE_TOKEN}}",
"profile-name"
]
},
"description": "Este método é responsável por alterar o seu nome de perfil no Whatsapp"
},
"response": []
},
{
"name": "Atualizar imagem de perfil",
"request": {
"method": "PUT",
"header": [
{
"key": "Client-Token",
"value": "{{CLIENT_TOKEN}}",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"value\": \"https://app.z-api.io/logos/zapi-dark.png\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{BASE_URL}}/instances/{{INSTANCE_ID}}/token/{{INSTANCE_TOKEN}}/profile-picture",
"host": [
"{{BASE_URL}}"
],
"path": [
"instances",
"{{INSTANCE_ID}}",
"token",
"{{INSTANCE_TOKEN}}",
"profile-picture"
]
},
"description": "Este método é responsável por alterar a sua imagem de perfil no Whatsapp."
},
"response": []
},
{
"name": "Atualizar descrição do perfil",
"request": {
"method": "PUT",
"header": [
{
"key": "Client-Token",
"value": "{{CLIENT_TOKEN}}",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"value\": \"Descrição do perfil\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{BASE_URL}}/instances/{{INSTANCE_ID}}/token/{{INSTANCE_TOKEN}}/profile-description",
"host": [
"{{BASE_URL}}"
],
"path": [
"instances",
"{{INSTANCE_ID}}",
"token",
"{{INSTANCE_TOKEN}}",
"profile-description"
]
},
"description": "Este método é responsável por alterar a sua descrição de perfil no Whatsapp"
},
"response": []
}
]
},
{
"name": "Ligações",
"item": [
{
"name": "Rejeitar chamadas",
"request": {
"method": "PUT",
"header": [
{
"key": "Client-Token",
"value": "{{CLIENT_TOKEN}}",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"value\": true\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{BASE_URL}}/instances/{{INSTANCE_ID}}/token/{{INSTANCE_TOKEN}}/update-call-reject-auto",
"host": [
"{{BASE_URL}}"
],
"path": [
"instances",
"{{INSTANCE_ID}}",
"token",
"{{INSTANCE_TOKEN}}",
"update-call-reject-auto"
]
},
"description": "Esse método ativa a opção de Rejeitar chamadas automático na sua API, com ela ativa todas as chamadas de voz recebidas pelo número conectado a API serão rejeitadas de forma automática."
},
"response": []
},
{
"name": "Mensagem de ligação",
"request": {
"method": "PUT",
"header": [
{
"key": "Client-Token",
"value": "{{CLIENT_TOKEN}}",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"value\": \"Mensagem de resposta de ligação rejeitada\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{BASE_URL}}/instances/{{INSTANCE_ID}}/token/{{INSTANCE_TOKEN}}/update-call-reject-message",
"host": [
"{{BASE_URL}}"
],
"path": [
"instances",
"{{INSTANCE_ID}}",
"token",
"{{INSTANCE_TOKEN}}",
"update-call-reject-message"
]
},
"description": "Através desse método você define a mensagem que será enviada após rejeitar a chamada de voz recebida pela API."
},
"response": []
}
]
},
{
"name": "Pegar QRCode",
"item": [
{
"name": "Pegar QRCode - bytes",
"request": {
"method": "GET",
"header": [
{
"key": "Client-Token",
"value": "{{CLIENT_TOKEN}}",
"type": "text"
}
],
"url": {
"raw": "{{BASE_URL}}/instances/{{INSTANCE_ID}}/token/{{INSTANCE_TOKEN}}/qr-code",
"host": [
"{{BASE_URL}}"
],
"path": [
"instances",
"{{INSTANCE_ID}}",
"token",
"{{INSTANCE_TOKEN}}",
"qr-code"
]
},
"description": "Este método retorna os bytes do QRCode. Você poderá renderizar em um componente do tipo QRCode compatível com sua linguagem de programação."
},
"response": []
},
{
"name": "Pegar QRCode - imagem",
"request": {
"method": "GET",
"header": [
{
"key": "Client-Token",
"value": "{{CLIENT_TOKEN}}",
"type": "text"
}
],
"url": {
"raw": "{{BASE_URL}}/instances/{{INSTANCE_ID}}/token/{{INSTANCE_TOKEN}}/qr-code/image",
"host": [
"{{BASE_URL}}"
],
"path": [
"instances",
"{{INSTANCE_ID}}",
"token",
"{{INSTANCE_TOKEN}}",
"qr-code",
"image"
]
},
"description": "Este método retorna uma imagem do tipo base64. Você poderá renderizar em um componente do tipo imagem compatível com sua linguagem de programação."
},
"response": []
},
{
"name": "Pegar QRCode - Telefone",
"request": {
"method": "GET",
"header": [
{
"key": "Client-Token",
"value": "{{CLIENT_TOKEN}}",
"type": "text"
}
],
"url": {
"raw": "{{BASE_URL}}/instances/{{INSTANCE_ID}}/token/{{INSTANCE_TOKEN}}/phone-code/{PHONE_NUMBER}",
"host": [
"{{BASE_URL}}"
],
"path": [
"instances",
"{{INSTANCE_ID}}",
"token",
"{{INSTANCE_TOKEN}}",
"phone-code",
"{PHONE_NUMBER}"
]
},
"description": "Este método retorna um código para que seja possível conectar o número a API sem a necessidade de leitura de qr-code, apenas inserindo o código gerado.\n\nVocê pode inserir o código gerado através da API diretamente no whatsapp, na mesma aba onde é feita a leitura do qr-code, clicando em \"Conectar com número de telefone\".\n\nAtenção: você deve preencher o parâmetro {PHONE_NUMBER} com o número que deseja conectar o seu celular."
},
"response": []
}
]
},
{
"name": "Minha instância",
"item": [
{
"name": "Reiniciar instância",
"request": {
"method": "GET",
"header": [
{
"key": "Client-Token",
"value": "{{CLIENT_TOKEN}}",
"type": "text"
}
],
"url": {
"raw": "{{BASE_URL}}/instances/{{INSTANCE_ID}}/token/{{INSTANCE_TOKEN}}/restart",
"host": [
"{{BASE_URL}}"
],
"path": [
"instances",
"{{INSTANCE_ID}}",
"token",
"{{INSTANCE_TOKEN}}",
"restart"
]
},
"description": "Este método basicamente é o botão \"Reiniciar\" do seu sistema operacional ou seja, como todo usuário expert, em casos onde tudo parece dar errado tente control+alt+del ou reinicia!"
},
"response": []
},
{
"name": "Desconectar instância",
"request": {
"method": "GET",
"header": [
{
"key": "Client-Token",
"value": "{{CLIENT_TOKEN}}",
"type": "text"
}
],
"url": {
"raw": "{{BASE_URL}}/instances/{{INSTANCE_ID}}/token/{{INSTANCE_TOKEN}}/disconnect",
"host": [
"{{BASE_URL}}"
],
"path": [
"instances",
"{{INSTANCE_ID}}",
"token",
"{{INSTANCE_TOKEN}}",
"disconnect"
]
},
"description": "Este método desconecta seu número do Z-API."
},
"response": []
},
{
"name": "Status da instância",
"request": {
"method": "GET",
"header": [
{
"key": "Client-Token",
"value": "{{CLIENT_TOKEN}}",
"type": "text"
}
],
"url": {
"raw": "{{BASE_URL}}/instances/{{INSTANCE_ID}}/token/{{INSTANCE_TOKEN}}/status",
"host": [
"{{BASE_URL}}"
],
"path": [
"instances",
"{{INSTANCE_ID}}",
"token",
"{{INSTANCE_TOKEN}}",
"status"
]
},
"description": "Este método te permite descobrir se sua instância está ou não conectada a uma conta de Whatsapp."
},
"response": []
},
{
"name": "Renomear instância",
"request": {
"method": "PUT",
"header": [
{
"key": "Client-Token",
"value": "{{CLIENT_TOKEN}}",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"value\": \"Novo nome da instância\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{BASE_URL}}/instances/{{INSTANCE_ID}}/token/{{INSTANCE_TOKEN}}/update-name",
"host": [
"{{BASE_URL}}"
],
"path": [
"instances",
"{{INSTANCE_ID}}",
"token",
"{{INSTANCE_TOKEN}}",
"update-name"
]
},
"description": "Método utilizado para renomear uma instância."
},
"response": []
},
{
"name": "Dados da instância",
"request": {
"method": "GET",
"header": [
{
"key": "Client-Token",
"value": "{{CLIENT_TOKEN}}",
"type": "text"
}
],
"url": {
"raw": "{{BASE_URL}}/instances/{{INSTANCE_ID}}/token/{{INSTANCE_TOKEN}}/me",
"host": [
"{{BASE_URL}}"
],
"path": [
"instances",
"{{INSTANCE_ID}}",
"token",
"{{INSTANCE_TOKEN}}",
"me"
]
},
"description": "Este método te permite obter os dados da sua instância."
},
"response": []
}
]
},
{
"name": "Leitura automática",
"request": {
"method": "PUT",
"header": [
{
"key": "Client-Token",
"value": "{{CLIENT_TOKEN}}",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"value\": false\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{BASE_URL}}/instances/{{INSTANCE_ID}}/token/{{INSTANCE_TOKEN}}/update-auto-read-message",
"host": [
"{{BASE_URL}}"
],
"path": [
"instances",
"{{INSTANCE_ID}}",
"token",
"{{INSTANCE_TOKEN}}",
"update-auto-read-message"
]
},
"description": "Esse método ativa a leitura automática de todas as mensagens recebidas pela API."
},
"response": []
},
{
"name": "Dados do celular",
"request": {
"method": "GET",
"header": [
{
"key": "Client-Token",
"value": "{{CLIENT_TOKEN}}",
"type": "text"
}
],
"url": {
"raw": "{{BASE_URL}}/instances/{{INSTANCE_ID}}/token/{{INSTANCE_TOKEN}}/device",
"host": [
"{{BASE_URL}}"
],
"path": [
"instances",
"{{INSTANCE_ID}}",
"token",
"{{INSTANCE_TOKEN}}",
"device"
]
},
"description": "Este método é responsável por retornar informações sobre o device/celular conectado."
},
"response": []
}
],
"description": "Uma instância é uma conexão a partir de um número de telefone com conta no WhatsApp, que será responsável pelo envio e recebimento de mensagens. É possível criar várias instâncias para que você consiga ter vários números de WhatsApp conectado a sua conta.\n\nTecnicamente falando uma instância nada mais é do que uma máquina virtual (ou container) dentro da nossa infraestrutura de servidores, dedicada a prover um ambiente para conexão do seu número.\n\nCada instância só possui um número, caso precise conectar mais números será necessário criar mais instâncias. Mas uma instância não é presa a um único número, ou seja, você pode desconectar um número e conectar outro na mesma instância.\n\nPara ajudar você a entender o funcionamento do Z-API, nosso serviço roda com base em um Whatsapp Web, e abstraímos os métodos permitindo que você manipule via API RestFul.\n\nPara melhor tangibilizar, nos próximos tópicos vamos de forma ordenada te ajudar nos primeiros passos."
},
{
"name": "Mobile",
"item": [
{
"name": "Registro do dispositivo",
"item": [
{
"name": "Verificar disponibilidade de registro",
"request": {
"method": "POST",
"header": [
{
"key": "Client-Token",
"value": "{{CLIENT_TOKEN}}",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"ddi\": \"55\",\n \"phone\": \"4499999999\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{BASE_URL}}/instances/{{INSTANCE_ID}}/token/{{INSTANCE_TOKEN}}/mobile/registration-available",
"host": [
"{{BASE_URL}}"
],
"path": [
"instances",
"{{INSTANCE_ID}}",
"token",
"{{INSTANCE_TOKEN}}",
"mobile",
"registration-available"
]
},
"description": "Método utilizado para verificar disponibilidade de registro de um número. Este método é obrigatóriamente **precedente** ao método de solicitar o envio do código, pois além de buscar as informções sobre a disponibilidade, também realiza um setup de onboarding do número no WhatsApp. Através dessa API você também pode ver os métodos disponíveis para solicitação do código de confirmação, além de saber se o número está banido ou não."
},
"response": []
},
{
"name": "Solicitar código de confirmação",
"request": {
"method": "POST",
"header": [
{
"key": "Client-Token",
"value": "{{CLIENT_TOKEN}}",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"ddi\": \"55\",\n \"phone\": \"4499999999\",\n \"method\": \"sms\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{BASE_URL}}/instances/{{INSTANCE_ID}}/token/{{INSTANCE_TOKEN}}/mobile/request-registration-code",
"host": [
"{{BASE_URL}}"
],
"path": [
"instances",
"{{INSTANCE_ID}}",
"token",
"{{INSTANCE_TOKEN}}",
"mobile",
"request-registration-code"
]
},
"description": "Método utilizado para solicitar o envio do código de confirmação. Para executar esse método, é necessário que antes você [<b>verifique se o número está disponível</b>](https://developer.z-api.io/mobile/registration-available) para ser registrado. Sem antes fazer essa verificação, não será possível solicitar o código."
},
"response": []
},
{
"name": "Responder captcha",
"request": {
"method": "POST",
"header": [
{
"key": "Client-Token",
"value": "{{CLIENT_TOKEN}}",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"captcha\": \"123456\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{BASE_URL}}/instances/{{INSTANCE_ID}}/token/{{INSTANCE_TOKEN}}/mobile/respond-captcha",
"host": [
"{{BASE_URL}}"
],
"path": [
"instances",
"{{INSTANCE_ID}}",
"token",
"{{INSTANCE_TOKEN}}",
"mobile",
"respond-captcha"
]
},
"description": "Método utilizado para responder ao captcha necessário para envio do código de confirmação. Esse método somente se faz necessário se a API de [<b>solicitar código</b>](https://developer.z-api.io/mobile/request-code) responder com o atributo \"captcha\", que por sua vez, contém o base64 da imagem com o captcha."
},
"response": []
},
{
"name": "Confirmar código de conta",
"request": {
"method": "POST",
"header": [
{
"key": "Client-Token",
"value": "{{CLIENT_TOKEN}}",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"code\": \"123456\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{BASE_URL}}/instances/{{INSTANCE_ID}}/token/{{INSTANCE_TOKEN}}/mobile/confirm-registration-code",
"host": [
"{{BASE_URL}}"
],
"path": [
"instances",
"{{INSTANCE_ID}}",
"token",
"{{INSTANCE_TOKEN}}",
"mobile",
"confirm-registration-code"
]
},
"description": "Método utilizado para confirmar o código que você recebeu. Para utilizar esse método, você precisa concluir as etapas de registro anteriores, que envolvem verificar a disponibilidade de registro do número e solicitar o código de confirmação. Após recebido o código, você pode utilizar essa rota para realizar a confirmação e conexão do número à instância mobile."
},
"response": []
}
]
},
{
"name": "Código PIN",
"item": [
{
"name": "Confirmar código PIN",
"request": {
"method": "POST",
"header": [
{
"key": "Client-Token",
"value": "{{CLIENT_TOKEN}}",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"code\": \"123456\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{BASE_URL}}/instances/{{INSTANCE_ID}}/token/{{INSTANCE_TOKEN}}/mobile/confirm-pin-code",
"host": [
"{{BASE_URL}}"
],
"path": [
"instances",
"{{INSTANCE_ID}}",
"token",
"{{INSTANCE_TOKEN}}",
"mobile",
"confirm-pin-code"
]
},
"description": "Método utilizado para confirmar código PIN da sua conta. Esse método somente é necessário caso você tenha configurado a verificação em duas etapas no WhatsApp. Se esse for o seu caso, é necessário que esse código PIN seja confirmado, caso contrário, não será possível conectar o número em uma instância mobile."
},
"response": []
},
{
"name": "Recuperar código PIN",
"request": {
"method": "POST",
"header": [
{
"key": "Client-Token",
"value": "{{CLIENT_TOKEN}}",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{BASE_URL}}/instances/{{INSTANCE_ID}}/token/{{INSTANCE_TOKEN}}/mobile/recover-pin-code",
"host": [
"{{BASE_URL}}"
],
"path": [
"instances",
"{{INSTANCE_ID}}",
"token",
"{{INSTANCE_TOKEN}}",
"mobile",
"recover-pin-code"
]
},
"description": "Método utilizado para solicitar email para recuperação do código PIN da sua conta. Esse será útil caso você tenha configurado a verificação em duas etapas no WhatsApp e não se lembre mais desse código. Dessa forma, o WhatsApp enviará um link para redefinição de código PIN no email que você vinculou à sua conta do WhatsApp."
},
"response": []
},
{
"name": "Verificar se possui código PIN",
"protocolProfileBehavior": {
"disableBodyPruning": true
},
"request": {
"method": "GET",
"header": [
{
"key": "Client-Token",
"value": "{{CLIENT_TOKEN}}",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"verificationCode\": \"123456\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{BASE_URL}}/instances/{{INSTANCE_ID}}/token/{{INSTANCE_TOKEN}}/security/two-fa-code",
"host": [
"{{BASE_URL}}"
],
"path": [
"instances",
"{{INSTANCE_ID}}",
"token",
"{{INSTANCE_TOKEN}}",
"security",
"two-fa-code"
]
},
"description": "Método utilizado para buscar se sua conta possui um código PIN de segurança cadastrado."
},
"response": []
},
{
"name": "Cadastrar código PIN",
"request": {
"method": "POST",
"header": [
{
"key": "Client-Token",
"value": "{{CLIENT_TOKEN}}",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"code\": \"123456\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{BASE_URL}}/instances/{{INSTANCE_ID}}/token/{{INSTANCE_TOKEN}}/security/two-fa-code",
"host": [
"{{BASE_URL}}"
],
"path": [
"instances",
"{{INSTANCE_ID}}",
"token",
"{{INSTANCE_TOKEN}}",
"security",
"two-fa-code"
]
},
"description": "Método utilizado para cadastrar um código PIN de segurança na sua conta do WhatsApp."
},
"response": []
},
{
"name": "Remover código PIN",
"request": {
"method": "POST",
"header": [
{
"key": "Client-Token",
"value": "{{CLIENT_TOKEN}}",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{BASE_URL}}/instances/{{INSTANCE_ID}}/token/{{INSTANCE_TOKEN}}/security/two-fa-code/remove",
"host": [
"{{BASE_URL}}"
],
"path": [
"instances",
"{{INSTANCE_ID}}",
"token",
"{{INSTANCE_TOKEN}}",
"security",
"two-fa-code",
"remove"
]
},
"description": "Método utilizado para remover o código PIN de segurança da conta."
},
"response": []
}
]
},
{
"name": "Email",
"item": [
{
"name": "Buscar email da conta",
"protocolProfileBehavior": {
"disableBodyPruning": true
},
"request": {
"method": "GET",
"header": [
{
"key": "Client-Token",
"value": "{{CLIENT_TOKEN}}",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{BASE_URL}}/instances/{{INSTANCE_ID}}/token/{{INSTANCE_TOKEN}}/security/email",
"host": [
"{{BASE_URL}}"
],
"path": [
"instances",
"{{INSTANCE_ID}}",
"token",
"{{INSTANCE_TOKEN}}",
"security",
"email"
]
},
"description": "Método utilizado para buscar o email configurado na conta do WhatsApp."
},
"response": []
},
{
"name": "Cadastrar email da conta",
"request": {
"method": "POST",
"header": [
{
"key": "Client-Token",
"value": "{{CLIENT_TOKEN}}",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"email\": \"example@email.com\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{BASE_URL}}/instances/{{INSTANCE_ID}}/token/{{INSTANCE_TOKEN}}/security/email",
"host": [
"{{BASE_URL}}"
],
"path": [
"instances",
"{{INSTANCE_ID}}",
"token",
"{{INSTANCE_TOKEN}}",
"security",
"email"
]
},
"description": "Método utilizado para cadastrar um email na sua conta do WhatsApp. Esse email pode ser utilizado mais tarde para recuperação do código PIN de segurança da sua conta."
},
"response": []
},
{
"name": "Verificar email da conta",
"request": {
"method": "POST",
"header": [
{
"key": "Client-Token",
"value": "{{CLIENT_TOKEN}}",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"verificationCode\": \"123456\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{BASE_URL}}/instances/{{INSTANCE_ID}}/token/{{INSTANCE_TOKEN}}/security/verify-email",
"host": [
"{{BASE_URL}}"
],
"path": [
"instances",
"{{INSTANCE_ID}}",
"token",
"{{INSTANCE_TOKEN}}",
"security",
"verify-email"
]
},
"description": "Método utilizado para realizar verificação do email da conta. Você pode cadastrar um email na sua conta do WhatsApp através da API de [<b>Cadastrar email na conta</b>](https://developer.z-api.io/mobile/set-account-email)."
},
"response": []
},
{