Skip to main content
GET
/
api
/
v1
/
campaigns
/
{campaign_id}
/
status
Obtenir le statut d'une campagne
curl --request GET \
  --url https://app.voicehire.io/api/v1/campaigns/{campaign_id}/status \
  --header 'X-API-Key: <api-key>'
{
  "campaign_id": "abc123def456",
  "status": "active",
  "stats": {
    "total_candidates": 45,
    "interviews_completed": 38,
    "average_score": 7.2,
    "time_saved_hours": 19.0,
    "completion_rate": 84.4,
    "qualified_count": 12,
    "voicemail_count": 3,
    "incomplete_count": 2,
    "unavailable_count": 1,
    "no_answer_count": 1,
    "invalid_count": 0
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.voicehire.io/llms.txt

Use this file to discover all available pages before exploring further.

​
Paramètres

​
campaign_id
string
required
Identifiant unique de la campagne

​
Réponse

{
  "campaign_id": "abc123def456",
  "status": "active",
  "stats": {
    "total_candidates": 45,
    "interviews_completed": 38,
    "average_score": 7.2,
    "time_saved_hours": 19.0,
    "completion_rate": 84.4,
    "qualified_count": 12,
    "voicemail_count": 3,
    "incomplete_count": 2,
    "unavailable_count": 1,
    "no_answer_count": 1,
    "invalid_count": 0
  }
}
​
campaign_id
string
required
Identifiant unique de la campagne
​
status
string
required
Statut actuel de la campagneValeurs possibles:
  • active - Campagne active, appels en cours
  • paused - Campagne en pause, appels suspendus
  • completed - Campagne terminée
​
stats
object
required
Statistiques détaillées de la campagne

​
Exemple de requête

curl -X GET https://app.voicehire.io/api/v1/campaigns/abc123def456/status \
  -H "X-API-Key: vh_live_XXXXXXXXXXXXX"

​
Codes d’erreur

CodeDescription
401Clé API manquante ou invalide
404Campagne non trouvée

Authorizations

​
X-API-Key
string
header
required

Clé API au format vh_live_XXXXX

Path Parameters

​
campaign_id
string
required

Identifiant de la campagne

Example:

"CAMP-20250701-ABC123"

Response

Statut de la campagne

​
campaign_id
string
​
status
enum<string>
Available options:
active,
paused,
completed
​
stats
object