Démarrage rapide

1. Créer une clé API

   Créez une clé sur app.callshift.ai/api-keys et gardez-la dans une variable d'environnement. Vérifiez qu'elle fonctionne en listant vos agents :

   Terminal

   export CALLSHIFT_API_KEY="your-api-key"
   
   curl "https://api.callshift.ai/v1/agents?limit=5" \
     -H "Authorization: Bearer $CALLSHIFT_API_KEY"

2. Choisir un agent

   Notez l'id de l'agent qui passera l'appel. Pour essayer une modification sans toucher à un agent en production, dupliquez-le d'abord avec POST/v1/agents/{agentId}/duplicate et travaillez sur la copie.

   JSON

   {
     "data": [
       { "id": "550e8400-e29b-41d4-a716-446655440000", "name": "Alice", "gender": "FEMALE", "language": "en", "entityId": null }
     ],
     "pageCount": 1
   }

3. Choisir un numéro de téléphone

   GET/v1/phones liste tous les numéros du compte. Prenez-en un dont isOutboundAllowed vaut true : son id est le phoneId de la campagne.

4. Créer une campagne

   Une campagne est créée inactive : aucun appel n'est encore passé.

   cURLJavaScriptPython

   curl -X POST "https://api.callshift.ai/v1/campaigns" \
     -H "Authorization: Bearer $CALLSHIFT_API_KEY" \
     -H "Content-Type: application/json" \
     -d '{
       "name": "API quickstart",
       "agentId": "550e8400-e29b-41d4-a716-446655440000",
       "phoneId": "0d3a7e6b-2b8e-4c5b-9c4e-5f4b9d2a1c8e"
     }'

   const res = await fetch("https://api.callshift.ai/v1/campaigns", {
     method: "POST",
     headers: {
       Authorization: `Bearer ${process.env.CALLSHIFT_API_KEY}`,
       "Content-Type": "application/json",
     },
     body: JSON.stringify({
       name: "API quickstart",
       agentId: "550e8400-e29b-41d4-a716-446655440000",
       phoneId: "0d3a7e6b-2b8e-4c5b-9c4e-5f4b9d2a1c8e",
     }),
   });
   const { id: campaignId } = await res.json();

   import os
   import requests
   
   res = requests.post(
       "https://api.callshift.ai/v1/campaigns",
       headers={"Authorization": f"Bearer {os.environ['CALLSHIFT_API_KEY']}"},
       json={
           "name": "API quickstart",
           "agentId": "550e8400-e29b-41d4-a716-446655440000",
           "phoneId": "0d3a7e6b-2b8e-4c5b-9c4e-5f4b9d2a1c8e",
       },
   )
   campaign_id = res.json()["id"]

5. Vous ajouter et démarrer la campagne

   Ajoutez un contact, votre propre mobile au format E.164, puis activez la campagne. Une campagne active appelle les nouveaux contacts dès qu'ils sont ajoutés.

   Terminal

   curl -X POST "https://api.callshift.ai/v1/campaigns/$CAMPAIGN_ID/contacts" \
     -H "Authorization: Bearer $CALLSHIFT_API_KEY" \
     -H "Content-Type: application/json" \
     -d '{ "contacts": [ { "firstName": "Ada", "phoneNumber": "+33612345678" } ] }'
   
   curl -X PATCH "https://api.callshift.ai/v1/campaigns/$CAMPAIGN_ID" \
     -H "Authorization: Bearer $CALLSHIFT_API_KEY" \
     -H "Content-Type: application/json" \
     -d '{ "isActive": true }'

   Votre téléphone sonne dans les secondes qui suivent. Décrochez et parlez à l'agent.

6. Consulter l'appel

   Une fois que vous avez raccroché, le résultat de l'appel est disponible. La liste donne le statut, le motif de fin d'appel et le résumé ; le détail y ajoute la transcription et l'enregistrement.

   Terminal

   curl "https://api.callshift.ai/v1/calls?campaignId=$CAMPAIGN_ID" \
     -H "Authorization: Bearer $CALLSHIFT_API_KEY"

Répondre plutôt aux appels entrants

Pour que l'agent réponde sur un numéro, attribuez-le à ce numéro avec PATCH/v1/phones/{phoneId}, puis appelez le numéro.

curl -X PATCH "https://api.callshift.ai/v1/phones/$PHONE_ID" \
  -H "Authorization: Bearer $CALLSHIFT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "agentId": "550e8400-e29b-41d4-a716-446655440000" }'

Étapes suivantes