curl --request POST \
  --url https://app.miyon.ai/api/v1/outbound/calls/bulk \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "agent_number": "+4921186942846",
  "destinations": [
    {
      "phone": "+491761234567"
    },
    {
      "phone": "+491769876543"
    }
  ],
  "prompt_variables": {
    "campaign": "Spring 2026"
  }
}
'

{
  "success": true,
  "batch_id": "6f1e9c2a-4d3b-4a1f-9c8e-2b7d5a0f3e11",
  "total": 2,
  "succeeded": 1,
  "failed": 1,
  "results": [
    {
      "destination": "+491761234567",
      "success": true,
      "consent_id": 48213,
      "call_sid": "outb_9f2c1d",
      "status": "initiated",
      "error": null
    },
    {
      "destination": "+491760000000",
      "success": false,
      "consent_id": 48214,
      "call_sid": null,
      "status": "failed",
      "error": "Something went wrong. Please try again or contact support."
    }
  ]
}

Outbound Calls

Place calls in bulk

Place calls to multiple destinations in one request, up to 10 destinations.

The whole request is validated before any call is placed. If validation fails - an invalid number, more than 10 destinations, a missing prompt variable - the entire request is rejected with a 400 and no calls are placed.

Once validation passes, each destination is dialed independently, so a bulk can return a mix of successes and failures per destination. It returns 201 even when some - or all - destinations fail: check each entry’s success and status in results.

Duplicate destinations are de-duplicated; each unique number is called once.

Bulk requests do not support metadata or variables. Use prompt_variables, shared or per destination.

POST

/

api

/

v1

/

outbound

/

calls

/

bulk

curl --request POST \
  --url https://app.miyon.ai/api/v1/outbound/calls/bulk \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "agent_number": "+4921186942846",
  "destinations": [
    {
      "phone": "+491761234567"
    },
    {
      "phone": "+491769876543"
    }
  ],
  "prompt_variables": {
    "campaign": "Spring 2026"
  }
}
'

{
  "success": true,
  "batch_id": "6f1e9c2a-4d3b-4a1f-9c8e-2b7d5a0f3e11",
  "total": 2,
  "succeeded": 1,
  "failed": 1,
  "results": [
    {
      "destination": "+491761234567",
      "success": true,
      "consent_id": 48213,
      "call_sid": "outb_9f2c1d",
      "status": "initiated",
      "error": null
    },
    {
      "destination": "+491760000000",
      "success": false,
      "consent_id": 48214,
      "call_sid": null,
      "status": "failed",
      "error": "Something went wrong. Please try again or contact support."
    }
  ]
}

Autorisierungen

Authorization

string

header

erforderlich

Scoped API token. Required scopes are listed on each operation in x-required-scopes.

Body

application/json

destinations

erforderlich

Up to 10 destinations, either as objects (with optional per-destination variables) or as plain E.164 strings. The two forms cannot be mixed.

Maximum array length: 10

Show child attributes

agent_number

string

erforderlich

Your agent's phone number, or its SIP ID if your account connects its own SIP trunk (then also set caller_number).

Beispiel:

"+4921186942846"

caller_number

string

Caller ID shown to the recipient, in E.164 format. Required when agent_number is a SIP ID; ignored otherwise.

Pattern: ^\+\d+$

prompt_variables

object

Shared variables applied to every destination. Cannot be combined with per-destination prompt_variables in the same request - use one or the other.

Show child attributes

Beispiel:

{
  "customer_name": "Max Mustermann",
  "order_id": "ORD-2026-0042"
}

Antwort

Request accepted and every destination attempted. Per-destination outcomes are in results.

success

boolean

True when the request was processed; check each row's success for the outcome per destination.

Beispiel:

true

batch_id

string<uuid>

Groups these calls together. Use it with Get a batch.

total

integer

Destinations in the request after deduplication.

Beispiel:

3

succeeded

integer

Destinations that were dialed.

Beispiel:

2

failed

integer

Destinations that were not dialed.

Beispiel:

1

results

object[]

Outcome per destination, in request order.

Show child attributes

mode

string

Always direct: calls are dialed immediately.

Allowed value: "direct"