evolution-api-sdk/lib/modules/instance/schemas/create.d.mts

Unofficial SDK for the Evolution Whatsapp API v2

interface WebhookConfig {
    url?: string;
    byEvents?: boolean;
    base64?: boolean;
    headers?: Record<string, string>;
    events?: string[];
}
interface RabbitMQConfig {
    enabled?: boolean;
    events?: string[];
}
interface SQSConfig {
    enabled?: boolean;
    events?: string[];
}
interface CreateInstanceRequest {
    instanceName: string;
    token?: string;
    qrcode?: boolean;
    number?: string;
    integration?: string;
    rejectCall?: boolean;
    msgCall?: string;
    groupsIgnore?: boolean;
    alwaysOnline?: boolean;
    readMessages?: boolean;
    readStatus?: boolean;
    syncFullHistory?: boolean;
    proxyHost?: string;
    proxyPort?: string;
    proxyProtocol?: "http" | "https";
    proxyUsername?: string;
    proxyPassword?: string;
    webhook?: WebhookConfig;
    rabbitmq?: RabbitMQConfig;
    sqs?: SQSConfig;
    chatwootAccountId?: number;
    chatwootToken?: string;
    chatwootUrl?: string;
    chatwootSignMsg?: boolean;
    chatwootReopenConversation?: boolean;
    chatwootConversationPending?: boolean;
    chatwootImportContacts?: boolean;
    chatwootNameInbox?: string;
    chatwootMergeBrazilContacts?: boolean;
    chatwootImportMessages?: boolean;
    chatwootDaysLimitImportMessages?: number;
    chatwootOrganization?: string;
    chatwootLogo?: string;
}
interface InstanceInfo {
    instanceName: string;
    instanceId: string;
    webhook_wa_business?: string | null;
    access_token_wa_business?: string;
    status: string;
}
interface InstanceSettings {
    rejectCall?: boolean;
    msgCall?: string;
    groupsIgnore?: boolean;
    alwaysOnline?: boolean;
    readMessages?: boolean;
    readStatus?: boolean;
    syncFullHistory?: boolean;
}
interface QRCodeInfo {
    code: string;
    base64: string;
}
interface CreateInstanceResponse {
    instance: InstanceInfo;
    hash: string;
    settings?: InstanceSettings;
    qrcode?: QRCodeInfo;
}

export type { CreateInstanceRequest, CreateInstanceResponse, InstanceInfo, InstanceSettings, QRCodeInfo, RabbitMQConfig, SQSConfig, WebhookConfig };