Messages

Enviar mensagem (GET)

get

Observação: Endpoint com efeito colateral via GET.

Autorizações

ApiTokenQuery

tokenstringObrigatório

Token simples enviado por query.

Parâmetros de consulta

tokenstringObrigatório

Token de autenticação.

Example: token_api

platform_idstringObrigatório

channel_idstringObrigatório

typestring · enumObrigatórioValores possíveis:

messagestringOpcional

Respostas

200

Mensagem enviada.

application/json

Other propertiesanyOpcional

401

Não autorizado.

application/json

422

Erro de validação.

application/json

500

Erro interno.

application/json

get

/v4/message/send

HTTPcURLJavaScriptPython

GET /api/v4/message/send?token=text&platform_id=text&channel_id=text&type=text HTTP/1.1
Accept: */*

{
  "message": "Mensagem enviada",
  "session_id": "session_123"
}

Enviar mensagem

post

Envia mensagem com os dados informados.

Autorizações

JwtAuth

AuthorizationstringObrigatório

Token JWT no header Authorization.

Corpo

application/json

contact_namestringOpcional

platform_idstringObrigatório

channel_idstringObrigatório

agent_idstringOpcional

typestring · enumObrigatórioValores possíveis:

messagestringOpcional

filestringOpcional

legendstringOpcional

close_sessioninteger · enumOpcionalValores possíveis:

agentstring · emailOpcional

attendance_idstringOpcional

is_hsmbooleanOpcional

hsm_template_namestringOpcional

hsm_placeholdersstring[]Opcional

gatewaystringOpcional

start_conversationbooleanOpcional

subjectstringOpcional

context_idstringOpcional

Respostas

200

Mensagem enviada.

application/json

Other propertiesanyOpcional

401

Não autorizado.

application/json

422

Erro de validação.

application/json

500

Erro interno.

application/json

post

/v4/message/send

HTTPcURLJavaScriptPython

POST /api/v4/message/send HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 92

{
  "platform_id": "contact_platform",
  "channel_id": "channel_123",
  "type": "text",
  "message": "Olá"
}

{
  "message": "Mensagem enviada",
  "session_id": "session_123"
}

Enviar mensagem (GET) - send_plus

get

Observação: Endpoint com efeito colateral via GET.

Autorizações

ApiTokenQuery

tokenstringObrigatório

Token simples enviado por query.

Parâmetros de consulta

tokenstringObrigatório

Token de autenticação.

Example: token_api

Respostas

200

Mensagem enviada.

application/json

Other propertiesanyOpcional

401

Não autorizado.

application/json

422

Erro de validação.

application/json

500

Erro interno.

application/json

get

/v4/message/send_plus

HTTPcURLJavaScriptPython

GET /api/v4/message/send_plus?token=text HTTP/1.1
Accept: */*

{
  "message": "Mensagem enviada",
  "session_id": "session_123"
}

Enviar mensagem (send_plus)

post

Envia mensagem com os dados informados.

Autorizações

JwtAuth

AuthorizationstringObrigatório

Token JWT no header Authorization.

Corpo

application/json

contact_namestringOpcional

platform_idstringObrigatório

channel_idstringObrigatório

agent_idstringOpcional

typestring · enumObrigatórioValores possíveis:

messagestringOpcional

filestringOpcional

legendstringOpcional

close_sessioninteger · enumOpcionalValores possíveis:

agentstring · emailOpcional

attendance_idstringOpcional

is_hsmbooleanOpcional

hsm_template_namestringOpcional

hsm_placeholdersstring[]Opcional

gatewaystringOpcional

start_conversationbooleanOpcional

subjectstringOpcional

context_idstringOpcional

Respostas

200

Mensagem enviada.

application/json

Other propertiesanyOpcional

401

Não autorizado.

application/json

422

Erro de validação.

application/json

500

Erro interno.

application/json

post

/v4/message/send_plus

HTTPcURLJavaScriptPython

POST /api/v4/message/send_plus HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 131

{
  "platform_id": "contact_platform",
  "channel_id": "channel_123",
  "type": "text",
  "message": "Olá",
  "contact_variables": {
    "name": "Cliente"
  }
}

{
  "message": "Mensagem enviada",
  "session_id": "session_123"
}

Marcar mensagens como lidas

post

Marca mensagens como lidas conforme os parâmetros informados.

Autorizações

JwtAuth

AuthorizationstringObrigatório

Token JWT no header Authorization.

Corpo

application/json

platform_idstringObrigatório

channel_idstringObrigatório

Respostas

200

Sucesso.

application/json

Other propertiesanyOpcional

404

Não encontrado.

application/json

422

Erro de validação.

application/json

post

/v4/message/read

HTTPcURLJavaScriptPython

POST /api/v4/message/read HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 57

{
  "platform_id": "platform_123",
  "channel_id": "channel_123"
}

{
  "status": true,
  "message": "Sucesso"
}

Obter quantidade de mensagens pendentes

post

Recupera quantidade de mensagens pendentes.

Autorizações

JwtAuth

AuthorizationstringObrigatório

Token JWT no header Authorization.

Corpo

application/json

platform_idstringObrigatório

channel_idstringObrigatório

Respostas

200

Contagem de pendentes.

application/json

countintegerOpcional

404

Não encontrado.

application/json

422

Erro de validação.

application/json

post

/v4/message/pending

HTTPcURLJavaScriptPython

POST /api/v4/message/pending HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 57

{
  "platform_id": "platform_123",
  "channel_id": "channel_123"
}

{
  "count": 3
}

Substituir variáveis de mensagem

post

Processa a solicitação de substituir variáveis de mensagem e retorna o resultado.

Autorizações

JwtAuth

AuthorizationstringObrigatório

Token JWT no header Authorization.

Corpo

application/json

messagestringObrigatório

session_idstringObrigatório

Respostas

200

Mensagem com variáveis substituídas.

application/json

stringOpcional

404

Não encontrado.

application/json

422

Erro de validação.

application/json

post

/v4/message/replace_vars

HTTPcURLJavaScriptPython

POST /api/v4/message/replace_vars HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 52

{
  "message": "Olá {nome}",
  "session_id": "session_123"
}

Olá Maria

Criar anotação de mensagem

post

Cria anotação de mensagem com os dados enviados.

Autorizações

JwtAuth

AuthorizationstringObrigatório

Token JWT no header Authorization.

Parâmetros de rota

messageIdstringObrigatório

Identificador da mensagem.

Example: msg_123

Corpo

application/json

annotationstring · máx: 255Obrigatório

Respostas

200

Sucesso.

application/json

Other propertiesanyOpcional

422

Erro de validação.

application/json

post

/v4/message/{messageId}/annotation

HTTPcURLJavaScriptPython

POST /api/v4/message/{messageId}/annotation HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 36

{
  "annotation": "Mensagem importante"
}

{
  "status": true,
  "message": "Sucesso"
}

Remover anotação de mensagem

delete

Remove anotação de mensagem identificado no caminho.

Autorizações

JwtAuth

AuthorizationstringObrigatório

Token JWT no header Authorization.

Parâmetros de rota

messageIdstringObrigatório

Identificador da mensagem.

Example: msg_123

Respostas

200

Sucesso.

application/json

Other propertiesanyOpcional

404

Não encontrado.

application/json

delete

/v4/message/{messageId}/annotation

HTTPcURLJavaScriptPython

DELETE /api/v4/message/{messageId}/annotation HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "status": true,
  "message": "Sucesso"
}

Listar mensagens predefinidas

get

Retorna mensagens predefinidas conforme filtros enviados.

Autorizações

JwtAuth

AuthorizationstringObrigatório

Token JWT no header Authorization.

Respostas

200

Sucesso.

application/json

Other propertiesanyOpcional

get

/v4/predefined_messages

HTTPcURLJavaScriptPython

GET /api/v4/predefined_messages HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Sucesso.

{
  "status": true,
  "message": "Sucesso"
}

Criar mensagem predefinida

post

Cria mensagem predefinida com os dados enviados.

Autorizações

JwtAuth

AuthorizationstringObrigatório

Token JWT no header Authorization.

Corpo

application/json

descriptionstringObrigatório

Respostas

200

Sucesso.

application/json

Other propertiesanyOpcional

post

/v4/predefined_messages

HTTPcURLJavaScriptPython

POST /api/v4/predefined_messages HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 61

{
  "description": "Boas-vindas",
  "message": [
    {
      "message": "Olá!"
    }
  ]
}

200

Sucesso.

{
  "status": true,
  "message": "Sucesso"
}

Detalhar mensagem predefinida

get

Recupera os dados de mensagem predefinida identificado no caminho.

Autorizações

JwtAuth

AuthorizationstringObrigatório

Token JWT no header Authorization.

Parâmetros de rota

idstringObrigatórioExample: pm_123

Respostas

200

Sucesso.

application/json

Other propertiesanyOpcional

get

/v4/predefined_messages/{id}

HTTPcURLJavaScriptPython

GET /api/v4/predefined_messages/{id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Sucesso.

{
  "status": true,
  "message": "Sucesso"
}

Atualizar mensagem predefinida

put

Atualiza mensagem predefinida conforme os dados enviados.

Autorizações

JwtAuth

AuthorizationstringObrigatório

Token JWT no header Authorization.

Parâmetros de rota

idstringObrigatório

Corpo

application/json

descriptionstringObrigatório

Respostas

200

Sucesso.

application/json

Other propertiesanyOpcional

put

/v4/predefined_messages/{id}

HTTPcURLJavaScriptPython

PUT /api/v4/predefined_messages/{id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 61

{
  "description": "Boas-vindas",
  "message": [
    {
      "message": "Olá!"
    }
  ]
}

200

Sucesso.

{
  "status": true,
  "message": "Sucesso"
}

Remover mensagem predefinida

delete

Remove mensagem predefinida identificado no caminho.

Autorizações

JwtAuth

AuthorizationstringObrigatório

Token JWT no header Authorization.

Parâmetros de rota

idstringObrigatório

Respostas

204

Removido.

404

Não encontrado.

application/json

delete

/v4/predefined_messages/{id}

HTTPcURLJavaScriptPython

DELETE /api/v4/predefined_messages/{id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

Sem conteúdo

Buscar por campanhas

post

Pesquisa por campanhas conforme critérios enviados.

Autorizações

JwtAuth

AuthorizationstringObrigatório

Token JWT no header Authorization.

Corpo

application/json

campaignsstring[] · mín: 1Obrigatório

order_bystring · enumOpcionalValores possíveis:

Respostas

200

Sucesso.

application/json

Other propertiesanyOpcional

post

/v4/predefined_messages/by_campaigns

HTTPcURLJavaScriptPython

POST /api/v4/predefined_messages/by_campaigns HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 49

{
  "campaigns": [
    "camp_1"
  ],
  "order_by": "description"
}

200

Sucesso.

{
  "status": true,
  "message": "Sucesso"
}

Enviar mensagem em canal genérico

post

Envia mensagem em canal genérico com os dados informados.

Corpo

application/json

Other propertiesanyOpcional

Respostas

200

Mensagem enviada.

application/json

Other propertiesanyOpcional

422

Erro de validação.

application/json

post

/v4/generic/messages/send

HTTPcURLJavaScriptPython

POST /api/v4/generic/messages/send HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 74

{
  "platform_id": "platform_123",
  "channel_id": "channel_123",
  "message": "Olá"
}

{
  "message": "Mensagem enviada",
  "session_id": "session_123"
}