Have the agent ring your phone
Call the operator's verified mobile and run the agent's CURRENT DRAFT over a real phone call, so they can hear unsaved/unpublished edits live (the assistant-invokable twin of the Call-me button; both dial the current draft). The dialed number is always the caller's own phone-verified AU mobile, there is no number input. Limited to 3 calls per hour per workspace. If the caller's mobile isn't verified, this returns an error telling them to verify it in Preferences → Profile. Use it to let the operator hear their latest changes on a real line; for a fast headless check of the draft without a phone, use talk_to_agent instead.
Authorization
bearerAuth A personal access token from Settings > API tokens.
In: header
Path Parameters
Workspace slug (GET /me lists yours).
Agent slug within the workspace.
Header Parameters
A key you choose, such as a UUID, that makes this POST safe to retry. Within 24 hours the same key and request answers with the first successful answer and runs nothing, the same key with a different request answers 422 idempotency_key_reused, and a key whose request is still running answers 409 idempotency_key_in_use. A failed request keeps nothing, so the same key runs it again.
1 <= length <= 255Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
curl -X POST "https://example.com/workspaces/string/agents/string/test-calls" \ -H "Content-Type: application/json" \ -d '{}'{
"property1": null,
"property2": null
}{
"type": "http://example.com",
"title": "string",
"status": 0,
"detail": "string",
"code": "string",
"errors": [
{
"path": "string",
"message": "string"
}
],
"estimate": {},
"retryAfterSeconds": 0
}{
"type": "http://example.com",
"title": "string",
"status": 0,
"detail": "string",
"code": "string",
"errors": [
{
"path": "string",
"message": "string"
}
],
"estimate": {},
"retryAfterSeconds": 0
}{
"type": "http://example.com",
"title": "string",
"status": 0,
"detail": "string",
"code": "string",
"errors": [
{
"path": "string",
"message": "string"
}
],
"estimate": {},
"retryAfterSeconds": 0
}{
"type": "http://example.com",
"title": "string",
"status": 0,
"detail": "string",
"code": "string",
"errors": [
{
"path": "string",
"message": "string"
}
],
"estimate": {},
"retryAfterSeconds": 0
}{
"type": "http://example.com",
"title": "string",
"status": 0,
"detail": "string",
"code": "string",
"errors": [
{
"path": "string",
"message": "string"
}
],
"estimate": {},
"retryAfterSeconds": 0
}{
"type": "http://example.com",
"title": "string",
"status": 0,
"detail": "string",
"code": "string",
"errors": [
{
"path": "string",
"message": "string"
}
],
"estimate": {},
"retryAfterSeconds": 0
}{
"type": "http://example.com",
"title": "string",
"status": 0,
"detail": "string",
"code": "string",
"errors": [
{
"path": "string",
"message": "string"
}
],
"estimate": {},
"retryAfterSeconds": 0
}List calls GET
List this agent's calls, newest first, each with its sessionId, agent name, the caller's number and name, channel, sentiment/outcome, the analysis summary, topic and urgency, its length in seconds, and a coarse metric pass/fail summary. Call this FIRST to resolve a sessionId before get_call_bundle, get_call_metrics or evaluate_call. Narrow it with since, until and outcome; page through older calls by passing back next_cursor until it is null. Real calls only by default; pass includeTests=true to widen to test and discovery calls. Eval runs never appear here.
Register a phone number POST
Register a phone number the workspace ALREADY OWNS at the provider (e.g. a number ordered from or ported to the carrier out-of-band) into the workspace, so it appears in list_phone_numbers and can be assigned to an agent with assign_phone_number. This does NOT purchase or port a number, order/port it with the provider first (attaching the right voice connection there), then register it here. Numbers on our carrier are verified against the carrier's LIVE state before the row is written: the providerSid must exist and match the number, and its voice connection must route to THIS environment's runtime. A number answered by another environment is refused (pass allowCrossEnvRouting: true to register it anyway, for a deliberate split-env setup). Routing metadata is read from the carrier, so connectionId/connectionName args are ignored when they disagree with the live record. Added unbilled (no Stripe rental enrolment; prices stay null), matching the demo-line pattern. Idempotent on the phone number, re-adding one already in this workspace returns it unchanged.