API de gerenciamento de contatos

Gerencie grupos de contas e contatos da Afilnet a partir de nossa API. Crie, edite ou modifique informações de grupo ou contato de seu próprio software.

  • API HTTP, gerencie grupos e contatos de qualquer linguagem de programação
  • 99,9% SLA, Otimizamos o desempenho de todos os servidores.
API do SMS

Linguagens de programação

Clique na linguagem de programação de sua preferência e acesse exemplos para integrar a API de Contatos com apenas copiar e colar

Funcionalidade da API

Criar grupo

Método API que permite criar um grupo de contatos na Afilnet. Os grupos de contatos podem ser usados para gerenciar embarques automatizados ou para realizar campanhas por SMS, voz ou e-mail.
Parâmetro Descrição Mandatório / Opcional
class=group Classe pedida: Classe à qual o pedido é requisitado Mandatório
method=creategroup 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
name Nome do grupo Mandatório
type Tipo de grupo (email ou móvel) Mandatório
fields Lista de campos separados por vírgulas. É obrigatório incluir um campo de telemóvel se tipo = mobile e um campo de email se tipo = email 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
INCORRECT_TYPE Tipo incorreto. O tipo deve ser mobile ou email
MISSING_MAIN_FIELD Campo principal em falta (mobile se tipo = mobile ou email se tipo = email)

Parâmetros:

  • class : group
  • method : creategroup
  • user : user
  • password : password
  • name : test name
  • type : mobile
  • fields : mobile,name,address

Pedido:

https://www.afilnet.com/api/http/?class=group&method=creategroup&user=user&password=password&name=test name&type=mobile&fields=mobile,name,address

Obter lista de campo de grupo

Método de API que permite obter uma lista de todos os campos em um grupo. Estes campos permitirão que você personalize suas mensagens (SMS, voz, e-mail, ...).
Parâmetro Descrição Mandatório / Opcional
class=group Classe pedida: Classe à qual o pedido é requisitado Mandatório
method=getgroupcolumns 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
idgroup Identificador do grupo 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
NOT_ACCESS_TO_GROUP Não tem acesso ao grupo indicado

Parâmetros:

  • class : group
  • method : getgroupcolumns
  • user : user
  • password : password
  • idgroup : 1000

Pedido:

https://www.afilnet.com/api/http/?class=group&method=getgroupcolumns&user=user&password=password&idgroup=1000

Adicionar um campo a um grupo

Método de API que permite adicionar um novo campo ao seu grupo de contatos. Cada campo é um dado adicional que armazena sobre os contatos do grupo (nome, sobrenome, endereço, referência, etc.)
Parâmetro Descrição Mandatório / Opcional
class=group Classe pedida: Classe à qual o pedido é requisitado Mandatório
method=addcolumntogroup 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
idgroup Identificador do grupo Mandatório
field Campo do grupo 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
NOT_ACCESS_TO_GROUP Não tem acesso ao grupo indicado

Parâmetros:

  • class : group
  • method : addcolumntogroup
  • user : user
  • password : password
  • idgroup : 1000
  • field : name

Pedido:

https://www.afilnet.com/api/http/?class=group&method=addcolumntogroup&user=user&password=password&idgroup=1000&field=name

Eliminar um campo de um grupo

Método de API que permite remover um campo existente de seu grupo de contato.
Parâmetro Descrição Mandatório / Opcional
class=group Classe pedida: Classe à qual o pedido é requisitado Mandatório
method=deletecolumnfromgroup 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
idgroup Identificador do grupo Mandatório
field Campo do grupo 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
NOT_ACCESS_TO_GROUP Não tem acesso ao grupo indicado

Parâmetros:

  • class : group
  • method : deletecolumnfromgroup
  • user : user
  • password : password
  • idgroup : 1000
  • field : name

Pedido:

https://www.afilnet.com/api/http/?class=group&method=deletecolumnfromgroup&user=user&password=password&idgroup=1000&field=name

Elimina un contatto da un gruppo

Método de API que permite excluir um grupo de contatos.
Parâmetro Descrição Mandatório / Opcional
class=group Classe pedida: Classe à qual o pedido é requisitado Mandatório
method=deletegroup 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
idgroup Identificador do grupo 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
NOT_ACCESS_TO_GROUP Não tem acesso ao grupo indicado

Parâmetros:

  • class : group
  • method : deletegroup
  • user : user
  • password : password
  • idgroup : 1000

Pedido:

https://www.afilnet.com/api/http/?class=group&method=deletegroup&user=user&password=password&idgroup=1000

Atribuir país a um grupo

Método API que permite atribuir um país a um grupo de contatos. Isso é obrigatório para criar eventos associados ao grupo.
Parâmetro Descrição Mandatório / Opcional
class=group Classe pedida: Classe à qual o pedido é requisitado Mandatório
method=assigncountrytogroup 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
idgroup Identificador do grupo Mandatório
countryiso3 Código ISO do país 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
NOT_ACCESS_TO_GROUP Não tem acesso ao grupo indicado
COUNTRY_NOT_FOUND Não há nenhum país com o código indicado

Parâmetros:

  • class : group
  • method : assigncountrytogroup
  • user : user
  • password : password
  • idgroup : 1000
  • countryiso3 : esp

Pedido:

https://www.afilnet.com/api/http/?class=group&method=assigncountrytogroup&user=user&password=password&idgroup=1000&countryiso3=esp

Obter lista de contactos de grupo

Método API que permite obter todos os contatos associados a um grupo.
Parâmetro Descrição Mandatório / Opcional
class=group Classe pedida: Classe à qual o pedido é requisitado Mandatório
method=getcontacts 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
idgroup Identificador do grupo 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
NOT_ACCESS_TO_GROUP Não tem acesso ao grupo indicado

Parâmetros:

  • class : group
  • method : getcontacts
  • user : user
  • password : password
  • idgroup : 1000

Pedido:

https://www.afilnet.com/api/http/?class=group&method=getcontacts&user=user&password=password&idgroup=1000

Obter um contato de um grupo

Método de API que retorna um contato de um grupo.
Parâmetro Descrição Mandatório / Opcional
class=group Classe pedida: Classe à qual o pedido é requisitado Mandatório
method=getcontact 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
idgroup ID do grupo Mandatório
idcontact ID de contato 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
NOT_ACCESS_TO_GROUP Não tem acesso ao grupo indicado
NOT_ACCESS_TO_CONTACT ERROR_NOT_ACCESS_TO_CONTACT

Parâmetros:

  • class : group
  • method : getcontact
  • user : user
  • password : password
  • idgroup : 1000
  • idcontact : 1000

Pedido:

https://www.afilnet.com/api/http/?class=group&method=getcontact&user=user&password=password&idgroup=1000&idcontact=1000

Adicionar contacto a um grupo

Método API que permite adicionar um novo contato a um grupo. O contato a ser adicionado deve ter atribuído todos os campos registrados no grupo.
Parâmetro Descrição Mandatório / Opcional
class=group Classe pedida: Classe à qual o pedido é requisitado Mandatório
method=addcontact 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
idgroup Identificador do grupo Mandatório
contact Contacto a ser adicionado com os seus campos separados por vírgulas, ver exemplo 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
CONTACT_EXISTS O contacto já se encontra no grupo
NOT_ACCESS_TO_GROUP Não tem acesso ao grupo indicado

Parâmetros:

  • class : group
  • method : addcontact
  • user : user
  • password : password
  • idgroup : 1000
  • contact : mobile:123456789,name:testname

Pedido:

https://www.afilnet.com/api/http/?class=group&method=addcontact&user=user&password=password&idgroup=1000&contact=mobile:123456789,name:testname

Adicionar uma lista de contatos a um grupo

Método de API que adiciona uma lista de contatos a um grupo.
Parâmetro Descrição Mandatório / Opcional
class=group Classe pedida: Classe à qual o pedido é requisitado Mandatório
method=addcontactlist 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
idgroup ID do grupo Mandatório
contacts Lista de contatos em formato JSON 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
NOT_ACCESS_TO_GROUP Não tem acesso ao grupo indicado

Parâmetros:

  • class : group
  • method : addcontactlist
  • user : user
  • password : password
  • idgroup : 1000
  • contacts : [{"name":"Test","mobile":"34600000000"},{"name":"Test","mobile":"34600000001"}]

Pedido:

https://www.afilnet.com/api/http/?class=group&method=addcontactlist&user=user&password=password&idgroup=1000&contacts=[{"name":"Test","mobile":"34600000000"},{"name":"Test","mobile":"34600000001"}]

Modificar contacto de um grupo

Método API que permite modificar um contato em um grupo. O contato deve ter atribuído todos os campos cadastrados no grupo.
Parâmetro Descrição Mandatório / Opcional
class=group Classe pedida: Classe à qual o pedido é requisitado Mandatório
method=modifycontact 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
idgroup Identificador do grupo Mandatório
idcontact Identificador do contacto Mandatório
contact Contacto a ser adicionado com os seus campos separados por vírgulas, ver exemplo 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
NOT_ACCESS_TO_GROUP Não tem acesso ao grupo indicado

Parâmetros:

  • class : group
  • method : modifycontact
  • user : user
  • password : password
  • idgroup : 1000
  • idcontact : 1000
  • contact : mobile:123456789,name:testname

Pedido:

https://www.afilnet.com/api/http/?class=group&method=modifycontact&user=user&password=password&idgroup=1000&idcontact=1000&contact=mobile:123456789,name:testname

Eliminar contacto de um grupo

Método de API que permite remover um contato de um grupo.
Parâmetro Descrição Mandatório / Opcional
class=group Classe pedida: Classe à qual o pedido é requisitado Mandatório
method=deletecontact 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
idgroup Identificador do grupo Mandatório
idcontact Identificador do contacto 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
NOT_ACCESS_TO_GROUP Não tem acesso ao grupo indicado

Parâmetros:

  • class : group
  • method : deletecontact
  • user : user
  • password : password
  • idgroup : 1000
  • idcontact : 1000

Pedido:

https://www.afilnet.com/api/http/?class=group&method=deletecontact&user=user&password=password&idgroup=1000&idcontact=1000

Ferramentas que melhoram nossa API de gerenciamento de contatos

CONEXÃO DE API SEGURA

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

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

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 de contatos

Usar a API de gerenciamento de contatos levará apenas alguns minutos

01

Solicite sua avaliação gratuita

Para acessar a API de contatos você deve estar registrado como cliente Afilnet. Inscreva-se em apenas alguns minutos.

02

Integrar a API de contatos

Faça a integração da API de Contatos com a linguagem de programação de sua preferência. Use nossos exemplos para integração rápida e entre em contato com nossa equipe se tiver dúvidas.

03

Usar ilimitado

Faça uso da API de contatos como quiser. Esta API não tem limitações, gerencie seus grupos de contatos como desejar.

04

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

Experimente o Afilnet de graça!

Cadastre-se gratuitamente e experimente Afilnet! Oferecemos a você uma avaliação gratuita de nossos serviços. *



(*) Promoção válida apenas para empresas que nunca utilizaram o serviço Afilnet. Ao solicitar o saldo gratuito, a Afilnet pode solicitar a verificação das informações da sua empresa


SMS em massa · Email marketing · Rede social · Mensagem instantânea · Certificação · e muito mais
Continuar INFORMAÇÃO IMPORTANTE SOBRE COOKIES: Se continuar a utilizar este website iremos assumir que aceita os termos de uso. Encontrará mais informação em Política de Cookies.
Métodos de Pagamento
Transferência bancária
Cartão de crédito
Paypal
Western Union
Skrill
Crypto
Afilnet no seu idioma

Copyright © 2022 Afilnet · Todos os direitos reservados