Saltar a la navegación

Obtener un contacto de campaña saliente

Obtiene un contacto de una campaña saliente.

Parámetros de ruta

campaign_idstringRequerido
lead_idstringRequerido

Encabezados

xi-api-keystringOpcional

Respuesta

Respuesta correcta.
lead_idstring
recipient_idstring or null

El id asignado a este destinatario al crear la campaña.

phone_numberstring

El número que marca la siguiente llamada del contacto. Cambia cuando el contacto pasa a otro número de la lista o solicita que se le llame a uno diferente.

phone_numbers_indexinteger

La posición en phone_numbers del número al que se llama.

user_idstring

La identidad del contacto: el user_id enviado en conversation_initiation_client_data o, de lo contrario, el número de teléfono del contacto.

attempt_countinteger

Llamadas realizadas, contabilizadas respecto a max_total_calls de la política.

failure_countinteger

Llamadas fallidas al número actual; se reinicia con un número nuevo.

callback_countinteger
Devoluciones de llamada solicitadas por el contacto.
redirect_countinteger

Las veces que el contacto pidió que se le llamara a otro número.

do_not_callboolean

Se establece cuando el contacto pidió que no se le llamara, se eliminó el contacto o se detuvo la campaña. No se vuelve a llamar al contacto.

terminal_dispositionenum or null

Por qué no se volverá a llamar al lead; no se define mientras aún pueda recibir llamadas.

created_at_unixinteger or null

Cuándo se unió el lead a la campaña; no se define para leads antiguos.

updated_at_unixinteger
dynamic_variablesmap from strings to any

Las variables dinámicas enviadas para el contacto, con los secretos ocultos.

overridesobject

Las anulaciones de conversación enviadas para el contacto.

phone_numberslist of stringsOpcional

Los números del contacto incluidos en la lista, en orden de llamada.

deliveryobject or nullOpcional

La entrega del último mensaje del contacto; se establece en campañas de mensajes.

Errores

422
Unprocessable Entity Error