ApiBrasil.Messaging.WhatsMeow (APIBrasil v0.0.1)

Copy Markdown View Source

API WhatsMeow (device-based): POST /whatsmeow/{action}.

Exige Authorization: Bearer + header DeviceToken.

{:ok, _envelope} = ApiBrasil.Messaging.WhatsMeow.instance_create(client, body)

{:ok, _envelope} =
  ApiBrasil.Messaging.WhatsMeow.send_text(client, %{
    "number" => "5511999999999",
    "text" => "Olá!"
  })

Além das funções nomeadas, request/4 aceita qualquer action do catálogo e queue/4 executa a mesma action por fila. As actions conhecidas estão em ApiBrasil.Generated.Catalog.service_actions("whatsmeow").

Summary

Functions

Conecta a instância: POST /whatsmeow/instance/connect.

Como instance_connect/3, mas devolve o resultado direto e levanta ApiBrasil.Core.Error em caso de falha.

Cria uma instância: POST /whatsmeow/instance/create.

Como instance_create/3, mas devolve o resultado direto e levanta ApiBrasil.Core.Error em caso de falha.

QR Code da instância: POST /whatsmeow/instance/qr.

Como instance_qr/3, mas devolve o resultado direto e levanta ApiBrasil.Core.Error em caso de falha.

Executa a action de forma assíncrona, por fila: POST /whatsmeow/{action}/queue.

Executa qualquer action do serviço: POST /whatsmeow/{action}.

Envia uma mídia: POST /whatsmeow/send/media.

Como send_media/3, mas devolve o resultado direto e levanta ApiBrasil.Core.Error em caso de falha.

Envia uma mensagem de texto: POST /whatsmeow/send/text.

Como send_text/3, mas devolve o resultado direto e levanta ApiBrasil.Core.Error em caso de falha.

Serviço do gateway coberto por este módulo: whatsmeow.

Types

result()

@type result() :: {:ok, map()} | {:error, ApiBrasil.Core.Error.t()}

Functions

instance_connect(client, body \\ nil, opts \\ [])

@spec instance_connect(ApiBrasil.Client.t(), term(), keyword()) ::
  {:ok, ApiBrasil.Core.DeviceResponse.t()} | {:error, ApiBrasil.Core.Error.t()}

Conecta a instância: POST /whatsmeow/instance/connect.

instance_connect!(client, body \\ nil, opts \\ [])

@spec instance_connect!(ApiBrasil.Client.t(), term(), keyword()) ::
  ApiBrasil.Core.DeviceResponse.t()

Como instance_connect/3, mas devolve o resultado direto e levanta ApiBrasil.Core.Error em caso de falha.

instance_create(client, body \\ nil, opts \\ [])

@spec instance_create(ApiBrasil.Client.t(), term(), keyword()) ::
  {:ok, ApiBrasil.Core.DeviceResponse.t()} | {:error, ApiBrasil.Core.Error.t()}

Cria uma instância: POST /whatsmeow/instance/create.

instance_create!(client, body \\ nil, opts \\ [])

@spec instance_create!(ApiBrasil.Client.t(), term(), keyword()) ::
  ApiBrasil.Core.DeviceResponse.t()

Como instance_create/3, mas devolve o resultado direto e levanta ApiBrasil.Core.Error em caso de falha.

instance_qr(client, body \\ nil, opts \\ [])

@spec instance_qr(ApiBrasil.Client.t(), term(), keyword()) ::
  {:ok, ApiBrasil.Core.DeviceResponse.t()} | {:error, ApiBrasil.Core.Error.t()}

QR Code da instância: POST /whatsmeow/instance/qr.

instance_qr!(client, body \\ nil, opts \\ [])

Como instance_qr/3, mas devolve o resultado direto e levanta ApiBrasil.Core.Error em caso de falha.

queue(client, action_name, body \\ nil, opts \\ [])

Executa a action de forma assíncrona, por fila: POST /whatsmeow/{action}/queue.

queue!(client, action_name, body \\ nil, opts \\ [])

Como queue/4, mas levanta ApiBrasil.Core.Error em caso de falha.

request(client, action_name, body \\ nil, opts \\ [])

Executa qualquer action do serviço: POST /whatsmeow/{action}.

As actions conhecidas estão em ApiBrasil.Generated.Catalog.service_actions("whatsmeow"); a documentação completa fica em https://doc.apibrasil.io.

request!(client, action_name, body \\ nil, opts \\ [])

Como request/4, mas levanta ApiBrasil.Core.Error em caso de falha.

send_media(client, body \\ nil, opts \\ [])

@spec send_media(ApiBrasil.Client.t(), term(), keyword()) ::
  {:ok, ApiBrasil.Core.DeviceResponse.t()} | {:error, ApiBrasil.Core.Error.t()}

Envia uma mídia: POST /whatsmeow/send/media.

send_media!(client, body \\ nil, opts \\ [])

Como send_media/3, mas devolve o resultado direto e levanta ApiBrasil.Core.Error em caso de falha.

send_text(client, body \\ nil, opts \\ [])

@spec send_text(ApiBrasil.Client.t(), term(), keyword()) ::
  {:ok, ApiBrasil.Core.DeviceResponse.t()} | {:error, ApiBrasil.Core.Error.t()}

Envia uma mensagem de texto: POST /whatsmeow/send/text.

send_text!(client, body \\ nil, opts \\ [])

Como send_text/3, mas devolve o resultado direto e levanta ApiBrasil.Core.Error em caso de falha.

service()

@spec service() :: String.t()

Serviço do gateway coberto por este módulo: whatsmeow.