Créer une campagne d’appels sortants

POST

/v1/convai/outbound-campaigns/campaigns/submit

POST

/v1/convai/outbound-campaigns/campaigns/submit

curl -X POST https://api.elevenlabs.io/v1/convai/outbound-campaigns/campaigns/submit \
     -H "Content-Type: application/json" \
     -d '{
  "call_name": "call_name",
  "agent_id": "agent_id",
  "recipients": [
    {}
  ],
  "channel_config": {
    "channel": "phone",
    "agent_phone_number_id": "agent_phone_number_id"
  }
}'

{
  "campaign": {
    "campaign_id": "campaign_id",
    "call_name": "call_name",
    "agent_id": "agent_id",
    "channel_config": {
      "channel": "phone",
      "agent_phone_number_id": "agent_phone_number_id"
    },
    "status": "active",
    "policy": {
      "timezone": "timezone",
      "retry": {},
      "calling_periods": [
        {
          "weekdays": [
            1
          ],
          "intervals": [
            {
              "start": "start",
              "end": "end"
            }
          ]
        }
      ],
      "data_collection": {},
      "followup_context": {}
    },
    "variant": "simple",
    "created_at_unix": 1,
    "updated_at_unix": 1,
    "channel": "phone",
    "mode": "voice",
    "counts": {
      "leads": 1,
      "terminal_leads": 1,
      "open_attention": 1
    },
    "agent_name": "agent_name",
    "source": "ui",
    "outcome": {
      "type": "data_collection",
      "data_collection_id": "data_collection_id",
      "equals": [
        "equals"
      ]
    },
    "scheduled_time_unix": 1,
    "branch_id": "branch_id",
    "environment": "environment",
    "target_concurrency_limit": 1
  },
  "created": true,
  "within_calling_window": true
}

Crée une campagne sortante qui appelle ou contacte chaque destinataire par message avec l’agent, durant les plages d’appel de la politique, en effectuant de nouvelles tentatives et des suivis dans les limites autorisées. Renvoie 201 pour une nouvelle campagne. Une requête répétée, identifiée par idempotency_key ou par son corps, renvoie la campagne existante avec created défini sur false.

Requête

This endpoint expects an object.

call_namestringRequis1-256 characters

Nom de la campagne.

agent_idstringRequis1-256 characters

Agent qui passe les appels.

recipientslist of objectsRequis

Personnes à appeler. Chaque destinataire devient un prospect de la campagne.

channel_configobjectRequis

scheduled_time_unixintegerOptionnel>=0

Date et heure auxquelles commencer à appeler ; omettez ce champ pour commencer immédiatement. Les appels attendent toutefois la prochaine plage d’appel.

timezonestringOptionnel

Fuseau horaire IANA dans lequel interpréter les plages d’appel, remplaçant celui de la politique.

branch_idstringOptionnel<=256 characters

Branche de l’agent à utiliser pour appeler.

environmentstringOptionnel<=256 characters

Environnement dans lequel résoudre les variables d’environnement de l’agent.

target_concurrency_limitintegerOptionnel>=1

Nombre maximal d’appels à passer simultanément.

idempotency_keystringOptionnel1-256 characters

Permet de répéter la requête sans risque : une répétition avec la même clé renvoie la campagne qu’elle a créée.

outcomeobjectOptionnel

Le résultat considéré comme une réussite pour les appels de la campagne.

policyobjectOptionnel

Politique à capturer dans l’instantané de la campagne. Lorsqu’elle est définie, elle prévaut sur la valeur par défaut du Workspace et sur tout remplacement par agent ; lorsqu’elle est omise, la configuration du Workspace doit exister et fournit la politique.

variantenumOptionnel

simple effectue une tentative par destinataire avec des plages d’appel toujours actives et sans collecte de données ; il ne peut pas être combiné avec policy. advanced utilise policy ou la configuration du Workspace et constitue la valeur par défaut des campagnes téléphoniques.

Valeurs autorisées:

Réponse

Réponse réussie

campaignobject

createdboolean

False lorsque la requête répète une requête antérieure et renvoie sa campagne.

within_calling_windowboolean

Indique si les appels commencent immédiatement plutôt que lors de la prochaine plage d’appel.

Erreurs

422

Outbound Campaigns Create Request Unprocessable Entity Error

En-têtes

Requête

Réponse

Erreurs