Ajuda IntegraĆ§Ć£o Zap

ReferĆŖncia da API

šŸ”Œ Canais E SessƵes

POST /v2/api/external/{apiId}/createtSession

CreateSession

{"openapi":"3.0.3","info":{"title":"Ajuda IntegraĆ§Ć£o Zap ā€” API Externa","version":"v4.x.x.x"},"tags":[{"name":"šŸ”Œ Canais e SessƵes"}],"servers":[{"url":"https://{baseUrl}","description":"InstalaĆ§Ć£o Ajuda IntegraĆ§Ć£o Zap do cliente","variables":{"baseUrl":{"default":"api.seudominio.com.br","description":"DomĆ­nio do backend Ajuda IntegraĆ§Ć£o Zap, sem protocolo e sem barra final."}}}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Token da API do tenant (na coleĆ§Ć£o Postman: `BearerToken`)."}},"parameters":{"ApiId":{"name":"apiId","in":"path","required":true,"description":"ID da API externa cadastrada no Ajuda IntegraĆ§Ć£o Zap.","schema":{"type":"string"}}}},"paths":{"/v2/api/external/{apiId}/createtSession":{"post":{"tags":["šŸ”Œ Canais e SessƵes"],"summary":"CreateSession","operationId":"CreateSession","parameters":[{"$ref":"#/components/parameters/ApiId"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Nome da instĆ¢ncia do WhatsApp"},"status":{"type":"string","description":"Status inicial da sessĆ£o (DISCONNECTED, CONNECTED)"},"type":{"type":"string","description":"Tipo da sessĆ£o"}}}}}},"responses":{"200":{"description":"RequisiĆ§Ć£o processada com sucesso.","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"ParĆ¢metros invĆ”lidos ou faltando."},"401":{"description":"Token ausente, invĆ”lido ou sem permissĆ£o."}}}}}}

POST /v2/api/external/{apiId}/deleteSession

DeleteSession

{"openapi":"3.0.3","info":{"title":"Ajuda IntegraĆ§Ć£o Zap ā€” API Externa","version":"v4.x.x.x"},"tags":[{"name":"šŸ”Œ Canais e SessƵes"}],"servers":[{"url":"https://{baseUrl}","description":"InstalaĆ§Ć£o Ajuda IntegraĆ§Ć£o Zap do cliente","variables":{"baseUrl":{"default":"api.seudominio.com.br","description":"DomĆ­nio do backend Ajuda IntegraĆ§Ć£o Zap, sem protocolo e sem barra final."}}}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Token da API do tenant (na coleĆ§Ć£o Postman: `BearerToken`)."}},"parameters":{"ApiId":{"name":"apiId","in":"path","required":true,"description":"ID da API externa cadastrada no Ajuda IntegraĆ§Ć£o Zap.","schema":{"type":"string"}}}},"paths":{"/v2/api/external/{apiId}/deleteSession":{"post":{"tags":["šŸ”Œ Canais e SessƵes"],"summary":"DeleteSession","operationId":"DeleteSession","parameters":[{"$ref":"#/components/parameters/ApiId"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"whatsappId":{"type":"integer","description":"ID da sessĆ£o do WhatsApp que serĆ” deletada"}}}}}},"responses":{"200":{"description":"RequisiĆ§Ć£o processada com sucesso.","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"ParĆ¢metros invĆ”lidos ou faltando."},"401":{"description":"Token ausente, invĆ”lido ou sem permissĆ£o."}}}}}}

POST /v2/api/external/{apiId}/requestNewQrCodeSession

RequestNewQrCode

{"openapi":"3.0.3","info":{"title":"Ajuda IntegraĆ§Ć£o Zap ā€” API Externa","version":"v4.x.x.x"},"tags":[{"name":"šŸ”Œ Canais e SessƵes"}],"servers":[{"url":"https://{baseUrl}","description":"InstalaĆ§Ć£o Ajuda IntegraĆ§Ć£o Zap do cliente","variables":{"baseUrl":{"default":"api.seudominio.com.br","description":"DomĆ­nio do backend Ajuda IntegraĆ§Ć£o Zap, sem protocolo e sem barra final."}}}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Token da API do tenant (na coleĆ§Ć£o Postman: `BearerToken`)."}},"parameters":{"ApiId":{"name":"apiId","in":"path","required":true,"description":"ID da API externa cadastrada no Ajuda IntegraĆ§Ć£o Zap.","schema":{"type":"string"}}}},"paths":{"/v2/api/external/{apiId}/requestNewQrCodeSession":{"post":{"tags":["šŸ”Œ Canais e SessƵes"],"summary":"RequestNewQrCode","operationId":"RequestNewQrCode","parameters":[{"$ref":"#/components/parameters/ApiId"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"whatsappId":{"type":"integer","description":"ID da sessĆ£o do WhatsApp que terĆ” um novo QR Code gerado"}}}}}},"responses":{"200":{"description":"RequisiĆ§Ć£o processada com sucesso.","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"ParĆ¢metros invĆ”lidos ou faltando."},"401":{"description":"Token ausente, invĆ”lido ou sem permissĆ£o."}}}}}}

POST /v2/api/external/{apiId}/showChannel

ShowChannelInformation

{"openapi":"3.0.3","info":{"title":"Ajuda IntegraĆ§Ć£o Zap ā€” API Externa","version":"v4.x.x.x"},"tags":[{"name":"šŸ”Œ Canais e SessƵes"}],"servers":[{"url":"https://{baseUrl}","description":"InstalaĆ§Ć£o Ajuda IntegraĆ§Ć£o Zap do cliente","variables":{"baseUrl":{"default":"api.seudominio.com.br","description":"DomĆ­nio do backend Ajuda IntegraĆ§Ć£o Zap, sem protocolo e sem barra final."}}}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Token da API do tenant (na coleĆ§Ć£o Postman: `BearerToken`)."}},"parameters":{"ApiId":{"name":"apiId","in":"path","required":true,"description":"ID da API externa cadastrada no Ajuda IntegraĆ§Ć£o Zap.","schema":{"type":"string"}}}},"paths":{"/v2/api/external/{apiId}/showChannel":{"post":{"tags":["šŸ”Œ Canais e SessƵes"],"summary":"ShowChannelInformation","operationId":"ShowChannelInformation","parameters":[{"$ref":"#/components/parameters/ApiId"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"number":{"type":"string","description":"NĆŗmero do WhatsApp do canal (formato: 5511999999999)"}}}}}},"responses":{"200":{"description":"RequisiĆ§Ć£o processada com sucesso.","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"ParĆ¢metros invĆ”lidos ou faltando."},"401":{"description":"Token ausente, invĆ”lido ou sem permissĆ£o."}}}}}}

POST /v2/api/external/{apiId}/showChannelById

ShowChannelInformationById

{"openapi":"3.0.3","info":{"title":"Ajuda IntegraĆ§Ć£o Zap ā€” API Externa","version":"v4.x.x.x"},"tags":[{"name":"šŸ”Œ Canais e SessƵes"}],"servers":[{"url":"https://{baseUrl}","description":"InstalaĆ§Ć£o Ajuda IntegraĆ§Ć£o Zap do cliente","variables":{"baseUrl":{"default":"api.seudominio.com.br","description":"DomĆ­nio do backend Ajuda IntegraĆ§Ć£o Zap, sem protocolo e sem barra final."}}}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Token da API do tenant (na coleĆ§Ć£o Postman: `BearerToken`)."}},"parameters":{"ApiId":{"name":"apiId","in":"path","required":true,"description":"ID da API externa cadastrada no Ajuda IntegraĆ§Ć£o Zap.","schema":{"type":"string"}}}},"paths":{"/v2/api/external/{apiId}/showChannelById":{"post":{"tags":["šŸ”Œ Canais e SessƵes"],"summary":"ShowChannelInformationById","operationId":"ShowChannelInformationById","parameters":[{"$ref":"#/components/parameters/ApiId"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","description":"ID do canal que serĆ” consultado"}}}}}},"responses":{"200":{"description":"RequisiĆ§Ć£o processada com sucesso.","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"ParĆ¢metros invĆ”lidos ou faltando."},"401":{"description":"Token ausente, invĆ”lido ou sem permissĆ£o."}}}}}}

POST /v2/api/external/{apiId}/qrCodeSession

ShowQrCode

{"openapi":"3.0.3","info":{"title":"Ajuda IntegraĆ§Ć£o Zap ā€” API Externa","version":"v4.x.x.x"},"tags":[{"name":"šŸ”Œ Canais e SessƵes"}],"servers":[{"url":"https://{baseUrl}","description":"InstalaĆ§Ć£o Ajuda IntegraĆ§Ć£o Zap do cliente","variables":{"baseUrl":{"default":"api.seudominio.com.br","description":"DomĆ­nio do backend Ajuda IntegraĆ§Ć£o Zap, sem protocolo e sem barra final."}}}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Token da API do tenant (na coleĆ§Ć£o Postman: `BearerToken`)."}},"parameters":{"ApiId":{"name":"apiId","in":"path","required":true,"description":"ID da API externa cadastrada no Ajuda IntegraĆ§Ć£o Zap.","schema":{"type":"string"}}}},"paths":{"/v2/api/external/{apiId}/qrCodeSession":{"post":{"tags":["šŸ”Œ Canais e SessƵes"],"summary":"ShowQrCode","operationId":"ShowQrCode","parameters":[{"$ref":"#/components/parameters/ApiId"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"whatsappId":{"type":"integer","description":"ID da sessĆ£o do WhatsApp que terĆ” o QR Code gerado"}}}}}},"responses":{"200":{"description":"RequisiĆ§Ć£o processada com sucesso.","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"ParĆ¢metros invĆ”lidos ou faltando."},"401":{"description":"Token ausente, invĆ”lido ou sem permissĆ£o."}}}}}}

POST /v2/api/external/{apiId}/startSession

StartSession

{"openapi":"3.0.3","info":{"title":"Ajuda IntegraĆ§Ć£o Zap ā€” API Externa","version":"v4.x.x.x"},"tags":[{"name":"šŸ”Œ Canais e SessƵes"}],"servers":[{"url":"https://{baseUrl}","description":"InstalaĆ§Ć£o Ajuda IntegraĆ§Ć£o Zap do cliente","variables":{"baseUrl":{"default":"api.seudominio.com.br","description":"DomĆ­nio do backend Ajuda IntegraĆ§Ć£o Zap, sem protocolo e sem barra final."}}}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Token da API do tenant (na coleĆ§Ć£o Postman: `BearerToken`)."}},"parameters":{"ApiId":{"name":"apiId","in":"path","required":true,"description":"ID da API externa cadastrada no Ajuda IntegraĆ§Ć£o Zap.","schema":{"type":"string"}}}},"paths":{"/v2/api/external/{apiId}/startSession":{"post":{"tags":["šŸ”Œ Canais e SessƵes"],"summary":"StartSession","operationId":"StartSession","parameters":[{"$ref":"#/components/parameters/ApiId"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"whatsappId":{"type":"integer","description":"ID da sessĆ£o do WhatsApp que serĆ” iniciada"}}}}}},"responses":{"200":{"description":"RequisiĆ§Ć£o processada com sucesso.","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"ParĆ¢metros invĆ”lidos ou faltando."},"401":{"description":"Token ausente, invĆ”lido ou sem permissĆ£o."}}}}}}