Funções (API) na calculadora

As funções da API estão disponíveis apenas nos planos "Business" e "MaviBot AI".

API MaviBot

LEGENDA:\ ! -Parâmetros obrigatórios

Como enviar callback

callback()

Você pode enviar callback apenas para OUTRO cliente.

VOCÊ NÃO PODE enviar um callback para SI MESMO!

callback(client_id, callback_message)

Parâmetros:

! client_id - identificador do cliente

! callback_message - texto da mensagem de callback

Um callback é uma mensagem especial do sistema que o bot reconhece como um comando para acionar uma ação específica. Esta mensagem é invisível para o usuário e é registrada apenas no perfil do cliente para processamento interno.

Vamos enviar um callback para o cliente com client_id=73704021

Em seguida, definimos a resposta para este callback no bloco com a condição.

callback('73704021', 'callback TEST123')

callback(client_id, 'callback TEST123')

Como enviar callback no Telegram

tg_callback()

tg_callback(platform_id , callback_message,group_id, business_connection_id)

Parâmetros:

! platform_id - identificador do cliente no Telegram

! callback_message - texto da mensagem de callback

group_id - identificador do bot do Telegram

tg_business - para trabalhar com clientes business, o valor "1" é passado.

Este é um exemplo com os parâmetros obrigatórios:

Este é um exemplo com os parâmetros opcionais:

tg_callback('73704021', 'callback TEST123')

tg_callback(platform_id, 'callback TEST123', None, 1)

Como adicionar um redirecionamento de bot com uma tag em resposta a um botão de callback?

tg_callback_url_open(callback_query_id, url)

Parâmetros: \ ! callback_query_id - este id permite identificar a pessoa que pressionou o botão e mostrar a ela uma notificação de Alerta,\ ! url - URL- especificando o bot e o parâmetro (parece: t.me/your_bot?start=XXXX, em vez de your_bot - nome do bot)

Como enviar mensagem para o cliente

message() | platform_message() | whatsapp_message()

Para armazenar texto com quebras de linha em uma variável, defina o valor da seguinte forma:

text = "Texto da primeira linha" + "\n" + "Texto da segunda linha" + "\n" +"Texto da terceira linha"

message(client_id, text, message_id, timeout)

Parâmetros:\ ! client_id - identificador do cliente\ ! text - texto da mensagem
message_id - o ID do bloco. Se você deixar o campo de texto vazio (") e preencher este parâmetro, o texto do bloco especificado será enviado ao cliente.

Nota: Se você passar o parâmetro message_id para a função message, o bloco ainda será executado completamente, e o cliente especificado no parâmetro client_id será movido para o bloco que você passou em message_id.

timeout - atraso da mensagem ou horário de envio agendado. Você pode usar o parâmetro timeout para atrasar o envio da mensagem:
a) Um atraso em segundos (até 3600 segundos). Se o valor exceder 3600, a mensagem será enviada em uma hora. Se o valor for negativo, a mensagem será enviada imediatamente. Exemplo: timeout = 50

b) Uma data e hora específicas no formato dd.mm.aaaa hh:mm, exemplo: timeout = '03.04.2022 15:00' . Se uma data passada for especificada, a mensagem será enviada imediatamente.

platform_message(platform_id, text, client_type, message_id, timeout,group_id)

Parâmetros:\ ! platform_id - identificador do cliente no mensageiro\ ! text - texto da mensagem
client_type - tipo de mensageiro, parâmetro opcional. Se não for especificado, o cliente será pesquisado no mesmo mensageiro do qual o bot envia a mensagem. Se for especificado, o cliente será encontrado no banco de dados do mensageiro especificado. Você pode encontrar os tipos de mensageiro aqui.
message_id - ID do bloco. Se for especificado, o cliente receberá a mensagem do bloco especificado, não o valor do parâmetro text.
timeout - horário de envio ou atraso. É semelhante ao parâmetro da função message() de mesmo nome.
group_id - identificador do bot

whatsapp_message(phone, text, message_id)

Parâmetros:\ ! phone- o número de telefone do cliente onde o Whatsapp está registrado\ ! text - texto da mensagem
message_id - é o ID do bloco. Se o campo de texto for deixado vazio ('') e este parâmetro for definido, o cliente receberá o conteúdo da mensagem do bloco especificado.

O bot do Whatsapp precisa estar conectado ao projeto.

Um exemplo simples de envio de mensagem por client_id:

Diferentes opções para enviar uma mensagem por client_id:

Exemplo de envio de mensagem via platform_message():

/*Enviando uma mensagem por client_id*/
message(73704021, 'Texto da mensagem para o cliente')
/*Enviando uma mensagem por client_id com um atraso de 30 segundos*/
message(73704021, 'Olá! Obrigado por escrever..','',30)
/*Enviando uma mensagem do bloco 3190 por client_id em 03.04.2022 às 15h*/
message(73704021, '',3190, '03.04.2022 15h')

/*Enviando mensagem no Whatsapp*/
whatsapp_message('79999999999', 'Texto da mensagem para o cliente')

Obtendo client_id pelo valor de platform_id

get_client_id_by_platform_id()

get_client_id_by_platform_id(client_type, platform_id , group)

Após a execução, a função retornará o client_id se um cliente correspondente às condições especificadas for encontrado; caso contrário, retornará None.

! client_type - mensageiro. Para o valor de client_type, leia este artigo.

! platform_id - ID do cliente no mensageiro especificado.

group - é um parâmetro obrigatório se mais de um bot de mensageiro estiver conectado.

Se vários mensageiros do mesmo tipo estiverem conectados no projeto, a pesquisa será baseada em todos os mensageiros conectados deste tipo.

Neste caso, recomendamos passar o parâmetro group.

Função para requisições get: requests_get(url, answer_type, headers, params, auth, proxy)

! url - é um link para onde a requisição é feita

answer_type – é um parâmetro opcional que define o que deve ser retornado da resposta do servidor: ('status' – retorna o código de status da resposta; 'json' – retorna o corpo json da resposta; 'text' – retorna o texto bruto da resposta; qualquer outro valor (incluindo o padrão) retorna uma resposta no formato: '{"status": status_code, "data": data}')

headers - é um parâmetro opcional para passar cabeçalhos da requisição,

params - são parâmetros da requisição get (também podem ser incluídos diretamente na URL),

auth - é um parâmetro opcional útil para autenticação de API. Se você não quiser usar nenhum parâmetro opcional, mas precisar do próximo, passe 0 aqui.

proxy - é um parâmetro opcional; aceita um valor: "de", que roteia a requisição através de um endereço IP europeu.

Funções para requisições post

requests_post(url, answer_type, headers, data, json_data, auth, proxy)

! url - é um link para onde a requisição é feita,

answer_type - é um parâmetro opcional que define o que deve ser retornado da resposta do servidor: ('status' – retorna o código de status da resposta; 'json' – retorna o corpo json da resposta; 'text' – retorna o texto bruto da resposta; qualquer outro valor (incluindo o padrão) retorna uma resposta no formato: '{"status": status_code, "data": data}')

headers - é um parâmetro opcional para passar cabeçalhos da requisição

data - é um parâmetro opcional; representa o corpo da requisição quando a API não funciona com json.

json_data - é um parâmetro opcional; também representa o corpo da requisição. Você deve usar apenas um desses parâmetros por vez.

Observe: certas configurações de cabeçalho podem bloquear o envio da requisição com um tipo específico de corpo.

auth - é um parâmetro opcional útil para autenticação de API. Se você não quiser usar nenhum parâmetro opcional, mas precisar do próximo, passe 0 aqui

proxy - é um parâmetro opcional; aceita um valor: "de", que roteia a requisição através de um endereço IP europeu.

Funções para requisições put

requests_put(url, answer_type, headers, data, auth, proxy)

! url - é um link para onde a requisição é feita

headers - é um parâmetro opcional para passar cabeçalhos da requisição

data - é um parâmetro opcional; representa o corpo da requisição quando a API não funciona com json.

auth - é um parâmetro opcional útil para autenticação de API. Se você não quiser usar nenhum parâmetro opcional, mas precisar do próximo, passe 0 aqui

proxy - é um parâmetro opcional; aceita um valor: "de", que roteia a requisição através de um endereço IP europeu.

data_is_json é um parâmetro opcional.
Se definido, os dados passados em data serão enviados em formato JSON.
Para ativá-lo, passe '1'.

Funções para requisições patch

requests_patch(url, answer_type, headers, data, auth, proxy)

! url - é um link para onde a requisição é feita

headers - é um parâmetro opcional para passar cabeçalhos da requisição

data - é um parâmetro opcional; representa o corpo da requisição quando a API não funciona com json.

auth - é um parâmetro opcional útil para autenticação de API. Se você não quiser usar nenhum parâmetro opcional, mas precisar do próximo, passe 0 aqui

proxy - é um parâmetro opcional; aceita um valor: "de", que roteia a requisição através de um endereço IP europeu.

Funções para requisições delete

requests_delete(url, answer_type, headers, data, json_data, auth, proxy)

! url - é um link para onde a requisição é feita

headers - é um parâmetro opcional para passar cabeçalhos da requisição

data - é um parâmetro opcional; representa o corpo da requisição quando a API não funciona com json.

json_data - é opcional e também pode ser usado como corpo da requisição. No entanto, apenas uma opção deve ser usada por vez

auth - é um parâmetro opcional útil para autenticação de API. Se você não quiser usar nenhum parâmetro opcional, mas precisar do próximo, passe 0 aqui

proxy - é um parâmetro opcional; aceita um valor: "de", que roteia a requisição através de um endereço IP europeu.

Função para obter o nome do bloco pelo seu ID

get_block_name_by_id(block_id)

! block_id — identificador (id) do bloco