跳到导航

获取外呼活动线索

获取外呼活动的一位潜在客户。

路径参数

campaign_idstring必需
lead_idstring必需

请求头

xi-api-keystring可选

响应

成功响应

lead_idstring
phone_numberstring

潜在客户下次呼叫要拨打的号码。当潜在客户转至其他列出的号码,或联系人要求改拨其他号码时,此号码会变更。

phone_numbers_indexinteger

正在呼叫的号码在 phone_numbers 中的位置。

user_idstring

联系人的身份:conversation_initiation_client_data 中提交的 user_id,否则为潜在客户的电话号码。

attempt_countinteger

已发起的呼叫,计入策略的 max_total_calls。

failure_countinteger

向当前号码呼叫失败的次数;更换号码时重置。

callback_countinteger

联系人请求的回拨。

redirect_countinteger

联系人要求改用其他号码呼叫的次数。

do_not_callboolean

当联系人要求不再呼叫、潜在客户被移除或活动停止时设置。该潜在客户不会再被呼叫。

updated_at_unixinteger
dynamic_variablesmap from strings to any

为潜在客户提交的动态变量,已隐去密钥。

overridesobject

为潜在客户提交的对话覆盖设置。

recipient_idstring可选

创建活动时分配给此收件人的 id。

phone_numberslist of strings可选

潜在客户列出的号码,按呼叫顺序排列。

terminal_dispositionenum可选

不再呼叫该潜在客户的原因;仍可能再次呼叫时不设置。

created_at_unixinteger可选

潜在客户加入活动的时间;旧潜在客户未设置此项。

deliveryobject可选

潜在客户最新的消息投递状态;在消息活动中设置。

错误

422
Leads Get Request Unprocessable Entity Error