Renvoie la liste de tous les contacts (clients, employés, leads, utilisateurs) avec les numéros
Les paramètres
- search (optionnel) — une barre de recherche. La recherche s'effectue combinée par:
- les noms et les numéros des clients, employés, leads ou utilisateurs
- les numéros internes du standard téléphonique virtuel des utilisateurs
- take (page par page) — combien de contacts renvoyer (par défaut 20)
- skip (page par page) — combien de contacts manquer (par défaut 0)
La réponse
Réponse 1
Réponse 1:
{
"totalCount": 128,
"contacts": [
{
"contact_type": "customer",
},
{
"contact_type": "employee",
},
{
"contact_type": "lead",
},
{
"contact_type": "user",
}
]
}
Où:
- totalCount — le nombre total de contacts (en tenant compte de la barre de recherche)
- contacts — la matrice de contacts. Chaque contact selon son type (client, employé, lead, utilisateur) a son propre ensemble d'attributs.
Le client
Réponse 2
Réponse 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"
}
}
Où:
- contact_type — le type de contact:
- id — l'identificateur de client
- name — le nom de client
- status — le statut de client. Les notions possibles:
- individual — la personne physique
- company — l'entreprise
- type — le type de client. Les notions possibles:
- potential — un client potentiel
- client — un client
- reseller — le revendeur
- partner — le partenaire
- phone — le numéro de téléphone. Contient les champs suivants
- phone — le numéro lui-même
- type — le type de numéro. Les notions possibles:
- work — de travail
- personal — personnel
- responsible — l'utilisateur responsable. Contient les champs suivants:
- id — l'identificateur de l'utilisateur
- name — le nom de l'utilisateur
- ext_num — le numéro interne de standard téléphonique virtuel de l'utilisateur
L'employé du client
Réponse 3
Réponse 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"
}
}
Où:
- contact_type — le type de contact:
- id — l'identificateur d'employé
- name — le nom d'employé
- phone — le numéro de téléphone. Contient les champs suivants
- phone — le numéro lui-même
- type — le type de numéro. Les notions possibles:
- work — de travail
- personal — personnel
- position — le poste d'employé. Contient les champs suivants:
- position — la valeur de poste. Les notions possibles:
- ceo — le PDG
- director — le directeur
- manager — le manager
- sales_manager — le manager de ventes
- hr — HR
- support — le service client
- custom — arbitraire
- title — le nom du poste arbitraire (pour position = custom)
- customer — le client connecté à l'employé. Contient des champs suivants:
- id — l'identificateur de client
- name — le nom de client
- responsible — l'utilisateur responsable de client parental. Contient des champs suivants:
- id — l'identificateur de l'utilisateur
- name — le nom de l'utilisateur
- ext_num — le numéro interne de standard téléphonique virtuel de l'utilisateur
Le lead
Réponse 4
Réponse 4:
{
"contact_type": "lead",
"id": 3486,
"name": "Good Company",
"phone": {
"phone": "+44123456789",
"type": "work"
},
"responsible": {
"id": 234,
"name": "John Beam",
"ext_num": "100"
}
}
Où:
- contact_type — le type de contact:
- lead — le lead
- id — l'identificateur de lead
- name — le nom de lead
- phone — le numéro de téléphone. Contient les champs suivants
- phone — le numéro lui-même
- type — le type de numéro. Les notions possibles:
- work — de travail
- personal — personnel
- responsible — l'utilisateur responsable. Contient les champs suivants:
- id — l'identificateur de l'utilisateur
- name — le nom de l'utilisateur
- ext_num — le numéro interne de standard téléphonique virtuel de l'utilisateur
L'utilisateur
Réponse 5
Réponse 5:
{
"contact_type": "user",
"id": 234,
"name": "John Beam",
"avatar": 2457,
"role": "",
"status": "",
"phone": {
"phone": "100",
"type": "internal"
},
"group": {
"type": "admin",
"title": ""
}
}
Où:
- contact_type — le type de contact:
- id — l'identificateur de l'utilisateur
- name — le nom de l'utilisateur
- avatar — l' avatar de l'utilisateur (l'identificateur de fichier)
- role — le rôle de l'utilisateur
- status — le statut de l'utilisateur
- phone — le numéro. Contient des champs suivants:
- phone — le numéro lui-même
- type — le type de numéro. Les notions possibles:
- work — de travail
- personal — personnel
- internal — le numéro interne de standard téléphonique virtuel
- group — le groupe de l'utilisateur. Contient les champs suivants:
- type — le type de groupe. Les notions possibles:
- admin — administrateur
- manager — manager
- chat_operator — opérateur
- trainee — stagiaire
- custom — utilisateur
- title — le nom de groupe (pour type = custom)