Pular para o conteúdo principal
POST
/
api
/
v1
/
campaigns
/
{campaign_id}
/
sftp
curl -X POST "https://app.talkover.ai/api/v1/campaigns/campaign-uuid/sftp" \
  -H "Authorization: Bearer talq_your_environment_token_here" \
  -H "Content-Type: application/json" \
  -d '{
    "host": "sftp.example.com",
    "port": 22,
    "username": "campaigns_user",
    "auth_type": "password",
    "password": "secret",
    "import_path": "/inbox",
    "export_path": "/outbox",
    "import_schedule": "daily"
  }'

{
  "success": true,
  "data": {
    "id": "sftp-config-uuid-1",
    "campaign_id": "campaign-uuid",
    "host": "sftp.example.com",
    "is_enabled": false,
    "created_at": "2024-01-15T16:00:00Z"
  }
}

​
Criar Configuração SFTP da Campanha

Configura a integração SFTP para uma campanha. A configuração é criada no estado disabled — teste a conexão com sucesso antes de habilitar.

​
Endpoint

POST /api/v1/campaigns/{campaign_id}/sftp

​
Parâmetros de caminho

​
campaign_id
string
obrigatório
UUID da campanha.

​
Cabeçalhos da requisição

​
Authorization
string
obrigatório
Token Bearer. Formato: Bearer talq_your_environment_token_here
​
Content-Type
string
obrigatório
Deve ser definido como application/json

​
Corpo da requisição

​
host
string
obrigatório
Hostname do servidor SFTP.
​
port
integer
Porta SFTP. Faixa: 1–65535. Padrão: 22.
​
username
string
obrigatório
Usuário SFTP.
​
auth_type
string
obrigatório
Método de autenticação. Opções: password, private_key.
​
password
string
Obrigatório quando auth_type é password.
​
private_key
string
Obrigatório quando auth_type é private_key. Chave privada codificada em PEM.
​
private_key_passphrase
string
Passphrase opcional para a chave privada.
​
import_path
string
Diretório remoto a varrer para importações de lista de contatos (ex: /inbox).
​
export_path
string
Diretório remoto onde arquivos de resultado de chamadas são enviados (ex: /outbox).
​
import_schedule
string
Agenda de importação automática. Opções: manual, hourly, daily. Padrão: manual.

​
Exemplos

curl -X POST "https://app.talkover.ai/api/v1/campaigns/campaign-uuid/sftp" \
  -H "Authorization: Bearer talq_your_environment_token_here" \
  -H "Content-Type: application/json" \
  -d '{
    "host": "sftp.example.com",
    "port": 22,
    "username": "campaigns_user",
    "auth_type": "password",
    "password": "secret",
    "import_path": "/inbox",
    "export_path": "/outbox",
    "import_schedule": "daily"
  }'

​
Resposta

{
  "success": true,
  "data": {
    "id": "sftp-config-uuid-1",
    "campaign_id": "campaign-uuid",
    "host": "sftp.example.com",
    "is_enabled": false,
    "created_at": "2024-01-15T16:00:00Z"
  }
}