POST /v1/campaigns/test-send
POST
/v1/campaigns/test-send
const url = 'https://seu-endereco-da-api/v1/campaigns/test-send';const options = { method: 'POST', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"channelId":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","contactId":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","departmentId":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","gatewaySteps":[{"kind":"text","text":"example","mediaKey":"example","mediaMime":"example","fileName":"example"}],"templateId":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","templateVariables":[{}],"headerMediaKey":"example","headerMediaMime":"example","cardMedia":[{}]}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://seu-endereco-da-api/v1/campaigns/test-send \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "channelId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "contactId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "departmentId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "gatewaySteps": [ { "kind": "text", "text": "example", "mediaKey": "example", "mediaMime": "example", "fileName": "example" } ], "templateId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "templateVariables": [ {} ], "headerMediaKey": "example", "headerMediaMime": "example", "cardMedia": [ {} ] }'Permissão que a Chave de acesso precisa: Criar e disparar campanhas (campaigns:manage) e Enviar mensagem e atender (conversations:write).
Authorizations
Seção intitulada “Authorizations”Request Bodyrequired
Seção intitulada “Request Bodyrequired”Media typeapplication/json
object
channelId
required
string format: uuid
contactId
required
string format: uuid
departmentId
string format: uuid
gatewaySteps
Array<object>
object
kind
required
string
text
string
mediaKey
string
mediaMime
string
fileName
string
templateId
string format: uuid
templateVariables
Array<object>
object
headerMediaKey
string
headerMediaMime
string
cardMedia
Array<object>
object
Responses
Seção intitulada “Responses”The assistant connected by MCP already sent 10 tests in the last hour with this key