Pular para o conteúdo principal

Pesquisa

api_get_contact_json

Retorna a lista de clientes (contatos) que foram visitados pelo menos uma vez, sem qualquer limitação de período.

Solicitação

Endpoint

POST https://yourdomain.pharmahrm.com/crm-api/db-function/run

Autenticação

Bearer Token (obrigatório)

Estrutura da solicitação

Cabeçalhos

Chave Valor
Authorization Bearer <token>
Content-Type application/json

Corpo da solicitação

{
  "function": "api_get_contact_json",
  "format": "json",
  "arguments": {
    "ids": "1,2,3,4"
  }
}
Campo Tipo Obrigatório Descrição
function string Sim Nome do método chamado. Para esta solicitação — "api_get_contact_json"
format string Sim Formato da resposta — json
arguments object Não Objeto de argumentos adicionais
ids string Não Lista de IDs de clientes separados por vírgula. Se não informado, são retornados todos os clientes visitados

Resposta bem-sucedida

200 OK

JSON

Exemplo de resposta
[{
                                        "isarchive": null,
                                        "company_id": 87458,
                                        "contact_id": 196879,
                                        "contact_name": "Приймачук Валентина Анатоліївна ",
                                        "contact_spec": "Гастроентерологія",
                                        "contact_type": "All",
                                        "contact_categ": null,
                                        "contact_email": null,
                                        "contact_phone": " 0963289903",
                                        "contact_target": [
                                            "Rx-Гастроентеролог"
                                        ],
                                        "company_morionid": 3475149,
                                        "contact_morionid": null,
                                        "contact_categ_by_direction": ["RX-A","OTC-B"]
                                    }
                                ]
Campo Descrição
contact_name Nome completo do cliente
contact_type Tipo de cliente (médico, farmacêutico)
contact_spec Especialidade do cliente
contact_target Grupo-alvo / categoria do cliente
contact_categ Categoria geral do cliente
contact_categ_by_direction Categoria por linha / direção do produto
isarchive Flag de arquivo — contém o motivo de arquivamento
contact_morionid Identificador do cliente na base Axioma
conpamy_id ID da instituição no Proxima CRM (local de trabalho)
company_morionid Identificador da instituição na base Axioma (local de trabalho principal)
contact_email E-mail do cliente
contact_phone Telefone do cliente
contact_id ID do cliente na base Proxima CRM

Resposta de erro

40x/50x

{
  "message": "string"
}
Código Descrição
400-499 Erro no lado do cliente
500-599 Erro no lado do servidor