Ir para o conteúdo

Contato

Cadastro de contato

O cadastro de contatos no CRM Rubeus é realizado através de um método bem simples e, para isso, será necessário apenas alguns dados. Confira, abaixo, estes dados:

POSTapplication/json /api/Contato/cadastro

Atributos Tipo Obrigatoriedade Descrição
codigo string Não Código de identificação externa.
nome string Sim Nome.
nomeSocial string Não Nome Social.
dataNascimento date Não Data de Nascimento.
Padrão: YYYY-MM-DD
telefonePrincipal string Condicional Telefone principal de contato.
No cadastro de contato é obrigatório informar o e-mail principal ou o telefone principal.
emailPrincipal string Condicional E-mail principal de contato.
No cadastro de contato é obrigatório informar o e-mail principal ou o telefone principal.
telefone array[] Não É possível enviar uma lista de telefones secundários para o cadastro de contato.
email array[] Não É possível enviar uma lista de emails secundários para o cadastro de contato.
cpf string Não CPF do contato.
Padrão: xxxxxxxxxxx
endereco string Não Endereço (limite de caracteres: 255).
cep string Não CEP.
Padrão:xxxxx-xxx
numero string Não Número (endereço).
bairro string Não Bairro (limite de caracteres: 45).
sexo integer Não Para informar o sexo utilize: 1 para Masculino e 2 para Feminino.
imagemUrl string Não URL para foto de perfil do contato.
Em alguns casos, o contato pode já estar cadastrado em um sistema e ter uma foto de perfil. Caso esteja disponível para acesso externo, basta informar a URL de acesso.
estadoCidade object Não Deve ser informado um objeto com os dados necessários para vincular o contato a uma cidade.
Se não for encontrada uma cidade com esse nome nessa UF, o contato não será vinculado a uma cidade.
↳ cidade string Não -
↳ estado string Não -
canhoto integer Não Campo para informar se o contato é ou não canhoto.
Padrão: 1 para sim ou 0 para não.
profissao string Não Profissão.
aluno integer Não Se o contato é ou não aluno.
Padrão: 1 para quando for aluno e 0 para quando não for aluno.
exaluno integer Não Se o contato é ex-aluno ou não.
Padrão: 1 se já foi aluno e 0 se nunca foi aluno.
escolaOrigem string Não Escola de origem do contato
anoFormacao string Não Ano de formação do contato.
Padrão: YYYY
deficiencias object Não Usado para informar a(s) deficiência(s) do contato.
Usar os dados da tabela de deficiências.
↳ id integer Não Identificação da deficiência.
↳ tipos array[] Não Usar o método listarDeficiencias para obter o campo id para a passagem de parâmetro.
outrasDeficiencias string Não Campo destinado à descrição da deficiência do contato se ela não existir nas opções pré-definidas.
estadoCivil integer Não Utilizar os dados da tabela estado civil.
cor integer Não Utilizar os dados da tabela cor.
grauInstrucao integer Não Utilizar os dados da tabela grau de instrução.
tags array[] Não Utilizado para enviar as tags do contato.
tagsRemovidas array[] Não Utilizado para remover as tags do contato.
evento object Não Utilizado para criar um evento ao realizar o cadastro do contato.
↳ tipo integer Não Id do tipo de evento.
↳ codTipo string Não código do tipo de evento.
↳ descricao string Não Texto HTML personalizado para agregar informações na exibição do evento.
↳ codOferta string Não Para vincular o evento a uma oferta de curso é preciso informar este campo junto com o codCurso correspondente.
↳ codCurso string Não Para vincular o evento a uma oferta de curso, é preciso informar este campo junto com o codOferta correspondente.
camposPersonalizados object Não Usado para atribuir algum campo específico que não está presente no escopo da API.
Os campos devem ser informados como no exemplo abaixo:

camposPersonalizados : { coluna: "valor" }
Os nomes das colunas dos campos personalizados são informados no método Instituicao/campoPersonalizado, e o valor poderá ser uma string normal ou um array de strings caso o campo seja multi valorado.
origem integer Sim Código de identificação do canal.
token string Sim Chave de acesso única referente ao canal.

O valor do campo dados no exemplo de retorno abaixo é o id que foi criado no processo.

1
2
3
4
{
    "success": true,
    "dados": 10
}

Dados do contato

POSTapplication/json /api/Contato/dadosPessoa

Atributos Tipo Obrigatoriedade Descrição
codigo string Condicional Chave única de identificação externa do contato enviado.
id integer Condicional Código de identificação do contato no CRM.
origem integer Sim Código de identificação do canal.
token string Sim Chave de acesso única referente ao canal. 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
{
    "success": true,
    "dados": {
        "id": "155",
        "nome": "Nome Exemplo",
        "nomeSocial": null,
        "codigo": "000",
        "imagem": "null",
        "cpf": "977.250.067-10",
        "datanascimento": "1996-07-02",
        "endereco": "Rua Heitor Tadeu",
        "cep": "xxxxx-xxx",
        "numero": "752",
        "bairro": "Barra",
        "cidade": "2354",
        "cidadeNome": "Sete Lagoas - MG",
        "sexo": "1",
        "sexoNome": "Masculino",
        "origemId": "1",
        "origemNome": "CRM",
        "urlPublicaRdStation": "null",
        "canhoto": null,
        "profissao": null,
        "aluno": null,
        "exaluno": null,
        "anoFormacao": null,
        "estadoCivil": null,
        "estadoCivilNome": null,
        "cor": null,
        "corNome": null,
        "grauInstrucao": null,
        "grauInstrucaoNome": null,
        "outrasDeficiencias": null,
        "mesclada": "1",
        "verificada": "0",
        "desinscreveu": "0",
        "camposPersonalizados": [{
            "nome": "Campo Personalizado",
            "coluna": "campopersonalizado",
            "tipo": "1",
            "valor": "valor"
        }],
        "pessoasRelacionadas": false,
        "telefones": {
            "principal": {
                "id": "1534",
                "telefone": "(31)154689835"
            },
            "secundarios": [{}]
        },
        "emails": {
            "principal": {
                "id": "1598",
                "email": "email@email.com"
            },
            "secundarios": [{
                "id": "1600",
                "email": "email2@email.com"
            }]
        },
        "tags": false,
        "origemCanal": false,
        "origens": [{
            "id": "1",
            "titulo": "CRM"
        }],
        "deficiencias": false
    }
}

Buscar por nome, email, telefone ou CPF

Semelhante ao método acima, este também faz a consulta de contatos no Rubeus, mas, os parâmetros são nome, email, telefone e/ou cpf. Todos os campos deverão ser buscados com o operador LIKE, portanto, acentos e letras maiúsculas/minúsculas deverão ser ignoradas, por exemplo, uma busca feita por nome "Carl" deverá retornar os dados dos contatos que possuem "carl" em alguma parte de seu nome. O operador utilizado entre as entidades de busca é AND, por isso se for buscado nome = "carls" e cpf = "781", o método retornará todos os dados dos contatos que possuem nome LIKE "%carls%" AND cpf LIKE "%781%". Todas as entidades trabalharão desta maneira. Nas entidades de telefone e e-mail, será validada através de todos os e-mails/telefone que um contato possa ter, sendo considerados os principais e secundários na hora da busca. Os dados retornados estarão disponíveis dentro de um array, estruturados exatamente igual ao método da API Pessoa/dadosPessoa.

POSTapplication/json /api/Contato/dadosPessoas

Atributos Tipo Obrigatoriedade Descrição
nome string Condicional Campo para informar o nome do contato.
email string Condicional Campo para informar o email do contato.
telefone string Condicional Campo para informar o telefone do contato.
cpf string Condicional Campo para informar o CPF do contato.
origem integer Sim Código de identificação do canal utilizado na integração.
token string Sim Chave de acesso única referente ao canal utilizado na integração.

Alterar código do contato

PUTapplication/json /api/Contato/alterarCodigo

Atributos Tipo Obrigatoriedade Descrição
id integer Condicional Id do contato.
Será passado se o codigoAntigo não for passado.
codigoAntigo string Condicional Código enviado no cadastro do contato.
Será passado se** o** id não for passado.
codigoNovo string Sim Código que será substituído com base no código antigo enviado.
origem integer Sim Código de identificação do canal.
token string Sim Chave de acesso única referente ao canal. 
1
2
3
4
{
    "success":true,
    "id":"9"
}

Excluir contato

DELETEapplication/json /api/Contato/excluirPessoa

Atributos Tipo Obrigatoriedade Descrição
id array[] ou integer obrigatório id dos contatos que devem ser excluídos..
Os id’s deverão ser informados da seguinte forma:
Um único id: 1
Vários id’s: [1, 2, 3]
origem integer Sim Código de identificação do canal.
token string Sim Chave de acesso única referente ao canal. 
1
2
3
4
{
    "success": true,
    "id": 9
}

1
2
3
4
{
    "success": true,
    "id": 1633
}