POST /v2/api/external/{apiId}/bulkDispatch/incrementProgress/{dispatchId}
BulkDispatchIncrementProgress
{"openapi":"3.0.3","info":{"title":"Connect.ai — API Externa","version":"v4.x.x.x"},"tags":[{"name":"📤 Envio em Lote"}],"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}/bulkDispatch/incrementProgress/{dispatchId}":{"post":{"tags":["📤 Envio em Lote"],"summary":"BulkDispatchIncrementProgress","operationId":"BulkDispatchIncrementProgress","parameters":[{"$ref":"#/components/parameters/ApiId"},{"name":"dispatchId","in":"path","required":true,"schema":{"type":"string"},"description":"Identificador do recurso na rota."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"}}}}}},"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}/bulkDispatch/list
BulkDispatchList
{"openapi":"3.0.3","info":{"title":"Connect.ai — API Externa","version":"v4.x.x.x"},"tags":[{"name":"📤 Envio em Lote"}],"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}/bulkDispatch/list":{"get":{"tags":["📤 Envio em Lote"],"summary":"BulkDispatchList","operationId":"BulkDispatchList","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."}}}}}}
GET /v2/api/external/{apiId}/bulkDispatch/show/{dispatchId}
BulkDispatchShow
{"openapi":"3.0.3","info":{"title":"Connect.ai — API Externa","version":"v4.x.x.x"},"tags":[{"name":"📤 Envio em Lote"}],"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}/bulkDispatch/show/{dispatchId}":{"get":{"tags":["📤 Envio em Lote"],"summary":"BulkDispatchShow","operationId":"BulkDispatchShow","parameters":[{"$ref":"#/components/parameters/ApiId"},{"name":"dispatchId","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}/bulkDispatch/update/{dispatchId}
BulkDispatchUpdate
{"openapi":"3.0.3","info":{"title":"Connect.ai — API Externa","version":"v4.x.x.x"},"tags":[{"name":"📤 Envio em Lote"}],"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}/bulkDispatch/update/{dispatchId}":{"post":{"tags":["📤 Envio em Lote"],"summary":"BulkDispatchUpdate","operationId":"BulkDispatchUpdate","parameters":[{"$ref":"#/components/parameters/ApiId"},{"name":"dispatchId","in":"path","required":true,"schema":{"type":"string"},"description":"Identificador do recurso na rota."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string"},"cancellationReason":{"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."}}}}}}
BulkFastMessage
v2 crossChannelTicketCheck: quando a flag 'Verificar conversa em outros canais' do conta esta ligada, destinatarios com ticket aberto ou pendente (em qualquer canal) NAO recebem o disparo. A resposta inclui skipped (contagem) e skippedNumbers (lista). Para ignorar a checagem nesta chamada, envie "skipActiveTicketCheck": false no body.
{"openapi":"3.0.3","info":{"title":"Connect.ai — API Externa","version":"v4.x.x.x"},"tags":[{"name":"📤 Envio em Lote"}],"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}/bulkFastMessage":{"post":{"tags":["📤 Envio em Lote"],"summary":"BulkFastMessage","operationId":"BulkFastMessage","description":"v2 crossChannelTicketCheck: quando a flag 'Verificar conversa em outros canais' do conta esta ligada, destinatarios com ticket aberto ou pendente (em qualquer canal) NAO recebem o disparo. A resposta inclui skipped (contagem) e skippedNumbers (lista). Para ignorar a checagem nesta chamada, envie \"skipActiveTicketCheck\": false no body.","parameters":[{"$ref":"#/components/parameters/ApiId"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"whatsappId":{"type":"string"},"whatsappType":{"type":"string"},"arrayNumbers":{"type":"array","items":{"type":"string"}},"message":{"type":"string"},"min":{"type":"integer"},"max":{"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}/bulkIndividual
BulkIndividual
{"openapi":"3.0.3","info":{"title":"Connect.ai — API Externa","version":"v4.x.x.x"},"tags":[{"name":"📤 Envio em Lote"}],"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}/bulkIndividual":{"post":{"tags":["📤 Envio em Lote"],"summary":"BulkIndividual","operationId":"BulkIndividual","parameters":[{"$ref":"#/components/parameters/ApiId"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"whatsappId":{"type":"string"},"number":{"type":"string"},"message":{"type":"string"},"externalKey":{"type":"string","description":"Chave única do sistema para identificação (valor gerado do seu lado para controle do envio e não pode se repetir)"}}}}}},"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."}}}}}}
BulkSendMessage
v2 crossChannelTicketCheck: quando a flag 'Verificar conversa em outros canais' do conta esta ligada, destinatarios com ticket aberto ou pendente (em qualquer canal) NAO recebem o disparo. A resposta inclui skipped (contagem) e skippedNumbers (lista). Para ignorar a checagem nesta chamada, envie "skipActiveTicketCheck": false no body.
{"openapi":"3.0.3","info":{"title":"Connect.ai — API Externa","version":"v4.x.x.x"},"tags":[{"name":"📤 Envio em Lote"}],"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}/bulkSendMessage":{"post":{"tags":["📤 Envio em Lote"],"summary":"BulkSendMessage","operationId":"BulkSendMessage","description":"v2 crossChannelTicketCheck: quando a flag 'Verificar conversa em outros canais' do conta esta ligada, destinatarios com ticket aberto ou pendente (em qualquer canal) NAO recebem o disparo. A resposta inclui skipped (contagem) e skippedNumbers (lista). Para ignorar a checagem nesta chamada, envie \"skipActiveTicketCheck\": false no body.","parameters":[{"$ref":"#/components/parameters/ApiId"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"whatsappId":{"type":"string"},"arrayNumbers":{"type":"array","items":{"type":"string"}},"message":{"type":"string"},"min":{"type":"integer"},"max":{"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."}}}}}}
BulkSendMessageWithVariable
v2 crossChannelTicketCheck: quando a flag 'Verificar conversa em outros canais' do conta esta ligada, o destinatario com ticket aberto ou pendente (em qualquer canal) NAO recebe o disparo. A resposta inclui skipped (contagem) e skippedNumbers (lista). Para ignorar a checagem nesta chamada, envie "skipActiveTicketCheck": false no body.
{"openapi":"3.0.3","info":{"title":"Connect.ai — API Externa","version":"v4.x.x.x"},"tags":[{"name":"📤 Envio em Lote"}],"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}/bulkSendMessageWithVariable":{"post":{"tags":["📤 Envio em Lote"],"summary":"BulkSendMessageWithVariable","operationId":"BulkSendMessageWithVariable","description":"v2 crossChannelTicketCheck: quando a flag 'Verificar conversa em outros canais' do conta esta ligada, o destinatario com ticket aberto ou pendente (em qualquer canal) NAO recebe o disparo. A resposta inclui skipped (contagem) e skippedNumbers (lista). Para ignorar a checagem nesta chamada, envie \"skipActiveTicketCheck\": false no body.","parameters":[{"$ref":"#/components/parameters/ApiId"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"whatsappId":{"type":"string"},"message":{"type":"string"},"dataInput":{"type":"string"},"min":{"type":"integer"},"max":{"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."}}}}}}