ANanyreach
Conversations

Dial Conversation

Directly place a call (internal use by campaign-service only).

This endpoint initiates the call immediately via LiveKit/telephony. External callers should use POST /conversations to enqueue instead. Requires the 'conversations:dial' scope, which should only be granted to the campaign-service M2M application.

post/core/conversations/dial

Request

  • Base URL
    https://api.anyreach.ai (the document declares no server; this is the origin it was published from)
  • Auth
    HTTP bearer

Headers

x-anyreach-orgstring nullable

Organization ID for user PATs (pat_ prefix tokens)

Request body

idstring uuid nullable

Optional conversation ID for idempotent creation. If provided and a conversation with this ID already exists, the existing conversation is returned.

channel'telephone' | 'webrtc' | 'email' | 'text' | 'webchat' required

Channel type for the conversation.

user_idstring required

User ID (must be +E.164 phone number for telephony)

custom_metadataobject nullable

Optional custom metadata

agent_version_idstring nullable

Agent version ID (for webrtc)

agent_idstring nullable

Parent agent ID (resolves latest published version)

initial_contextstring

Context to inject into the agent's system prompt at conversation start

agent_numberstring nullable

Agent number (required for telephony)

to_addressstring nullable

Recipient address (email outbound-initiated)

from_addressstring nullable

Sender address (email outbound-initiated)

subjectstring nullable

Subject line for an outbound-initiated email. If omitted, the agent's configured email default_subject is used.

Response

Successful Response

object required

Changes

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