Comparação de Páginas

Caso tenha duvida de como realizar uma requisição na API, clique aqui.

É possível importar toda a API do Mensageria diretamente da nossa documentação que está disponível na plataforma, clique aqui.

Endpoint
buscar/contatos

seq

parâmetro

valor

descrição

1

Authorization

string

Informações
Esta documentação irá auxilar em como utilizar este campo, clique aqui.

2

mshash

String

Código identificador de cliente.

Informações
Para saber como ter acesso ao mshash, clique aqui.

3

busca

string

String de busca

4

limit

string

Limite de itens retornados a partir do offset

5

offset

string

Ponteiro que indica o item inicial da lista retornada

6

sort

string

Array de itens, separados por virgula, com os campos a serem usados como ordenação. no formato "+nome,-id" onde o + significa ascendente e - descedente, campos de ordenação permitidos id, token, matricula, localizador, nome, sexo, data_nascimento, telefone, email, estado, cidade, plataforma, plataforma_versao, optout_push, optout_sms, optout_email, optout_push_motivo,optout_sms_motivo, optout_email_motivo, empresa, data_criacao, data_primeiro_login

7

agrupar_localizador

boolean

Flag que agrupa ou não os resultados de um mesmo localizador caso ele seja diferente de nulo

8

agrupar_localizador_anterior

boolean

Agrupa na busca, também pelo localizador anterior do usuário, é utilizado para resultados de busca que consideram os logouts do usuário.

9

id_lista_tokens

integer

Busca em apenas uma lista específica

Informações

Dica: Para este metodo, basta utilizar os parametros de: Authorization, mshash e id_lista_tokens.

Desta forma terá um retorno de busca mais genérico.

Exemplo de retorno:

Bloco de código

{
    "status": true,
    "data": [
        {
            "id": 14772331,
            "localizador": null,
            "matricula": null,
            "token": "APA91bEmMdBL_gmWJNyXHVSo0ISOKamkNMr_48AiCls4ghxWcw1sLOJ-tKtXgQwdXlP80LAD1TkzFkcawvofPZBAuFfnBuu_IKhsMwRXSjplJp3CAuUklQnaWkH2RN6eK2cRFrqul7ntHVsFKzKdqyiPaw0E176RoA",
            "device_token_anterior": null,
            "last_gcm_cycle": "2021-01-25 01:01:00",
            "sexo": null,
            "device_tipo": 0,
            "telefone": null,
            "nome": null,
            "plataforma": 1,
            "optout_sms": 0,
            "cidade": null,
            "optout_push_motivo": null,
            "data_primeiro_login": null,
            "id_operadora": 30,
            "gcm_verificado": null,
            "data_criacao": "2021-01-24 22:32:42",
            "optout_sms_motivo": null,
            "localizador_anterior": null,
            "optout_push": 0,
            "optout_email": null,
            "estado": null,
            "plataforma_versao": 28,
            "id_aplicacao": 4,
            "email": null,
            "data_nascimento": null,
            "optout_email_motivo": null,
            "empresa": null,
            "instalacoes": 1,
            "localizador_id": 14772331
        }
    ],
    "critica": [
        null
    ],
    "timestamp": "2021-01-25T09:52:35-03:00",
    "msg": null
}

Um abraço!

Versões comparadas

Versão antiga 1

Nova versão 2

Chave