Obtendo Mensagens

Instancie o objeto da classe do pacote SDK PHP:

<?php

require 'vendor/autoload.php';

use ZapMeSdk\Base as ZapMeSdk;

$zapMeSdk = (new ZapMeSdk())
            ->withApi('SUA_API_AQUI')
            ->withSecret('SUA_CHAVE_SECRETA_AQUI');

No exemplo acima altere:

• SUA_API_AQUI - para sua credencial de API

• SUA_CHAVE_SECRETA_AQUI - para sua credencial de Chave Secreta

Obtendo Mensagens

Recupere as mensagens da seguinte forma:

$zapMeSdk->getMessages();

A resposta será um objeto jSON como este:

{
    "status": true,
    "result": "success",
    "date": "2022-08-01 03:00:04",
    "data": [
        {
            "id": 1,
            "hash": "e763e2cc00485335b619",
            "message": "Inventore consequuntur incidunt occaecati dolorem. Nobis numquam voluptas necessitatibus ut deleniti. In aliquid quod iusto ipsam molestiae possimus maxime. Excepturi eveniet qui distinctio nihil quibusdam voluptate.",
            "phone": "9621891589608",
            "type": "api",
            "status": "missing_number",
            "created_at": "2022-08-01 02:12:16",
            "updated_at": "2022-08-01 02:12:16"
        },
        {
            "id": 2,
            "hash": "32a3b457ea993e4a0e23",
            "message": "Ex iure deserunt voluptas totam minus sit cum laboriosam. Sint aut hic delectus reiciendis aut reiciendis autem. Amet illum facilis earum molestiae. Odio soluta accusamus numquam ratione ipsam.",
            "phone": "7930790068646",
            "type": "api",
            "status": "missing_number",
            "created_at": "2022-08-01 02:12:16",
            "updated_at": "2022-08-01 02:12:16"
        },
    ]
}

Aviso

Sem a paginação definida, a quantidade máxima retornada será de 50 mensagens.

Obtendo Mensagens (Paginação)

Recupere as mensagens com paginação da seguinte forma:

$zapMeSdk->getMessages(true, 1, 1);

A resposta será um objeto jSON como este:

{
    "status": true,
    "result": "success",
    "date": "2022-08-01 03:00:04",
    "data": [
        {
            "id": 1,
            "hash": "e763e2cc00485335b619",
            "message": "Inventore consequuntur incidunt occaecati dolorem. Nobis numquam voluptas necessitatibus ut deleniti. In aliquid quod iusto ipsam molestiae possimus maxime. Excepturi eveniet qui distinctio nihil quibusdam voluptate.",
            "phone": "9621891589608",
            "type": "api",
            "status": "missing_number",
            "created_at": "2022-08-01 02:12:16",
            "updated_at": "2022-08-01 02:12:16"
        },
    ]
}

Aviso

O primeiro parâmetro do método getMessages será true para indicar que a paginação está ativa. O segundo parâmetro será a página atual e o terceiro parâmetro será a quantidade de mensagens por página. Caso não haja mais resultados a serem exibidos o retorno do parâmetro data será vazio.

Tratamento de Casos de Erros

Ao emitir uma requisição para a API da ZapMe, independente do método utilizado, uma série de validações será aplicada afim de verificar se todos os requisitos necessários atendem as expectativas. Se você perceber que a requisição retornou com o status como false, o result irá conter um identificador do tipo do erro e haverá uma chave chamada: error correspondendo a um array com as descrições sobre o erro:

{
    "status": false,
    "result": "invalid_credential",
    "date": "2022-08-01 01:54:33",
    "error": [
        "credenciais invalidas"
    ]
}

Consulte a guia Tratamento de Erros para mais informações.