Central de ajuda

Referência da API

📊 Listagens

GET /v2/api/external/{apiId}/getAllSessionApis

GetAllSessionApis

{"openapi":"3.0.3","info":{"title":"sistema — API Externa","version":"v4.x.x.x"},"tags":[{"name":"📊 Listagens"}],"servers":[{"url":"https://{baseUrl}","description":"Instalação sistema do cliente","variables":{"baseUrl":{"default":"api.seudominio.com.br","description":"Domínio do backend sistema, 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 sistema.","schema":{"type":"string"}}}},"paths":{"/v2/api/external/{apiId}/getAllSessionApis":{"get":{"tags":["📊 Listagens"],"summary":"GetAllSessionApis","operationId":"GetAllSessionApis","parameters":[{"$ref":"#/components/parameters/ApiId"}],"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."}}}}}}

GET /v2/api/external/{apiId}/listChannels

ListChannels

{"openapi":"3.0.3","info":{"title":"sistema — API Externa","version":"v4.x.x.x"},"tags":[{"name":"📊 Listagens"}],"servers":[{"url":"https://{baseUrl}","description":"Instalação sistema do cliente","variables":{"baseUrl":{"default":"api.seudominio.com.br","description":"Domínio do backend sistema, 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 sistema.","schema":{"type":"string"}}}},"paths":{"/v2/api/external/{apiId}/listChannels":{"get":{"tags":["📊 Listagens"],"summary":"ListChannels","operationId":"ListChannels","parameters":[{"$ref":"#/components/parameters/ApiId"}],"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."}}}}}}

GET /v2/api/external/{apiId}/listContacts

ListContacts

{"openapi":"3.0.3","info":{"title":"sistema — API Externa","version":"v4.x.x.x"},"tags":[{"name":"📊 Listagens"}],"servers":[{"url":"https://{baseUrl}","description":"Instalação sistema do cliente","variables":{"baseUrl":{"default":"api.seudominio.com.br","description":"Domínio do backend sistema, 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 sistema.","schema":{"type":"string"}}}},"paths":{"/v2/api/external/{apiId}/listContacts":{"get":{"tags":["📊 Listagens"],"summary":"ListContacts","operationId":"ListContacts","parameters":[{"$ref":"#/components/parameters/ApiId"},{"name":"pageNumber","in":"query","required":false,"description":"Número da página","schema":{"type":"integer"}}],"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."}}}}}}

GET /v2/api/external/{apiId}/listOpportunities

ListOpportunities

{"openapi":"3.0.3","info":{"title":"sistema — API Externa","version":"v4.x.x.x"},"tags":[{"name":"📊 Listagens"}],"servers":[{"url":"https://{baseUrl}","description":"Instalação sistema do cliente","variables":{"baseUrl":{"default":"api.seudominio.com.br","description":"Domínio do backend sistema, 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 sistema.","schema":{"type":"string"}}}},"paths":{"/v2/api/external/{apiId}/listOpportunities":{"get":{"tags":["📊 Listagens"],"summary":"ListOpportunities","operationId":"ListOpportunities","parameters":[{"$ref":"#/components/parameters/ApiId"},{"name":"page","in":"query","required":false,"description":"Número da página","schema":{"type":"integer"}},{"name":"limit","in":"query","required":false,"description":"Limite de resultados por página","schema":{"type":"integer"}}],"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."}}}}}}

GET /v2/api/external/{apiId}/listQueues

ListQueues

{"openapi":"3.0.3","info":{"title":"sistema — API Externa","version":"v4.x.x.x"},"tags":[{"name":"📊 Listagens"}],"servers":[{"url":"https://{baseUrl}","description":"Instalação sistema do cliente","variables":{"baseUrl":{"default":"api.seudominio.com.br","description":"Domínio do backend sistema, 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 sistema.","schema":{"type":"string"}}}},"paths":{"/v2/api/external/{apiId}/listQueues":{"get":{"tags":["📊 Listagens"],"summary":"ListQueues","operationId":"ListQueues","parameters":[{"$ref":"#/components/parameters/ApiId"}],"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."}}}}}}

GET /v2/api/external/{apiId}/listSessions

ListSessions

{"openapi":"3.0.3","info":{"title":"sistema — API Externa","version":"v4.x.x.x"},"tags":[{"name":"📊 Listagens"}],"servers":[{"url":"https://{baseUrl}","description":"Instalação sistema do cliente","variables":{"baseUrl":{"default":"api.seudominio.com.br","description":"Domínio do backend sistema, 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 sistema.","schema":{"type":"string"}}}},"paths":{"/v2/api/external/{apiId}/listSessions":{"get":{"tags":["📊 Listagens"],"summary":"ListSessions","operationId":"ListSessions","parameters":[{"$ref":"#/components/parameters/ApiId"}],"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."}}}}}}

GET /v2/api/external/{apiId}/listTags

ListTags

{"openapi":"3.0.3","info":{"title":"sistema — API Externa","version":"v4.x.x.x"},"tags":[{"name":"📊 Listagens"}],"servers":[{"url":"https://{baseUrl}","description":"Instalação sistema do cliente","variables":{"baseUrl":{"default":"api.seudominio.com.br","description":"Domínio do backend sistema, 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 sistema.","schema":{"type":"string"}}}},"paths":{"/v2/api/external/{apiId}/listTags":{"get":{"tags":["📊 Listagens"],"summary":"ListTags","operationId":"ListTags","parameters":[{"$ref":"#/components/parameters/ApiId"},{"name":"isActive","in":"query","required":false,"description":"Filtrar por tags ativas (true/false)","schema":{"type":"string"}}],"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."}}}}}}

GET /v2/api/external/{apiId}/listTickets

ListTickets

{"openapi":"3.0.3","info":{"title":"sistema — API Externa","version":"v4.x.x.x"},"tags":[{"name":"📊 Listagens"}],"servers":[{"url":"https://{baseUrl}","description":"Instalação sistema do cliente","variables":{"baseUrl":{"default":"api.seudominio.com.br","description":"Domínio do backend sistema, 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 sistema.","schema":{"type":"string"}}}},"paths":{"/v2/api/external/{apiId}/listTickets":{"get":{"tags":["📊 Listagens"],"summary":"ListTickets","operationId":"ListTickets","parameters":[{"$ref":"#/components/parameters/ApiId"},{"name":"pageNumber","in":"query","required":false,"description":"Número da página","schema":{"type":"integer"}},{"name":"status","in":"query","required":false,"description":"Status do ticket (open, pending, closed)","schema":{"type":"string"}}],"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."}}}}}}