Obter um lead da campanha de chamadas ativas

GET

/v1/convai/outbound-campaigns/campaigns/:campaign_id/leads/:lead_id

GET

/v1/convai/outbound-campaigns/campaigns/:campaign_id/leads/:lead_id

curl https://api.elevenlabs.io/v1/convai/outbound-campaigns/campaigns/campaign_id/leads/lead_id

{
  "lead_id": "lead_id",
  "phone_number": "phone_number",
  "phone_numbers_index": 1,
  "user_id": "user_id",
  "attempt_count": 1,
  "failure_count": 1,
  "callback_count": 1,
  "redirect_count": 1,
  "do_not_call": true,
  "updated_at_unix": 1,
  "dynamic_variables": {
    "key": "value"
  },
  "overrides": {
    "language": "language",
    "first_message": "first_message",
    "prompt": "prompt",
    "voice_id": "voice_id"
  },
  "recipient_id": "recipient_id",
  "phone_numbers": [
    "phone_numbers"
  ],
  "terminal_disposition": "campaign_ended",
  "created_at_unix": 1,
  "delivery": {
    "status": "pending",
    "stage": "queued",
    "sent_at_unix": 1,
    "delivered_at_unix": 1,
    "read_at_unix": 1,
    "replied_at_unix": 1,
    "failed_at_unix": 1,
    "error_message": "error_message"
  }
}

Obtenha um lead de uma campanha ativa.

Parâmetros de caminho

campaign_idstringObrigatório

lead_idstringObrigatório

Resposta

Resposta bem-sucedida

lead_idstring

phone_numberstring

O número para o qual a próxima chamada do lead disca. Ele muda quando o lead passa para outro número listado ou o contato pede para receber uma chamada em outro número.

phone_numbers_indexinteger

A posição em phone_numbers do número para o qual a chamada está sendo feita.

user_idstring

A identidade do contato: o user_id enviado em conversation_initiation_client_data ou, caso contrário, o número de telefone do lead.

attempt_countinteger

Chamadas realizadas, contabilizadas no max_total_calls da política.

failure_countinteger

Chamadas com falha para o número atual; é redefinido ao usar um novo número.

callback_countinteger

Retornos de chamada solicitados pelo contato.

redirect_countinteger

Vezes em que o contato pediu para receber uma chamada em outro número.

do_not_callboolean

Definido quando o contato pede para não receber chamadas, o lead é removido ou a campanha é interrompida. O lead não recebe novas chamadas.

updated_at_unixinteger

dynamic_variablesmap from strings to any

As variáveis dinâmicas enviadas para o lead, com segredos ocultados.

overridesobject

As substituições de conversa enviadas para o lead.

recipient_idstringOpcional

O id atribuído a este destinatário quando a campanha foi criada.

phone_numberslist of stringsOpcional

Os números listados do lead, na ordem de chamada.

terminal_dispositionenumOpcional

Por que o lead não receberá outra chamada; não definido enquanto ele ainda puder receber uma.

created_at_unixintegerOpcional

Quando o lead entrou na campanha; não definido para leads mais antigos.

deliveryobjectOpcional

A entrega de mensagem mais recente do lead; definida em campanhas de mensagens.

Erros

422

Leads Get Request Unprocessable Entity Error

Parâmetros de caminho

Cabeçalhos

Resposta

Erros