Calls, Messages, Stages
List Call Stage Messages
Accounts
Calls, Messages, Stages
Corpora, Query, Sources
Webhooks
Calls, Messages, Stages
List Call Stage Messages
Returns all messages that were exchanged during a specific stage of a call
GET
/
api
/
calls
/
{call_id}
/
stages
/
{call_stage_id}
/
messages
curl --request GET \
--url https://api.ultravox.ai/api/calls/{call_id}/stages/{call_stage_id}/messages \
--header 'X-API-Key: <api-key>'
{
"next": "http://api.example.org/accounts/?cursor=cD00ODY%3D\"",
"previous": "http://api.example.org/accounts/?cursor=cj0xJnA9NDg3",
"results": [
{
"role": "MESSAGE_ROLE_UNSPECIFIED",
"text": "<string>",
"invocationId": "<string>",
"toolName": "<string>",
"errorDetails": "<string>",
"medium": "MESSAGE_MEDIUM_UNSPECIFIED",
"callStageMessageIndex": 123,
"callStageId": "<string>"
}
],
"total": 123
}
Authorizations
API key
Query Parameters
The pagination cursor value.
Number of results to return per page.
Response
200 - application/json
The message's role.
Available options:
MESSAGE_ROLE_UNSPECIFIED
, MESSAGE_ROLE_USER
, MESSAGE_ROLE_AGENT
, MESSAGE_ROLE_TOOL_CALL
, MESSAGE_ROLE_TOOL_RESULT
The message text for user and agent messages, tool arguments for tool_call messages, tool results for tool_result messages.
The invocation ID for tool messages. Used to pair tool calls with their results.
The tool name for tool messages.
For failed tool calls, additional debugging information. While the text field is presented to the model so it can respond to failures gracefully, the full details are only exposed via the Ultravox REST API.
The medium of the message.
Available options:
MESSAGE_MEDIUM_UNSPECIFIED
, MESSAGE_MEDIUM_VOICE
, MESSAGE_MEDIUM_TEXT
The index of the message within the call stage.
The call stage this message appeared in.
curl --request GET \
--url https://api.ultravox.ai/api/calls/{call_id}/stages/{call_stage_id}/messages \
--header 'X-API-Key: <api-key>'
{
"next": "http://api.example.org/accounts/?cursor=cD00ODY%3D\"",
"previous": "http://api.example.org/accounts/?cursor=cj0xJnA9NDg3",
"results": [
{
"role": "MESSAGE_ROLE_UNSPECIFIED",
"text": "<string>",
"invocationId": "<string>",
"toolName": "<string>",
"errorDetails": "<string>",
"medium": "MESSAGE_MEDIUM_UNSPECIFIED",
"callStageMessageIndex": 123,
"callStageId": "<string>"
}
],
"total": 123
}