Skip to main content
GET
/
api
/
v1
/
campaigns
/
{campaign_id}
/
details
Obtenir les détails d'une campagne
curl --request GET \
  --url https://app.voicehire.io/api/v1/campaigns/{campaign_id}/details \
  --header 'X-API-Key: <api-key>'
{
  "campaign_id": "abc123def456",
  "job_title": "Développeur Full Stack",
  "contract_type": "CDI",
  "job_description": "Nous recherchons un développeur full stack expérimenté...",
  "company_name": "TechCorp",
  "client_company": "StartupInnovante",
  "additional_info": "Télétravail possible 2 jours par semaine",
  "created_at": "2024-01-15T10:30:00",
  "updated_at": "2024-01-15T10:30:00",
  "status": "active",
  "questions": [
    {
      "order": 1,
      "question": "Pouvez-vous décrire votre expérience avec React et Node.js ?",
      "weight": 2.0
    },
    {
      "order": 2,
      "question": "Comment gérez-vous le travail en équipe agile ?",
      "weight": 1.5
    },
    {
      "order": 3,
      "question": "Quelle est votre approche pour résoudre des problèmes complexes ?",
      "weight": 1.0
    }
  ],
  "campaign_settings": {
    "language_test_mode": "none",
    "enable_salary_question": true,
    "enable_job_search_question": true,
    "enable_availability_question": true,
    "enable_engage": null,
    "enable_recap_interview": null,
    "enable_recap_job": null
  }
}

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",
  "job_title": "Développeur Full Stack",
  "contract_type": "CDI",
  "job_description": "Nous recherchons un développeur full stack expérimenté...",
  "company_name": "TechCorp",
  "client_company": "StartupInnovante",
  "additional_info": "Télétravail possible 2 jours par semaine",
  "created_at": "2024-01-15T10:30:00",
  "updated_at": "2024-01-15T10:30:00",
  "status": "active",
  "questions": [
    {
      "order": 1,
      "question": "Pouvez-vous décrire votre expérience avec React et Node.js ?",
      "weight": 2.0
    },
    {
      "order": 2,
      "question": "Comment gérez-vous le travail en équipe agile ?",
      "weight": 1.5
    },
    {
      "order": 3,
      "question": "Quelle est votre approche pour résoudre des problèmes complexes ?",
      "weight": 1.0
    }
  ],
  "campaign_settings": {
    "language_test_mode": "none",
    "enable_salary_question": true,
    "enable_job_search_question": true,
    "enable_availability_question": true,
    "enable_engage": null,
    "enable_recap_interview": null,
    "enable_recap_job": null
  }
}
​
campaign_id
string
required
Identifiant unique de la campagne
​
job_title
string
required
Titre du poste proposé
​
contract_type
string
required
Type de contrat (CDI, CDD, Stage, etc.)
​
job_description
string
required
Description complète du poste et de l’offre d’emploi
​
company_name
string
required
Nom de l’entreprise qui recrute
​
client_company
string
Nom de l’entreprise cliente (si différent de l’entreprise qui recrute)
​
additional_info
string
Informations complémentaires sur le poste
​
created_at
string
required
Date et heure de création de la campagne (format ISO 8601)
​
updated_at
string
required
Date et heure de dernière modification (format ISO 8601)
​
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
​
questions
array
required
Liste des questions d’entretien avec leurs poids respectifs
​
campaign_settings
object
required
Paramètres de configuration de la campagne

​
Exemple de requête

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

​
Codes d’erreur

CodeDescription
401Clé API manquante ou invalide
404Campagne non trouvée ou n’appartient pas à votre agence
500Erreur interne du serveur

Authorizations

​
X-API-Key
string
header
required

Clé API au format vh_live_XXXXX

Path Parameters

​
campaign_id
string
required

Identifiant unique de la campagne

Response

Détails de la campagne

​
campaign_id
string
​
job_title
string
​
contract_type
string
​
job_description
string
​
company_name
string
​
client_company
string | null
​
additional_info
string | null
​
created_at
string<date-time>
​
updated_at
string<date-time>
​
status
enum<string>
Available options:
active,
paused,
completed
​
questions
object[]
​
campaign_settings
object