curl --request PATCH \
--url https://api.prod.usesimple.ai/api/v1/calls/{uuid}/tags \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"tags": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
]
}
'{
"success": true,
"call": {
"id": 123,
"simple_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"from_number": "<string>",
"to_number": "<string>",
"status": "<string>",
"started_at": "2023-11-07T05:31:56Z",
"ended_at": "2023-11-07T05:31:56Z",
"duration": 123,
"created_at": "2023-11-07T05:31:56Z",
"prompt": {
"prompt_text": "<string>",
"created_at": "2023-11-07T05:31:56Z"
},
"transcripts": [
{
"text": "<string>",
"role": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"function_name": "<string>",
"arguments": {}
}
],
"call_prompt": "<string>",
"answered_by": "voicemail",
"record": true,
"language": "en",
"transferred": true,
"direction": "<string>",
"tags": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"description": "<string>",
"color": "<string>"
}
],
"voice_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"background_noise": "<string>",
"agent_speaks_first": true,
"external_identifiers": {},
"params": {},
"recording_presigned_url": "<string>",
"analyzers": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"prompt": "<string>",
"output_config": {
"type": "string",
"properties": {}
}
}
],
"analysis_results": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"analyzer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"prompt": "<string>",
"output_config": {},
"result": {}
}
],
"summary": {}
}
}Update the tags associated with a specific call
curl --request PATCH \
--url https://api.prod.usesimple.ai/api/v1/calls/{uuid}/tags \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"tags": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
]
}
'{
"success": true,
"call": {
"id": 123,
"simple_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"from_number": "<string>",
"to_number": "<string>",
"status": "<string>",
"started_at": "2023-11-07T05:31:56Z",
"ended_at": "2023-11-07T05:31:56Z",
"duration": 123,
"created_at": "2023-11-07T05:31:56Z",
"prompt": {
"prompt_text": "<string>",
"created_at": "2023-11-07T05:31:56Z"
},
"transcripts": [
{
"text": "<string>",
"role": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"function_name": "<string>",
"arguments": {}
}
],
"call_prompt": "<string>",
"answered_by": "voicemail",
"record": true,
"language": "en",
"transferred": true,
"direction": "<string>",
"tags": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"description": "<string>",
"color": "<string>"
}
],
"voice_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"background_noise": "<string>",
"agent_speaks_first": true,
"external_identifiers": {},
"params": {},
"recording_presigned_url": "<string>",
"analyzers": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"prompt": "<string>",
"output_config": {
"type": "string",
"properties": {}
}
}
],
"analysis_results": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"analyzer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"prompt": "<string>",
"output_config": {},
"result": {}
}
],
"summary": {}
}
}Array of call tag UUIDs to assign to the call
Tags Updated Successfully
Show child attributes
Indicates how the call was answered - by a human, voicemail, or if there was no answer
voicemail, human, no_answer, unknown The language to use for the call - English (en) or Spanish (es)
en, es, ar Indicates if the call was transferred
The direction of the call (inbound/outbound)
The ID of the voice used for the call
The background noise setting for the call
Whether the agent speaks first in the call
List of analyzers configured for this call
Show child attributes
Unique identifier for the analyzer
The prompt used for analysis
Configuration for the expected output format
Show child attributes
The type of output expected
string, boolean, datetime, object Results from analyzers that have completed
Show child attributes
Unique identifier for the analysis result
Identifier of the analyzer that produced this result
The prompt used for analysis
Configuration for the expected output format
The analysis result, structure depends on the output_config
The summary of the call if available
Was this page helpful?