Módulo de campanha
Download OpenAPI specification:Download
API para enviar uma ação de módulo de campanha dentro de um bot na plataforma Builder.
Para usar a API de envio de campanha, terá que fazer o login no primeiro endpoint antes.
Login
Fazer o login do usuário no Builder.
Request Body schema: application/json
| user required | string (User) |
| password required | string (Password) |
Responses
Request samples
- Payload
Content type
application/json
{- "user": "string",
- "password": "string"
}Response samples
- 200
- 422
Content type
application/json
{- "token": "string",
- "refresh_token": "string"
}Criar ação de campanha
Authorizations:
Token
path Parameters
| organization_name required | any (Nome da organização) |
| bot_name required | any (Nome do bot) |
Request Body schema: application/json
| _id | string ( Id) |
| organization | string (Organização) |
| scheduled_date | string (Data marcada) |
| campaign_name | string (Nome da campanha) |
| status | any (Status) Default: "not_started" Enum: "concluded" "in_progress" "not_started" "error" An enumeration. |
| bot_name | string (Nome do bot) |
| creation_date | string <date-time> (Data de criação) |
| description | string (Descrição) |
| name | string (Nome) |
| file | string (Arquivo) |
| content | string (Content) |
| sheet_values | Array of strings (Valores do sheets) |
| log_file | string (Arquivo de log) |
Responses
Request samples
- Payload
Content type
application/json
{- "_id": "5eb7cf5a86d9755df3a6c593",
- "organization": "string",
- "scheduled_date": "string",
- "campaign_name": "string",
- "status": "not_started",
- "bot_name": "string",
- "creation_date": "2019-08-24T14:15:22Z",
- "description": "string",
- "name": "string",
- "file": "string",
- "content": "string",
- "sheet_values": [
- "string"
], - "log_file": "string"
}Response samples
- 201
- 422
Content type
application/json
{- "_id": "5eb7cf5a86d9755df3a6c593",
- "organization": "string",
- "scheduled_date": "string",
- "campaign_name": "string",
- "status": "not_started",
- "bot_name": "string",
- "creation_date": "2019-08-24T14:15:22Z",
- "description": "string",
- "name": "string",
- "file": "string",
- "content": "string",
- "sheet_values": [
- "string"
], - "log_file": "string"
}