Bland.Ai
  1. 批次
Bland.Ai
  • 入门指南
  • 基本
    • 发送呼叫(简单)
      POST
    • 使用 Pathways 发送呼叫(简单)
      POST
  • 通话
    • 发送呼叫
      POST
    • 使用 AI 分析通话
      POST
    • 停止当前通话
      POST
    • 列出通话
      GET
    • 通话详情
      GET
    • 声音录制
      GET
    • 获取更正的成绩单
      GET
  • 网络代理
    • 创建网络代理
      POST
    • 更新网络代理设置
      POST
    • 授权网络代理呼叫
      POST
    • 删除网络代理
      POST
    • 列出网络代理
      GET
  • 对话途径
    • 获取单一途径信息
      GET
    • 创建途径
      POST
    • 更新途径
      POST
    • 删除途径
      DELETE
  • 呼入号码
    • 购买呼入号码
    • 更新入站详细信息
    • 列出呼入号码
    • 呼入号码详情
  • 呼出号码
    • 购买呼出号码
    • 列出呼出号码
  • 声音
    • 列出声音
    • 语音详情
    • 生成音频样本
  • 定制工具
    • 创建自定义工具
    • 更新自定义工具
    • 列出自定义工具
    • 自定义工具详细信息
  • 自定义 Twilio 帐户
    • 创建加密密钥
    • 删除加密密钥
    • 上传呼入电话号码
    • 删除呼入电话号码
  • 子账号
    • 创建子账户
    • 将积分转移到子账户
    • 轮换子账户 API 密钥
    • 禁用子账户
    • 列出子账户
    • 列出子账户详细信息
  • 批次
    • 发送一批呼叫
      POST
    • 使用 AI 分析批次
      POST
    • 停止活动批次
      POST
    • 列出批次
      GET
    • 批次详情
      GET
    • 检索批量分析
      GET
  • 短信
    • A2P 注册
    • 检查短信 A2P 状态
    • 更新短信提示
    • 短信对话分析
    • 获取短信
    • 切换短信回复方式
    • 更新短信 Webhook
  • 账户
    • 帐户详细资料
  1. 批次

批次详情

开发环境
开发环境
GET
/v1/batches/{batch_id}
检索特定batch_id 的调用和批次数据。
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request GET 'http://dev-cn.your-api-server.com/v1/batches/' \
--header 'authorization: <authorization>'
响应示例响应示例
{
  "batch_params": {
    "id": "AAcQq8zXxLB56LWg-gen-batch",
    "campaign_id": null,
    "created_at": "2023-12-07T20:43:44.544773+00:00",
    "label": "Customer Satisfaction Follow-up",
    "base_prompt": "You are calling {{name}} about their recent purchase of the item: {{item}}. Ask them each of the following questions about the specific item they purchased: {{questions}}",
    "endpoint_code": "api",
    "call_params": {
      "reduce_latency": true,
      "voice_id": 0,
      "language": "eng",
      "max_duration": 10,
      "wait_for_greeting": false
    }
  },
  "call_data": [
    {
      "status": "completed",
      "corrected_duration": "12",
      "end_at": "2023-12-16T00:17:38.000Z",
      "call_id": "ffa99be3-63dd-44dc-9523-380cd25c1b9e",
      "to": "1112223333",
      "from": "+17473423273",
      "completed": true,
      "created_at": "2023-12-16T00:17:22.383682+00:00",
      "queue_status": "complete",
      "endpoint_url": "api.bland.ai",
      "max_duration": 30,
      "error_message": null,
      "answered_by": "voicemail",
      "request_data": {
        "phone_number": "1112223333",
        "reduce_latency": true,
        "wait": false,
        "language": "ENG"
      },
      "transcripts": [
        {
          "id": 1188954,
          "created_at": "2023-12-16T00:17:30.46833+00:00",
          "text": " Hi, Im calling about the laundromat for sale.  —  ",
          "user": "assistant",
          "c_id": "ffa99be3-63dd-44dc-9523-380cd25c1b9e"
        },
        {
          "id": 1188957,
          "created_at": "2023-12-16T00:17:35.14056+00:00",
          "text": "I'll get back to you as soon as you can. Just leave a message. Thank you. Bye.",
          "user": "user",
          "c_id": "ffa99be3-63dd-44dc-9523-380cd25c1b9e"
        },
        {
          "id": 1188959,
          "created_at": "2023-12-16T00:17:36.710551+00:00",
          "text": "Ended call: Goodbye",
          "user": "agent-action",
          "c_id": "ffa99be3-63dd-44dc-9523-380cd25c1b9e"
        }
      ],
      "call_length": 0.12345
    }
  ],
  "analysis": {
    "total_calls": 88,
    "completed_calls": 86,
    "in_progress_calls": 2,
    "queue_statuses": {
      "complete": 85,
      "started": 2,
      "call_error": 1
    },
    "call_lengths": {
      "average": 17,
      "average_nonzero": 31,
      "summary": {
        "0-5": 18,
        "5-10": 4,
        "10-15": 3,
        "15-20": 2,
        "20-30": 14,
        "30-45": 28,
        "45-60": 11,
        "60-90": 6,
        "90-120": 1,
        "120+": 1
      },
      "all": [
        7,
        32
      ]
    },
    "call_ids": [
      "ffa99be3-63dd-44dc-9523-380cd25c1b9e",
      "591338a8-34b2-41e6-93da-b9029c9bdedc"
    ],
    "error_messages": [
      {
        "call_id": "c52f5f8c-147e-478c-4b40-88214feeba29",
        "error_message": "Cannot transfer to +12223334444 - Call is no longer active"
      }
    ],
    "endpoints": {
      "api.bland.ai": 88
    }
  }
}

请求参数

Path 参数
batch_id
string 
必需
您要检索的一批呼叫的唯一标识符。
Header 参数
authorization
string 
必需
示例值:
<authorization>

返回响应

🟢200成功
application/json
Body
batch_params
object 
必需
包含批次参数和设置的对象。
id
string 
必需
批次的唯一标识符 - 用作batch_id其他 API 调用中的参数。
campaign_id
null 
必需
created_at
string 
批次的创建时间戳。
必需
label
string 
批次的标签或描述。
必需
base_prompt
string 
必需
用于此批次中的呼叫的基本提示。
endpoint_code
string 
必需
用于API集成的端点代码。
call_params
object 
必需
包含批处理中调用的参数的对象。
call_data
array [object {16}] 
必需
对象数组,每个对象代表单独的呼叫数据。
status
string 
可选
corrected_duration
string 
可选
end_at
string 
可选
call_id
string 
可选
每个单独呼叫的唯一标识符。
to
string 
可选
拨打电话的电话号码。
from
string 
可选
拨打电话的电话号码。
completed
boolean 
指示呼叫是否完成。
可选
created_at
string 
可选
queue_status
string 
可选
创建单个呼叫时的时间戳。
endpoint_url
string 
可选
max_duration
integer 
可选
error_message
null 
可选
answered_by
string 
可选
如果批次设置answered_by_enabled为 true,则包含字符串值。 价值观: voicemail human unknown no-answer null
request_data
object 
可选
transcripts
array [object {5}] 
可选
call_length
number 
可选
通话持续时间(以分钟为单位)。
analysis
object 
必需
包含批次分析数据的对象。
total_calls
integer 
必需
批次中的调用总数,包括已完成的调用和正在进行的调用。
completed_calls
integer 
必需
批次中已完成的调用总数。
in_progress_calls
integer 
必需
批次中正在进行的调用总数。
queue_statuses
object 
必需
包含每个队列状态中的呼叫数量的对象。
call_lengths
object 
必需
包含average、average_nonzero、summary和all字段。 average:平均通话时长(以分钟为单位)。 average_nonzero:平均通话时长(以分钟为单位),不包括时长小于一秒的通话。 summary:按范围分组的呼叫长度摘要。 all:包含每个通话时长,以防您想要使用与默认分组不同的分组。
call_ids
array[string]
必需
包含call_id批次中的每个。
error_messages
array [object {2}] 
必需
包含批处理中调用可能具有的任何错误消息。
endpoints
object 
必需
包含已发送到每个端点的呼叫数。仅适用于 API 集成。
修改于 2024-05-10 09:15:24
上一页
列出批次
下一页
检索批量分析
Built with