Devuelve el listado de todos los contactos (clientes, empleados, leads, usuarios) con números de teléfono
Parámetros
- search (opcional) - barra de búsqueda. La búsqueda se realiza de forma combinada por:
- a los nombres y números de clientes, leads, empleados y usuarios
- a las extensiones de los usuarios de la centralita
- take (para la muestra por página) - cuántos contactos devolver (por defecto 20)
- skip (para la muestra por página) - cuántos contactos saltarse (por defecto 0)
Respuesta
(Respuesta 1)
Respuesta 1:
{
"totalCount": 128,
"contacts": [
{
"contact_type": "customer",
},
{
"contact_type": "employee",
},
{
"contact_type": "lead",
},
{
"contact_type": "user",
}
]
}
donde
- totalCount — número total de contactos (incluyendo la barra de búsqueda)
- contacts — conjunto de contactos. Cada uno de los contactos depende de su tipo (cliente, empleado, lead, usuario) contendrá su propio conjunto de atributos.
Cliente
(Respuesta 2)
Respuesta 2:
{
"contact_type": "customer",
"id": 3486,
"name": "Good Company",
"status": "company",
"type": "client",
"phone": {
"phone": "+44123456789",
"type": "work"
},
"responsible": {
"id": 234,
"name": "John Beam",
"ext_num": "100"
}
}
donde
- contact_type — tipo de contacto:
- id — identificador de cliente
- name — nombre de cliente
- status — estado de cliente. Valores posibles:
- individual — persona física/li>
- company — empresa
- type — tipo de cliente. Valores posibles:
- potential — cliente potencial
- client — cliente
- reseller — agente
- partner — colaborador
- phone — número de teléfono. Contiene los siguientes campos:
- phone — solo número
- type — tipo de número. Valores posibles:
- work — de trabajo
- personal — personal
- responsible — usuario responsable. Contiene los siguientes campos:
- id — identificador de usuario
- name — nombre de usuario
- ext_num — extensión de la centralita virtual de usuario
Empleado del cliente
(Respuesta 3)
Respuesta 3:
{
"contact_type": "employee",
"id": 8,
"name": "Michael Simpson",
"phone": {
"phone": "+44123456789",
"type": "work"
},
"position": {
"position": "manager",
"title": ""
},
"customer": {
"id": 3486,
"name": "Good Company"
},
"responsible": {
"id": 234,
"name": "John Beam",
"ext_num": "100"
}
}
donde
- contact_type — tipo de contacto:
- id — identificador de empleado
- name — nombre de empleado
- phone — número de teléfono. Contiene los siguientes campos:
- phone — solo número
- type — tipo de número. Valores posibles:
- work — de trabajo
- personal — personal
- position — cargo del empleado. Contiene los siguientes campos:
- position — valor del cargo. Valores posibles:
- ceo — director general
- director — director
- manager — agente
- sales_manager — comercial
- hr — RRHH
- support — soporte
- custom — otro
- title — nombre de otro cargo (paraposition = custom)
- customer — cliente asignado al empleado. Contiene los siguientes campos:
- id — identificador de cliente
- name — nombre de cliente
- responsible — usuario responsable por el cliente matriz. Contiene los siguientes campos:
- id — identificador de usuario
- name — nombre de usuario
- ext_num — extensión de la centralita del usuario
Lead
(Respuesta 4)
Respuesta 4:
{
"contact_type": "lead",
"id": 3486,
"name": "Good Company",
"phone": {
"phone": "+44123456789",
"type": "work"
},
"responsible": {
"id": 234,
"name": "John Beam",
"ext_num": "100"
}
}
donde
- contact_type — tipo de contacto:
- id — identificador de lead
- name — nombre de lead
- phone — número de teléfono. Contiene los siguientes campos:
- phone — solo número
- type — tipo de número. Valores posibles:
- work — de trabajo
- personal — personal
- responsible — usuario responsable. Contiene los siguientes campos:
- id — identificador de usuario
- name — nombre de usuario
- ext_num — extensión de la centralita del usuario
Usuario
(Respuesta 5)
Respuesta 5:
{
"contact_type": "user",
"id": 234,
"name": "John Beam",
"avatar": 2457,
"role": "",
"status": "",
"phone": {
"phone": "100",
"type": "internal"
},
"group": {
"type": "admin",
"title": ""
}
}
donde
- contact_type — tipo de contacto:
- id — identificador de usuario
- name — nombre de usuario
- avatar — avatar de usuario (identificador de archivo)
- role — rol de usuario
- status — estado de usuario
- phone — número de teléfono. Contiene los siguientes campos:
- phone — solo número
- type — tipo de número. Valores posibles:
- work — de trabajo
- personal — personal
- internal — extensión de la centralita del usuario
- group — grupo del usuario. Contiene los siguientes campos:
- type — tipo de grupo. Valores posibles:
- admin — administradores
- manager — agentes
- chat_operator — operadores
- trainee — becarios
- custom — personalizado
- title — nombre del grupo personalizado (para type = custom)