메뉴얼
에이전트 메뉴얼 수정
보낸 필드만 바꾸고 생략한 필드는 유지합니다. 필드에 null을 보낼 수 없고, 바꿀 필드가 하나도 없으면 거절합니다. expected_head_revision이 현재 리비전과 다르면 409 REVISION_CONFLICT로 거절합니다.
PATCH
/
agents
/
{agent_id}
/
manuals
/
{manual_id}
에이전트 메뉴얼 수정
curl --request PATCH \
--url https://client-api.tryvox.co/v3/agents/{agent_id}/manuals/{manual_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"expected_head_revision": 1,
"name": "<string>",
"trigger": "<string>",
"content": "<string>",
"built_in_tools": [
{
"toolType": "end_call",
"speakDuringExecution": {
"enabled": false,
"messages": [
"<string>"
]
},
"allowInterruptionDuringExecution": false,
"responseMode": "wait",
"name": "end_call",
"description": "<string>"
}
],
"config": {}
}
'import requests
url = "https://client-api.tryvox.co/v3/agents/{agent_id}/manuals/{manual_id}"
payload = {
"expected_head_revision": 1,
"name": "<string>",
"trigger": "<string>",
"content": "<string>",
"built_in_tools": [
{
"toolType": "end_call",
"speakDuringExecution": {
"enabled": False,
"messages": ["<string>"]
},
"allowInterruptionDuringExecution": False,
"responseMode": "wait",
"name": "end_call",
"description": "<string>"
}
],
"config": {}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
expected_head_revision: 1,
name: '<string>',
trigger: '<string>',
content: '<string>',
built_in_tools: [
{
toolType: 'end_call',
speakDuringExecution: {enabled: false, messages: ['<string>']},
allowInterruptionDuringExecution: false,
responseMode: 'wait',
name: 'end_call',
description: '<string>'
}
],
config: {}
})
};
fetch('https://client-api.tryvox.co/v3/agents/{agent_id}/manuals/{manual_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://client-api.tryvox.co/v3/agents/{agent_id}/manuals/{manual_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'expected_head_revision' => 1,
'name' => '<string>',
'trigger' => '<string>',
'content' => '<string>',
'built_in_tools' => [
[
'toolType' => 'end_call',
'speakDuringExecution' => [
'enabled' => false,
'messages' => [
'<string>'
]
],
'allowInterruptionDuringExecution' => false,
'responseMode' => 'wait',
'name' => 'end_call',
'description' => '<string>'
]
],
'config' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://client-api.tryvox.co/v3/agents/{agent_id}/manuals/{manual_id}"
payload := strings.NewReader("{\n \"expected_head_revision\": 1,\n \"name\": \"<string>\",\n \"trigger\": \"<string>\",\n \"content\": \"<string>\",\n \"built_in_tools\": [\n {\n \"toolType\": \"end_call\",\n \"speakDuringExecution\": {\n \"enabled\": false,\n \"messages\": [\n \"<string>\"\n ]\n },\n \"allowInterruptionDuringExecution\": false,\n \"responseMode\": \"wait\",\n \"name\": \"end_call\",\n \"description\": \"<string>\"\n }\n ],\n \"config\": {}\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://client-api.tryvox.co/v3/agents/{agent_id}/manuals/{manual_id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"expected_head_revision\": 1,\n \"name\": \"<string>\",\n \"trigger\": \"<string>\",\n \"content\": \"<string>\",\n \"built_in_tools\": [\n {\n \"toolType\": \"end_call\",\n \"speakDuringExecution\": {\n \"enabled\": false,\n \"messages\": [\n \"<string>\"\n ]\n },\n \"allowInterruptionDuringExecution\": false,\n \"responseMode\": \"wait\",\n \"name\": \"end_call\",\n \"description\": \"<string>\"\n }\n ],\n \"config\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://client-api.tryvox.co/v3/agents/{agent_id}/manuals/{manual_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"expected_head_revision\": 1,\n \"name\": \"<string>\",\n \"trigger\": \"<string>\",\n \"content\": \"<string>\",\n \"built_in_tools\": [\n {\n \"toolType\": \"end_call\",\n \"speakDuringExecution\": {\n \"enabled\": false,\n \"messages\": [\n \"<string>\"\n ]\n },\n \"allowInterruptionDuringExecution\": false,\n \"responseMode\": \"wait\",\n \"name\": \"end_call\",\n \"description\": \"<string>\"\n }\n ],\n \"config\": {}\n}"
response = http.request(request)
puts response.read_body{
"name": "<string>",
"trigger": "<string>",
"content": "<string>",
"agent_id": "<string>",
"manual_id": "<string>",
"head_revision": 123,
"built_in_tools": [
{
"toolType": "end_call",
"speakDuringExecution": {
"enabled": false,
"messages": [
"<string>"
]
},
"allowInterruptionDuringExecution": false,
"responseMode": "wait",
"name": "end_call",
"description": "<string>"
}
],
"config": {},
"references": {},
"diagnostics": [
{}
]
}{
"error": {
"code": "VALIDATION_ERROR",
"message": "Request validation failed.",
"details": {
"field": "name",
"reason": "must not be blank"
}
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "Authentication is required.",
"details": {}
}
}{
"error": {
"code": "FORBIDDEN",
"message": "Permission denied.",
"details": {}
}
}{
"error": {
"code": "RESOURCE_NOT_FOUND",
"message": "Resource not found.",
"details": {
"resource": "agent"
}
}
}{
"error": {
"code": "CONFLICT",
"message": "The requested operation conflicts with current state.",
"details": {
"current_status": "draft"
}
}
}{
"error": {
"code": "RATE_LIMIT_EXCEEDED",
"message": "Too many requests.",
"details": {
"limit": 10,
"window_seconds": 1,
"scope": "user"
}
}
}{
"error": {
"code": "INTERNAL_ERROR",
"message": "Internal server error.",
"details": {}
}
}{
"error": {
"code": "SERVICE_UNAVAILABLE",
"message": "Service temporarily unavailable.",
"details": {}
}
}Authorizations
조직 API 키를 Authorization: Bearer <token> 형식으로 보냅니다.
Path Parameters
agent_id로 반환되는 에이전트 UUID입니다.
Body
application/json
수정할 메뉴얼 필드와 현재 편집본 리비전입니다.
Required range:
x >= 0메뉴얼 이름입니다. 목록과 편집 화면에서 메뉴얼을 구분하는 라벨이며 최대 128자입니다.
Maximum string length:
128메뉴얼 본문입니다. 공백을 포함해 최대 8,096자이며 @tool:과 @manual: 참조를 담을 수 있습니다.
Maximum string length:
8096built_in_tools
(EndCallTool · object | TransferCallTool · object | TransferAgentTool · object | SendSmsTool · object | SendDtmfTool · object | SearchAddressTool · object | SkillTool · object)[] | null
통화 종료 built-in 도구 설정입니다.
- EndCallTool
- TransferCallTool
- TransferAgentTool
- SendSmsTool
- SendDtmfTool
- SearchAddressTool
- SkillTool
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Response
성공 응답
메뉴얼 이름입니다. 목록과 편집 화면에서 메뉴얼을 구분하는 라벨이며 최대 128자입니다.
Maximum string length:
128메뉴얼 본문입니다. 공백을 포함해 최대 8,096자이며 @tool:과 @manual: 참조를 담을 수 있습니다.
Maximum string length:
8096에이전트 UUID입니다.
built_in_tools
(EndCallTool · object | TransferCallTool · object | TransferAgentTool · object | SendSmsTool · object | SendDtmfTool · object | SearchAddressTool · object | SkillTool · object)[]
통화 종료 built-in 도구 설정입니다.
- EndCallTool
- TransferCallTool
- TransferAgentTool
- SendSmsTool
- SendDtmfTool
- SearchAddressTool
- SkillTool
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Was this page helpful?
⌘I
에이전트 메뉴얼 수정
curl --request PATCH \
--url https://client-api.tryvox.co/v3/agents/{agent_id}/manuals/{manual_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"expected_head_revision": 1,
"name": "<string>",
"trigger": "<string>",
"content": "<string>",
"built_in_tools": [
{
"toolType": "end_call",
"speakDuringExecution": {
"enabled": false,
"messages": [
"<string>"
]
},
"allowInterruptionDuringExecution": false,
"responseMode": "wait",
"name": "end_call",
"description": "<string>"
}
],
"config": {}
}
'import requests
url = "https://client-api.tryvox.co/v3/agents/{agent_id}/manuals/{manual_id}"
payload = {
"expected_head_revision": 1,
"name": "<string>",
"trigger": "<string>",
"content": "<string>",
"built_in_tools": [
{
"toolType": "end_call",
"speakDuringExecution": {
"enabled": False,
"messages": ["<string>"]
},
"allowInterruptionDuringExecution": False,
"responseMode": "wait",
"name": "end_call",
"description": "<string>"
}
],
"config": {}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
expected_head_revision: 1,
name: '<string>',
trigger: '<string>',
content: '<string>',
built_in_tools: [
{
toolType: 'end_call',
speakDuringExecution: {enabled: false, messages: ['<string>']},
allowInterruptionDuringExecution: false,
responseMode: 'wait',
name: 'end_call',
description: '<string>'
}
],
config: {}
})
};
fetch('https://client-api.tryvox.co/v3/agents/{agent_id}/manuals/{manual_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://client-api.tryvox.co/v3/agents/{agent_id}/manuals/{manual_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'expected_head_revision' => 1,
'name' => '<string>',
'trigger' => '<string>',
'content' => '<string>',
'built_in_tools' => [
[
'toolType' => 'end_call',
'speakDuringExecution' => [
'enabled' => false,
'messages' => [
'<string>'
]
],
'allowInterruptionDuringExecution' => false,
'responseMode' => 'wait',
'name' => 'end_call',
'description' => '<string>'
]
],
'config' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://client-api.tryvox.co/v3/agents/{agent_id}/manuals/{manual_id}"
payload := strings.NewReader("{\n \"expected_head_revision\": 1,\n \"name\": \"<string>\",\n \"trigger\": \"<string>\",\n \"content\": \"<string>\",\n \"built_in_tools\": [\n {\n \"toolType\": \"end_call\",\n \"speakDuringExecution\": {\n \"enabled\": false,\n \"messages\": [\n \"<string>\"\n ]\n },\n \"allowInterruptionDuringExecution\": false,\n \"responseMode\": \"wait\",\n \"name\": \"end_call\",\n \"description\": \"<string>\"\n }\n ],\n \"config\": {}\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://client-api.tryvox.co/v3/agents/{agent_id}/manuals/{manual_id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"expected_head_revision\": 1,\n \"name\": \"<string>\",\n \"trigger\": \"<string>\",\n \"content\": \"<string>\",\n \"built_in_tools\": [\n {\n \"toolType\": \"end_call\",\n \"speakDuringExecution\": {\n \"enabled\": false,\n \"messages\": [\n \"<string>\"\n ]\n },\n \"allowInterruptionDuringExecution\": false,\n \"responseMode\": \"wait\",\n \"name\": \"end_call\",\n \"description\": \"<string>\"\n }\n ],\n \"config\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://client-api.tryvox.co/v3/agents/{agent_id}/manuals/{manual_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"expected_head_revision\": 1,\n \"name\": \"<string>\",\n \"trigger\": \"<string>\",\n \"content\": \"<string>\",\n \"built_in_tools\": [\n {\n \"toolType\": \"end_call\",\n \"speakDuringExecution\": {\n \"enabled\": false,\n \"messages\": [\n \"<string>\"\n ]\n },\n \"allowInterruptionDuringExecution\": false,\n \"responseMode\": \"wait\",\n \"name\": \"end_call\",\n \"description\": \"<string>\"\n }\n ],\n \"config\": {}\n}"
response = http.request(request)
puts response.read_body{
"name": "<string>",
"trigger": "<string>",
"content": "<string>",
"agent_id": "<string>",
"manual_id": "<string>",
"head_revision": 123,
"built_in_tools": [
{
"toolType": "end_call",
"speakDuringExecution": {
"enabled": false,
"messages": [
"<string>"
]
},
"allowInterruptionDuringExecution": false,
"responseMode": "wait",
"name": "end_call",
"description": "<string>"
}
],
"config": {},
"references": {},
"diagnostics": [
{}
]
}{
"error": {
"code": "VALIDATION_ERROR",
"message": "Request validation failed.",
"details": {
"field": "name",
"reason": "must not be blank"
}
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "Authentication is required.",
"details": {}
}
}{
"error": {
"code": "FORBIDDEN",
"message": "Permission denied.",
"details": {}
}
}{
"error": {
"code": "RESOURCE_NOT_FOUND",
"message": "Resource not found.",
"details": {
"resource": "agent"
}
}
}{
"error": {
"code": "CONFLICT",
"message": "The requested operation conflicts with current state.",
"details": {
"current_status": "draft"
}
}
}{
"error": {
"code": "RATE_LIMIT_EXCEEDED",
"message": "Too many requests.",
"details": {
"limit": 10,
"window_seconds": 1,
"scope": "user"
}
}
}{
"error": {
"code": "INTERNAL_ERROR",
"message": "Internal server error.",
"details": {}
}
}{
"error": {
"code": "SERVICE_UNAVAILABLE",
"message": "Service temporarily unavailable.",
"details": {}
}
}