更新入站详细信息

开发环境

http://dev-cn.your-api-server.com

POST

/v1/inbound/{phone_number}

更新您的呼入代理的设置、提示和其他详细信息。

请求示例

Shell

JavaScript

Java

Swift

curl --location --request POST 'http://dev-cn.your-api-server.com/v1/inbound/' \
--header 'authorization: <authorization>' \
--header 'Content-Type: application/json' \
--data-raw '{
  "prompt": "<string>",
  "pathway_id": "<string>",
  "voice": "<string>",
  "first_sentence": "<string>",
  "wait_for_greeting": true,
  "interruption_threshold": 123,
  "model": "<string>",
  "tools": [
    {}
  ],
  "language": "<string>",
  "timezone": "<string>",
  "transfer_phone_number": "<string>",
  "transfer_list": {},
  "dynamic_data": {},
  "keywords": [
    "<string>"
  ],
  "max_duration": 123,
  "webhook": "<string>",
  "analysis_schema": {},
  "metadata": {},
  "record": true
}'

响应示例

{
  "status": "success",
  "message": "Successfully updated number +18584139939.",
  "updates": {
    "prompt": "(Your prompt)",
    "voice": "maya",
    "webhook": null,
    "first_sentence": "Roberta speaking, how can I help you?",
    "record": false,
    "max_duration": 30,
    "model": "enhanced"
  }
}

请求参数

Path 参数

phone_number

string

必需

您要更新的呼入电话号码。

格式注释：

'+'或前缀'%2B'是可选的。
如果未提供国家/地区代码，将采用美国国家/地区代码。
有效示例+13334445555：

%2B13334445555
13334445555
3334445555

Header 参数

Content-Type

string

必需

示例值:

application/json

authorization

string

必需

示例值:

Body 参数application/json

prompt

string

可选

pathway_id

string

可选

设置您的代理将遵循的路径。这将覆盖该prompt字段，因此如果您要设置路径，则无需传递“提示”字段。警告：设置路径会将以下字段设置为其null默认值 - prompt、first_sentence、model、dynamic_data、tools 设置为null或空字符串以清除路径。

voice

string

可选

设置座席的声音 - 可以通过“列表声音”端点找到所有可用的声音。

first_sentence

string

可选

让您的客服人员为其第一响应说出特定的短语或句子。

wait_for_greeting

boolean

可选

默认情况下，客服人员在呼叫接通后立即开始通话。当wait_for_greeting设置为时true，座席将等待呼叫接收者先发言然后再响应。

interruption_threshold

integer

可选

调整 AI 在等待用户说完时的耐心程度。较低的值意味着 AI 会更快地响应，而较高的值意味着 AI 在响应之前会等待更长时间。推荐范围：50-200 50：极其快速的来回对话 100：平衡地以自然的速度做出反应 200：非常有耐心，允许长时间停顿和中断。非常适合收集详细信息。尝试从 100 开始，然后根据您的用例需要以 ~10 的增量进行小幅调整。

model

string

可选

选择用于您通话的型号。选项：base、turbo和enhanced。几乎在所有情况下，enhanced这是目前最好的选择。

tools

array [object]

可选

通过API调用与现实世界交互。

language

string

可选

选择您选择的支持语言。针对该语言优化 API 的每个部分 - 转录、语音和其他内部工作。支持的语言及其代码：英语：ENG 西班牙语：ESP 法语： FRE 抛光：POL 德语：GER 意大利语：ITA 巴西葡萄牙语：PBR 葡萄牙语：POR

timezone

string

可选

设置通话的时区。自动处理美国境内的呼叫。这对于依赖预约设置、日程安排或根据一天中的时间进行不同行为的用例有很大帮助。时区选项位于TZ 标识符列中。

transfer_phone_number

string

可选

代理可以在特定条件下转接的电话号码 - 例如被要求与人员或主管通话。设置为null删除。

transfer_list

object

可选

让您的代理能够将呼叫转接至一组电话号码。 transfer_phone_number如果指定了 a 则覆盖transfer_list.default。默认为transfer_list.default, 或所选的电话号码。将呼叫路由到不同部门的示例用法： "transfer_list": { "default": "+12223334444", "sales": "+12223334444", "support": "+12223334444", "billing": "+12223334444" }

dynamic_data

object

可选

将外部 API 的数据集成到代理的知识中。设置为null或空字符串以清除动态数据设置。发送呼叫端点中的详细用法。

keywords

array[string]

可选

max_duration

integer

可选

当通话开始时，会设置一个max_duration分钟计时器。在该计时器结束时，如果呼叫仍然处于活动状态，它将自动结束。示例值：20, 2

webhook

string

可选

通话结束后，我们会将 POST 请求中的通话详细信息发送到您在此处指定的 URL。请求正文将与GET /v1/calls/:call_id端点的响应匹配。

analysis_schema

object

可选

定义一个 JSON 架构，决定如何获取有关呼叫的信息 - 电子邮件地址、姓名、预约时间或任何其他类型的自定义数据等信息。在 Webhook 响应中或以后每当您检索调用数据时，您都会在下获得您定义的数据analysis。例如，如果您想从调用中检索此信息：

json "analysis_schema": {   "email_address": "email",   "first_name": "string",   "last_name": "string",   "wants_to_book_appointment": "boolean",   "appointment_time": "YYYY-MM-DD HH:MM:SS" }

调用完成后，您将在 Webhook 中填写如下内容：

json "analysis": {   "email_address": "johndoe@gmail.com",   "first_name": "John",   "last_name": "Doe",   "wants_to_book_appointment": true,   "appointment_time": "2024-01-01 12:00:00" }

metadata

object

可选

添加您想要与呼叫关联的任何其他信息。这对于跟踪或分类呼叫非常有用。

record

boolean

可选

要记录您的电话通话，请设置record为 true。呼叫完成后，您可以通过recording_url呼叫详细信息或 Webhook 中的字段进行访问。

示例

返回响应

🟢200成功

application/json

Body

status

string

必需

message

string

必需

updates

object

必需

prompt

string

必需

voice

string

必需

webhook

null

必需

first_sentence

string

必需

record

boolean

必需

max_duration

integer

必需

model

string

必需

修改于 2024-05-10 08:12:43

购买呼入号码

列出呼入号码