ApiBrasil.Messaging.Evolution (APIBrasil v0.0.1)

Copy Markdown View Source

Evolution API (device-based): POST /evolution/{controller}/{action}.

Exige Authorization: Bearer + header DeviceToken.

# controller + action
{:ok, _envelope} =
  ApiBrasil.Messaging.Evolution.request(client, "message", "sendText", %{
    "number" => "5511999999999",
    "text" => "Olá!"
  })

# caminho completo do catálogo
{:ok, _envelope} = ApiBrasil.Messaging.Evolution.call(client, "instance/create", body)

# a mesma chamada, por fila
{:ok, _envelope} =
  ApiBrasil.Messaging.Evolution.queue(client, "message", "sendText", body)

Exemplos de controller/action: instance/create, message/sendText. Os caminhos documentados estão em ApiBrasil.Generated.Catalog.evolution_paths/0 e em https://doc.apibrasil.io.

Summary

Types

result()

Functions

call(client, path, body \\ nil, opts \\ [])

Executa um caminho completo do catálogo: POST /evolution/{path}.

call!(client, path, body \\ nil, opts \\ [])

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

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

Executa a mesma chamada de forma assíncrona, por fila: POST /evolution/{controller}/{action}/queue.

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

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

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

Executa POST /evolution/{controller}/{action}.

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

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

Types

result()

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

Functions

call(client, path, body \\ nil, opts \\ [])

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

Executa um caminho completo do catálogo: POST /evolution/{path}.

ApiBrasil.Messaging.Evolution.call(client, "chat/findChats", body)

call!(client, path, body \\ nil, opts \\ [])

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

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

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

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

Executa a mesma chamada de forma assíncrona, por fila: POST /evolution/{controller}/{action}/queue.

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

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

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

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

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

Executa POST /evolution/{controller}/{action}.

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

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

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