⚪Leads
https://host/webservice/v1/contato
🟢Listar
{
"qtype" : "contato.id",//campo de filtro
"query" : "1",//valor para consultar
"oper" : ">=",//operador da consulta
"page" : "1",//página a ser mostrada
"rp" : "20",//quantidade de registros por página
"sortname" : "contato.id",//campo para ordenar a consulta
"sortorder" : "desc"//ordenação (asc= crescente | desc=decrescente)
}curl --location --request GET 'https://host/webservice/v1/contato' \
--header 'ixcsoft: listar' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic MzY3OmExNmMwZDVkZGM3ZjFiODViMzJmYzIyOThlMDM5MjgyNzg3NTkwMGQwNGNmMTNiMzY1Y2M2ZWMxMmViMTU3MzQ=' \
--data '{
"qtype" : "contato.id",
"query" : "1",
"oper" : ">=",
"page" : "1",
"rp" : "20",
"sortname" : "contato.id",
"sortorder" : "desc"
}'🟠Inserir
{
"nome":"",
"data_cadastro":""
}{
"complemento": "",
"referencia": "",
"id_caixa_ftth": "",
"distancia_caixa_mais_proxima": "",
"id_tipo_elemento": "",
"cnpj_cpf": "",
"razao": "",
"quantidade_pessoas_lead": "",
"quantidade_smart_lead": "",
"frequencia_smart_lead": "",
"quantidade_celular_lead": "",
"frequencia_celular_lead": "",
"quantidade_computador_lead": "",
"frequencia_computador_lead": "",
"quantidade_console_lead": "",
"frequencia_console_lead": "",
"data_nascimento": "DD/MM/AAAA",
"caixa_mais_proxima": "",
"id_filial": "",
"operador_neutro": "",
"external_id": "",
"external_system": "",
"tipo_rede": "",
"indicado_por": "",
"ativo": "",
"status_viabilidade": "",
"cadastro_site": "",
"id_fornecedor": "",
"lead": "",
"principal": "",
"nome": "",
"data": "DD/MM/AAAA",
"data_cadastro": "DD/MM/AAAA hh:mm:ss",
"id_responsavel": "",
"tipo_pessoa": "",
"id_cliente": "",
"pipe_id_pessoa": "",
"fone_comercial": "",
"fone_residencial": "",
"fone_celular": "",
"fone_whatsapp": "",
"facebook": "",
"email": "",
"skype": "",
"website": "",
"endereco": "",
"numero": "",
"cidade": "",
"obs": "",
"bairro": "",
"uf": "",
"cep": "",
"velocidade_calculada": "",
"latitude": "",
"longitude": "",
"id_contato_tipo": "",
"id_prospeccao": "",
"id_candidato_tipo": "",
"id_campanha": "",
"id_concorrente": "",
"identificador": "",
"origem_medium": "",
"origem_campaing": "",
"origem_source": "",
"conversao_duplicada_marketing": "",
"id_vd_contrato": "",
"ultima_atualizacao": "DD/MM/AAAA hh:mm:ss",
"alerta": "",
"data_ult_verificacao_viab": "DD/MM/AAAA",
"moradia": "",
"tipo_localidade": "",
"identificador_ultima_conversao": "",
"id_estagio": "",
"ordem_kanban": ""
}curl --location 'https://host/webservice/v1/contato' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic MzY3OmExNmMwZDVkZGM3ZjFiODViMzJmYzIyOThlMDM5MjgyNzg3NTkwMGQwNGNmMTNiMzY1Y2M2ZWMxMmViMTU3MzQ=' \
--data '{
"complemento": "",
"referencia": "",
"id_caixa_ftth": "",
"distancia_caixa_mais_proxima": "",
"id_tipo_elemento": "",
"cnpj_cpf": "",
"razao": "",
"quantidade_pessoas_lead": "",
"quantidade_smart_lead": "",
"frequencia_smart_lead": "",
"quantidade_celular_lead": "",
"frequencia_celular_lead": "",
"quantidade_computador_lead": "",
"frequencia_computador_lead": "",
"quantidade_console_lead": "",
"frequencia_console_lead": "",
"data_nascimento": "DD/MM/AAAA",
"caixa_mais_proxima": "",
"id_filial": "",
"operador_neutro": "",
"external_id": "",
"external_system": "",
"tipo_rede": "",
"indicado_por": "",
"ativo": "",
"status_viabilidade": "",
"cadastro_site": "",
"id_fornecedor": "",
"lead": "",
"principal": "",
"nome": "",
"data": "DD/MM/AAAA",
"data_cadastro": "DD/MM/AAAA hh:mm:ss",
"id_responsavel": "",
"tipo_pessoa": "",
"id_cliente": "",
"pipe_id_pessoa": "",
"fone_comercial": "",
"fone_residencial": "",
"fone_celular": "",
"fone_whatsapp": "",
"facebook": "",
"email": "",
"skype": "",
"website": "",
"endereco": "",
"numero": "",
"cidade": "",
"obs": "",
"bairro": "",
"uf": "",
"cep": "",
"velocidade_calculada": "",
"latitude": "",
"longitude": "",
"id_contato_tipo": "",
"id_prospeccao": "",
"id_candidato_tipo": "",
"id_campanha": "",
"id_concorrente": "",
"identificador": "",
"origem_medium": "",
"origem_campaing": "",
"origem_source": "",
"conversao_duplicada_marketing": "",
"id_vd_contrato": "",
"ultima_atualizacao": "DD/MM/AAAA hh:mm:ss",
"alerta": "",
"data_ult_verificacao_viab": "DD/MM/AAAA",
"moradia": "",
"tipo_localidade": "",
"identificador_ultima_conversao": "",
"id_estagio": "",
"ordem_kanban": ""
}'{
// Principal
"principal":"S",//Sim
"principal":"N",//Nao
//Tipo de pessoa
"tipo_pessoa":"F",//Fisica
"tipo_pessoa":"J",//Juridica
"tipo_pessoa":"E",//Estrangeiro
//Lead
"lead":"S",//Sim
"lead":"N",//Nao
//Ativo
"ativo":"S",//Sim
"ativo":"N",//Nao
//Moradia
"moradia":"P",//Propria
"moradia":"A",//Alugada
//Tipo de localidade
"tipo_localidade":"R",//Zona rural
"tipo_localidade":"U",//Zona urbana
//Auto viabilidade
"cadastro_site":"S",//Sim
"cadastro_site":"N",//Nao
//Lead Viável
"status_viabilidade":"S",//Sim
"status_viabilidade":"N",//Nao
//Tipo de rede
"tipo_rede":"P",//Propria
"tipo_rede":"N",//Neutra
"tipo_rede":"A",//Ambas
//Frequencia de uso das Smart TVs
"frequencia_smart_lead":"Diário",//Diário
"frequencia_smart_lead":"Semanal",//Semanal
"frequencia_smart_lead":"Raro",//Raro
//Frequncia de uso de celulares e tablets
"frequencia_celular_lead":"Diário",//Diário
"frequencia_celular_lead":"Semanal",//Semanal
"frequencia_celular_lead":"Raro",//Raro
//Frequencia de uso de computadores
"frequencia_computador_lead":"Diário",//Diário
"frequencia_computador_lead":"Semanal",//Semanal
"frequencia_computador_lead":"Raro",//Raro
//Frqwuencia de uso de videogames
"frequencia_console_lead":"Diário",//Diário
"frequencia_console_lead":"Semanal",//Semanal
"frequencia_console_lead":"Raro",//Raro
}🔵Editar
Deve ser informado o id, a ser editado, na URL:
https://host/webservice/v1/contato/5
Todos os campos devem ser inseridos para realizar uma alteração cadastral.
{
"complemento": "",
"referencia": "",
"id_caixa_ftth": "",
"distancia_caixa_mais_proxima": "",
"id_tipo_elemento": "",
"cnpj_cpf": "",
"razao": "",
"quantidade_pessoas_lead": "",
"quantidade_smart_lead": "",
"frequencia_smart_lead": "",
"quantidade_celular_lead": "",
"frequencia_celular_lead": "",
"quantidade_computador_lead": "",
"frequencia_computador_lead": "",
"quantidade_console_lead": "",
"frequencia_console_lead": "",
"data_nascimento": "DD/MM/AAAA",
"caixa_mais_proxima": "",
"id_filial": "",
"operador_neutro": "",
"external_id": "",
"external_system": "",
"tipo_rede": "",
"indicado_por": "",
"ativo": "",
"status_viabilidade": "",
"cadastro_site": "",
"id_fornecedor": "",
"lead": "",
"principal": "",
"nome": "",
"data": "DD/MM/AAAA",
"data_cadastro": "DD/MM/AAAA hh:mm:ss",
"id_responsavel": "",
"tipo_pessoa": "",
"id_cliente": "",
"pipe_id_pessoa": "",
"fone_comercial": "",
"fone_residencial": "",
"fone_celular": "",
"fone_whatsapp": "",
"facebook": "",
"email": "",
"skype": "",
"website": "",
"endereco": "",
"numero": "",
"cidade": "",
"obs": "",
"bairro": "",
"uf": "",
"cep": "",
"velocidade_calculada": "",
"latitude": "",
"longitude": "",
"id_contato_tipo": "",
"id_prospeccao": "",
"id_candidato_tipo": "",
"id_campanha": "",
"id_concorrente": "",
"identificador": "",
"origem_medium": "",
"origem_campaing": "",
"origem_source": "",
"conversao_duplicada_marketing": "",
"id_vd_contrato": "",
"ultima_atualizacao": "DD/MM/AAAA hh:mm:ss",
"alerta": "",
"data_ult_verificacao_viab": "DD/MM/AAAA",
"moradia": "",
"tipo_localidade": "",
"identificador_ultima_conversao": "",
"id_estagio": "",
"ordem_kanban": ""
}curl --location --request PUT 'https://host/webservice/v1/contato/5' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic MzY3OmExNmMwZDVkZGM3ZjFiODViMzJmYzIyOThlMDM5MjgyNzg3NTkwMGQwNGNmMTNiMzY1Y2M2ZWMxMmViMTU3MzQ=' \
--data '{
"complemento": "",
"referencia": "",
"id_caixa_ftth": "",
"distancia_caixa_mais_proxima": "",
"id_tipo_elemento": "",
"cnpj_cpf": "",
"razao": "",
"quantidade_pessoas_lead": "",
"quantidade_smart_lead": "",
"frequencia_smart_lead": "",
"quantidade_celular_lead": "",
"frequencia_celular_lead": "",
"quantidade_computador_lead": "",
"frequencia_computador_lead": "",
"quantidade_console_lead": "",
"frequencia_console_lead": "",
"data_nascimento": "DD/MM/AAAA",
"caixa_mais_proxima": "",
"id_filial": "",
"operador_neutro": "",
"external_id": "",
"external_system": "",
"tipo_rede": "",
"indicado_por": "",
"ativo": "",
"status_viabilidade": "",
"cadastro_site": "",
"id_fornecedor": "",
"lead": "",
"principal": "",
"nome": "",
"data": "DD/MM/AAAA",
"data_cadastro": "DD/MM/AAAA hh:mm:ss",
"id_responsavel": "",
"tipo_pessoa": "",
"id_cliente": "",
"pipe_id_pessoa": "",
"fone_comercial": "",
"fone_residencial": "",
"fone_celular": "",
"fone_whatsapp": "",
"facebook": "",
"email": "",
"skype": "",
"website": "",
"endereco": "",
"numero": "",
"cidade": "",
"obs": "",
"bairro": "",
"uf": "",
"cep": "",
"velocidade_calculada": "",
"latitude": "",
"longitude": "",
"id_contato_tipo": "",
"id_prospeccao": "",
"id_candidato_tipo": "",
"id_campanha": "",
"id_concorrente": "",
"identificador": "",
"origem_medium": "",
"origem_campaing": "",
"origem_source": "",
"conversao_duplicada_marketing": "",
"id_vd_contrato": "",
"ultima_atualizacao": "DD/MM/AAAA hh:mm:ss",
"alerta": "",
"data_ult_verificacao_viab": "DD/MM/AAAA",
"moradia": "",
"tipo_localidade": "",
"identificador_ultima_conversao": "",
"id_estagio": "",
"ordem_kanban": ""
}'{
// Principal
"principal":"S",//Sim
"principal":"N",//Nao
//Tipo de pessoa
"tipo_pessoa":"F",//Fisica
"tipo_pessoa":"J",//Juridica
"tipo_pessoa":"E",//Estrangeiro
//Lead
"lead":"S",//Sim
"lead":"N",//Nao
//Ativo
"ativo":"S",//Sim
"ativo":"N",//Nao
//Moradia
"moradia":"P",//Propria
"moradia":"A",//Alugada
//Tipo de localidade
"tipo_localidade":"R",//Zona rural
"tipo_localidade":"U",//Zona urbana
//Auto viabilidade
"cadastro_site":"S",//Sim
"cadastro_site":"N",//Nao
//Lead Viável
"status_viabilidade":"S",//Sim
"status_viabilidade":"N",//Nao
//Tipo de rede
"tipo_rede":"P",//Propria
"tipo_rede":"N",//Neutra
"tipo_rede":"A",//Ambas
//Frequencia de uso das Smart TVs
"frequencia_smart_lead":"Diário",//Diário
"frequencia_smart_lead":"Semanal",//Semanal
"frequencia_smart_lead":"Raro",//Raro
//Frequncia de uso de celulares e tablets
"frequencia_celular_lead":"Diário",//Diário
"frequencia_celular_lead":"Semanal",//Semanal
"frequencia_celular_lead":"Raro",//Raro
//Frequencia de uso de computadores
"frequencia_computador_lead":"Diário",//Diário
"frequencia_computador_lead":"Semanal",//Semanal
"frequencia_computador_lead":"Raro",//Raro
//Frqwuencia de uso de videogames
"frequencia_console_lead":"Diário",//Diário
"frequencia_console_lead":"Semanal",//Semanal
"frequencia_console_lead":"Raro",//Raro
}🔴Deletar
Deve ser informado o id, a ser excluído, na URL: https://host/webservice/v1/contato/5
curl --location --request DELETE 'https://host/webservice/v1/contato/5' \
--header 'Authorization: Basic MzY3OmExNmMwZDVkZGM3ZjFiODViMzJmYzIyOThlMDM5MjgyNzg3NTkwMGQwNGNmMTNiMzY1Y2M2ZWMxMmViMTU3MzQ=' \
--data ''Last updated