Skip to main content
POST
/
campaigns
/
{campaign_id}
/
source
Source des candidats avec SMS
curl --request POST \
  --url https://app.voicehire.io/api/v1/campaigns/{campaign_id}/source \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "candidates": [
    {
      "first_name": "<string>",
      "last_name": "<string>",
      "phone": "<string>",
      "email": "<string>"
    }
  ]
}
'
{
  "campaign_id": "abc123def456",
  "candidates_sourced": 8,
  "candidates_skipped": 2,
  "sms_sent": 8,
  "errors": []
}

​
Paramètres

​
campaign_id
string
required
Identifiant unique de la campagne

​
Corps de la requête

​
candidates
array
required
Liste des candidats à sourcer (maximum 100)

​
Réponse

{
  "campaign_id": "abc123def456",
  "candidates_sourced": 8,
  "candidates_skipped": 2,
  "sms_sent": 8,
  "errors": []
}
​
campaign_id
string
required
Identifiant de la campagne
​
candidates_sourced
integer
required
Nombre de candidats sourcés avec succès
​
candidates_skipped
integer
required
Nombre de candidats ignorés (déjà présents)
​
sms_sent
integer
required
Nombre de SMS envoyés
​
errors
array
Liste des erreurs rencontrées

​
Exemple de requête

curl -X POST https://app.voicehire.io/api/v1/campaigns/abc123def456/source \
  -H "X-API-Key: vh_live_XXXXXXXXXXXXX" \
  -H "Content-Type: application/json" \
  -d '{
    "candidates": [
      {
        "first_name": "Pierre",
        "last_name": "Durand",
        "phone": "0612345678"
      },
      {
        "first_name": "Sophie",
        "last_name": "Bernard",
        "phone": "0687654321",
        "email": "[email protected]"
      }
    ]
  }'

​
Notes importantes

  • Les candidats sourcés reçoivent un SMS d’invitation (nécessite un template SMS configuré)
  • Les candidats doivent cliquer sur le lien SMS pour s’inscrire et être appelés
  • L’email est optionnel mais recommandé pour le suivi

​
Codes d’erreur

CodeDescription
400Données invalides ou template SMS non configuré
401Clé API manquante ou invalide
402Crédits insuffisants
404Campagne non trouvée

Authorizations

​
X-API-Key
string
header
required

Clé API VoiceHire (format vh_live_...)

Path Parameters

​
campaign_id
string
required

ID de la campagne

Body

application/json
​
candidates
object[]
required
Maximum array length: 100

Response

200 - application/json

Candidats sourcés

​
campaign_id
string
​
candidates_sourced
integer
​
candidates_skipped
integer
​
sms_sent
integer
​
errors
object[]