POST /v2/api/external/{apiId}/campaign/cancel/{campaignId}
CampaignCancel
{"openapi":"3.0.3","info":{"title":"Connect.ai — API Externa","version":"v4.x.x.x"},"tags":[{"name":"📣 Campanhas"}],"servers":[{"url":"https://{baseUrl}","description":"Instalação Connect.ai do cliente","variables":{"baseUrl":{"default":"api.seudominio.com.br","description":"Domínio do backend Connect.ai, sem protocolo e sem barra final."}}}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Token da API do conta (na coleção Postman: `BearerToken`)."}},"parameters":{"ApiId":{"name":"apiId","in":"path","required":true,"description":"ID da API externa cadastrada no Connect.ai.","schema":{"type":"string"}}}},"paths":{"/v2/api/external/{apiId}/campaign/cancel/{campaignId}":{"post":{"tags":["📣 Campanhas"],"summary":"CampaignCancel","operationId":"CampaignCancel","parameters":[{"$ref":"#/components/parameters/ApiId"},{"name":"campaignId","in":"path","required":true,"schema":{"type":"string"},"description":"Identificador do recurso na rota."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object"}}}},"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}/campaign/contacts/add/{campaignId}
CampaignContactsAdd
{"openapi":"3.0.3","info":{"title":"Connect.ai — API Externa","version":"v4.x.x.x"},"tags":[{"name":"📣 Campanhas"}],"servers":[{"url":"https://{baseUrl}","description":"Instalação Connect.ai do cliente","variables":{"baseUrl":{"default":"api.seudominio.com.br","description":"Domínio do backend Connect.ai, sem protocolo e sem barra final."}}}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Token da API do conta (na coleção Postman: `BearerToken`)."}},"parameters":{"ApiId":{"name":"apiId","in":"path","required":true,"description":"ID da API externa cadastrada no Connect.ai.","schema":{"type":"string"}}}},"paths":{"/v2/api/external/{apiId}/campaign/contacts/add/{campaignId}":{"post":{"tags":["📣 Campanhas"],"summary":"CampaignContactsAdd","operationId":"CampaignContactsAdd","parameters":[{"$ref":"#/components/parameters/ApiId"},{"name":"campaignId","in":"path","required":true,"schema":{"type":"string"},"description":"Identificador do recurso na rota."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"number":{"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}/campaign/contacts/{campaignId}
CampaignContactsList
{"openapi":"3.0.3","info":{"title":"Connect.ai — API Externa","version":"v4.x.x.x"},"tags":[{"name":"📣 Campanhas"}],"servers":[{"url":"https://{baseUrl}","description":"Instalação Connect.ai do cliente","variables":{"baseUrl":{"default":"api.seudominio.com.br","description":"Domínio do backend Connect.ai, sem protocolo e sem barra final."}}}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Token da API do conta (na coleção Postman: `BearerToken`)."}},"parameters":{"ApiId":{"name":"apiId","in":"path","required":true,"description":"ID da API externa cadastrada no Connect.ai.","schema":{"type":"string"}}}},"paths":{"/v2/api/external/{apiId}/campaign/contacts/{campaignId}":{"get":{"tags":["📣 Campanhas"],"summary":"CampaignContactsList","operationId":"CampaignContactsList","parameters":[{"$ref":"#/components/parameters/ApiId"},{"name":"campaignId","in":"path","required":true,"schema":{"type":"string"},"description":"Identificador do recurso na rota."}],"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}/campaign/contacts/remove/{campaignId}/{contactId}
CampaignContactsRemove
{"openapi":"3.0.3","info":{"title":"Connect.ai — API Externa","version":"v4.x.x.x"},"tags":[{"name":"📣 Campanhas"}],"servers":[{"url":"https://{baseUrl}","description":"Instalação Connect.ai do cliente","variables":{"baseUrl":{"default":"api.seudominio.com.br","description":"Domínio do backend Connect.ai, sem protocolo e sem barra final."}}}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Token da API do conta (na coleção Postman: `BearerToken`)."}},"parameters":{"ApiId":{"name":"apiId","in":"path","required":true,"description":"ID da API externa cadastrada no Connect.ai.","schema":{"type":"string"}}}},"paths":{"/v2/api/external/{apiId}/campaign/contacts/remove/{campaignId}/{contactId}":{"post":{"tags":["📣 Campanhas"],"summary":"CampaignContactsRemove","operationId":"CampaignContactsRemove","parameters":[{"$ref":"#/components/parameters/ApiId"},{"name":"campaignId","in":"path","required":true,"schema":{"type":"string"},"description":"Identificador do recurso na rota."},{"name":"contactId","in":"path","required":true,"schema":{"type":"string"},"description":"Identificador do recurso na rota."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object"}}}},"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}/campaign/contacts/removeAll/{campaignId}
CampaignContactsRemoveAll
{"openapi":"3.0.3","info":{"title":"Connect.ai — API Externa","version":"v4.x.x.x"},"tags":[{"name":"📣 Campanhas"}],"servers":[{"url":"https://{baseUrl}","description":"Instalação Connect.ai do cliente","variables":{"baseUrl":{"default":"api.seudominio.com.br","description":"Domínio do backend Connect.ai, sem protocolo e sem barra final."}}}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Token da API do conta (na coleção Postman: `BearerToken`)."}},"parameters":{"ApiId":{"name":"apiId","in":"path","required":true,"description":"ID da API externa cadastrada no Connect.ai.","schema":{"type":"string"}}}},"paths":{"/v2/api/external/{apiId}/campaign/contacts/removeAll/{campaignId}":{"post":{"tags":["📣 Campanhas"],"summary":"CampaignContactsRemoveAll","operationId":"CampaignContactsRemoveAll","parameters":[{"$ref":"#/components/parameters/ApiId"},{"name":"campaignId","in":"path","required":true,"schema":{"type":"string"},"description":"Identificador do recurso na rota."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object"}}}},"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}/campaign/create
CampaignCreate
{"openapi":"3.0.3","info":{"title":"Connect.ai — API Externa","version":"v4.x.x.x"},"tags":[{"name":"📣 Campanhas"}],"servers":[{"url":"https://{baseUrl}","description":"Instalação Connect.ai do cliente","variables":{"baseUrl":{"default":"api.seudominio.com.br","description":"Domínio do backend Connect.ai, sem protocolo e sem barra final."}}}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Token da API do conta (na coleção Postman: `BearerToken`)."}},"parameters":{"ApiId":{"name":"apiId","in":"path","required":true,"description":"ID da API externa cadastrada no Connect.ai.","schema":{"type":"string"}}}},"paths":{"/v2/api/external/{apiId}/campaign/create":{"post":{"tags":["📣 Campanhas"],"summary":"CampaignCreate","operationId":"CampaignCreate","parameters":[{"$ref":"#/components/parameters/ApiId"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"start":{"type":"string"},"message1":{"type":"string"},"message2":{"type":"string"},"message3":{"type":"string"},"sessionId":{"type":"string"},"delay":{"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."}}}}}}
POST /v2/api/external/{apiId}/campaign/delete/{campaignId}
CampaignDelete
{"openapi":"3.0.3","info":{"title":"Connect.ai — API Externa","version":"v4.x.x.x"},"tags":[{"name":"📣 Campanhas"}],"servers":[{"url":"https://{baseUrl}","description":"Instalação Connect.ai do cliente","variables":{"baseUrl":{"default":"api.seudominio.com.br","description":"Domínio do backend Connect.ai, sem protocolo e sem barra final."}}}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Token da API do conta (na coleção Postman: `BearerToken`)."}},"parameters":{"ApiId":{"name":"apiId","in":"path","required":true,"description":"ID da API externa cadastrada no Connect.ai.","schema":{"type":"string"}}}},"paths":{"/v2/api/external/{apiId}/campaign/delete/{campaignId}":{"post":{"tags":["📣 Campanhas"],"summary":"CampaignDelete","operationId":"CampaignDelete","parameters":[{"$ref":"#/components/parameters/ApiId"},{"name":"campaignId","in":"path","required":true,"schema":{"type":"string"},"description":"Identificador do recurso na rota."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object"}}}},"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}/campaign/duplicate/{campaignId}
CampaignDuplicate
{"openapi":"3.0.3","info":{"title":"Connect.ai — API Externa","version":"v4.x.x.x"},"tags":[{"name":"📣 Campanhas"}],"servers":[{"url":"https://{baseUrl}","description":"Instalação Connect.ai do cliente","variables":{"baseUrl":{"default":"api.seudominio.com.br","description":"Domínio do backend Connect.ai, sem protocolo e sem barra final."}}}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Token da API do conta (na coleção Postman: `BearerToken`)."}},"parameters":{"ApiId":{"name":"apiId","in":"path","required":true,"description":"ID da API externa cadastrada no Connect.ai.","schema":{"type":"string"}}}},"paths":{"/v2/api/external/{apiId}/campaign/duplicate/{campaignId}":{"post":{"tags":["📣 Campanhas"],"summary":"CampaignDuplicate","operationId":"CampaignDuplicate","parameters":[{"$ref":"#/components/parameters/ApiId"},{"name":"campaignId","in":"path","required":true,"schema":{"type":"string"},"description":"Identificador do recurso na rota."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object"}}}},"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}/campaign/list
CampaignList
{"openapi":"3.0.3","info":{"title":"Connect.ai — API Externa","version":"v4.x.x.x"},"tags":[{"name":"📣 Campanhas"}],"servers":[{"url":"https://{baseUrl}","description":"Instalação Connect.ai do cliente","variables":{"baseUrl":{"default":"api.seudominio.com.br","description":"Domínio do backend Connect.ai, sem protocolo e sem barra final."}}}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Token da API do conta (na coleção Postman: `BearerToken`)."}},"parameters":{"ApiId":{"name":"apiId","in":"path","required":true,"description":"ID da API externa cadastrada no Connect.ai.","schema":{"type":"string"}}}},"paths":{"/v2/api/external/{apiId}/campaign/list":{"get":{"tags":["📣 Campanhas"],"summary":"CampaignList","operationId":"CampaignList","parameters":[{"$ref":"#/components/parameters/ApiId"},{"name":"page","in":"query","required":false,"schema":{"type":"integer"}},{"name":"limit","in":"query","required":false,"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."}}}}}}
POST /v2/api/external/{apiId}/campaign/pause/{campaignId}
CampaignPause
{"openapi":"3.0.3","info":{"title":"Connect.ai — API Externa","version":"v4.x.x.x"},"tags":[{"name":"📣 Campanhas"}],"servers":[{"url":"https://{baseUrl}","description":"Instalação Connect.ai do cliente","variables":{"baseUrl":{"default":"api.seudominio.com.br","description":"Domínio do backend Connect.ai, sem protocolo e sem barra final."}}}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Token da API do conta (na coleção Postman: `BearerToken`)."}},"parameters":{"ApiId":{"name":"apiId","in":"path","required":true,"description":"ID da API externa cadastrada no Connect.ai.","schema":{"type":"string"}}}},"paths":{"/v2/api/external/{apiId}/campaign/pause/{campaignId}":{"post":{"tags":["📣 Campanhas"],"summary":"CampaignPause","operationId":"CampaignPause","parameters":[{"$ref":"#/components/parameters/ApiId"},{"name":"campaignId","in":"path","required":true,"schema":{"type":"string"},"description":"Identificador do recurso na rota."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object"}}}},"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}/campaign/report/{campaignId}
CampaignReport
{"openapi":"3.0.3","info":{"title":"Connect.ai — API Externa","version":"v4.x.x.x"},"tags":[{"name":"📣 Campanhas"}],"servers":[{"url":"https://{baseUrl}","description":"Instalação Connect.ai do cliente","variables":{"baseUrl":{"default":"api.seudominio.com.br","description":"Domínio do backend Connect.ai, sem protocolo e sem barra final."}}}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Token da API do conta (na coleção Postman: `BearerToken`)."}},"parameters":{"ApiId":{"name":"apiId","in":"path","required":true,"description":"ID da API externa cadastrada no Connect.ai.","schema":{"type":"string"}}}},"paths":{"/v2/api/external/{apiId}/campaign/report/{campaignId}":{"get":{"tags":["📣 Campanhas"],"summary":"CampaignReport","operationId":"CampaignReport","parameters":[{"$ref":"#/components/parameters/ApiId"},{"name":"campaignId","in":"path","required":true,"schema":{"type":"string"},"description":"Identificador do recurso na rota."}],"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}/campaign/resume/{campaignId}
CampaignResume
{"openapi":"3.0.3","info":{"title":"Connect.ai — API Externa","version":"v4.x.x.x"},"tags":[{"name":"📣 Campanhas"}],"servers":[{"url":"https://{baseUrl}","description":"Instalação Connect.ai do cliente","variables":{"baseUrl":{"default":"api.seudominio.com.br","description":"Domínio do backend Connect.ai, sem protocolo e sem barra final."}}}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Token da API do conta (na coleção Postman: `BearerToken`)."}},"parameters":{"ApiId":{"name":"apiId","in":"path","required":true,"description":"ID da API externa cadastrada no Connect.ai.","schema":{"type":"string"}}}},"paths":{"/v2/api/external/{apiId}/campaign/resume/{campaignId}":{"post":{"tags":["📣 Campanhas"],"summary":"CampaignResume","operationId":"CampaignResume","parameters":[{"$ref":"#/components/parameters/ApiId"},{"name":"campaignId","in":"path","required":true,"schema":{"type":"string"},"description":"Identificador do recurso na rota."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object"}}}},"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}/campaign/skip/{campaignId}
CampaignSkip
{"openapi":"3.0.3","info":{"title":"Connect.ai — API Externa","version":"v4.x.x.x"},"tags":[{"name":"📣 Campanhas"}],"servers":[{"url":"https://{baseUrl}","description":"Instalação Connect.ai do cliente","variables":{"baseUrl":{"default":"api.seudominio.com.br","description":"Domínio do backend Connect.ai, sem protocolo e sem barra final."}}}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Token da API do conta (na coleção Postman: `BearerToken`)."}},"parameters":{"ApiId":{"name":"apiId","in":"path","required":true,"description":"ID da API externa cadastrada no Connect.ai.","schema":{"type":"string"}}}},"paths":{"/v2/api/external/{apiId}/campaign/skip/{campaignId}":{"post":{"tags":["📣 Campanhas"],"summary":"CampaignSkip","operationId":"CampaignSkip","parameters":[{"$ref":"#/components/parameters/ApiId"},{"name":"campaignId","in":"path","required":true,"schema":{"type":"string"},"description":"Identificador do recurso na rota."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object"}}}},"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}/campaign/start/{campaignId}
CampaignStart
{"openapi":"3.0.3","info":{"title":"Connect.ai — API Externa","version":"v4.x.x.x"},"tags":[{"name":"📣 Campanhas"}],"servers":[{"url":"https://{baseUrl}","description":"Instalação Connect.ai do cliente","variables":{"baseUrl":{"default":"api.seudominio.com.br","description":"Domínio do backend Connect.ai, sem protocolo e sem barra final."}}}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Token da API do conta (na coleção Postman: `BearerToken`)."}},"parameters":{"ApiId":{"name":"apiId","in":"path","required":true,"description":"ID da API externa cadastrada no Connect.ai.","schema":{"type":"string"}}}},"paths":{"/v2/api/external/{apiId}/campaign/start/{campaignId}":{"post":{"tags":["📣 Campanhas"],"summary":"CampaignStart","operationId":"CampaignStart","parameters":[{"$ref":"#/components/parameters/ApiId"},{"name":"campaignId","in":"path","required":true,"schema":{"type":"string"},"description":"Identificador do recurso na rota."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object"}}}},"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}/campaign/update/{campaignId}
CampaignUpdate
{"openapi":"3.0.3","info":{"title":"Connect.ai — API Externa","version":"v4.x.x.x"},"tags":[{"name":"📣 Campanhas"}],"servers":[{"url":"https://{baseUrl}","description":"Instalação Connect.ai do cliente","variables":{"baseUrl":{"default":"api.seudominio.com.br","description":"Domínio do backend Connect.ai, sem protocolo e sem barra final."}}}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Token da API do conta (na coleção Postman: `BearerToken`)."}},"parameters":{"ApiId":{"name":"apiId","in":"path","required":true,"description":"ID da API externa cadastrada no Connect.ai.","schema":{"type":"string"}}}},"paths":{"/v2/api/external/{apiId}/campaign/update/{campaignId}":{"post":{"tags":["📣 Campanhas"],"summary":"CampaignUpdate","operationId":"CampaignUpdate","parameters":[{"$ref":"#/components/parameters/ApiId"},{"name":"campaignId","in":"path","required":true,"schema":{"type":"string"},"description":"Identificador do recurso na rota."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"start":{"type":"string"},"message1":{"type":"string"},"message2":{"type":"string"},"message3":{"type":"string"},"sessionId":{"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."}}}}}}