Update call

Update a call with additional metadata. The call can be either a phone call or a web call. The response includes the updated call details. If override is True, existing metadata will be completely replaced with new metadata, including None values.

Authorizations

X-Api-Key

string

header

required

The API Key created in Rounded Studio.

• You can create it by going to the "API Keys" settings of your profile.
• Need help? You can email us at [e-mail] or join our Discord community.

Path Parameters

call_id

string

required

Body

application/json

Schema for updating a call with metadata.

metadata

object | null

Additional metadata to associate with the call.

Example:

{
  "source": "marketing_campaign",
  "utm_medium": "email"
}

override

boolean | null

default:false

If True, existing metadata will be completely replaced with new metadata. If False, existing metadata will be merged with new metadata.

Response

200

application/json

Successfully updated call information

data

object

required

The call data retrieved.

• PhoneCallGetApiResponseData
• WebCallGetApiResponseData

Show child attributes

data.id

string

required

Unique identifier for the call.

Example:

"123e4567-e89b-12d3-a456-426614174000"

data.status

enum<string>

required

Current status of the call.

Available options:

queued,

initiated,

ringing,

connected,

in_progress,

completed,

redirection_completed,

busy,

no_answer,

canceled,

failed

data.from_number

string

required

Phone number that initiated the call.

Example:

"[phone]"

data.to_number

string

required

Phone number that received the call.

Example:

"[phone]"

data.direction

enum<string>

required

Direction of the call (inbound or outbound)

Available options:

inbound,

outbound

data.organization_id

string | null

ID of the organization the call belongs to.

Example:

"123e4567-e89b-12d3-a456-426614174001"

data.type

enum<string>

Indicates this is a phone call.

Available options:

phone_call,

web_call

data.agent_id

string | null

ID of the agent handling the call.

Example:

"123e4567-e89b-12d3-a456-426614174002"

data.metadata

object | null

Additional metadata associated with the call.

Example:

{
  "source": "marketing_campaign",
  "utm_medium": "email"
}

data.start_time

string | null

Timestamp when the call started.

Example:

"2023-06-15T14:30:00Z"

data.end_time

string | null

Timestamp when the call ended.

Example:

"2023-06-15T14:35:00Z"

data.duration_seconds

integer | null

Duration of the call in seconds.

Example:

300

data.redirect_duration_seconds

integer | null

Duration of call redirection in seconds.

Example:

5

data.cost

number | null

Estimation of the cost of the call in EUR.

Example:

0.15

data.transcript_string

string | null

Plain text representation of the call transcript.

Example:

"Agent: Hello, how can I help you today?\nUser: I'd like to check on my order status."

data.transcript

object[] | null

Structured representation of the call transcript with messages and tool calls.

• Message Content
• Tool Call
• Tool Response
• Task Switch

Response schema for regular message content.

Show child attributes

data.transcript.role

enum<string>

required

Role of the entity sending the message (user, agent, tool, etc.).

Available options:

user,

agent,

tool,

task_switch

data.transcript.start_time

string

required

Timestamp when the message was created.

Example:

"2023-06-15T14:31:23Z"

data.transcript.content

string

required

The actual text content of the message.

Example:

"Hello, how can I help you today?"

data.variable_values

object[] | null

Values of variables collected during the call.

API response schema for variable values. This schema is used in the call response.

Show child attributes

data.variable_values.name

string

required

Name of the variable.

Example:

"customer_name"

data.variable_values.type

enum<string>

required

Data type of the variable.

Available options:

string,

boolean,

number,

datetime

data.variable_values.value

string

required

The actual value of the variable as a string.

Example:

"John Doe"

data.variable_values.timestamp

string | null

When the variable was last updated.

Example:

"2023-06-15T14:33:12Z"

data.recording_url

string | null

A temporary URL to access the call recording that expires after 1 hour. Returns null if no recording exists or if recording failed.

message

string

default:Call retrieved successfully

Response message indicating the result of the operation.

error

object | null

Show child attributes

error.message

string

required

error.type

string

required

error.status

integer

required

error.details

object[] | null

Show child attributes

error.details.message

string

required

error.details.field

string | null

Example:

{
  "details": [
    {
      "field": "email",
      "message": "Invalid email format"
    }
  ],
  "message": "An error occurred while processing your request",
  "status": 400,
  "type": "generic_error"
}

status

integer

default:200

HTTP status code of the response.