Sign in

v51

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-014102371.0 MB
ProviderCall

Create a provider call

Admin-triggered outbound call placed through the specified provider. The handler bypasses normal dialroute selection (via server-side metadata) and preserves the admin-supplied source number verbatim so provider carrier allowlists accept it. The created Call(s)/Groupcall(s) are persisted and their IDs are returned on the ProviderCall record. Admin-only (PermissionProjectSuperAdmin).

post/providercalls

Request body

provider_idstring uuid required

The provider to force the call through. Obtained from the GET /providers response.

flow_idstring uuid

Optional flow to execute after the destination answers. Obtained from the GET /flows response.

anonymous'yes' | 'no' | 'auto'

Controls the anonymous caller-ID flag. Defaults to auto.

Example request

{
  "provider_id": "4dbeabd6-f397-4375-95d2-a38411e07ed1",
  "flow_id": "00000000-0000-0000-0000-000000000000",
  "actions": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "next_id": "550e8400-e29b-41d4-a716-446655440000",
      "type": "talk",
      "tm_execute": "2026-01-15T09:30:00.000000Z"
    }
  ],
  "source": {
    "type": "tel",
    "target": "+14155551234",
    "target_name": "John Smith",
    "name": "Main Office",
    "detail": "Primary contact number"
  },
  "destinations": [
    {
      "type": "tel",
      "target": "+14155551234",
      "target_name": "John Smith",
      "name": "Main Office",
      "detail": "Primary contact number"
    }
  ],
  "anonymous": "auto"
}

Response

The created providercall record.

idstring uuid

The unique identifier of the providercall. Returned from the POST /providercalls response.

customer_idstring uuid

The customer the record is attributed to. Set server-side from the authenticated admin's own customer.

provider_idstring uuid

The provider the call was forced through. Returned from the GET /providers response.

flow_idstring uuid

The flow executed after the destination answered. 00000000-0000-0000-0000-000000000000 when no flow was attached.

anonymous'yes' | 'no' | 'auto'

The anonymous caller-ID option requested. auto (default) resolves the same as no today.

call_idsstring[]

IDs of the Call records that the call-creation step produced. Returned from the POST /calls response and retrievable via GET /calls/{id}.

groupcall_idsstring[]

IDs of any Groupcall records produced when a destination resolved to a group-type address. Retrievable via GET /groupcalls/{id}.

tm_createstring date-time

The creation timestamp.

tm_updatestring date-time

The last update timestamp.

tm_deletestring date-time

The deletion timestamp. null until soft-deleted.

Example response

{
  "id": "b7d1c0f6-9a2e-4b3f-8e2a-1c7d5b8a9e0f",
  "customer_id": "6a93f71e-8b2d-4e5f-9a1c-2d3e4f5a6b7c",
  "provider_id": "4dbeabd6-f397-4375-95d2-a38411e07ed1",
  "flow_id": "00000000-0000-0000-0000-000000000000",
  "source": {
    "type": "tel",
    "target": "+14155551234",
    "target_name": "John Smith",
    "name": "Main Office",
    "detail": "Primary contact number"
  },
  "destinations": [
    {
      "type": "tel",
      "target": "+14155551234",
      "target_name": "John Smith",
      "name": "Main Office",
      "detail": "Primary contact number"
    }
  ],
  "anonymous": "auto",
  "call_ids": [
    "9f8e7d6c-5b4a-3c2d-1e0f-abcdef012345"
  ],
  "groupcall_ids": [],
  "tm_create": "2026-04-21T23:15:00.000000Z",
  "tm_update": "2026-04-21T23:15:00.000000Z",
  "tm_delete": "2026-04-22T00:00:00.000000Z"
}