Calls

Create Call

Schedules a single outbound call. The call is queued and initiated when resources are available.

post/v1/calls

Request

Base URL: https://api.dialnexa.com
URL: https://api.dialnexa.com/v1/calls
Auth: HTTP bearer

Request body

phone_numberstring required

Phone number to call (must include country code). Format: +[country code][phone number]

agent_idstring required

Agent ID to use for the call. Must belong to the authenticated organization.

agent_version_numbernumber

Specific agent version number to use (optional). If provided, must be a published version. If not provided, will use the latest published version.

phone_number_idstring

One of the agent's outbound numbers to call from. Required when the agent has more than one outbound number.

metadataobject required

Metadata for the call including customer information and any additional context. This data will be available during the call for personalization.

notesobject

Optional notes stored on the call log. Must be a JSON object with at most 15 top-level keys.

Example request

{
  "phone_number": "+911234567890",
  "agent_id": "agent_2g7Xy3tY53gRlp",
  "agent_version_number": 2,
  "phone_number_id": "phn_2g7Xy3tY53gRlp",
  "metadata": {
    "customer_name": "John Doe",
    "customer_email": "john@example.com",
    "priority": "high"
  },
  "notes": {
    "customer_name": "John Doe",
    "follow_up_required": true,
    "source": "crm"
  }
}

Response

Call created and queued successfully.

idstring required

Unique call ID for tracking. Use this ID to reference the call in other API endpoints.

agent_idstring required

The ID of the agent used for this call.

to_phone_numberstring required

The phone number that will receive the call.

agent_version_numbernumber

Numeric agent version actually selected for this call. If omitted in the request, the latest published version is selected.

Example response

{
  "id": "call_mfgsn90vwcozgb",
  "agent_id": "agent_mfgsn90vwcozgb",
  "to_phone_number": "+911234567890",
  "agent_version_number": 2
}

Changes

No recorded changes to this operation across all 1 revision of this API.