Sign in

v52

latestOpenAPI 3.0.1raw.githubusercontent.com2026-08-01353775.9 KB
Conversation

Trigger an outbound touch for an externally-orchestrated campaign

Sends one outbound touch (voice or WhatsApp) under an EXTERNAL campaign and returns the conversationId to mirror the conversation off. Lorikeet runs no timers or sequencing: subscribe to the outcome webhooks to drive the next touch. Consent and do-not-contact are re-checked on every touch.

post/v1/conversation/campaign/touch

Request body

campaignIdstring required

The ID of the externally-orchestrated campaign to trigger the touch under.

workflowIdstring

The ID of the workflow (talk track) to run for this touch. Resolved to the active version. Provide at most one of workflowId or agentId.

agentIdstring

The ID of the agent (talk track) to run for this touch. Provide at most one of workflowId or agentId.

initialMessagestring

The opening message for WhatsApp touches. If omitted, provide a workflowId or contentSid.

contentSidstring

WhatsApp only: the pre-approved template (content SID) to open a conversation cold, outside the customer-service window.

contentVariablesobject

WhatsApp only: variables to fill into the template.

variablesobject

Variables passed to the workflow or agent at runtime. Values may be typed (string, number, boolean, object, array).

Example request

{
  "customer": {
    "phoneNumber": "+61400000000"
  }
}

Response

conversationIdstring required

The ID of the conversation that was created. Mirror the conversation off this ID.