WebChat

Inscrever push

post

Processa a solicitação de inscrever push e retorna o resultado.

Parâmetros de rota

channelstringObrigatório

ID do canal WebChat.

Example: channel_123

Corpo

application/json

Other propertiesanyOpcional

Respostas

200

Sucesso.

application/json

Other propertiesanyOpcional

post

/v4/webchat/{channel}/push/subscribe

HTTPcURLJavaScriptPython

POST /api/v4/webchat/{channel}/push/subscribe HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 39

{
  "endpoint": "https://push.example.com"
}

200

Sucesso.

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

Remover inscrição push

post

Remove inscrição push identificado no caminho.

Parâmetros de rota

channelstringObrigatórioExample: channel_123

Corpo

application/json

Other propertiesanyOpcional

Respostas

200

Sucesso.

application/json

Other propertiesanyOpcional

post

/v4/webchat/{channel}/push/subscribe/delete

HTTPcURLJavaScriptPython

POST /api/v4/webchat/{channel}/push/subscribe/delete HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 39

{
  "endpoint": "https://push.example.com"
}

200

Sucesso.

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

Manifest do canal

get

Processa a solicitação de manifest do canal e retorna o resultado.

Parâmetros de rota

channelstringObrigatórioExample: channel_123

Respostas

200

Sucesso.

application/json

Other propertiesanyOpcional

get

/v4/webchat/{channel}/manifest.json

HTTPcURLJavaScriptPython

GET /api/v4/webchat/{channel}/manifest.json HTTP/1.1
Accept: */*

200

Sucesso.

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

Configuração do canal

get

Processa a solicitação de configuração do canal e retorna o resultado.

Parâmetros de rota

channelstringObrigatórioExample: channel_123

Respostas

200

Sucesso.

application/json

Other propertiesanyOpcional

get

/v4/webchat/{channel}/configuration

HTTPcURLJavaScriptPython

GET /api/v4/webchat/{channel}/configuration HTTP/1.1
Accept: */*

200

Sucesso.

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

Verificar sessão existente

get

Verifica sessão existente e retorna o estado atual.

Parâmetros de rota

channelstringObrigatórioExample: channel_123

Respostas

200

Sucesso.

application/json

Other propertiesanyOpcional

get

/v4/webchat/{channel}/session-exists

HTTPcURLJavaScriptPython

GET /api/v4/webchat/{channel}/session-exists HTTP/1.1
Accept: */*

200

Sucesso.

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

Listar mensagens do WebChat

get

Retorna mensagens do WebChat conforme filtros enviados.

Parâmetros de rota

channelstringObrigatórioExample: channel_123

Respostas

200

Sucesso.

application/json

Other propertiesanyOpcional

get

/v4/webchat/{channel}/messages

HTTPcURLJavaScriptPython

GET /api/v4/webchat/{channel}/messages HTTP/1.1
Accept: */*

200

Sucesso.

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

Criar sessão WebChat

post

Cria sessão WebChat com os dados enviados.

Parâmetros de rota

channelstringObrigatórioExample: channel_123

Corpo

application/json

Other propertiesanyOpcional

Respostas

200

Sucesso.

application/json

Other propertiesanyOpcional

post

/v4/webchat/{channel}/session-create

HTTPcURLJavaScriptPython

POST /api/v4/webchat/{channel}/session-create HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 52

{
  "name": "Visitante",
  "email": "[email protected]"
}

200

Sucesso.

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

Finalizar sessão WebChat

post

Finaliza sessão WebChat conforme a sessão informada.

Parâmetros de rota

channelstringObrigatórioExample: channel_123

Corpo

application/json

Other propertiesanyOpcional

Respostas

200

Sucesso.

application/json

Other propertiesanyOpcional

post

/v4/webchat/{channel}/session-finish

HTTPcURLJavaScriptPython

POST /api/v4/webchat/{channel}/session-finish HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 28

{
  "session_id": "session_123"
}

200

Sucesso.

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

Atualizar sessão WebChat

patch

Atualiza sessão WebChat conforme os dados enviados.

Parâmetros de rota

channelstringObrigatórioExample: channel_123

Corpo

application/json

Other propertiesanyOpcional

Respostas

200

Sucesso.

application/json

Other propertiesanyOpcional

patch

/v4/webchat/{channel}/session-update

HTTPcURLJavaScriptPython

PATCH /api/v4/webchat/{channel}/session-update HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 47

{
  "session_id": "session_123",
  "name": "Visitante"
}

200

Sucesso.

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

Reiniciar fluxo

post

Reinicia fluxo no contexto do canal informado.

Parâmetros de rota

channelstringObrigatório

Corpo

application/json

Other propertiesanyOpcional

Respostas

200

Sucesso.

application/json

Other propertiesanyOpcional

post

/v4/webchat/{channel}/flow-restart

HTTPcURLJavaScriptPython

POST /api/v4/webchat/{channel}/flow-restart HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 28

{
  "session_id": "session_123"
}

200

Sucesso.

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

Auto iniciar fluxo

post

Aciona o auto início de fluxo para o canal informado.

Parâmetros de rota

channelstringObrigatório

Corpo

application/json

Other propertiesanyOpcional

Respostas

200

Sucesso.

application/json

Other propertiesanyOpcional

post

/v4/webchat/{channel}/flow-autoStart

HTTPcURLJavaScriptPython

POST /api/v4/webchat/{channel}/flow-autoStart HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 28

{
  "session_id": "session_123"
}

200

Sucesso.

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

Finalizar fluxo

delete

Finaliza fluxo conforme a sessão informada.

Parâmetros de rota

channelstringObrigatório

Respostas

200

Sucesso.

application/json

Other propertiesanyOpcional

delete

/v4/webchat/{channel}/flow-finish

HTTPcURLJavaScriptPython

DELETE /api/v4/webchat/{channel}/flow-finish HTTP/1.1
Accept: */*

200

Sucesso.

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

Encerrar simulador de fluxo

post

Encerra simulador de fluxo conforme a sessão informada.

Parâmetros de rota

channelstringObrigatório

Corpo

application/json

Other propertiesanyOpcional

Respostas

200

Sucesso.

application/json

Other propertiesanyOpcional

post

/v4/webchat/{channel}/simulator-finish

HTTPcURLJavaScriptPython

POST /api/v4/webchat/{channel}/simulator-finish HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 28

{
  "session_id": "session_123"
}

200

Sucesso.

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