Contacts
Les contacts sont un élément central de seven. Sur cette page, nous examinerons les différents points de terminaison de contacts que vous pouvez utiliser pour gérer les contacts de manière programmatique. Nous verrons comment vous pouvez interroger, créer, mettre à jour et supprimer des contacts.
Le modèle de contact
Le modèle de contact contient toutes les informations sur vos contacts, telles que leur nom, avatar et numéro de téléphone. Si vous avez créé vos propres propriétés de contact, le nom unique est affiché comme propriété supplémentaire dans l'objet properties.
Propriétés
- Name
id- Type
- integer
- Description
ID unique du contact.
- Name
avatar- Type
- string
- Description
L'URL de l'avatar du contact.
intials- Name
initials- Type
- string
- Description
Les initiales du contact.
- Name
color- Type
- hex color
- Description
Code couleur hexadécimal.
validation- Name
state- Type
- string
- Description
Le dernier résultat de validation du numéro de téléphone mobile du contact. Peut avoir une des valeurs valid, invalid, absent ou unknown.
- Name
timestamp- Type
- timestamp
- Description
L'heure de la dernière validation du numéro de téléphone mobile du contact.
properties- Name
firstname- Type
- string
- Description
Prénom du contact.
- Name
lastname- Type
- string
- Description
Nom de famille du contact.
- Name
home_number- Type
- phonenumber
- Description
Numéro de téléphone fixe du contact.
- Name
mobile_number- Type
- phonenumber
- Description
Numéro de téléphone mobile du contact.
- Name
address- Type
- string
- Description
Adresse du contact.
- Name
email- Type
- string
- Description
E-mail du contact.
- Name
postal_code- Type
- integer
- Description
Code postal du contact.
- Name
city- Type
- string
- Description
Ville du contact.
- Name
birthday- Type
- date
- Description
Date de naissance du contact.
- Name
notes- Type
- string
- Description
Notes sur le contact.
- Name
groups- Type
- array
- Description
Un tableau composé des ID des groupes dont le contact est membre. Si cette propriété est spécifiée lors de la modification ou de la création d'un contact, elle doit contenir tous les ID de groupe dont le contact doit être membre.
- Name
created- Type
- timestamp
- Description
Heure à laquelle le contact a été créé.
{
"id": 12876881,
"avatar": "https://static.seven.io/uploads/contact_images/4A000c0d4e9431F483090dE8D13F3806.jpg",
"validation": {
"state": "absent",
"timestamp": "2024-01-09 16:08:29"
},
"initials": {
"initials": "PM",
"color": "9EB384"
},
"properties": {
"firstname": "Peter",
"lastname": "Mustermann",
"mobile_number": 4917612345678,
"home_number": null,
"email": null,
"address": null,
"postal_code": null,
"city": null,
"birthday": "1977-07-07",
"notes": null
},
"groups": [
18008
],
"created": "2024-01-09 13:14:48"
}
Interroger la liste des contacts
Vous pouvez utiliser ce point de terminaison pour récupérer une liste page par page de tous vos contacts. Par défaut, un maximum de 30 contacts sont affichés par page.
- Name
order_by- Type
- string
- Optional
- Optional
- Description
La colonne par laquelle les contacts doivent être triés.
- Name
order_direction- Type
- string
- Optional
- Optional
- Description
La direction du tri. Peut être soit asc soit desc.
- Name
search- Type
- string
- Optional
- Optional
- Description
Vous pouvez utiliser ce paramètre pour rechercher dans toutes les colonnes de vos contacts.
- Name
offset- Type
- integer
- Optional
- Optional
- Description
La page à afficher.
- Name
limit- Type
- integer
- Optional
- Optional
- Description
Le nombre de contacts à afficher par page. Peut être une valeur entre 30 et 500.
- Name
group_id- Type
- integer
- Optional
- Optional
- Description
Afficher uniquement les contacts qui sont membres d'un groupe spécifique.
Requête
curl -G https://gateway.seven.io/api/contacts \
-H "X-Api-Key: VOTRE_CLÉ_API" \
Réponse
{
"pagingMetadata": {
"offset": 0,
"count": 30,
"total": 20013,
"limit": 30,
"has_more": true
},
"data": [
{
"id": 12876881,
"avatar": "https://static.seven.io/uploads/contact_images/4A000c0d4e9431F483090dE8D13F3806.jpg",
"validation": {
"state": "absent",
"timestamp": "2024-01-09 16:08:29"
},
"initials": {
"initials": "PM",
"color": "9EB384"
},
"properties": {
"firstname": "Peter",
"lastname": "Mustermann",
"mobile_number": 4917612345678,
"home_number": null,
"email": null,
"address": null,
"postal_code": null,
"city": null,
"birthday": "1977-07-07",
"notes": null
},
"groups": [
18008
],
"created": "2024-01-09 13:14:48"
},
{
"id": 12454415,
// ...
}
]
}
Créer un contact
Vous pouvez utiliser ce point de terminaison pour ajouter un nouveau contact. Si tout s'est bien passé, vous recevrez l'objet contact créé en réponse. Si vous avez créé vos propres propriétés de contact et souhaitez les spécifier pour le contact, veuillez entrer le nom unique de la propriété comme paramètre supplémentaire.
cURL
curl https://gateway.seven.io/api/contacts \
-H "X-Api-Key: VOTRE_CLÉ_API" \
-d "firstname=Frank" \
-d "lastname=McAllister" \
-d "mobile_number=1-800-759-3000" \
-d "avatar=https://picsum.photos/200"
Réponse
{
"id": 12876882,
"avatar": "https://static.seven.io/uploads/contact_images/4A000c0d4e9431F483090dE8D13F3806.jpg",
"validation": {
"state": null,
"timestamp": null
},
"initials": {
"initials": "FM",
"color": "EEE0C9"
},
"properties": {
"firstname": "Frank",
"lastname": "McAllister",
"mobile_number": "18007593000",
"home_number": null,
"email": null,
"address": null,
"postal_code": null,
"city": null,
"birthday": null,
"notes": null
},
"groups": [],
"created": "2024-01-09 13:12:48"
}
Récupérer un contact
Vous pouvez utiliser ce point de terminaison pour récupérer un contact en spécifiant son ID. Dans la liste en haut de cette page, vous pouvez lire quelles propriétés sont contenues dans les objets contact.
cURL
curl https://gateway.seven.io/api/contacts/12876881 \
-H "X-Api-Key: VOTRE_CLÉ_API"
Réponse
{
"id": 12876881,
"avatar": "https://static.seven.io/uploads/contact_images/4A000c0d4e9431F483090dE8D13F3806.jpg",
"validation": {
"state": "absent",
"timestamp": "2024-01-09 16:08:29"
},
"initials": {
"initials": "PM",
"color": "9EB384"
},
"properties": {
"firstname": "Peter",
"lastname": "Mustermann",
"mobile_number": 4917612345678,
"home_number": null,
"email": null,
"address": null,
"postal_code": null,
"city": null,
"birthday": "1977-07-07",
"notes": null
},
"groups": [
18008
],
"created": "2024-01-09 13:14:48"
}
Mettre à jour un contact
Vous pouvez utiliser ce point de terminaison pour modifier une ou plusieurs propriétés d'un contact. Les noms des propriétés peuvent être trouvés dans la liste du modèle de contact. Vous recevrez l'objet contact mis à jour en réponse.
cURL
curl -X PATCH https://gateway.seven.io/api/contacts/12876881 \
-H "X-Api-Key: VOTRE_CLÉ_API" \
-d firstname="Marc" \
-d lastname="Gump"
Réponse
{
"id": 12876881,
"avatar": "https://static.seven.io/uploads/contact_images/4A000c0d4e9431F483090dE8D13F3806.jpg",
"validation": {
"state": "absent",
"timestamp": "2024-01-09 16:08:29"
},
"initials": {
"initials": "CF",
"color": "9EB384"
},
"properties": {
"firstname": "Marc",
"lastname": "Gump",
"mobile_number": 4917612345678,
"home_number": null,
"email": null,
"address": null,
"postal_code": null,
"city": null,
"birthday": "1977-07-07",
"notes": null
},
"groups": [
18008
],
"created": "2024-01-09 13:14:48"
}
Supprimer un contact
Ce point de terminaison vous permet de supprimer des contacts de votre liste de contacts.
cURL
curl -X DELETE https://gateway.seven.io/api/contacts/12454414 \
-H "X-Api-Key: VOTRE_CLÉ_API"