accordous/z-api-client

There is no license information available for the latest version (v1.0.2) of this package.

Client for Z-API

v1.0.2 2023-04-22 21:13 UTC

This package is auto-updated.

Last update: 2024-04-24 18:46:57 UTC


README

Esse pacote auxilia no consumo da API do Z-API utilizando Laravel.

Documentação: Z-API - Manual API.

Instalação

composer require accordous/z-api-client

Configuração

  • Publique o arquivo de configuração caso tenha interesse em alterar algum dos valores pré-definidos
php artisan vendor:publish --tag=Z-API
  • Altere as configurações no arquivo .env do seu projeto Laravel
Z_API_HOST='https://api.z-api.io'

Recursos

  • Obter situação da instância /status

get

use Accordous\ZAPIClient\Services\ZAPIService;

$service = new ZAPIService($instanciaId, $instanciaToken);

$response = $service->instance()->situacao();

$result = $response->json();
  • Reiniciar instância /restart

get

use Accordous\ZAPIClient\Services\ZAPIService;

$service = new ZAPIService($instanciaId, $instanciaToken);

$response = $service->instance()->reiniciar();

$result = $response->json();

Recursos

  • Enviar texto simples /send-text

post

use Accordous\ZAPIClient\Services\ZAPIService;

$service = new ZAPIService($instanciaId, $instanciaToken);

$attributes = [
    'phone' => '5511999999999',
    'message' => 'Welcome to *Z-API*',
];

$response = $service->messages()->enviarTextoSimples($attributes);

$result = $response->json();