voice module route (requires voice:session:admin)

POST

/v1/m/voice/sessions/open

curl --request POST \
  --url https://example.com/v1/m/voice/sessions/open \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "agent_ref": "example", "approval_ref": "example", "model_ref": "example", "provider_ref": "example", "session_ref": "example" }'

• this engine

Opens one voice session; session, agent, model and provider references are all required, and an engaged stop freezes the call.

Authorizations

• bearerAuth

Parameters

Header Parameters

X-Olivares-Tenant

string format: uuid

Target tenant id; required when the principal can act in more than one tenant.

Request Body ^required

Media type application/json

object

agent_ref

required

string

>= 1 characters

approval_ref

Any of:

string

Empty or omitted starts the approval phase; a value attempts the approved dispatch phase.

string

null

null

model_ref

required

string

>= 1 characters

provider_ref

required

string

>= 1 characters

session_ref

required

string

>= 1 characters

Example ^generated

{
  "agent_ref": "example",
  "approval_ref": "example",
  "model_ref": "example",
  "provider_ref": "example",
  "session_ref": "example"
}

Responses

200

OK

Media type application/json

object

Example ^generated

{}

400

Bad request

Media type application/json

object

Example ^generated

{}

401

Unauthenticated

Media type application/json

object

Example ^generated

{}

403

Forbidden

Media type application/json

object

Example ^generated

{}

404

Not found

Media type application/json

object

Example ^generated

{}

409

Conflict / setup required

Media type application/json

object

Example ^generated

{}

429

Rate limited

Media type application/json

object

Example ^generated

{}