API de bate-papo na Web
Conecte-se com nossa API de bate- papo na Web, obtenha insights sobre conversas de bate-papo ou comunique-se a partir de seu próprio software em tempo real.
- API HTTP, Conecte-se via HTTP usando qualquer linguagem de programação.
- 99,9% SLA, Otimizamos o desempenho de todos os servidores.
Funcionalidade da API
Obtenha uma lista de canais de chat ativos
Parâmetro | Descrição | Mandatório / Opcional |
---|---|---|
class=chat | Classe pedida: Classe à qual o pedido é requisitado | Mandatório |
method=getchatchannels | Método de classe requisitado: Método da classe à qual o pedido é requisitado | Mandatório |
user | Utilizador e email da sua conta Afilnet | Mandatório |
password | Password da sua conta Afilnet | Mandatório |
Responda:
- status
-
result (if status=success), aqui receberá os seguintes valores:
-
list
- platformid
- platform
- name
-
list
- error (if status=error), aqui receberá o código de erro
Códigos de erro:
Código | Descrição |
---|---|
MISSING_USER | Utilizador ou email não incluído |
MISSING_PASSWORD | Password não incluída |
MISSING_CLASS | Classe não incluída |
MISSING_METHOD | Método não incluído |
MISSING_COMPULSORY_PARAM | Parâmetro obrigatório não incluído |
INCORRECT_USER_PASSWORD | Utilizador ou password incorretos |
INCORRECT_CLASS | Classe incorreta |
INCORRECT_METHOD | Método incorreto |
Parâmetros:
- class : chat
- method : getchatchannels
- user : user
- password : password
Pedido:
Envie uma mensagem por bate-papo
Parâmetro | Descrição | Mandatório / Opcional |
---|---|---|
class=chat | Classe pedida: Classe à qual o pedido é requisitado | Mandatório |
method=sendmessage | Método de classe requisitado: Método da classe à qual o pedido é requisitado | Mandatório |
user | Utilizador e email da sua conta Afilnet | Mandatório |
password | Password da sua conta Afilnet | Mandatório |
platform | Plataforma para a qual a mensagem é enviada. Valores possíveis: 'webchat', 'whatsapp', 'telegram', 'operator' | Mandatório |
platformid | Identificador de plataforma | Mandatório |
destination | Destinatário para onde a mensagem de bate-papo é enviada | Mandatório |
message | Mensagem para enviar via chat | Mandatório |
Responda:
- status
-
result (if status=success), aqui receberá os seguintes valores:
- Não lhe será enviado qualquer valor adicional
- error (if status=error), aqui receberá o código de erro
Códigos de erro:
Código | Descrição |
---|---|
MISSING_USER | Utilizador ou email não incluído |
MISSING_PASSWORD | Password não incluída |
MISSING_CLASS | Classe não incluída |
MISSING_METHOD | Método não incluído |
MISSING_COMPULSORY_PARAM | Parâmetro obrigatório não incluído |
INCORRECT_USER_PASSWORD | Utilizador ou password incorretos |
INCORRECT_CLASS | Classe incorreta |
INCORRECT_METHOD | Método incorreto |
CHANNEL_NOT_FOUND | O canal indicado não existe |
Parâmetros:
- class : chat
- method : sendmessage
- user : user
- password : password
- platform : whatsapp
- platformid : 100
- destination : 3460000000
- message : test+message
Pedido:
Envie um arquivo por bate-papo
Parâmetro | Descrição | Mandatório / Opcional |
---|---|---|
class=chat | Classe pedida: Classe à qual o pedido é requisitado | Mandatório |
method=sendfile | Método de classe requisitado: Método da classe à qual o pedido é requisitado | Mandatório |
user | Utilizador e email da sua conta Afilnet | Mandatório |
password | Password da sua conta Afilnet | Mandatório |
platform | Plataforma para a qual a mensagem é enviada. Valores possíveis: 'webchat', 'whatsapp', 'telegram', 'operator' | Mandatório |
platformid | Identificador de plataforma | Mandatório |
destination | Destinatário para onde o arquivo é enviado | Mandatório |
type | Tipo de arquivo sendo enviado. Valores possíveis: 'imagem', 'vídeo', 'áudio', 'voz', 'documento', 'contato' | Mandatório |
fileurl | Url onde se encontra o arquivo a ser enviado por chat | Mandatório |
thumburl | Url da imagem em miniatura que acompanha o arquivo | Opcional |
message | Mensagem que acompanha o arquivo | Opcional |
Responda:
- status
-
result (if status=success), aqui receberá os seguintes valores:
- Não lhe será enviado qualquer valor adicional
- error (if status=error), aqui receberá o código de erro
Códigos de erro:
Código | Descrição |
---|---|
MISSING_USER | Utilizador ou email não incluído |
MISSING_PASSWORD | Password não incluída |
MISSING_CLASS | Classe não incluída |
MISSING_METHOD | Método não incluído |
MISSING_COMPULSORY_PARAM | Parâmetro obrigatório não incluído |
INCORRECT_USER_PASSWORD | Utilizador ou password incorretos |
INCORRECT_CLASS | Classe incorreta |
INCORRECT_METHOD | Método incorreto |
CHANNEL_NOT_FOUND | O canal indicado não existe |
CHAT_NOT_FOUND | O chat indicado não existe |
INCORRECT_FILETYPE | O tipo de arquivo está errado, verifique os valores possíveis |
INCORRECT_FILEURL | O url do arquivo não é válido |
INCORRECT_THUMBURL | O url da miniatura é inválido |
Parâmetros:
- class : chat
- method : sendfile
- user : user
- password : password
- platform : whatsapp
- platformid : 100
- destination : 3460000000
- type : image
- fileurl : https://www.example.com/image.jpg
- thumburl : https://www.example.com/thumb.jpg
- message : test+message
Pedido:
Obtenha uma lista de conversas em um bate-papo
Parâmetro | Descrição | Mandatório / Opcional |
---|---|---|
class=chat | Classe pedida: Classe à qual o pedido é requisitado | Mandatório |
method=getchats | Método de classe requisitado: Método da classe à qual o pedido é requisitado | Mandatório |
user | Utilizador e email da sua conta Afilnet | Mandatório |
password | Password da sua conta Afilnet | Mandatório |
platform | Plataforma para a qual a mensagem é enviada. Valores possíveis: 'webchat', 'whatsapp', 'telegram', 'operator' | Mandatório |
platformid | Identificador de plataforma | Mandatório |
Responda:
- status
-
result (if status=success), aqui receberá os seguintes valores:
-
list
- platformid
- platform
- message
- destination
- messageid
- sent
- status
- datetime
-
list
- error (if status=error), aqui receberá o código de erro
Códigos de erro:
Código | Descrição |
---|---|
MISSING_USER | Utilizador ou email não incluído |
MISSING_PASSWORD | Password não incluída |
MISSING_CLASS | Classe não incluída |
MISSING_METHOD | Método não incluído |
MISSING_COMPULSORY_PARAM | Parâmetro obrigatório não incluído |
INCORRECT_USER_PASSWORD | Utilizador ou password incorretos |
INCORRECT_CLASS | Classe incorreta |
INCORRECT_METHOD | Método incorreto |
CHANNEL_NOT_FOUND | O canal indicado não existe |
CHAT_NOT_FOUND | O chat indicado não existe |
Parâmetros:
- class : chat
- method : getchats
- user : user
- password : password
- platform : whatsapp
- platformid : 100
Pedido:
Obtenha uma lista de mensagens de um bate-papo
Parâmetro | Descrição | Mandatório / Opcional |
---|---|---|
class=chat | Classe pedida: Classe à qual o pedido é requisitado | Mandatório |
method=getmessages | Método de classe requisitado: Método da classe à qual o pedido é requisitado | Mandatório |
user | Utilizador e email da sua conta Afilnet | Mandatório |
password | Password da sua conta Afilnet | Mandatório |
platform | Plataforma para a qual a mensagem é enviada. Valores possíveis: 'webchat', 'whatsapp', 'telegram', 'operator' | Mandatório |
platformid | Identificador de plataforma | Mandatório |
destination | Destinatário do qual você deseja obter as mensagens | Mandatório |
Responda:
- status
-
result (if status=success), aqui receberá os seguintes valores:
-
list
- platformid
- platform
- message
- destination
- messageid
- sent
- status
- datetime
-
list
- error (if status=error), aqui receberá o código de erro
Códigos de erro:
Código | Descrição |
---|---|
MISSING_USER | Utilizador ou email não incluído |
MISSING_PASSWORD | Password não incluída |
MISSING_CLASS | Classe não incluída |
MISSING_METHOD | Método não incluído |
MISSING_COMPULSORY_PARAM | Parâmetro obrigatório não incluído |
INCORRECT_USER_PASSWORD | Utilizador ou password incorretos |
INCORRECT_CLASS | Classe incorreta |
INCORRECT_METHOD | Método incorreto |
CHANNEL_NOT_FOUND | O canal indicado não existe |
CHAT_NOT_FOUND | O chat indicado não existe |
Parâmetros:
- class : chat
- method : getmessages
- user : user
- password : password
- platform : whatsapp
- platformid : 100
- destination : 34600000000
Pedido:
Obtenha uma lista de mensagens não lidas de um bate-papo
Parâmetro | Descrição | Mandatório / Opcional |
---|---|---|
class=chat | Classe pedida: Classe à qual o pedido é requisitado | Mandatório |
method=getunreadmessages | Método de classe requisitado: Método da classe à qual o pedido é requisitado | Mandatório |
user | Utilizador e email da sua conta Afilnet | Mandatório |
password | Password da sua conta Afilnet | Mandatório |
platform | Plataforma para a qual a mensagem é enviada. Valores possíveis: 'webchat', 'whatsapp', 'telegram', 'operator' | Mandatório |
platformid | Identificador de plataforma | Mandatório |
destination | Destinatário do qual você deseja obter as mensagens | Mandatório |
Responda:
- status
-
result (if status=success), aqui receberá os seguintes valores:
-
list
- platformid
- platform
- message
- destination
- messageid
- issent
- status
- datetime
-
list
- error (if status=error), aqui receberá o código de erro
Códigos de erro:
Código | Descrição |
---|---|
MISSING_USER | Utilizador ou email não incluído |
MISSING_PASSWORD | Password não incluída |
MISSING_CLASS | Classe não incluída |
MISSING_METHOD | Método não incluído |
MISSING_COMPULSORY_PARAM | Parâmetro obrigatório não incluído |
INCORRECT_USER_PASSWORD | Utilizador ou password incorretos |
INCORRECT_CLASS | Classe incorreta |
INCORRECT_METHOD | Método incorreto |
CHANNEL_NOT_FOUND | O canal indicado não existe |
CHAT_NOT_FOUND | O chat indicado não existe |
Parâmetros:
- class : chat
- method : getunreadmessages
- user : user
- password : password
- platform : whatsapp
- platformid : 100
- destination : 34600000000
Pedido:
Ferramentas que melhoram nossa API de bate-papo na Web
CONEXÃO DE API SEGURA
Segurança à medida do seu negócio
Configure suas conexões API, crie novos acessos e gerencie os existentes.
Filtre todos os acessos API por IP, adicione ou remova IPs habilitados para garantir a segurança de seus acessos.
Acompanhe todas as conexões feitas, API usada e datas / horas de conexão
VÁRIAS APIs
Conectividade sob medida para o seu negócio
Oferecemos várias APIs para se conectar conosco, temos uma API HTTP, BASIC AUTH, SOAP e Autenticação JWT para que você possa se conectar conosco da maneira que desejar.
Conecte-se com qualquer uma das APIs de forma segura, simples e centralizada . A API Afilnet é perfeita para o seu software.
Registros de API
Conheça cada solicitação em detalhes
Graças aos nossos logs poderá rever todas as solicitações feitas e a resposta correspondente da nossa API, que lhe permitirá consultar detalhes quando precisar deles.
A informação que pode consultar é a seguinte:
- IP de origem da solicitação
- Data e hora do pedido
- API e método sendo chamados
- Parâmetros enviados para a API
- Resposta da API
- metadados
Etapas para usar a API do Web Chat
A introdução à API do Web Chat levará apenas alguns minutos
Solicite sua avaliação gratuita
Você deve ser um usuário registrado na Afilnet para ter acesso à API do Web Chat. Inscreva-se em alguns minutos.
Integrar a API do Web Chat
Integre com a API do Web Chat usando o código que fornecemos para sua linguagem de programação favorita.
Solicite sua avaliação gratuita
Ofereceremos crédito gratuito para que você possa experimentar o serviço de Web Chat antes de comprar.
Bem vindo ao Afilnet!
Tudo pronto!, conseguiu melhorar as suas comunicações com a Afilnet. Estamos aqui para dar suporte à nossa API quando você precisar