Cadastro

Módulo Link

Criação e gerenciamento de links curtos. Com as funções deste módulo, você pode encurtar URLs longos para uso em seus envios de SMS.

Métodos de API

Criar link curto
https://api.mobizon.com.br/service/Link/Create

Excluir links curtos
https://api.mobizon.com.br/service/Link/Delete

Obter dados básicos do link curto
https://api.mobizon.com.br/service/Link/Get

Obter links curtos da campanha
https://api.mobizon.com.br/service/Link/GetLinks

Obter estatísticas de cliques nos links
https://api.mobizon.com.br/service/Link/GetStats

Obter lista de links
https://api.mobizon.com.br/service/Link/List

Editar dados do link curto
https://api.mobizon.com.br/service/Link/Update

Criar link curto

https://api.mobizon.com.br/service/Link/Create

Este método destina-se à criação de links curtos.

Parâmetros da requisição

data array – Parâmetros do link

ParâmetroTipoDescrição
data[fullLink]stringLink completo.
O link que deve ser encurtado no formato de uma URL válida.
Exemplo: https://help.mobizon.com/api-docs/sms-api?utm_campaign=docs&utm_source=help&utm_medium=test#server-response-format ou www.mobizon.com
data[status]integerStatus do link curto:
0 – link inativo;
1 – link ativo (definido por padrão).
data[expirationDate]dateData de expiração do link.
O link será válido até o final do dia especificado no fuso horário do usuário.
Por padrão, a validade do link não é limitada.
Formato: AAAA-MM-DD.
data[comment]stringComentário do link.
Graças a este campo, é possível encontrar facilmente um link curto entre outros.
Exemplo: "Descontos da Black Friday" ou "Lembrete de saldo negativo".
O comprimento máximo do comentário é de 255 caracteres.

Resposta do servidor

array: Dados do link curto criado

CampoTipoDescrição
idintegerIdentificador do link.
codestringCódigo do link curto.
shortLinkstringLink curto.

Códigos de resposta da API

CódigoDescrição
0Link curto criado com sucesso.
1Se algum parâmetro contiver valores inválidos.

Examples

curl -X POST \
  'https://api.mobizon.com.br/service/link/create?output=json&api=v1&apiKey=KKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKK' \
  -H 'cache-control: no-cache' \
  -H 'content-type: application/x-www-form-urlencoded' \
  -d 'data%5BfullLink%5D=http%3A%2F%2Fmobizon.com.br&data%5Bstatus%5D=1&data%5BexpirationDate%5D=2026-12-31&data%5Bcomment%5D=Coment%C3%A1rio+do+link'
var data = "data%5BfullLink%5D=http%3A%2F%2Fmobizon.com.br&data%5Bstatus%5D=1&data%5BexpirationDate%5D=2026-12-31&data%5Bcomment%5D=Coment%C3%A1rio+do+link";

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
if (this.readyState === 4) {
console.log(this.responseText);
}
});

xhr.open("POST", "https://api.mobizon.com.br/service/link/create?output=json&api=v1&apiKey=KKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKK");
xhr.setRequestHeader("content-type", "application/x-www-form-urlencoded");
xhr.setRequestHeader("cache-control", "no-cache");

xhr.send(data);
<?php
use Mobizon\MobizonApi;

$api = new MobizonApi('KKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKK', 'api.mobizon.com.br');

// Chamada do método API
if ($api->call(
    'link',
    'create',
    array(
        'data' => array(
            //link completo
            'fullLink' => 'http://mobizon.com.br',
            //status do link
            'status' => '1',
            //data de expiração do link
            'expirationDate' => '2026-12-31',
            //comentário do link
            'comment' => 'Comentário do link'
        )
    )
)
) {
    // Obtenção do resultado da execução do método
    $result = $api->getData();
} else {
    // Ocorreu um erro durante a execução, exibição do código de erro e do texto da mensagem
    echo '[' . $api->getCode() . '] ' . $api->getMessage() . PHP_EOL;
}

Excluir links curtos

https://api.mobizon.com.br/service/Link/Delete

Este método destina-se à exclusão de links curtos.

Parâmetros da requisição

ParâmetroTipoDescrição
idsarrayIdentificadores dos links.

Resposta do servidor

Array de dados

CampoTipoDescrição
processedarrayIdentificadores dos links excluídos.
notProcessedarrayIdentificadores dos links não excluídos.

Examples

curl -X POST \
  'https://api.mobizon.com.br/service/link/delete?output=json&api=v1&apiKey=KKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKK' \
  -H 'cache-control: no-cache' \
  -H 'content-type: application/x-www-form-urlencoded' \
  -d 'ids%5B0%5D=123&ids%5B1%5D=455&ids%5B2%5D=567'
var data = "ids%5B0%5D=123&ids%5B1%5D=455&ids%5B2%5D=567";

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
if (this.readyState === 4) {
console.log(this.responseText);
}
});

xhr.open("POST", "https://api.mobizon.com.br/service/link/delete?output=json&api=v1&apiKey=KKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKK");
xhr.setRequestHeader("content-type", "application/x-www-form-urlencoded");
xhr.setRequestHeader("cache-control", "no-cache");

xhr.send(data);
<?php
use Mobizon\MobizonApi;

$api = new MobizonApi('KKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKK', 'api.mobizon.com.br');

// Chamada do método API
if ($api->call(
    'link',
    'delete',
    array(
        //identificadores dos links
        'ids' => array(
            '123',
            '455',
            '567'
        )
    )
)
) {
    // Obtenção do resultado da execução do método
    $result = $api->getData();
} else {
    // Ocorreu um erro durante a execução, exibição do código de erro e do texto da mensagem
    echo '[' . $api->getCode() . '] ' . $api->getMessage() . PHP_EOL;
}

Obter dados básicos do link curto

https://api.mobizon.com.br/service/Link/Get

Este método permite obter os dados básicos de um link curto através de um de seus três parâmetros: id, code, shortLink.

Em uma única requisição, é possível obter os dados de apenas um link curto.

Parâmetros da requisição

Para obter os dados, deve-se passar um dos parâmetros:

ParâmetroTipoDescrição
idintegerIdentificador do link.
codestringCódigo do link curto.
Combinação de caracteres única para cada link curto.
Localizado no final do link curto.
Exemplo: http://mbz.im/mgjf, onde mgjf é o código do link curto.
shortLinkstringLink curto.
URL criada pelo nosso serviço que, ao ser acessada, redirecionará seus visitantes para o link originalmente definido por você.
Exemplo: http://mbz.im/mgjf.

Resposta do servidor

Array de dados

CampoTipoDescrição
idintegerIdentificador do link.
statusintegerStatus definido pelo usuário:
0 – link inativo;
1 – link ativo.
moderatorStatusintegerStatus definido pelo administrador:
0 – bloqueado pelo administrador;
1 – confirmado pelo administrador.
clickCntintegerNúmero de cliques no link curto.
createTsstringHora de criação do link curto.
Formato: AAAA-MM-DD HH-MM-SS.
moderatorStatusintegerStatus de moderação do link (0 – bloqueado, 1 – confirmado).
expirationDatestringData de expiração do link curto.
Formato: AAAA-MM-DD.
Se a data não estiver definida – o valor do campo é NULL.
codestringCódigo do link curto.
fullLinkstringLink completo.
shortLinkstringLink curto.
commentstringComentário do usuário para o link curto.
Se o comentário estiver ausente – o valor do campo é NULL.
moderatorCommentstringComentário do moderador.
Se o comentário estiver ausente – o valor do campo é NULL.

Códigos de resposta da API

CódigoDescrição
0Dados básicos do link curto obtidos com sucesso.
2Se o link com o identificador especificado não for encontrado.
12Se nenhum dos parâmetros for passado.

Examples

curl -X POST \
  'https://api.mobizon.com.br/service/link/get?output=json&api=v1&apiKey=KKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKK' \
  -H 'cache-control: no-cache' \
  -H 'content-type: application/x-www-form-urlencoded' \
  -d 'code=zxc'
var data = "code=zxc";

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
if (this.readyState === 4) {
console.log(this.responseText);
}
});

xhr.open("POST", "https://api.mobizon.com.br/service/link/get?output=json&api=v1&apiKey=KKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKK");
xhr.setRequestHeader("content-type", "application/x-www-form-urlencoded");
xhr.setRequestHeader("cache-control", "no-cache");

xhr.send(data);
<?php
use Mobizon\MobizonApi;

$api = new MobizonApi('KKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKK', 'api.mobizon.com.br');

// Chamada do método API
if ($api->call(
    'link',
    'get',
    array(
        //código do link curto
        'code' => 'zxc'
    )
)
) {
    // Obtenção do resultado da execução do método
    $result = $api->getData();
} else {
    // Ocorreu um erro durante a execução, exibição do código de erro e do texto da mensagem
    echo '[' . $api->getCode() . '] ' . $api->getMessage() . PHP_EOL;
}

Obter links curtos da campanha

https://api.mobizon.com.br/service/Link/GetLinks

Este método permite obter informações e estatísticas da lista de links curtos de uma campanha.

Parâmetros da requisição

ParâmetroTipoDescrição
campaignIdintegerIdentificador da campanha.

Resposta do servidor

Estrutura do objeto de link: array de links curtos, no qual cada elemento contém os seguintes campos:

CampoTipoDescrição
idintegerIdentificador do link curto.
codestringCódigo do link curto.
fullLinkstringLink completo.
shortLinkstringLink curto.
clickCntintegerNúmero de cliques no link curto.
redirectCntintegerNúmero de redirecionamentos pelo link curto.
commentstringComentário do usuário para o link curto.

Códigos de resposta da API

CódigoDescrição
0Links curtos da campanha obtidos com sucesso.
2Se a campanha não for encontrada.

Obter estatísticas de cliques nos links

https://api.mobizon.com.br/service/Link/GetStats

Este método destina-se a obter estatísticas de cliques para um ou mais links curtos por seus IDs.

Os dados podem ser agrupados por meses, dias, horas, minutos.

Parâmetros da requisição

ParâmetroTipoDescrição
idsarrayIdentificadores dos links.
O número máximo de IDs na requisição é 5.
Sintaxe do parâmetro: ids[] para cada identificador.
typestringTipo de estatística solicitada.
Permite obter dados em diferentes intervalos de tempo:
monthly – número de cliques por mês. O intervalo máximo para obter estatísticas é de 3 anos;
daily – número de cliques por dia. O intervalo máximo para obter estatísticas é de 90 dias;
hourly – número de cliques por hora. O intervalo máximo para obter estatísticas é de 1 semana;
minute – número de cliques por minuto. O intervalo máximo para obter estatísticas é de 3 horas.
criteriaarrayCritérios de busca (consulte a tabela Critérios de busca).

Critérios de busca

A busca de dados estatísticos é formada com base na data e hora especificadas.

ParâmetroTipoDescrição
criteria[dateFrom]stringExtrair estatísticas a partir da data e hora especificadas.
Formato: AAAA-MM-DD HH:MM:SS.
criteria[dateTo]stringExtrair estatísticas até a data e hora especificadas.
Formato: AAAA-MM-DD HH:MM:SS.

Importante: se os critérios de busca dateFrom e dateTo não estiverem definidos, as estatísticas do campo type serão extraídas para o último intervalo máximo possível.

Se apenas um critério dateFrom estiver definido ou se o intervalo de tempo entre dateFrom e dateTo exceder o intervalo máximo permitido, as estatísticas serão extraídas pelo intervalo máximo permitido a partir da data dateFrom.

Se apenas o critério dateTo estiver definido, as estatísticas serão extraídas pelo período máximo possível até a data dateTo.

Resposta do servidor

Array de dados:

CampoTipoDescrição
itemsarrayDados estatísticos.
totalsstringNúmero total de cliques durante o período solicitado.

Códigos de resposta da API

CódigoDescrição
0Estatísticas obtidas com sucesso.
12Se mais de 5 identificadores de links forem especificados ou se o tipo de estatística estiver incorreto.

Examples

curl -X POST \
  'https://api.mobizon.com.br/service/link/getStats?output=json&api=v1&apiKey=KKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKK' \
  -H 'cache-control: no-cache' \
  -H 'content-type: application/x-www-form-urlencoded' \
  -d 'ids%5B0%5D=123&ids%5B1%5D=455&ids%5B2%5D=567&type=monthly&criteria%5BdateFrom%5D=2018-01-21+13%3A30%3A00'
var data = "ids%5B0%5D=123&ids%5B1%5D=455&ids%5B2%5D=567&type=monthly&criteria%5BdateFrom%5D=2018-01-21+13%3A30%3A00";

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
if (this.readyState === 4) {
console.log(this.responseText);
}
});

xhr.open("POST", "https://api.mobizon.com.br/service/link/getStats?output=json&api=v1&apiKey=KKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKK");
xhr.setRequestHeader("content-type", "application/x-www-form-urlencoded");
xhr.setRequestHeader("cache-control", "no-cache");

xhr.send(data);
<?php
use Mobizon\MobizonApi;

$api = new MobizonApi('KKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKK', 'api.mobizon.com.br');

// Chamada do método API
if ($api->call(
    'link',
    'getStats',
    array(
        //identificadores dos links
        'ids' => array(
            '123',
            '455',
            '567'
        ),
        //tipo de estatística
        'type' => 'monthly',
        //critérios de busca
        'criteria' => array(
            'dateFrom' => '2018-01-21 13:30:00'
        )
    )
)
) {
    // Obtenção do resultado da execução do método
    $result = $api->getData();
} else {
    // Ocorreu um erro durante a execução, exibição do código de erro e do texto da mensagem
    echo '[' . $api->getCode() . '] ' . $api->getMessage() . PHP_EOL;
}

Obter lista de links

https://api.mobizon.com.br/service/Link/List

Este método permite obter uma lista de links curtos criados. A busca pode ser realizada por ID e dados dos campos do link curto.

Parâmetros da requisição

ParâmetroTipoDescrição
criteriaarrayCritérios de busca (consulte a tabela Critérios de busca).
paginationarrayParâmetros de paginação (consulte a tabela Parâmetros de paginação).
sortarrayParâmetros de ordenação (consulte a tabela Parâmetros de ordenação).

Critérios de busca

Informações sobre os campos do link curto pelos quais a busca é realizada. Para a busca, pode-se usar tanto um único campo quanto um conjunto de campos.

ParâmetroTipoDescrição
criteria[status]integerBusca pelo status do link curto:
0 – link inativo;
1 – link ativo.
criteria[moderatorStatus]integerBusca pelo status de moderação do link:
0 – bloqueado;
1 – permitido.
criteria[createTsFrom]datetimeBusca pela data de criação do link, a partir da data especificada.
Formato: AAAA-MM-DD.
criteria[createTsTo]datetimeBusca pela data e hora de criação do link até a data e hora especificadas.
Formato: AAAA-MM-DD HH:MM:SS.
criteria[query]stringBusca por vários atributos do link.
A busca pode ser realizada por:
Código do link curto;
Código de rastreamento do destinatário;
Comentário do link curto.

Parâmetros de paginação

Estes parâmetros são destinados à saída estruturada (parcial) da informação solicitada.

ParâmetroTipoDescrição
pagination[pageSize]integerNúmero de elementos exibidos por página (25, 50, 100).
pagination[currentPage]integerPágina atual
A numeração das páginas começa em 0.

Parâmetros de ordenação

Com esses parâmetros, você pode ordenar os resultados da busca por um dos campos em ordem crescente (ASC) ou decrescente (DESC).

Exemplo:

Ordenação pelo código do link curto em ordem crescente – sort[code]=ASC.
Ordenação pelo link original em ordem decrescente – sort[fullLink]=DESC.

ParâmetroDescrição
sort[createTs]Ordenação pela data e hora de criação do link.
Formato: AAAA-MM-DD HH-MM-SS.
sort[expirationDate]Ordenação pela data de expiração do link.
Formato: AAAA-MM-DD.
sort[clickCnt]Ordenação pelo número de cliques.
sort[code]Ordenação pelo código do link curto.
sort[fullLink]Ordenação pelo link original.

Resposta do servidor

Array de dados:

CampoTipoDescrição
itemsarrayLista de links encontrados.
Consulte a descrição dos campos dos links curtos na descrição do método Link/Get.
totalItemCountintegerNúmero total de elementos encontrados.

Examples

curl -X POST \
  'https://api.mobizon.com.br/service/link/list?output=json&api=v1&apiKey=KKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKK' \
  -H 'cache-control: no-cache' \
  -H 'content-type: application/x-www-form-urlencoded' \
  -d 'criteria%5Bstatus%5D=1&criteria%5BmoderatorStatus%5D=1&pagination%5BcurrentPage%5D=2&pagination%5BpageSize%5D=50&sort%5BclickCnt%5D=ASC'
var data = "criteria%5Bstatus%5D=1&criteria%5BmoderatorStatus%5D=1&pagination%5BcurrentPage%5D=2&pagination%5BpageSize%5D=50&sort%5BclickCnt%5D=ASC";

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
if (this.readyState === 4) {
console.log(this.responseText);
}
});

xhr.open("POST", "https://api.mobizon.com.br/service/link/list?output=json&api=v1&apiKey=KKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKK");
xhr.setRequestHeader("content-type", "application/x-www-form-urlencoded");
xhr.setRequestHeader("cache-control", "no-cache");

xhr.send(data);
<?php
use Mobizon\MobizonApi;

$api = new MobizonApi('KKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKK', 'api.mobizon.com.br');

// Chamada do método API
if ($api->call(
    'link',
    'list',
    array(
        //critérios de busca
        'criteria' => array(
            //apenas links ativos
            'status' => '1',
            //links permitidos pelo moderador
            'moderatorStatus' => '1'
        ),
        //parâmetros de pagination
        'pagination' => array(
            //página atual
            'currentPage' => '2',
            //número de elementos exibidos por página
            'pageSize' => '50'
        ),
        //parâmetros de ordenação
        'sort' => array(
            //ordenação por número de cliques em ordem crescente
            'clickCnt' => 'ASC'
        )
    )
)
) {
    // Obtenção do resultado da execução do método
    $result = $api->getData();
} else {
    // Ocorreu um erro durante a execução, exibição do código de erro e do texto da mensagem
    echo '[' . $api->getCode() . '] ' . $api->getMessage() . PHP_EOL;
}

Editar dados do link curto

https://api.mobizon.com.br/service/Link/Update

Este método permite alterar os parâmetros de um link curto criado.

Parâmetros da requisição

ParâmetroTipoDescrição
idintegerIdentificador do link.
dataintegerOs parâmetros editáveis do link estão listados na tabela Parâmetros do link.

Parâmetros do link

ParâmetroTipoDescrição
data[status]integerStatus do link curto:
0 – link inativo;
1 – link ativo.
data[expirationDate]dateData de expiração do link curto.
Formato: AAAA-MM-DD.
Se o valor não for passado – a validade do link será ilimitada.
data[comment]stringComentário do link.
O comprimento máximo do comentário é de 255 caracteres.

Resposta do servidor

string – Link curto.

Códigos de resposta da API

CódigoDescrição
0Parâmetros alterados com sucesso.
1Se algum parâmetro contiver valores inválidos.
2Se o link com o identificador especificado não for encontrado.

Examples

curl -X POST \
  'https://api.mobizon.com.br/service/link/update?output=json&api=v1&apiKey=KKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKK' \
  -H 'cache-control: no-cache' \
  -H 'content-type: application/x-www-form-urlencoded' \
  -d 'id=123&data%5Bstatus%5D=0'
var data = "id=123&data%5Bstatus%5D=0";

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
if (this.readyState === 4) {
console.log(this.responseText);
}
});

xhr.open("POST", "https://api.mobizon.com.br/service/link/update?output=json&api=v1&apiKey=KKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKK");
xhr.setRequestHeader("content-type", "application/x-www-form-urlencoded");
xhr.setRequestHeader("cache-control", "no-cache");

xhr.send(data);
<?php
use Mobizon\MobizonApi;

$api = new MobizonApi('KKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKK', 'api.mobizon.com.br');

// Chamada do método API
if ($api->call(
    'link',
    'update',
    array(
        //identificador do link
        'id' => '123',
        'data' => array(
            //status do link
            'status' => '0'
        )
    )
)
) {
    // Obtenção do resultado da execução do método
    $result = $api->getData();
} else {
    // Ocorreu um erro durante a execução, exibição do código de erro e do texto da mensagem
    echo '[' . $api->getCode() . '] ' . $api->getMessage() . PHP_EOL;
}