Aller au contenu
Vérifié

Ajouter un contact

Classez une personne dans le carnet de contacts à la main, et gérez le cas où elle s'y trouve déjà.

create_contact est la voie de saisie manuelle vers le carnet de contacts, la même que celle du formulaire « ajouter un contact » du tableau de bord : un nom et un e-mail, avec en plus le téléphone et l'entreprise. Le carnet est indexé par e-mail : envoyer un e-mail qui existe déjà n'est donc pas une erreur, la réponse est un succès normal qui désigne le contact que vous avez déjà.

Méthode

POST/cpi/create_contact
user

Create Contact

Adds a person to the contact book by hand, from typed details rather than from a received message. Takes only the fields a contact has, name, email, phone, company, job title and its kind (personal or business, which then needs no model to classify it), and ignores anything else the caller happens to hold, such as a shipping address. The email is the book's key, so it is required and a repeat of one already filed returns the existing contact instead of a second copy.

Pas à pas

Envoyez les quatre champs d'un contact

name et email sont les deux seuls champs que create_contact exige. source vaut manual par défaut et context vaut Added by hand si vous les omettez ; les deux apparaissent dans l'historique d'activité du contact.

curl -s https://xuda.ai/cpi/create_contact \
  -H 'content-type: application/json' \
  -d '{
    "api_key": "YOUR_API_KEY",
    "name": "Priya Shah",
    "email": "[email protected]",
    "phone": "+1 555 0110",
    "company": "Northwind"
  }'
const res = await fetch('https://xuda.ai/cpi/create_contact', {
  method: 'POST',
  headers: { 'content-type': 'application/json' },
  body: JSON.stringify({
    api_key: 'YOUR_API_KEY',
    name: 'Priya Shah',
    email: '[email protected]',
    phone: '+1 555 0110',
    company: 'Northwind',
  }),
});
const { code, data } = await res.json();
if (code > 0 && data.existed) console.log('already in the book:', data.contact_id);
else if (code > 0) console.log('created:', data.contact_id);
import requests

res = requests.post(
    'https://xuda.ai/cpi/create_contact',
    json={
        'api_key': 'YOUR_API_KEY',
        'name': 'Priya Shah',
        'email': '[email protected]',
        'phone': '+1 555 0110',
        'company': 'Northwind',
    },
)
body = res.json()
if body['code'] > 0 and body['data']['existed']:
    print('already in the book:', body['data']['contact_id'])
elif body['code'] > 0:
    print('created:', body['data']['contact_id'])

La réponse

json
{
  "code": 1,
  "data": {
    "contact_id": "cnt_a91f0e",
    "name": "Priya Shah",
    "email": "[email protected]",
    "existed": false
  }
}

existed: true est le cas du doublon : l'e-mail était déjà dans le carnet, et contact_id désigne le contact qui l'avait déjà plutôt qu'un nouveau. Distinguez les deux cas avec existed, pas avec code : les deux reviennent avec code: 1.

phone et company sont enregistrés sur le contact mais ne sont pas renvoyés dans cette réponse ; relisez-les avec get_contacts ou get_contact_members si vous devez confirmer ce qui a été enregistré.

Erreurs

Suite