Trigger an outbound agent call (not generally available)

POST

/api/v2/aura/calls

curl --request POST \
  --url https://api.sipstack.com/api/v2/aura/calls \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --data '{ "agentId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "to": "+14165550100" }'

• Production

Triggers an outbound Aura voice-agent call for your organization.

:::caution[Not generally available] This endpoint is not enabled for API access and returns 403 (“outbound Aura calling is not enabled for API access”). It is documented for completeness; the read endpoints above are the supported surface today. Contact support if outbound agent calling is on your roadmap. :::

When enabled, it requires the aura:write scope and an agentId provisioned on your organization, and returns 202 with an outboundCallId.

Authorizations

• apiKeyAuth

Request Body ^required

Media type application/json

object

agentId

required

A voice agent provisioned on your organization.

string format: uuid

to

required

Destination phone number (optional leading +, 3–20 digits).

string

Example

+14165550100

Responses

202

Origination accepted (only when the feature is enabled).

Media type application/json

object

success

boolean

data

object

status

string

outboundCallId

string

nullable

agent_id

string format: uuid

to

string

Example

{
  "data": {
    "status": "originating"
  }
}

400

Missing agentId or an invalid to.

Media type application/json

Inline error shape used by the messaging API and management endpoints.

object

success

boolean

error

string

Example

{
  "success": false,
  "error": "Recipient phone number (to) is required"
}

401

Missing or invalid API key.

Media type application/json

Inline error shape used by the messaging API and management endpoints.

object

success

boolean

error

string

Example

{
  "success": false,
  "error": "Recipient phone number (to) is required"
}

403

Outbound Aura calling is not enabled for API access, or the key is missing the aura:write scope.

Media type application/json

Inline error shape used by the messaging API and management endpoints.

object

success

boolean

error

string

Example

{
  "success": false,
  "error": "Recipient phone number (to) is required"
}

404

No Aura voice service provisioned, or agentId is not one of your agents.

Media type application/json

Inline error shape used by the messaging API and management endpoints.

object

success

boolean

error

string

Example

{
  "success": false,
  "error": "Recipient phone number (to) is required"
}