GET
/
commercial
/
checkPhone
cURL
curl --request GET \
  --url https://api.gextra.net/fr/commercial/checkPhone
[
  {
    "id": 123,
    "gclid": "<string>",
    "customId": "<string>",
    "capretraiteid": "<string>",
    "resultat": "commercial.resultat.refuse",
    "type": "commercial.type.email"
  }
]

Description

Permet de vérifier si un numéro de téléphone donné (phone en paramètre de requête) est associé à un contact existant dans la base de données commerciale (tables commercial et commercialrelation). Retourne une liste (potentiellement vide) des enregistrements commerciaux correspondants trouvés. Chaque enregistrement contient les champs id, gclid, customId, capretraiteid, resultat. Important : Cette route nécessite un paramètre password dans la requête pour des raisons d’authentification.

Query Parameters

phone
string
required

Le numéro de téléphone à vérifier.

Example:

"0123456789"

password
string
required

Mot de passe pour l'accès sécurisé

Example:

"your_password_here"

Response

Succès de la vérification. Retourne une liste (potentiellement vide) des enregistrements commerciaux correspondants.

id
integer

ID de l'enregistrement commercial.

gclid
string | null

Google Click ID associé.

customId
string | null

ID personnalisé associé.

capretraiteid
string | null

ID Cap Retraite associé.

resultat
enum<string> | null

Résultat :

commercial.resultat.refuse - Admission refusée

commercial.resultat.nosuite - Ne donnera pas de suite

commercial.resultat.realisee - Admission réalisée

Available options:
commercial.resultat.refuse,
commercial.resultat.nosuite,
commercial.resultat.realisee
type
enum<string>

Type de contact commercial:

commercial.type.email - Email

commercial.type.phone - Téléphone

commercial.type.visite - Visite

commercial.type.website - Site Repotel

commercial.type.organisme - Organisme de placement

Available options:
commercial.type.email,
commercial.type.phone,
commercial.type.visite,
commercial.type.website,
commercial.type.organisme