Config system Z-API
2 funções do TermoSell para config system z-api.
// npm install termo_core --save-exact
import * as sell from "termo_core/sell";
// ou: import { sell } from "termo_core";| Função | Rota | O que faz |
|---|---|---|
buscar_auto_complete_config_system_z_api | GET /config_system_z_api/autocomplete | Lista básica dos números de WhatsApp (Z-API) para seleção |
deletar_pelo_id_config_system_z_api | DELETE /config_system_z_api/{id} | Exclui um número de WhatsApp (Z-API) pelo id |
buscar_auto_complete_config_system_z_api
GET/config_system_z_api/autocomplete Exige credencial
Lista básica dos números de WhatsApp (Z-API) para seleção
Exige qualquer permissão da área configuracoes (qualquer ação liberada na área já libera a leitura). Devolve só id, nome e número de cada número de WhatsApp conectado pela Z-API, em ordem alfabética de nome. busca procura o trecho no nome (sem diferenciar maiúsculas) ou no número. pagina começa em 1 (padrão 1) e tamanho tem padrão 10, sem máximo; valores menores que 1 viram 1. total conta os registros que casam com a busca.
function buscar_auto_complete_config_system_z_api(
credencial_de_acesso: CredencialDeAcesso,
parametros: ParametrosDeBuscarAutoCompleteConfigSystemZApi = {},
opcoes_da_chamada?: OpcoesDaChamada,
): Promise<tipos.PaginaConfigSystemZApiAutoComplete>import { CredencialDeAcesso } from "termo_core";
import { buscar_auto_complete_config_system_z_api } from "termo_core/sell";
const credencial_de_acesso = CredencialDeAcesso.token_do_usuario_logado(token_do_usuario);
const resposta = await buscar_auto_complete_config_system_z_api(credencial_de_acesso, { busca: "..." });Argumentos
Nome
Tipo
Retorno: Promise<tipos.PaginaConfigSystemZApiAutoComplete> · Rust: Result<tipos::PaginaConfigSystemZApiAutoComplete, ErroAoChamarServico> · veja PaginaConfigSystemZApiAutoComplete.
deletar_pelo_id_config_system_z_api
DELETE/config_system_z_api/{id} Exige credencial
Exclui um número de WhatsApp (Z-API) pelo id
Exige a permissão deletar da área configuracoes. A exclusão é lógica e não há como restaurar: o número some das consultas e o TermoSell deixa de atender as mensagens que chegam por ele.
function deletar_pelo_id_config_system_z_api(
credencial_de_acesso: CredencialDeAcesso,
id: string,
opcoes_da_chamada?: OpcoesDaChamada,
): Promise<void>import { CredencialDeAcesso } from "termo_core";
import { deletar_pelo_id_config_system_z_api } from "termo_core/sell";
const credencial_de_acesso = CredencialDeAcesso.token_do_usuario_logado(token_do_usuario);
await deletar_pelo_id_config_system_z_api(credencial_de_acesso, id);Argumentos
Nome
Tipo
Retorno: Promise<void> · Rust: Result<(), ErroAoChamarServico> · sem corpo na resposta.
Tipos
Tipos usados pelas funções desta página. O nome é o mesmo nos dois pacotes.
PaginaConfigSystemZApiAutoComplete
import type { PaginaConfigSystemZApiAutoComplete } from "termo_core/sell";
export interface PaginaConfigSystemZApiAutoComplete {
itens: Array<PaginaConfigSystemZApiAutoCompleteItensItem>;
pagina: number;
tamanho: number;
total: number;
}PaginaConfigSystemZApiAutoCompleteItensItem
import type { PaginaConfigSystemZApiAutoCompleteItensItem } from "termo_core/sell";
export interface PaginaConfigSystemZApiAutoCompleteItensItem {
id: string;
nome: string;
numero: string;
}