📤 Envio em Lote

BulkDispatchIncrementProgress

post

https://{{baseurl}}https://{{BaseUrl}}

/v2/api/external/{ApiID}/bulkDispatch/incrementProgress/{dispatchId}

Autorizações

bearerAuth

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

ApiIDstringObrigatório

dispatchIdstringObrigatório

Corpo

application/json

successbooleanOpcional

Respostas

200

Successful response

application/json

post/v2/api/external/{ApiID}/bulkDispatch/incrementProgress/{dispatchId}

HTTPcURLJavaScriptPython

POST /v2/api/external/{ApiID}/bulkDispatch/incrementProgress/{dispatchId} HTTP/1.1
Host: {{baseurl}}
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 16

{
  "success": true
}

200

Successful response

BulkDispatchList

get

https://{{baseurl}}https://{{BaseUrl}}

/v2/api/external/{ApiID}/bulkDispatch/list

Autorizações

bearerAuth

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

ApiIDstringObrigatório

Parâmetros de consulta

pageintegerOpcionalExample: 1

limitintegerOpcionalExample: 20

Respostas

200

Successful response

application/json

get/v2/api/external/{ApiID}/bulkDispatch/list

HTTPcURLJavaScriptPython

GET /v2/api/external/{ApiID}/bulkDispatch/list HTTP/1.1
Host: {{baseurl}}
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Successful response

BulkDispatchShow

get

https://{{baseurl}}https://{{BaseUrl}}

/v2/api/external/{ApiID}/bulkDispatch/show/{dispatchId}

Autorizações

bearerAuth

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

ApiIDstringObrigatório

dispatchIdstringObrigatório

Respostas

200

Successful response

application/json

get/v2/api/external/{ApiID}/bulkDispatch/show/{dispatchId}

HTTPcURLJavaScriptPython

GET /v2/api/external/{ApiID}/bulkDispatch/show/{dispatchId} HTTP/1.1
Host: {{baseurl}}
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Successful response

BulkDispatchUpdate

post

https://{{baseurl}}https://{{BaseUrl}}

/v2/api/external/{ApiID}/bulkDispatch/update/{dispatchId}

Autorizações

bearerAuth

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

ApiIDstringObrigatório

dispatchIdstringObrigatório

Corpo

application/json

statusstringOpcional

cancellationReasonstringOpcional

Respostas

200

Successful response

application/json

post/v2/api/external/{ApiID}/bulkDispatch/update/{dispatchId}

HTTPcURLJavaScriptPython

POST /v2/api/external/{ApiID}/bulkDispatch/update/{dispatchId} HTTP/1.1
Host: {{baseurl}}
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 69

{
  "status": "cancelled",
  "cancellationReason": "Cancelado pelo usuário"
}

200

Successful response

BulkFastMessage

post

https://{{baseurl}}https://{{BaseUrl}}

/v2/api/external/{ApiID}/bulkFastMessage

Autorizações

bearerAuth

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

ApiIDstringObrigatório

Corpo

application/json

whatsappIdstringOpcional

whatsappTypestringOpcional

arrayNumbersstring[]Opcional

messagestringOpcional

minnumberOpcional

maxnumberOpcional

Respostas

200

Successful response

application/json

post/v2/api/external/{ApiID}/bulkFastMessage

HTTPcURLJavaScriptPython

POST /v2/api/external/{ApiID}/bulkFastMessage HTTP/1.1
Host: {{baseurl}}
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 157

{
  "whatsappId": "{{whatsappId}}",
  "whatsappType": "baileys",
  "arrayNumbers": [
    "5511999990001",
    "5511999990002"
  ],
  "message": "Olá, mensagem rápida!",
  "min": 3,
  "max": 8
}

200

Successful response

BulkIndividual

post

https://{{baseurl}}https://{{BaseUrl}}

/v2/api/external/{ApiID}/bulkIndividual

Autorizações

bearerAuth

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

ApiIDstringObrigatório

Corpo

application/json

whatsappIdstringOpcional

numberstringOpcional

messagestringOpcional

externalKeystringOpcional

Respostas

200

Successful response

application/json

post/v2/api/external/{ApiID}/bulkIndividual

HTTPcURLJavaScriptPython

POST /v2/api/external/{ApiID}/bulkIndividual HTTP/1.1
Host: {{baseurl}}
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 125

{
  "whatsappId": "{{whatsappId}}",
  "number": "5511999990001",
  "message": "Olá, mensagem individual!",
  "externalKey": "{{SecretKey}}"
}

200

Successful response

BulkSendMessage

post

https://{{baseurl}}https://{{BaseUrl}}

/v2/api/external/{ApiID}/bulkSendMessage

Autorizações

bearerAuth

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

ApiIDstringObrigatório

Corpo

application/json

whatsappIdstringOpcional

arrayNumbersstring[]Opcional

messagestringOpcional

minnumberOpcional

maxnumberOpcional

Respostas

200

Successful response

application/json

post/v2/api/external/{ApiID}/bulkSendMessage

HTTPcURLJavaScriptPython

POST /v2/api/external/{ApiID}/bulkSendMessage HTTP/1.1
Host: {{baseurl}}
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 124

{
  "whatsappId": "{{whatsappId}}",
  "arrayNumbers": [
    "5511999990001",
    "5511999990002"
  ],
  "message": "Olá, tudo bem?",
  "min": 3,
  "max": 8
}

200

Successful response

BulkSendMessageWithVariable

post

https://{{baseurl}}https://{{BaseUrl}}

/v2/api/external/{ApiID}/bulkSendMessageWithVariable

Autorizações

bearerAuth

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

ApiIDstringObrigatório

Corpo

application/json

whatsappIdstringOpcional

messagestringOpcional

dataInputstringOpcional

minnumberOpcional

maxnumberOpcional

Respostas

200

Successful response

application/json

post/v2/api/external/{ApiID}/bulkSendMessageWithVariable

HTTPcURLJavaScriptPython

POST /v2/api/external/{ApiID}/bulkSendMessageWithVariable HTTP/1.1
Host: {{baseurl}}
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 165

{
  "whatsappId": "{{whatsappId}}",
  "message": "Olá {nome}, seu código é {codigo}",
  "dataInput": "5511999990001,João,ABC123\n5511999990002,Maria,DEF456",
  "min": 3,
  "max": 8
}

200

Successful response