Typescript (SDK)
import { SyllableSDK } from "syllable-sdk";
const syllableSDK = new SyllableSDK({
apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
});
async function run() {
const result = await syllableSDK.channels.targets.update({
channelId: 508167,
targetId: 880236,
channelTargetUpdateRequest: {
agentId: 1,
channelId: 1,
target: "+19995551234",
targetMode: "email",
fallbackTarget: "+19995551235",
isTest: true,
id: 1,
},
});
console.log(result);
}
run();import os
from syllable_sdk import SyllableSDK, models
with SyllableSDK(
api_key_header=os.getenv("SYLLABLESDK_API_KEY_HEADER", ""),
) as ss_client:
res = ss_client.channels.targets.update(channel_id=508167, target_id=880236, channel_target_update_request={
"agent_id": 1,
"channel_id": 1,
"target": "+19995551234",
"target_mode": models.TargetModes.EMAIL,
"fallback_target": "+19995551235",
"is_test": True,
"id": 1,
})
# Handle response
print(res)curl --request PUT \
--url https://api.syllable.cloud/api/v1/channels/{channel_id}/targets/{target_id} \
--header 'Content-Type: application/json' \
--header 'Syllable-API-Key: <api-key>' \
--data '
{
"agent_id": 123,
"channel_id": 123,
"target": "<string>",
"id": 123,
"fallback_target": "+19995551235",
"is_test": false
}
'const options = {
method: 'PUT',
headers: {'Syllable-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
agent_id: 123,
channel_id: 123,
target: '<string>',
id: 123,
fallback_target: '+19995551235',
is_test: false
})
};
fetch('https://api.syllable.cloud/api/v1/channels/{channel_id}/targets/{target_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://api.syllable.cloud/api/v1/channels/{channel_id}/targets/{target_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'agent_id' => 123,
'channel_id' => 123,
'target' => '<string>',
'id' => 123,
'fallback_target' => '+19995551235',
'is_test' => false
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"Syllable-API-Key: <api-key>"
],
]);
$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://api.syllable.cloud/api/v1/channels/{channel_id}/targets/{target_id}"
payload := strings.NewReader("{\n \"agent_id\": 123,\n \"channel_id\": 123,\n \"target\": \"<string>\",\n \"id\": 123,\n \"fallback_target\": \"+19995551235\",\n \"is_test\": false\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Syllable-API-Key", "<api-key>")
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.put("https://api.syllable.cloud/api/v1/channels/{channel_id}/targets/{target_id}")
.header("Syllable-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"agent_id\": 123,\n \"channel_id\": 123,\n \"target\": \"<string>\",\n \"id\": 123,\n \"fallback_target\": \"+19995551235\",\n \"is_test\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.syllable.cloud/api/v1/channels/{channel_id}/targets/{target_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Syllable-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"agent_id\": 123,\n \"channel_id\": 123,\n \"target\": \"<string>\",\n \"id\": 123,\n \"fallback_target\": \"+19995551235\",\n \"is_test\": false\n}"
response = http.request(request)
puts response.read_body{
"agent_id": 123,
"channel_id": 123,
"target": "<string>",
"id": 123,
"channel_name": "<string>",
"updated_at": "2023-11-07T05:31:56Z",
"last_updated_by": "<string>",
"fallback_target": "+19995551235",
"is_test": false,
"agent": {
"name": "<string>",
"type": "<string>",
"prompt_id": 123,
"timezone": "<string>",
"variables": {},
"tool_headers": {
"some-header": "some-value"
},
"id": 123,
"updated_at": "2023-11-07T05:31:56Z",
"last_updated_by": "user@email.com",
"description": "Agent for answering questions about weather.",
"label": "Information",
"labels": [
"Information",
"Weather"
],
"custom_message_id": 1,
"language_group_id": 1,
"bridge_phrases_id": 1,
"prompt_tool_defaults": [
{
"tool_name": "<string>",
"default_values": [
{
"field_name": "<string>",
"default_value": "<unknown>"
}
]
}
],
"languages": [
"<string>"
],
"agent_initiated": false,
"stt_provider": "Google STT V2 (Chirp 2)",
"wait_sound": "No Sound",
"enable_verbal_language_change": false,
"prompt": {
"name": "<string>",
"type": "<string>",
"llm_config": {
"provider": "azure_openai",
"model": "gpt-4o",
"version": "2024-05-13",
"api_version": "2024-06-01",
"temperature": 1,
"seed": 123
},
"id": 123,
"last_updated": "2024-01-01T12:00:00Z",
"description": "Prompt for a weather agent.",
"context": "You are a weather agent. Answer the user's questions about weather and nothing else.",
"tools": [],
"session_end_enabled": false,
"session_end_tool_id": 1,
"edit_comments": "Updated prompt text to include requirement to not answer questions that aren't about weather.",
"last_updated_by": "user@email.com",
"session_end_tool": {
"name": "<string>",
"definition": {
"tool": {
"function": {
"name": "<string>",
"description": "<string>",
"parameters": "<unknown>"
},
"type": "function"
},
"type": "endpoint",
"endpoint": {
"url": "<string>",
"timeout": 45
},
"context": {
"task": {
"id": "<string>",
"config": {},
"variables": [
{
"name": "<string>",
"value": "<unknown>",
"valueFrom": "inputs.provided_dob == patient_dob",
"description": "<string>",
"title": "<string>",
"format": "<string>",
"pattern": "<string>",
"enum": [
"<string>"
],
"examples": [
"<unknown>"
]
}
],
"metadata": {
"priority": 123
},
"tool": {
"name": "<string>",
"description": "<string>"
},
"type": "expression",
"version": "v1alpha",
"inputs": [
{
"name": "<string>",
"description": "<string>",
"title": "<string>",
"format": "<string>",
"pattern": "<string>",
"enum": [
"<string>"
],
"examples": [
"<unknown>"
],
"required": true
}
],
"expression": "inputs.can_sign_consent == `true`",
"output": null,
"on": {
"start": [
{
"name": "<string>",
"value": "<unknown>",
"valueFrom": "inputs.provided_dob == patient_dob",
"if": "inputs.can_sign_consent == `true`",
"action": "set"
}
],
"submit": [
{
"name": "<string>",
"value": "<unknown>",
"valueFrom": "inputs.provided_dob == patient_dob",
"if": "inputs.can_sign_consent == `true`",
"action": "set"
}
]
}
}
},
"defaults": "<unknown>",
"static_parameters": [
{
"default": "fahrenheit",
"description": "Whether the temperature information should be fetched in Celsius or Fahrenheit",
"name": "temperature_unit",
"required": false,
"type": "string"
}
],
"result": "<unknown>",
"options": {
"propagate_tool_result": false
}
},
"service_id": 123,
"id": 123,
"last_updated": "2023-11-07T05:31:56Z",
"last_updated_by": "<string>",
"version_number": 123,
"last_updated_comments": "Updated to use new API endpoint",
"service_name": "<string>",
"prompts_info": [
{
"id": 123,
"name": "<string>"
}
],
"agents_info": [
{
"id": 123,
"name": "<string>"
}
]
},
"agent_count": 5,
"version_number": 1,
"tools_full": [
{
"name": "<string>",
"definition": {
"tool": {
"function": {
"name": "<string>",
"description": "<string>",
"parameters": "<unknown>"
},
"type": "function"
},
"type": "endpoint",
"endpoint": {
"url": "<string>",
"timeout": 45
},
"context": {
"task": {
"id": "<string>",
"config": {},
"variables": [
{
"name": "<string>",
"value": "<unknown>",
"valueFrom": "inputs.provided_dob == patient_dob",
"description": "<string>",
"title": "<string>",
"format": "<string>",
"pattern": "<string>",
"enum": [
"<string>"
],
"examples": [
"<unknown>"
]
}
],
"metadata": {
"priority": 123
},
"tool": {
"name": "<string>",
"description": "<string>"
},
"type": "expression",
"version": "v1alpha",
"inputs": [
{
"name": "<string>",
"description": "<string>",
"title": "<string>",
"format": "<string>",
"pattern": "<string>",
"enum": [
"<string>"
],
"examples": [
"<unknown>"
],
"required": true
}
],
"expression": "inputs.can_sign_consent == `true`",
"output": null,
"on": {
"start": [
{
"name": "<string>",
"value": "<unknown>",
"valueFrom": "inputs.provided_dob == patient_dob",
"if": "inputs.can_sign_consent == `true`",
"action": "set"
}
],
"submit": [
{
"name": "<string>",
"value": "<unknown>",
"valueFrom": "inputs.provided_dob == patient_dob",
"if": "inputs.can_sign_consent == `true`",
"action": "set"
}
]
}
}
},
"defaults": "<unknown>",
"static_parameters": [
{
"default": "fahrenheit",
"description": "Whether the temperature information should be fetched in Celsius or Fahrenheit",
"name": "temperature_unit",
"required": false,
"type": "string"
}
],
"result": "<unknown>",
"options": {
"propagate_tool_result": false
}
},
"service_id": 123,
"id": 123,
"last_updated": "2023-11-07T05:31:56Z",
"last_updated_by": "<string>",
"version_number": 123,
"last_updated_comments": "Updated to use new API endpoint",
"service_name": "<string>",
"prompts_info": [
{
"id": 123,
"name": "<string>"
}
],
"agents_info": [
{
"id": 123,
"name": "<string>"
}
],
"validation_issues": [
{
"id": "<string>",
"message": "<string>",
"severity": "error",
"path": "<string>",
"value": "<string>"
}
]
}
]
},
"custom_message": {
"name": "<string>",
"text": "<string>",
"repeat_after_language_change": true,
"id": 123,
"updated_at": "2023-11-07T05:31:56Z",
"last_updated_by": "<string>",
"type": "greeting",
"preamble": "If this is an emergency, please hang up and call 911.",
"subject": "Your appointment reminder",
"label": "Customer service",
"rules": [],
"agent_count": 1
},
"channel_targets": [
"<unknown>"
],
"tools": [
{
"name": "<string>",
"definition": {
"tool": {
"function": {
"name": "<string>",
"description": "<string>",
"parameters": "<unknown>"
},
"type": "function"
},
"type": "endpoint",
"endpoint": {
"url": "<string>",
"timeout": 45
},
"context": {
"task": {
"id": "<string>",
"config": {},
"variables": [
{
"name": "<string>",
"value": "<unknown>",
"valueFrom": "inputs.provided_dob == patient_dob",
"description": "<string>",
"title": "<string>",
"format": "<string>",
"pattern": "<string>",
"enum": [
"<string>"
],
"examples": [
"<unknown>"
]
}
],
"metadata": {
"priority": 123
},
"tool": {
"name": "<string>",
"description": "<string>"
},
"type": "expression",
"version": "v1alpha",
"inputs": [
{
"name": "<string>",
"description": "<string>",
"title": "<string>",
"format": "<string>",
"pattern": "<string>",
"enum": [
"<string>"
],
"examples": [
"<unknown>"
],
"required": true
}
],
"expression": "inputs.can_sign_consent == `true`",
"output": null,
"on": {
"start": [
{
"name": "<string>",
"value": "<unknown>",
"valueFrom": "inputs.provided_dob == patient_dob",
"if": "inputs.can_sign_consent == `true`",
"action": "set"
}
],
"submit": [
{
"name": "<string>",
"value": "<unknown>",
"valueFrom": "inputs.provided_dob == patient_dob",
"if": "inputs.can_sign_consent == `true`",
"action": "set"
}
]
}
}
},
"defaults": "<unknown>",
"static_parameters": [
{
"default": "fahrenheit",
"description": "Whether the temperature information should be fetched in Celsius or Fahrenheit",
"name": "temperature_unit",
"required": false,
"type": "string"
}
],
"result": "<unknown>",
"options": {
"propagate_tool_result": false
}
},
"service_id": 123,
"id": 123,
"last_updated": "2023-11-07T05:31:56Z",
"last_updated_by": "<string>",
"version_number": 123,
"last_updated_comments": "Updated to use new API endpoint",
"service_name": "<string>",
"prompts_info": [
{
"id": 123,
"name": "<string>"
}
],
"agents_info": [
{
"id": 123,
"name": "<string>"
}
],
"validation_issues": [
{
"id": "<string>",
"message": "<string>",
"severity": "error",
"path": "<string>",
"value": "<string>"
}
]
}
],
"language_group": {
"name": "<string>",
"language_configs": [
{
"dtmf_code": 123,
"voice_speed": 1,
"voice_pitch": 0
}
],
"skip_current_language_in_message": true,
"id": 123,
"updated_at": "2023-11-07T05:31:56Z",
"last_updated_by": "<string>",
"description": "Languages spoken by operators at Call Center 1",
"edit_comments": "Added Spanish support.",
"agents_info": [
{
"id": 1,
"name": "Test Agent"
}
]
}
},
"a2p_verified": true
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}channels.targets
Edit Channel Target
Update channel target by ID
PUT
/
api
/
v1
/
channels
/
{channel_id}
/
targets
/
{target_id}
Typescript (SDK)
import { SyllableSDK } from "syllable-sdk";
const syllableSDK = new SyllableSDK({
apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
});
async function run() {
const result = await syllableSDK.channels.targets.update({
channelId: 508167,
targetId: 880236,
channelTargetUpdateRequest: {
agentId: 1,
channelId: 1,
target: "+19995551234",
targetMode: "email",
fallbackTarget: "+19995551235",
isTest: true,
id: 1,
},
});
console.log(result);
}
run();import os
from syllable_sdk import SyllableSDK, models
with SyllableSDK(
api_key_header=os.getenv("SYLLABLESDK_API_KEY_HEADER", ""),
) as ss_client:
res = ss_client.channels.targets.update(channel_id=508167, target_id=880236, channel_target_update_request={
"agent_id": 1,
"channel_id": 1,
"target": "+19995551234",
"target_mode": models.TargetModes.EMAIL,
"fallback_target": "+19995551235",
"is_test": True,
"id": 1,
})
# Handle response
print(res)curl --request PUT \
--url https://api.syllable.cloud/api/v1/channels/{channel_id}/targets/{target_id} \
--header 'Content-Type: application/json' \
--header 'Syllable-API-Key: <api-key>' \
--data '
{
"agent_id": 123,
"channel_id": 123,
"target": "<string>",
"id": 123,
"fallback_target": "+19995551235",
"is_test": false
}
'const options = {
method: 'PUT',
headers: {'Syllable-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
agent_id: 123,
channel_id: 123,
target: '<string>',
id: 123,
fallback_target: '+19995551235',
is_test: false
})
};
fetch('https://api.syllable.cloud/api/v1/channels/{channel_id}/targets/{target_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://api.syllable.cloud/api/v1/channels/{channel_id}/targets/{target_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'agent_id' => 123,
'channel_id' => 123,
'target' => '<string>',
'id' => 123,
'fallback_target' => '+19995551235',
'is_test' => false
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"Syllable-API-Key: <api-key>"
],
]);
$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://api.syllable.cloud/api/v1/channels/{channel_id}/targets/{target_id}"
payload := strings.NewReader("{\n \"agent_id\": 123,\n \"channel_id\": 123,\n \"target\": \"<string>\",\n \"id\": 123,\n \"fallback_target\": \"+19995551235\",\n \"is_test\": false\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Syllable-API-Key", "<api-key>")
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.put("https://api.syllable.cloud/api/v1/channels/{channel_id}/targets/{target_id}")
.header("Syllable-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"agent_id\": 123,\n \"channel_id\": 123,\n \"target\": \"<string>\",\n \"id\": 123,\n \"fallback_target\": \"+19995551235\",\n \"is_test\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.syllable.cloud/api/v1/channels/{channel_id}/targets/{target_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Syllable-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"agent_id\": 123,\n \"channel_id\": 123,\n \"target\": \"<string>\",\n \"id\": 123,\n \"fallback_target\": \"+19995551235\",\n \"is_test\": false\n}"
response = http.request(request)
puts response.read_body{
"agent_id": 123,
"channel_id": 123,
"target": "<string>",
"id": 123,
"channel_name": "<string>",
"updated_at": "2023-11-07T05:31:56Z",
"last_updated_by": "<string>",
"fallback_target": "+19995551235",
"is_test": false,
"agent": {
"name": "<string>",
"type": "<string>",
"prompt_id": 123,
"timezone": "<string>",
"variables": {},
"tool_headers": {
"some-header": "some-value"
},
"id": 123,
"updated_at": "2023-11-07T05:31:56Z",
"last_updated_by": "user@email.com",
"description": "Agent for answering questions about weather.",
"label": "Information",
"labels": [
"Information",
"Weather"
],
"custom_message_id": 1,
"language_group_id": 1,
"bridge_phrases_id": 1,
"prompt_tool_defaults": [
{
"tool_name": "<string>",
"default_values": [
{
"field_name": "<string>",
"default_value": "<unknown>"
}
]
}
],
"languages": [
"<string>"
],
"agent_initiated": false,
"stt_provider": "Google STT V2 (Chirp 2)",
"wait_sound": "No Sound",
"enable_verbal_language_change": false,
"prompt": {
"name": "<string>",
"type": "<string>",
"llm_config": {
"provider": "azure_openai",
"model": "gpt-4o",
"version": "2024-05-13",
"api_version": "2024-06-01",
"temperature": 1,
"seed": 123
},
"id": 123,
"last_updated": "2024-01-01T12:00:00Z",
"description": "Prompt for a weather agent.",
"context": "You are a weather agent. Answer the user's questions about weather and nothing else.",
"tools": [],
"session_end_enabled": false,
"session_end_tool_id": 1,
"edit_comments": "Updated prompt text to include requirement to not answer questions that aren't about weather.",
"last_updated_by": "user@email.com",
"session_end_tool": {
"name": "<string>",
"definition": {
"tool": {
"function": {
"name": "<string>",
"description": "<string>",
"parameters": "<unknown>"
},
"type": "function"
},
"type": "endpoint",
"endpoint": {
"url": "<string>",
"timeout": 45
},
"context": {
"task": {
"id": "<string>",
"config": {},
"variables": [
{
"name": "<string>",
"value": "<unknown>",
"valueFrom": "inputs.provided_dob == patient_dob",
"description": "<string>",
"title": "<string>",
"format": "<string>",
"pattern": "<string>",
"enum": [
"<string>"
],
"examples": [
"<unknown>"
]
}
],
"metadata": {
"priority": 123
},
"tool": {
"name": "<string>",
"description": "<string>"
},
"type": "expression",
"version": "v1alpha",
"inputs": [
{
"name": "<string>",
"description": "<string>",
"title": "<string>",
"format": "<string>",
"pattern": "<string>",
"enum": [
"<string>"
],
"examples": [
"<unknown>"
],
"required": true
}
],
"expression": "inputs.can_sign_consent == `true`",
"output": null,
"on": {
"start": [
{
"name": "<string>",
"value": "<unknown>",
"valueFrom": "inputs.provided_dob == patient_dob",
"if": "inputs.can_sign_consent == `true`",
"action": "set"
}
],
"submit": [
{
"name": "<string>",
"value": "<unknown>",
"valueFrom": "inputs.provided_dob == patient_dob",
"if": "inputs.can_sign_consent == `true`",
"action": "set"
}
]
}
}
},
"defaults": "<unknown>",
"static_parameters": [
{
"default": "fahrenheit",
"description": "Whether the temperature information should be fetched in Celsius or Fahrenheit",
"name": "temperature_unit",
"required": false,
"type": "string"
}
],
"result": "<unknown>",
"options": {
"propagate_tool_result": false
}
},
"service_id": 123,
"id": 123,
"last_updated": "2023-11-07T05:31:56Z",
"last_updated_by": "<string>",
"version_number": 123,
"last_updated_comments": "Updated to use new API endpoint",
"service_name": "<string>",
"prompts_info": [
{
"id": 123,
"name": "<string>"
}
],
"agents_info": [
{
"id": 123,
"name": "<string>"
}
]
},
"agent_count": 5,
"version_number": 1,
"tools_full": [
{
"name": "<string>",
"definition": {
"tool": {
"function": {
"name": "<string>",
"description": "<string>",
"parameters": "<unknown>"
},
"type": "function"
},
"type": "endpoint",
"endpoint": {
"url": "<string>",
"timeout": 45
},
"context": {
"task": {
"id": "<string>",
"config": {},
"variables": [
{
"name": "<string>",
"value": "<unknown>",
"valueFrom": "inputs.provided_dob == patient_dob",
"description": "<string>",
"title": "<string>",
"format": "<string>",
"pattern": "<string>",
"enum": [
"<string>"
],
"examples": [
"<unknown>"
]
}
],
"metadata": {
"priority": 123
},
"tool": {
"name": "<string>",
"description": "<string>"
},
"type": "expression",
"version": "v1alpha",
"inputs": [
{
"name": "<string>",
"description": "<string>",
"title": "<string>",
"format": "<string>",
"pattern": "<string>",
"enum": [
"<string>"
],
"examples": [
"<unknown>"
],
"required": true
}
],
"expression": "inputs.can_sign_consent == `true`",
"output": null,
"on": {
"start": [
{
"name": "<string>",
"value": "<unknown>",
"valueFrom": "inputs.provided_dob == patient_dob",
"if": "inputs.can_sign_consent == `true`",
"action": "set"
}
],
"submit": [
{
"name": "<string>",
"value": "<unknown>",
"valueFrom": "inputs.provided_dob == patient_dob",
"if": "inputs.can_sign_consent == `true`",
"action": "set"
}
]
}
}
},
"defaults": "<unknown>",
"static_parameters": [
{
"default": "fahrenheit",
"description": "Whether the temperature information should be fetched in Celsius or Fahrenheit",
"name": "temperature_unit",
"required": false,
"type": "string"
}
],
"result": "<unknown>",
"options": {
"propagate_tool_result": false
}
},
"service_id": 123,
"id": 123,
"last_updated": "2023-11-07T05:31:56Z",
"last_updated_by": "<string>",
"version_number": 123,
"last_updated_comments": "Updated to use new API endpoint",
"service_name": "<string>",
"prompts_info": [
{
"id": 123,
"name": "<string>"
}
],
"agents_info": [
{
"id": 123,
"name": "<string>"
}
],
"validation_issues": [
{
"id": "<string>",
"message": "<string>",
"severity": "error",
"path": "<string>",
"value": "<string>"
}
]
}
]
},
"custom_message": {
"name": "<string>",
"text": "<string>",
"repeat_after_language_change": true,
"id": 123,
"updated_at": "2023-11-07T05:31:56Z",
"last_updated_by": "<string>",
"type": "greeting",
"preamble": "If this is an emergency, please hang up and call 911.",
"subject": "Your appointment reminder",
"label": "Customer service",
"rules": [],
"agent_count": 1
},
"channel_targets": [
"<unknown>"
],
"tools": [
{
"name": "<string>",
"definition": {
"tool": {
"function": {
"name": "<string>",
"description": "<string>",
"parameters": "<unknown>"
},
"type": "function"
},
"type": "endpoint",
"endpoint": {
"url": "<string>",
"timeout": 45
},
"context": {
"task": {
"id": "<string>",
"config": {},
"variables": [
{
"name": "<string>",
"value": "<unknown>",
"valueFrom": "inputs.provided_dob == patient_dob",
"description": "<string>",
"title": "<string>",
"format": "<string>",
"pattern": "<string>",
"enum": [
"<string>"
],
"examples": [
"<unknown>"
]
}
],
"metadata": {
"priority": 123
},
"tool": {
"name": "<string>",
"description": "<string>"
},
"type": "expression",
"version": "v1alpha",
"inputs": [
{
"name": "<string>",
"description": "<string>",
"title": "<string>",
"format": "<string>",
"pattern": "<string>",
"enum": [
"<string>"
],
"examples": [
"<unknown>"
],
"required": true
}
],
"expression": "inputs.can_sign_consent == `true`",
"output": null,
"on": {
"start": [
{
"name": "<string>",
"value": "<unknown>",
"valueFrom": "inputs.provided_dob == patient_dob",
"if": "inputs.can_sign_consent == `true`",
"action": "set"
}
],
"submit": [
{
"name": "<string>",
"value": "<unknown>",
"valueFrom": "inputs.provided_dob == patient_dob",
"if": "inputs.can_sign_consent == `true`",
"action": "set"
}
]
}
}
},
"defaults": "<unknown>",
"static_parameters": [
{
"default": "fahrenheit",
"description": "Whether the temperature information should be fetched in Celsius or Fahrenheit",
"name": "temperature_unit",
"required": false,
"type": "string"
}
],
"result": "<unknown>",
"options": {
"propagate_tool_result": false
}
},
"service_id": 123,
"id": 123,
"last_updated": "2023-11-07T05:31:56Z",
"last_updated_by": "<string>",
"version_number": 123,
"last_updated_comments": "Updated to use new API endpoint",
"service_name": "<string>",
"prompts_info": [
{
"id": 123,
"name": "<string>"
}
],
"agents_info": [
{
"id": 123,
"name": "<string>"
}
],
"validation_issues": [
{
"id": "<string>",
"message": "<string>",
"severity": "error",
"path": "<string>",
"value": "<string>"
}
]
}
],
"language_group": {
"name": "<string>",
"language_configs": [
{
"dtmf_code": 123,
"voice_speed": 1,
"voice_pitch": 0
}
],
"skip_current_language_in_message": true,
"id": 123,
"updated_at": "2023-11-07T05:31:56Z",
"last_updated_by": "<string>",
"description": "Languages spoken by operators at Call Center 1",
"edit_comments": "Added Spanish support.",
"agents_info": [
{
"id": 1,
"name": "Test Agent"
}
]
}
},
"a2p_verified": true
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Authorizations
Body
application/json
Request model to update a channel target.
The internal ID of the agent associated with the channel target
Example:
1
The internal ID of the channel associated with the channel target
Example:
1
The name of the channel target. Must correspond to an organization-level target (available targets can be fetched from /channels/available-targets).
Example:
"+19995551234"
The mode of the channel target (must match one of the supported modes of the associated channel)
Available options:
voice, chat, sms, email, whatsapp Example:
"voice"
The internal ID of the channel target
Example:
1
The fallback for the channel target (currently only supported for "voice" mode)
Example:
"+19995551235"
Whether the channel target is intended for testing. If true, any sessions created through this target will be labeled as a test session (i.e., will not be included in dashboard data and can easily be filtered out in the Sessions screen in the SyllableConsole).
Example:
true
Response
Successful Response
Response model for channel target operations. A channel target links a channel to an agent, allowing users to communicate with the agent through that channel. For more information, see Console docs.
The internal ID of the agent associated with the channel target
Example:
1
The internal ID of the channel associated with the channel target
Example:
1
The name of the channel target. Must correspond to an organization-level target (available targets can be fetched from /channels/available-targets).
Example:
"+19995551234"
The mode of the channel target (must match one of the supported modes of the associated channel)
Available options:
voice, chat, sms, email, whatsapp Example:
"voice"
The internal ID of the channel target
Example:
1
The name of the channel associated with the channel target
Example:
"+19995551234"
Timestamp of the most recent update to the channel target
Example:
"2024-01-01T00:00:00Z"
Email of the user who last updated the channel target
Example:
"user@email.com"
The fallback for the channel target (currently only supported for "voice" mode)
Example:
"+19995551235"
Whether the channel target is intended for testing. If true, any sessions created through this target will be labeled as a test session (i.e., will not be included in dashboard data and can easily be filtered out in the Sessions screen in the SyllableConsole).
Example:
true
Definition of the agent with which the channel target is associated.
Show child attributes
Show child attributes
Twilio US A2P messaging-path configuration snapshot from the last explicit verify; null if never checked.
⌘I