HighLevel: Get Conversation Channel

← Locations operations · Get started

Operation gohighlevel.get_conversation_channel

Provider route: GET /locations/{locationId}/conversationChannels/{type}. 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["locations"]["getConversationChannel"]>[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.locations.getConversationChannel(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.locations.get_conversation_channel(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	object	Required within parent	Additional keys: not allowed
path.locationId	string	Required within parent
path.type	string	Required within parent	One of: SMS, Email

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 Get Conversation Channel — response body

Referenced models: Get Conversation Channel — response body

Schemas

Get Conversation Channel — response body

Field	Type	Presence	Description and constraints
$	object	Root
conversationChannel	Model	Required within parent	Expand Get Conversation Channel — response body — conversation Channel

Referenced models: Get Conversation Channel — response body — conversation Channel

Get Conversation Channel — response body — conversation Channel

Field	Type	Presence	Description and constraints
$	object	Root
Email	array	Optional	List of Email providers configured for this location
Email[]	Model	Each item	Expand Get Conversation Channel — response body — conversation Channel SMS item
SMS	array	Optional	List of SMS providers configured for this location
SMS[]	Model	Each item	Expand Get Conversation Channel — response body — conversation Channel SMS item

Referenced models: Get Conversation Channel — response body — conversation Channel SMS item

Get Conversation Channel — response body — conversation Channel SMS item

Field	Type	Presence	Description and constraints
$	object	Root
conversationProvider	Model	Required within parent	Expand Get Conversation Channel — response body — conversation Channel SMS item conversation Provider

Referenced models: Get Conversation Channel — response body — conversation Channel SMS item conversation Provider

Get Conversation Channel — response body — conversation Channel SMS item conversation Provider

Field	Type	Presence	Description and constraints
$	object	Root
_id	string	Required within parent	Provider ID
default	boolean	Required within parent	Whether this is the default provider
name	string	Required within parent	Provider name
type	string	Required within parent	Provider type Known values: SMS, Email

Policy, approvals and errors

SDK function policy ID: gohighlevel.get_conversation_channel. Catalog operation: get-conversation-channel. 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: ["locations.readonly"]

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

Official provider source