Skip to content
Vocapable Developers

Queue one compliant live/BYO mobile AI call

POST
/v1/mobile/receptionist/call-ai
curl --request POST \
  --url https://api.vocapable.com/v1/mobile/receptionist/call-ai \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: example' \
  --data '{ "agent_id": "example", "contact_id": "example" }'

Launch exactly one resource-bound call through the shared production pipeline.

The native admission dependency enforces rate limits, current production agreements, and a membership/device idempotency key before this handler runs. mock=False is intentional: mobile Call AI has no test or managed-carrier branch, and the shared core refuses anything except the tenant’s verified default BYO route.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Header Parameters

Section titled “Header Parameters”
Idempotency-Key
required
string
<= 255 characters

Unique key for this mobile Call AI request, so a retry replays the original result instead of placing another call. Stored for 24 hours; a replay carries Idempotent-Replay: true. Required on this endpoint.

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
MobileCallAiRequest

A deliberately narrow native request for one compliant outbound AI call.

The app chooses both durable resources from the companion read models. It cannot provide an E.164 destination, caller-ID override, carrier account, telephony mode, or a list of contacts, so this endpoint cannot become an alternate bulk dialer.

object
agent_id
required
Agent Id
string
>= 1 characters <= 64 characters
contact_id
required
Contact Id
string
>= 1 characters <= 64 characters
Examplegenerated
{
  "agent_id": "example",
  "contact_id": "example"
}

Responses

Section titled “Responses”

202

Section titled “202”

Successful Response

Media typeapplication/json
MobileCallAiResponse

The queued result of one native Call AI request.

Mobile launch is always routed through the tenant’s verified BYO carrier plane. The generic call contract also permits the test-only mock transport, so it must not be used as this endpoint’s response model or a native client could be told an impossible transport state.

object
id
required
Id
string
agent_id
required
Agent Id
string
agent_version_id
required
Agent Version Id
string
contact_id
required
Contact Id
string
telephony
required
Telephony
string
Allowed value: byo
state
required
State
string
disposition
Any of:
string
call_id
Any of:
string
created_at
required
Created At
string format: date-time
Example
{
  "telephony": "byo"
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Examplegenerated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}