Passer au contenu principal

​
Etiquettes

Les etiquettes sont une fonctionnalite WhatsApp Business qui vous permet de categoriser et d’organiser vos conversations. Via l’API Wappfy, vous pouvez creer des etiquettes personnalisees, les attribuer a des conversations et recuperer les conversations par etiquette.
Les etiquettes ne sont disponibles que sur les comptes WhatsApp Business. Les comptes WhatsApp personnels ne prennent pas en charge les etiquettes.
Tous les endpoints d’etiquettes sont limites a une instance specifique : 
/api/instances/{instanceId}/labels/...

​
Creer une etiquette

Creez une nouvelle etiquette avec un nom et une couleur. 
curl -X POST https://api.wappfy.io/api/instances/inst_abc123/labels \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "VIP Customer",
    "color": 1
  }'
Reponse : 
{
  "data": {
    "id": "1",
    "name": "VIP Customer",
    "color": 1
  }
}

​
Couleurs des etiquettes

WhatsApp Business prend en charge un ensemble fixe de couleurs d’etiquettes identifiees par numero :
ID couleurCouleur
0Gris clair
1Vert
2Bleu
3Jaune
4Rose/Rouge

​
Lister les etiquettes

Recuperez toutes les etiquettes de l’instance. 
curl https://api.wappfy.io/api/instances/inst_abc123/labels \
  -H "X-Api-Key: YOUR_API_KEY"
Reponse : 
{
  "data": [
    { "id": "1", "name": "New Customer", "color": 0 },
    { "id": "2", "name": "VIP Customer", "color": 1 },
    { "id": "3", "name": "Pending Payment", "color": 3 },
    { "id": "4", "name": "Resolved", "color": 2 }
  ]
}

​
Mettre a jour une etiquette

Mettez a jour le nom ou la couleur d’une etiquette existante. 
curl -X PUT https://api.wappfy.io/api/instances/inst_abc123/labels/2 \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Premium Customer",
    "color": 2
  }'

​
Supprimer une etiquette

Supprimez definitivement une etiquette. Cela retire l’etiquette de toutes les conversations auxquelles elle etait attribuee. 
curl -X DELETE https://api.wappfy.io/api/instances/inst_abc123/labels/2 \
  -H "X-Api-Key: YOUR_API_KEY"
La suppression d’une etiquette la retire de toutes les conversations associees. Cette action est irreversible.

​
Etiquettes de conversation

​
Obtenir les etiquettes d’une conversation

Recuperez toutes les etiquettes attribuees a une conversation specifique. 
curl https://api.wappfy.io/api/instances/inst_abc123/labels/chats/[email protected] \
  -H "X-Api-Key: YOUR_API_KEY"
Reponse : 
{
  "data": [
    { "id": "1", "name": "New Customer", "color": 0 },
    { "id": "3", "name": "Pending Payment", "color": 3 }
  ]
}

​
Definir les etiquettes d’une conversation

Attribuez une ou plusieurs etiquettes a une conversation. Cela remplace toutes les etiquettes existantes sur la conversation. 
curl -X PUT https://api.wappfy.io/api/instances/inst_abc123/labels/chats/[email protected] \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "label_ids": ["1", "2"]
  }'
Pour retirer toutes les etiquettes d’une conversation, transmettez un tableau vide : {"label_ids": []}.

​
Obtenir les conversations par etiquette

Recuperez toutes les conversations auxquelles une etiquette specifique est attribuee. 
curl https://api.wappfy.io/api/instances/inst_abc123/labels/2/chats \
  -H "X-Api-Key: YOUR_API_KEY"
Reponse : 
{
  "data": [
    {
      "chat_id": "[email protected]",
      "name": "Maria Silva"
    },
    {
      "chat_id": "[email protected]",
      "name": "Carlos Oliveira"
    }
  ]
}

​
Cas d’utilisation courants

Utilisez un webhook pour ecouter les evenements message.received. Lorsqu’un message provient d’un contact inconnu, attribuez l’etiquette “Nouveau prospect” via l’API. Cela aide votre equipe a identifier et prioriser rapidement les nouvelles conversations.
Creez des etiquettes comme “Ouvert”, “En cours” et “Resolu”. Mettez a jour l’etiquette au fur et a mesure que votre equipe traite les demandes de support. Utilisez l’endpoint “Obtenir les conversations par etiquette” pour construire une file d’attente de support simple.
Etiquetez les clients par categorie (par ex., “VIP”, “Grossiste”, “Detail”). Lors de l’envoi de messages en masse, recuperez toutes les conversations d’une etiquette et envoyez les messages en boucle.

​
Reference des endpoints

MethodeEndpointDescription
POST/api/instances/{id}/labelsCreer une nouvelle etiquette
GET/api/instances/{id}/labelsLister toutes les etiquettes
PUT/api/instances/{id}/labels/{labelId}Mettre a jour une etiquette
DELETE/api/instances/{id}/labels/{labelId}Supprimer une etiquette
GET/api/instances/{id}/labels/chats/{chatId}Obtenir les etiquettes d’une conversation
PUT/api/instances/{id}/labels/chats/{chatId}Definir les etiquettes d’une conversation
GET/api/instances/{id}/labels/{labelId}/chatsObtenir les conversations par etiquette

​
Gestion des erreurs

Code de statutDescription
400Couleur d’etiquette invalide ou champs obligatoires manquants.
404Etiquette ou conversation non trouvee.
409Une etiquette avec le meme nom existe deja.
422Format d’identifiant de conversation invalide.