HighLevel: Add an external outbound call

← Conversations operations · Get started

Operation gohighlevel.add_an_outbound_message

Provider route: POST /conversations/messages/outbound. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/gohighlevel with npm, or alter-sdk-gohighlevel with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { HighLevelIntegration } from "@alter-ai/gohighlevel";

async function execute(input: Parameters<HighLevelIntegration["conversations"]["addAnOutboundMessage"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new HighLevelIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.conversations.addAnOutboundMessage(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_gohighlevel import HighLevelIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = HighLevelIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.conversations.add_an_outbound_message(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
body	Model	Required within parent	Expand Add an external outbound call — request body — body

Referenced models: Add an external outbound call — request body — body

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	Model	Root	Expand Add an inbound message — response body

Referenced models: Add an inbound message — response body

Schemas

Add an inbound message — response body

Field	Type	Presence	Description and constraints
$	object	Root
contactId	string	Optional	Contact ID associated with the processed message
conversationId	string	Required within parent	Conversation ID.
dateAdded	string	Optional	Timestamp when the processed message was created Format: date-time
emailMessageId	string	Optional	Email message ID created for email conversations
message	string	Required within parent	Result message returned after processing
messageId	string	Required within parent	This is the main Message ID
success	boolean	Required within parent	Whether the message processing succeeded

Add an external outbound call — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
altId	string	Optional	external mail provider's message id
attachments	array	Optional	Array of attachments
attachments[]	string	Each item
call	JSON	Optional	Phone call dialer and receiver information
call (allOf 1)	Model	All variants apply	Expand Add an inbound message — request body — body call from, status, to
conversationId	string	Required within parent	Conversation Id
conversationProviderId	string	Required within parent	Conversation Provider Id
date	string	Optional	Date of the outbound message Format: date-time
type	string	Required within parent	Message Type One of: Call

Referenced models: Add an inbound message — request body — body call from, status, to

Add an inbound message — request body — body call from, status, to

Field	Type	Presence	Description and constraints
$	object	Root
from	string	Optional	Phone number of the dialer
status	string	Optional	Call status One of: pending, completed, answered, busy, no-answer, failed, canceled, voicemail
to	string	Optional	Phone number of the receiver

Policy, approvals and errors

SDK function policy ID: gohighlevel.add_an_outbound_message. Catalog operation: add-an-outbound-message. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["conversations/message.write"]

Pinned headers: {"Version": "v3"}

Official provider source