Référence de l'API
Référence de l'API
L'API REST CallShift, ressource par ressource. Requêtes et réponses sont en JSON, et chaque requête inclut votre clé API.
| URL de base | https://api.callshift.ai |
| Authentification | Authorization: Bearer <API key> sur chaque route /v1. Voir Authentification. |
| Erreurs | Un statut HTTP et un corps JSON. Voir Erreurs. |
| Pagination | page, limit et pageCount. Voir Pagination. |
| Lisible par machine | Spécification OpenAPI 3.1 et Swagger UI, pour générer un client ou essayer une requête. |
Ressources
Les pages de chaque ressource sont en anglais, la langue de la spécification OpenAPI.
Agents
Créez, dupliquez et configurez des agents vocaux, leur parcours d'appel et leur analyse de fin d'appel.
Outils
Les fonctions qu'un agent utilise pendant l'appel : votre endpoint, une recherche web, un SMS, un email.
Appels
Chaque appel avec son résultat, son résumé, sa transcription, son enregistrement et son coût estimé.
Campagnes
Les séries d'appels sortants : mettez des contacts en file d'attente, lancez et arrêtez la campagne, rappelez les contacts non joints.
Contacts
Mettez à jour un contact du CRM ou désinscrivez un numéro.
Numéros de téléphone
Les numéros du compte et l'agent qui répond sur chacun.
Trunks SIP
Les connexions aux opérateurs et leur limite d'appels par seconde.
Webhooks
Les endpoints qui reçoivent les données de fin d'appel.
Entités
Les unités du compte, qui regroupent agents, numéros et webhooks.
Factures
Les factures du compte et l'historique des paiements.
État du service
La seule route publique, accessible sans clé API : elle indique si l'API et sa base de données sont disponibles.
curl "https://api.callshift.ai/health"const res = await fetch("https://api.callshift.ai/health");
const data = await res.json();import requests
res = requests.get(
"https://api.callshift.ai/health",
)
print(res.json()){
"status": "healthy",
"database": "connected"
}{
"status": "healthy",
"database": "connected"
}