发送一批呼叫

开发环境

POST

/v1/batches

通过单个 API 请求一次发送大量调用。

请求示例

Shell

JavaScript

Java

Swift

curl --location --request POST 'http://dev-cn.your-api-server.com/v1/batches' \
--header 'authorization: <authorization>' \
--header 'Content-Type: application/json' \
--data-raw '{
  "base_prompt": "<string>",
  "call_data": [
    {}
  ],
  "label": "<string>",
  "campaign_id": "<string>",
  "test_mode": true
}'

响应示例

{
  "message": "success",
  "batch_id": "3p$7rQ3p9sT5bzmF-gen-batch"
}

请求参数

Header 参数

Content-Type

string

必需

示例值:

application/json

authorization

string

必需

示例值:

Body 参数application/json

base_prompt

string

必需

这是用于请求中所有电话呼叫的提示或任务。可以用{{花括号}}将信息插入到变量名称周围。例子： json "You are calling {{business}} to renew their subscription to {{service}} before it expires on {{date}}."

call_data

array [object]

必需

定义要进行的调用及其属性的列表。 call_data 中的每个呼叫必须有一个“phone_number”属性。属性区分大小写。例子：

json [   {        "phone_number": "1234567890",     "business": "ABC Corp",     "service": "Netflix",     "date": "September 4th"   },   {     "phone_number": "32176540987",     "business": "XYZ inc.",     "service": "Window Cleaning",     "date": "December 20th"   } ]

label

string

可选

为您的批次添加用户友好的标签，以跟踪其初衷。这有助于区分属于同一营销活动的多个调用批次。检索批次时显示。

campaign_id

string

可选

用于campaign_id将相关批次组织在一起。这可以手动设置或通过营销活动自动生成。

test_mode

boolean

可选

当此项设置为时true，仅调度的第一个调用call_data。一个常见的用例是将第一个值设置phone_number为您自己的值，以确认所有内容均已正确设置。如果为真，则在响应中包含其他信息，以便更轻松地发现任何问题。

示例

返回响应

🟢200成功

application/json

Body

message

string

必需

如果返回“成功”以外的任何内容，则表示发生错误。

batch_id

string

批次的唯一标识符。

必需

修改于 2024-05-10 09:15:17

列出子账户详细信息

使用 AI 分析批次