Class AccountsResource

Hierarchy

  • Resource
    • AccountsResource

Constructors

Methods

  • Completa la conexión con lo que la red social pegó a la URL de vuelta.

    Esta llamada no la necesita la mayoría. La URL de vuelta la construye la red a partir del enlace de connectLinks, y apunta a un front de PlanVortex: es ese front el que llama aquí. El método existe para quien sirve su propia interfaz en uno de los dominios registrados en el servidor. En la integración normal —la del ejemplo connect-flow— basta con mandar al usuario a la url del token temporal y esperarlo de vuelta.

    El endpoint contesta 200 aunque haya fallado, con el error dentro del cuerpo, porque el navegador aterriza aquí desde una redirección y un 400 crudo sería una página rota. La librería deshace ese apaño: si viene errorCode, lanza el error que le toca, igual que cualquier otro método. Lo que devuelve son sólo cuentas buenas.

    Y vuelven SIN habilitar: no ocupan plaza del plan ni publican hasta que se llama a enable. Una sola autorización puede dejar varias — un usuario de Facebook con cuatro páginas son cuatro—, y por eso hay un paso de elección en medio.

    Parameters

    Returns Promise<ConnectResult>

  • Los enlaces de autorización de cada red conectable, para mandar a la persona a la suya.

    Con credenciales de app contesta 519. Se llama con un cliente autenticado con el token temporal: pv.asTemporalToken(token).accounts.connectLinks(orgId).

    Una red que no puede dar enlace simplemente no aparece, y eso es una respuesta legítima y no un fallo: es lo que pasa con Discord en una organización que todavía no ha guardado sus propias credenciales de bot.

    MIRA authorization, NO si link está vacío. Nueve de las diez redes son redirect y se manda a la persona a link. WhatsApp no es una URL: su alta es el Embedded Signup de Meta, un popup que levantas tú con el SDK de JavaScript de Facebook, así que su link es cadena vacía y lo que necesitas para abrirlo viaja en authorization — ver ConnectLink. Recorrer la lista redirigiendo a link manda a tu usuario a tu propia página.

    OJO: la red devuelve al usuario a un front de PlanVortex, no a una URL tuya — ver redirect_uri en ConnectLinksOptions.

    Parameters

    Returns Promise<
        {
            authorization: {
                app_id?: string;
                config_id?: string;
                feature_type?: string;
                graph_version?: string;
                session_info_version?: string;
                type: "redirect"
                | "meta_embedded_signup";
            };
            link: string;
            social_network: | "facebook"
            | "instagram"
            | "linkedin"
            | "tiktok"
            | "twitter"
            | "whatsapp"
            | "youtube"
            | "google_business"
            | "bluesky"
            | "discord";
        }[],
    >

  • Da de alta una de las cuentas que dejó connect, o recupera una que se desconectó mientras su token guardado siga sirviendo (si no, error 700 y hay que autorizar otra vez).

    Es el paso que ocupa plaza del plan: con el cupo lleno contesta 706, así que se llama una a una y se mira el hueco antes (organizations.limits). Y es también el que enciende los webhooks de la red, en cualquier plan que no sea el gratuito.

    Parameters

    Returns Promise<EnableResult>

  • El menú fijo del chat, una entrada por idioma.

    Sólo las redes con mensajería lo tienen: en las demás la llamada devuelve el error 710. Se comprueba con persistent_menu de catalog.socialCapabilities().

    Parameters

    Returns Promise<
        {
            call_to_actions?: { [key: string]: unknown }[];
            composer_input_disabled?: boolean;
            locale?: string;
        }[],
    >

  • Los nombres CRUDOS de las métricas que publica la red de esta cuenta.

    Son los que se pasan a metrics y los que vuelven en cada fila. No es el vocabulario común —eso es metrics de una publicación—: aquí cada red habla su idioma (page_impressions, total_interactions, allPageViews).

    Parameters

    Returns Promise<string[]>

  • La serie de métricas ya medidas de una cuenta.

    Es lectura de lo guardado, no una llamada a la red: mirar la gráfica no cuesta créditos. El agrupado lo decide el rango — hasta 31 días por día, hasta 720 por mes, y de ahí por año— y viene dicho en group.

    Parameters

    Returns Promise<
        {
            group: "day"
            | "month"
            | "year";
            stats: {
                date: string;
                group: "day" | "month" | "year";
                group_value: number;
                name: string;
                value: number;
            }[];
        },
    >

  • Desconecta la cuenta y borra sus publicaciones. Lo ya publicado en la red se queda donde está: esto no la toca.

    Parameters

    Returns Promise<void>

  • Reemplaza el menú fijo del chat. Es un REEMPLAZO: lo que no vaya en el array desaparece.

    La entrada con locale: "default" es obligatoria — es la que se enseña cuando ninguna otra encaja.

    Parameters

    • idOrganization: string
    • idAccount: string
    • menu: {
          call_to_actions?: { [key: string]: unknown }[];
          composer_input_disabled?: boolean;
          locale?: string;
      }[]
      • Optionalcall_to_actions?: { [key: string]: unknown }[]

        The buttons. A postback sends you its payload as a message; a web_url opens a page; a nested holds more buttons.

      • Optionalcomposer_input_disabled?: boolean

        true hides the text box, leaving the menu as the only way to answer.

      • Optionallocale?: string

        default, or a locale such as es_ES.

    • options: RequestOptions = {}

    Returns Promise<
        {
            call_to_actions?: { [key: string]: unknown }[];
            composer_input_disabled?: boolean;
            locale?: string;
        }[],
    >

  • Cambia el nombre con el que la cuenta se ve en PlanVortex. Es lo único editable.

    Parameters

    • idOrganization: string
    • idAccount: string
    • body: { name?: string }
    • options: RequestOptions = {}

    Returns Promise<Account>