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.
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
https://api.mobizon.com.br/service/Link/Create
Este método destina-se à criação de links curtos.
data array – Parâmetros do link
| Parâmetro | Tipo | Descrição |
|---|---|---|
data[fullLink] | string | Link 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] | integer | Status do link curto: 0 – link inativo; 1 – link ativo (definido por padrão). |
data[expirationDate] | date | Data 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] | string | Comentá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. |
array: Dados do link curto criado
| Campo | Tipo | Descrição |
|---|---|---|
id | integer | Identificador do link. |
code | string | Código do link curto. |
shortLink | string | Link curto. |
| Código | Descrição |
|---|---|
| 0 | Link curto criado com sucesso. |
| 1 | Se algum parâmetro contiver valores inválidos. |
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;
}
https://api.mobizon.com.br/service/Link/Delete
Este método destina-se à exclusão de links curtos.
| Parâmetro | Tipo | Descrição |
|---|---|---|
ids | array | Identificadores dos links. |
Array de dados
| Campo | Tipo | Descrição |
|---|---|---|
processed | array | Identificadores dos links excluídos. |
notProcessed | array | Identificadores dos links não excluídos. |
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;
}
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.
Para obter os dados, deve-se passar um dos parâmetros:
| Parâmetro | Tipo | Descrição |
|---|---|---|
id | integer | Identificador do link. |
code | string | Có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. |
shortLink | string | Link 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. |
Array de dados
| Campo | Tipo | Descrição |
|---|---|---|
id | integer | Identificador do link. |
status | integer | Status definido pelo usuário: 0 – link inativo; 1 – link ativo. |
moderatorStatus | integer | Status definido pelo administrador: 0 – bloqueado pelo administrador; 1 – confirmado pelo administrador. |
clickCnt | integer | Número de cliques no link curto. |
createTs | string | Hora de criação do link curto. Formato: AAAA-MM-DD HH-MM-SS. |
moderatorStatus | integer | Status de moderação do link (0 – bloqueado, 1 – confirmado). |
expirationDate | string | Data de expiração do link curto. Formato: AAAA-MM-DD.Se a data não estiver definida – o valor do campo é NULL. |
code | string | Código do link curto. |
fullLink | string | Link completo. |
shortLink | string | Link curto. |
comment | string | Comentário do usuário para o link curto. Se o comentário estiver ausente – o valor do campo é NULL. |
moderatorComment | string | Comentário do moderador. Se o comentário estiver ausente – o valor do campo é NULL. |
| Código | Descrição |
|---|---|
| 0 | Dados básicos do link curto obtidos com sucesso. |
| 2 | Se o link com o identificador especificado não for encontrado. |
| 12 | Se nenhum dos parâmetros for passado. |
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;
}
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âmetro | Tipo | Descrição |
|---|---|---|
campaignId | integer | Identificador da campanha. |
Estrutura do objeto de link: array de links curtos, no qual cada elemento contém os seguintes campos:
| Campo | Tipo | Descrição |
|---|---|---|
id | integer | Identificador do link curto. |
code | string | Código do link curto. |
fullLink | string | Link completo. |
shortLink | string | Link curto. |
clickCnt | integer | Número de cliques no link curto. |
redirectCnt | integer | Número de redirecionamentos pelo link curto. |
comment | string | Comentário do usuário para o link curto. |
| Código | Descrição |
|---|---|
| 0 | Links curtos da campanha obtidos com sucesso. |
| 2 | Se a campanha não for encontrada. |
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âmetro | Tipo | Descrição |
|---|---|---|
ids | array | Identificadores dos links. O número máximo de IDs na requisição é 5. Sintaxe do parâmetro: ids[] para cada identificador. |
type | string | Tipo 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. |
criteria | array | Critérios de busca (consulte a tabela Critérios de busca). |
A busca de dados estatísticos é formada com base na data e hora especificadas.
| Parâmetro | Tipo | Descrição |
|---|---|---|
criteria[dateFrom] | string | Extrair estatísticas a partir da data e hora especificadas. Formato: AAAA-MM-DD HH:MM:SS. |
criteria[dateTo] | string | Extrair 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.
Array de dados:
| Campo | Tipo | Descrição |
|---|---|---|
items | array | Dados estatísticos. |
totals | string | Número total de cliques durante o período solicitado. |
| Código | Descrição |
|---|---|
| 0 | Estatísticas obtidas com sucesso. |
| 12 | Se mais de 5 identificadores de links forem especificados ou se o tipo de estatística estiver incorreto. |
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;
}
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âmetro | Tipo | Descrição |
|---|---|---|
criteria | array | Critérios de busca (consulte a tabela Critérios de busca). |
pagination | array | Parâmetros de paginação (consulte a tabela Parâmetros de paginação). |
sort | array | Parâmetros de ordenação (consulte a tabela Parâmetros de ordenação). |
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âmetro | Tipo | Descrição |
|---|---|---|
criteria[status] | integer | Busca pelo status do link curto: 0 – link inativo; 1 – link ativo. |
criteria[moderatorStatus] | integer | Busca pelo status de moderação do link: 0 – bloqueado; 1 – permitido. |
criteria[createTsFrom] | datetime | Busca pela data de criação do link, a partir da data especificada. Formato: AAAA-MM-DD. |
criteria[createTsTo] | datetime | Busca pela data e hora de criação do link até a data e hora especificadas. Formato: AAAA-MM-DD HH:MM:SS. |
criteria[query] | string | Busca 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. |
Estes parâmetros são destinados à saída estruturada (parcial) da informação solicitada.
| Parâmetro | Tipo | Descrição |
|---|---|---|
pagination[pageSize] | integer | Número de elementos exibidos por página (25, 50, 100). |
pagination[currentPage] | integer | Página atual A numeração das páginas começa em 0. |
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âmetro | Descriçã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. |
Array de dados:
| Campo | Tipo | Descrição |
|---|---|---|
items | array | Lista de links encontrados. Consulte a descrição dos campos dos links curtos na descrição do método Link/Get. |
totalItemCount | integer | Número total de elementos encontrados. |
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;
}
https://api.mobizon.com.br/service/Link/Update
Este método permite alterar os parâmetros de um link curto criado.
| Parâmetro | Tipo | Descrição |
|---|---|---|
id | integer | Identificador do link. |
data | integer | Os parâmetros editáveis do link estão listados na tabela Parâmetros do link. |
| Parâmetro | Tipo | Descrição |
|---|---|---|
data[status] | integer | Status do link curto: 0 – link inativo; 1 – link ativo. |
data[expirationDate] | date | Data 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] | string | Comentário do link. O comprimento máximo do comentário é de 255 caracteres. |
string – Link curto.
| Código | Descrição |
|---|---|
| 0 | Parâmetros alterados com sucesso. |
| 1 | Se algum parâmetro contiver valores inválidos. |
| 2 | Se o link com o identificador especificado não for encontrado. |
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;
}