Skip to main content
POST
/
campaigns
/
create
Crée une nouvelle campagne
curl --request POST \
  --url https://app.voicehire.io/api/v1/campaigns/create \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "job_title": "Développeur Full Stack",
  "contract_type": "CDI",
  "job_description": "<string>",
  "additional_info": "<string>",
  "client_name": "<string>",
  "questions": [
    "Quelle est votre expérience avec React?",
    "Êtes-vous disponible pour du télétravail?"
  ],
  "question_weights": [
    0
  ],
  "enable_salary_question": true,
  "enable_job_search_question": true,
  "enable_availability_question": true,
  "enable_engage": true,
  "enable_recapInterview": true,
  "enable_recapJob": true
}
'
{
  "campaign_id": "abc123def456",
  "candidate_link": "https://app.voicehire.io/link/abc123def456",
  "status": "active",
  "questions_generated": 6
}

​
Corps de la requête

​
job_title
string
required
Titre du poste à pourvoir
​
contract_type
string
required
Type de contrat proposéValeurs possibles:
  • CDI - Contrat à durée indéterminée
  • CDD - Contrat à durée déterminée
  • Stage - Convention de stage
  • Alternance - Contrat d’alternance
  • Freelance - Mission freelance
  • Interim - Mission d’intérim
​
job_description
string
required
Description détaillée du poste, des responsabilités et du profil recherché
​
additional_info
string
Informations complémentaires sur le poste ou l’entreprise (optionnel)
​
client_name
string
Nom de l’entreprise cliente (sera utilisé lors des appels) (optionnel)
​
questions
array
Questions personnalisées pour l’entretien (maximum 8) (optionnel)Si non fourni, 6 questions seront générées automatiquement par IA
​
question_weights
array
Poids associés à chaque question (requis si des questions sont fournies) (optionnel)Valeurs possibles pour chaque poids: 0, 0.5, 1, 1.5, 2
​
enable_salary_question
boolean
default:"true"
Activer la question sur les prétentions salariales (optionnel)
​
enable_job_search_question
boolean
default:"true"
Activer la question sur la recherche d’emploi actuelle (optionnel)
​
enable_availability_question
boolean
default:"true"
Activer la question sur la disponibilité (optionnel)
​
enable_engage
boolean
default:"null"
Active la présentation de votre structure par l’agent VoiceHire (optionnel)Si fourni, surcharge le réglage global de l’agence
​
enable_recapInterview
boolean
default:"null"
Active l’explication du déroulé de l’entretien par l’agent VoiceHire (optionnel)Si fourni, surcharge le réglage global de l’agence
​
enable_recapJob
boolean
default:"null"
Active la présentation du poste par l’agent VoiceHire (optionnel)Si fourni, surcharge le réglage global de l’agence

​
Réponse

{
  "campaign_id": "abc123def456",
  "candidate_link": "https://app.voicehire.io/link/abc123def456",
  "status": "active",
  "questions_generated": 6
}
​
campaign_id
string
required
Identifiant unique de la campagne créée
​
candidate_link
string
required
Lien à partager avec les candidats pour postuler
​
status
string
required
Statut de la campagne (toujours active à la création)
​
questions_generated
integer
required
Nombre de questions générées pour l’entretien

​
Exemple de requête

curl -X POST https://app.voicehire.io/api/v1/campaigns/create \
  -H "X-API-Key: vh_live_XXXXXXXXXXXXX" \
  -H "Content-Type: application/json" \
  -d '{
    "job_title": "Développeur Full Stack",
    "contract_type": "CDI",
    "job_description": "Nous recherchons un développeur Full Stack expérimenté...",
    "client_name": "TechCorp",
    "questions": [
      "Quelle est votre expérience avec React et Node.js?",
      "Avez-vous déjà travaillé en méthodologie Agile?"
    ],
    "question_weights": [2, 1.5],
    "enable_salary_question": true,
    "enable_engage": true,
    "enable_recapInterview": false
  }'

​
Codes d’erreur

CodeDescription
400Données invalides (champs requis manquants, format incorrect)
401Clé API manquante ou invalide
402Crédits insuffisants pour créer une campagne

Authorizations

​
X-API-Key
string
header
required

Clé API VoiceHire (format vh_live_...)

Body

application/json
​
job_title
string
required

Titre du poste

Example:

"Développeur Full Stack"

​
contract_type
enum<string>
required

Type de contrat

Available options:
CDI,
CDD,
Stage,
Alternance,
Freelance,
Interim
​
job_description
string
required

Description détaillée du poste

​
additional_info
string

Informations complémentaires (optionnel)

​
client_name
string

Nom de l'entreprise cliente (optionnel)

​
questions
string[]

Questions personnalisées (optionnel, max 8)

Example:
[
  "Quelle est votre expérience avec React?",
  "Êtes-vous disponible pour du télétravail?"
]
​
question_weights
enum<number>[]

Poids des questions (requis si questions fournies)

Available options:
0,
0.5,
1,
1.5,
2
​
enable_salary_question
boolean
default:true

Activer la question sur le salaire

​
enable_job_search_question
boolean
default:true

Activer la question sur la recherche d'emploi

​
enable_availability_question
boolean
default:true

Activer la question sur la disponibilité

​
enable_engage
boolean

Active la présentation de votre structure par l'agent VoiceHire (optionnel, surcharge le réglage de l'agence)

​
enable_recapInterview
boolean

Active l'explication du déroulé de l'entretien par l'agent VoiceHire (optionnel, surcharge le réglage de l'agence)

​
enable_recapJob
boolean

Active la présentation du poste par l'agent VoiceHire (optionnel, surcharge le réglage de l'agence)

Response

Campagne créée avec succès

​
campaign_id
string

ID unique de la campagne

​
candidate_link
string<uri>

Lien pour les candidats

​
status
enum<string>
Available options:
active
​
questions_generated
integer

Nombre de questions générées