Mettre en pause une campagne d'appels sortants

{
  "campaign_id": "string",
  "call_name": "string",
  "agent_id": "string",
  "channel_config": {
    "channel": "phone",
    "agent_phone_number_id": "string",
    "mode_config": {
      "ringing_timeout_secs": 60,
      "twilio_call_recording_enabled": false,
      "twilio_machine_detection": {
        "mode": "enable",
        "actions": [
          {
            "action": "hang_up",
            "answered_by": [
              "human"
            ]
          }
        ]
      },
      "mode": "voice"
    }
  },
  "status": "active",
  "policy": {
    "timezone": "string",
    "retry": {
      "retry_delay_seconds": 600,
      "max_short_retries": 1,
      "max_total_calls": 6,
      "max_callbacks": 2,
      "max_redirects": 2,
      "interval_placement": "start",
      "rotate_step_seconds": 900,
      "max_consecutive_failures_per_number": 1
    },
    "calling_periods": [
      {
        "weekdays": [
          1
        ],
        "intervals": [
          {
            "start": "string",
            "end": "string"
          }
        ]
      }
    ],
    "data_collection": {
      "callback_time": "string",
      "redirect_phone_number": "string",
      "stop": "string",
      "mappings": {}
    },
    "followup_context": {
      "call_type": true,
      "previous_conversation_id": true,
      "previous_summary": true,
      "previous_transcript": true
    }
  },
  "variant": "simple",
  "source": "ui",
  "outcome": {
    "type": "evaluation_criteria",
    "criteria_id": "string"
  },
  "created_at_unix": 1,
  "scheduled_time_unix": 1,
  "updated_at_unix": 1,
  "branch_id": "string",
  "environment": "string",
  "target_concurrency_limit": 1,
  "channel": "phone",
  "mode": "voice",
  "counts": {
    "leads": 1,
    "terminal_leads": 1,
    "open_attention": 1,
    "delivery": {
      "sent": 0,
      "delivered": 0,
      "read": 0,
      "replied": 0,
      "failed": 0
    }
  },
  "agent_name": ""
}

Met en pause une campagne sortante. Aucun nouvel appel n’est passé jusqu’à sa reprise ; les appels déjà passés se poursuivent.

Paramètres de chemin

campaign_idstringRequis

Réponse

Réponse réussie

campaign_idstring

call_namestring

Nom de la campagne.

agent_idstring

channel_configobject

statusenum

attention signifie qu’un élément d’attention ouvert bloque certains appels de la campagne, tandis que les autres se poursuivent. stopping signifie que les appels en attente sont annulés et que les appels déjà passés se terminent.

policyobject

La stratégie adoptée par la campagne lors de sa création.

variantenum

Valeurs autorisées:

sourceenum or null

Indique si la campagne a été créée dans l’application ou via l’API.

Valeurs autorisées:

outcomeobject or null

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

created_at_unixinteger

scheduled_time_unixinteger or null

Date et heure auxquelles la campagne commence à appeler ; non défini pour démarrer dès sa création.

updated_at_unixinteger

branch_idstring or null

Branche de l’agent utilisée par la campagne pour les appels.

environmentstring or null

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

target_concurrency_limitinteger or null

Nombre maximal d’appels que la campagne passe simultanément.

channelenum

Valeurs autorisées:

modeenum

Valeurs autorisées:

countsobject

agent_namestringPar défaut

Erreurs

422

Unprocessable Entity Error

Paramètres de chemin

En-têtes

Réponse

Erreurs