Autenticação

Cada pedido realizado terá de incluir a autenticação do cliente. A API suporta dois métodos de autenticação, que podem ser utilizados indistintamente:

Autenticação básica HTTP, com o seu utilizador e a sua apiPassword.
API Key, com a chave de API da sua conta.

Autenticação básica HTTP

A autenticação é incluída no cabeçalho do pedido http utilizando uma autenticação de acesso básico HTTP.

O cabeçalho de autorização é construído a partir da combinação utilizador:apiPassword, codificando-a em base64. A esta combinação antepõe-se Authorization: Basic

Por exemplo, para o utilizador username e a palavra-passe apiPassword o cabeçalho resultante seria:

Authorization: Basic dXNlcm5hbWU6YXBpUGFzc3dvcmQ=

Exemplo de pedido com autenticação básica HTTP:

curl -X GET '{{DASHBOARD_HOST}}/api/rest/account' \
-H 'Content-Type: application/json' \
-H 'Authorization: Basic YOUR_AUTH_TOKEN'

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => '{{DASHBOARD_HOST}}/api/rest/account',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/json',
    'Authorization: Basic YOUR_AUTH_TOKEN',
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

import java.io.DataOutputStream;
import java.io.BufferedReader;
import java.io.InputStreamReader;
import java.net.URL;
import java.net.HttpsURLConnection;

public class App {
  public static void main(String[] args) {
    try {
      URL url = new URL("{{DASHBOARD_HOST}}/api/rest/account");
      HttpsURLConnection connection = (HttpsURLConnection) url.openConnection();
      connection.setRequestMethod("GET");
      connection.setRequestProperty("Authorization", "Basic YOUR_AUTH_TOKEN");
      connection.setRequestProperty("Accept", "application/json");
      BufferedReader in = new BufferedReader(new InputStreamReader(connection.getInputStream()));
      String inputLine;
      StringBuffer response = new StringBuffer();
      while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
      }
      in.close();
      System.out.println(response.toString());
    } catch (Exception e) {
      // TODO: handle exception
    }
  }
}

var axios = require('axios');
var config = {
  method: 'get',
  url: '{{DASHBOARD_HOST}}/api/rest/account',
  headers: {
    'Content-Type': 'application/json',
    'Authorization': 'Basic YOUR_AUTH_TOKEN'
  }
};

axios(config)
.then(function (response) {
  console.log(JSON.stringify(response.data));
})
.catch(function (error) {
  console.log(error);
});

import requests

url = "{{DASHBOARD_HOST}}/api/rest/account"

payload = {}
headers = {
  'Content-Type': 'application/json',
  'Authorization': 'Basic YOUR_AUTH_TOKEN'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

require "uri"
require "net/http"

url = URI("{{DASHBOARD_HOST}}/api/rest/account")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Content-Type"] = "application/json"
request["Authorization"] = "Basic YOUR_AUTH_TOKEN"

response = https.request(request)
puts response.read_body

using System;
using RestSharp;
namespace HelloWorldApplication {
  class HelloWorld {
    static void Main(string[] args) {
      var client = new RestClient("{{DASHBOARD_HOST}}/api/rest/account");
      client.Timeout = -1;
      var request = new RestRequest(Method.GET);
      request.AddHeader("Authorization", "Basic YOUR_AUTH_TOKEN");
      request.AddHeader("Content-Type", "application/json");
      IRestResponse response = client.Execute(request);
      Console.WriteLine(response.Content);
    }
  }
}

API Key

Como alternativa à autenticação básica, pode autenticar os seus pedidos com a API Key da sua conta. Não é necessário indicar o utilizador: a API Key identifica, por si só, a conta.

A API Key é enviada no cabeçalho X-Api-Key do pedido http, tal como está, sem qualquer codificação.

Por exemplo, para a API Key YOUR_API_KEY o cabeçalho resultante seria:

X-Api-Key: YOUR_API_KEY

Exemplo de pedido com API Key:

curl -X GET '{{DASHBOARD_HOST}}/api/rest/account' \
-H 'Content-Type: application/json' \
-H 'X-Api-Key: YOUR_API_KEY'

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => '{{DASHBOARD_HOST}}/api/rest/account',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/json',
    'X-Api-Key: YOUR_API_KEY',
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

import java.io.DataOutputStream;
import java.io.BufferedReader;
import java.io.InputStreamReader;
import java.net.URL;
import java.net.HttpsURLConnection;

public class App {
  public static void main(String[] args) {
    try {
      URL url = new URL("{{DASHBOARD_HOST}}/api/rest/account");
      HttpsURLConnection connection = (HttpsURLConnection) url.openConnection();
      connection.setRequestMethod("GET");
      connection.setRequestProperty("X-Api-Key", "YOUR_API_KEY");
      connection.setRequestProperty("Accept", "application/json");
      BufferedReader in = new BufferedReader(new InputStreamReader(connection.getInputStream()));
      String inputLine;
      StringBuffer response = new StringBuffer();
      while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
      }
      in.close();
      System.out.println(response.toString());
    } catch (Exception e) {
      // TODO: handle exception
    }
  }
}

var axios = require('axios');
var config = {
  method: 'get',
  url: '{{DASHBOARD_HOST}}/api/rest/account',
  headers: {
    'Content-Type': 'application/json',
    'X-Api-Key': 'YOUR_API_KEY'
  }
};

axios(config)
.then(function (response) {
  console.log(JSON.stringify(response.data));
})
.catch(function (error) {
  console.log(error);
});

import requests

url = "{{DASHBOARD_HOST}}/api/rest/account"

payload = {}
headers = {
  'Content-Type': 'application/json',
  'X-Api-Key': 'YOUR_API_KEY'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

require "uri"
require "net/http"

url = URI("{{DASHBOARD_HOST}}/api/rest/account")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Content-Type"] = "application/json"
request["X-Api-Key"] = "YOUR_API_KEY"

response = https.request(request)
puts response.read_body

using System;
using RestSharp;
namespace HelloWorldApplication {
  class HelloWorld {
    static void Main(string[] args) {
      var client = new RestClient("{{DASHBOARD_HOST}}/api/rest/account");
      client.Timeout = -1;
      var request = new RestRequest(Method.GET);
      request.AddHeader("X-Api-Key", "YOUR_API_KEY");
      request.AddHeader("Content-Type", "application/json");
      IRestResponse response = client.Execute(request);
      Console.WriteLine(response.Content);
    }
  }
}

Campanhas

Parâmetro	Tipo	Obrigatório	Descrição
message	string	Sim	Texto da mensagem. O máximo de caracteres permitidos é 160 se não for especificado que a mensagem é multipartes (consulte o parâmetro `parts`). O texto deverá estar codificado em UTF-8.
to	array	Sim	Número de telemóvel do destinatário da mensagem. Deve-se incluir o prefixo do país do destinatário (exemplo Portugal: 351912345678). Pode-se especificar diversos destinatários através deste parâmetro.
from	string	Sim	Nome do remetente da mensagem, este parâmetro é formado por 15 caracteres numéricos ou 11 caracteres alfanuméricos. Não é permitida a utilização de caracteres especiais.
encoding	string	Não	Os valores possíveis são 'gsm', 'gsm-pt' e 'utf-16'. O valor `gsm` deve ser utilizado para envios convencionais na codificação GSM7 com até 160 caracteres por mensagem. O valor `gsm-pt` deve ser utilizado para mensagens convencionais numa codificação variante GSM7 com caracteres adicionais e até 155 caracteres por mensagem. O valor `utf-16` deve ser utilizado para envios com caracteres especiais na codificação UCS2 (UTF16) com até 70 caracteres por mensagem. O valor por defeito deste parâmetro é `gsm`.
scheduleDate	string	Não	Data de envio das mensagens em UTC. Para envios de mensagens programadas, é possível especificar a data e hora do envio no formato `YYYYmmddHHiiss` (Exemplo: 20130215142000 seria 15 de fevereiro de 2013 às 14:20). Para envios imediatos, não especifique este parâmetro.
expirationDate	string	Não	Data de validade das mensagens em UTC. Formato `YYYYmmddHHiiss` (Exemplo: 20130215142000 seria 15 de fevereiro de 2013 às 14:20).
parts	integer	Não	Este parâmetro indica o número máximo de partes que a mensagem terá no momento do envio. O valor por defeito deste parâmetro é `1`. Caso este parâmetro não seja especificado, ao enviar uma mensagem com mais de 160 caracteres em codificação GSM ou 70 caracteres na codificação UTF16, o processamento da mensagem falhará. É preciso ter em conta que mensagens concatenadas em GSM são fracionadas em partes com até 153 caracteres cada e em UTF16 em 67. Cada parte será processada e tarifada distintamente, mas ao destinatário chegará como uma única mensagem com a indicação de paginação de acordo com as limitações de cada operadora local. O nosso servidor utilizará o mínimo de partes necessárias para processar a mensagem, mesmo que seja indicado um valor alto de partes no parâmetro. Caso o número indicado seja inferior ao necessário, o envio falhará e será devolvido o código 105. O número máximo de partes permitidas é `15`.
notificationUrl	string\|array	Não	URL para o qual será feita a chamada GET com os parâmetros de resposta desejados.
trans	integer	Não	Os valores disponíveis são 1 ou 0. Ao indicar o valor 0 (este é o valor por defeito caso o parâmetro não seja especificado), o servidor não realizará nenhuma alteração nos caracteres especiais da mensagem. Com o valor 1 indicado, o servidor fará a alteração dos caracteres especiais para caracteres comuns de acordo com a seguinte regra de tradução: 'á' => 'a', 'í'=>'i', 'ó'=>'o', 'ú'=>'u', 'ç'=>'Ç', 'Á'=>'A', 'Í'=>'I', 'Ó'=>'O', 'Ú'=>'U', 'À'=>'A', 'È'=>'E', 'Ì'=>'I', 'Ò'=>'O', 'Ù'=>'U', 'º' => '', 'ª' => '', 'Õ' => 'O', 'õ' => 'o', 'â' => 'a', 'ê' => 'e', 'î'=>'i', 'ô'=>'o', 'û'=>'u', 'Â'=>'A', 'Ê'=>'E', 'Î'=>'I', 'Ô'=>'O', 'Û'=>'U', 'ã' => 'a', 'Ã' => 'A'.
campaignName	string	Não	Nome da campanha. Se especificado, será criada uma campanha com o nome indicado no painel, que conterá as estatísticas de envio. Se já existir uma campanha com este nome, as estatísticas de entrega serão adicionadas à campanha existente. Existe um limite de 10 campanhas diárias com nome personalizado. A partir da décima campanha, os envios serão automaticamente agrupados numa campanha com nome genérico, por exemplo: API_SMS_2026_01.
tags	array	Não	`campaignName` é necessário se este parâmetro for especificado. Lista de tags para adicionar à campanha. As tags podem ser usadas para filtrar as estatísticas no painel.
certified	boolean	Não	Se for especificado como `true`, a mensagem será enviada como certificada. `* Mensagens certificadas têm custo adicional`
sub	array	Não	array com variáveis de substituição que serão aplicadas à mensagem.
splitParts	boolean	Não	Para mensagens que excedem o tamanho máximo do SMS, o servidor dividirá a mensagem em vários SMS, em vez de usar o SMS concatenado. O valor por defeito é `false`.
flash	boolean	Não	Um flash SMS é uma mensagem que aparece diretamente no ecrã do dispositivo. Dependendo do modelo e do sistema operativo, é possível armazená-lo na caixa de entrada e enviar mensagens concatenadas.
shortenUrls	boolean	Não	Se especificado como `true`, os URLs incluídos no parâmetro `message` serão automaticamente encurtados antes do envio. O valor por defeito é `false`.
availableTimes	array	Não	Indique as horas em que o SMS será enviado. Os objetos json são definidos na forma: `[{"day": 1, "from": "09:00", "to": "21:00"}]` `day`: é indicado um dia no intervalo de segunda a domingo, deve ser um número entre 1 e 7. Opcional: Se não for especificado, o intervalo será aplicado a todos os dias da semana. `from`: hora que define o início do intervalo de tempo no formato UTC de 24 horas. `to`: hora que define o fim do intervalo de tempo no formato UTC de 24 horas.
otpConfig	object	Não	No caso de adicionar a variável `{OTP_CODE}` dentro do parâmetro "message", os parâmetros do código OTP podem ser especificados. Por exemplo: `{"alpha": true, "length": 5}` `alpha`: indique se o código é alfanumérico ou numérico. O valor por defeito é `false`. `length`: tamanho do código. O valor mínimo é `3` e o valor máximo é `10`. O valor por defeito é `4`. `maxAttempts`: número máximo de tentativas. O valor mínimo é `1` e o valor máximo é `10`. O valor por defeito é `3`. `maxSecondsValidity`: número máximo de segundos entre a criação e validação do código. O valor mínimo é `30` e o valor máximo é `600`. O valor por defeito é `60`. `appId`: o mesmo telefone ou e-mail pode ser validado ao mesmo tempo, desde que seja com um `appId` diferente. O valor por defeito é `""`. `rejectIfPendingCode`: impede a geração de um novo código OTP se existir um anterior em estado pendente. O valor por defeito é `false`.

Filtro	Descrição	Exemplo	Resultado
lower	Devolve o texto em `minúsculas`.	{name\|lower}	my name
upper	Devolve o texto em `maiúsculas`.	{name\|upper}	MY NAME
capitalize	Devolve o texto com `a primeira letra da primeira palavra em maiúsculas`.	{name\|capitalize}	My name
capitalizeAll	Devolve o texto com `a primeira letra de cada palavra em maiúsculas`.	{name\|capitalizeAll}	My Name
formatDotComma	Devolve o número com um `ponto` como separador de milhares e `vírgula` como separador de decimais.	{number\|formatDotComma}	1.234,56
formatCommaDot	Devolve o número com uma `vírgula` como separador de milhares e `ponto` como separador de decimais.	{number\|formatCommaDot}	1,234.56
shorten	Devolve um URL `encurtado`. Deve ser um URL válido.	{url\|shorten}	https://sms.tl/xxxxxx

Parâmetro	Tipo	Obrigatório	Descrição
id	string	Sim	Identificador da mensagem devolvido na resposta à chamada para `api/rest/sms` no campo `id`. É possível especificar vários identificadores separados por vírgulas.

Parâmetro	Tipo	Obrigatório	Descrição
body	string	Não	Corpo do email em formato `HTML` com codificação `UTF-8`. Obrigatório sem templateId.
templateId	integer	Não	ID do modelo legacy para enviar como o corpo do email. Necessário sem body. Este ID refere-se a modelos criados a partir da versão anterior ({{DASHBOARD_HOST}}) da aplicação {{NAME}}. Recomenda-se a utilização do parâmetro templateV2Id sempre que possível.
templateV2Id	integer	Não	ID do modelo para enviar como o corpo do email. Necessário sem body. Este ID refere-se à versão atual ({{HOST}}) da aplicação {{NAME}}.
to	array	Sim	Emails destinatários do envio. É permitido indicar múltiplos destinatários.
cc	array	Não	Emails destinatários em cópia do envio. É permitido indicar múltiplos destinatários.
bcc	array	Não	Emails destinatários em cópia oculta do envio. É permitido indicar múltiplos destinatários.
fromEmail	string	Sim	Email remetente. O email indicado deve estar validado na plataforma {{NAME}}.
subject	string	Sim	Breve resumo sobre o assunto da mensagem.
fromName	string	Não	Nome do remetente do envio.
replyTo	string	Sim	Endereço de e-mail para onde os destinatários poderão responder. O email indicado deve estar validado na plataforma {{NAME}}.
scheduleDate	string	Não	Data de envio das mensagens. Para envios de mensagens programadas, é possível especificar a data e hora do envio no formato `YYYYmmddHHiiss` (Exemplo: 20130215142000 seria 15 de fevereiro de 2013 às 14:20). Para envios imediatos, não especifique este parâmetro.
campaignName	string	Não	Nome da campanha. Se especificado, será criada no painel uma campanha com o nome indicado, que conterá as estatísticas de envio. Se já existir uma campanha com este nome, as estatísticas de entrega serão adicionadas à campanha existente. Existe um limite de 10 campanhas diárias com nome personalizado. A partir da décima campanha, os envios serão automaticamente agrupados numa campanha com nome genérico, por exemplo: API_MAILING_2026_01.
tags	array	Não	`campaignName` é necessário se este parâmetro for especificado. Lista de tags para adicionar à campanha. As tags podem ser usadas para filtrar as estatísticas no painel.
certified	boolean	Não	Se for especificado como `true`, a mensagem será enviada como certificada. `* Mensagens certificadas têm custo adicional`
sub	array	Não	array com variáveis de substituição que serão aplicadas à mensagem.
attachments	array	Não	Anexos do email. Um array de objetos é definido da seguinte forma: `[{ "name": "filename.txt", "content": "Ci4vYmluL3pvb2tlZ...", "contentType": "text/plain" }]` `name`: nome do ficheiro. `content`: conteúdo do ficheiro em base64. `contentType`: Content type do ficheiro. `* Os anexos têm um custo adicional`
trackOpens	boolean	Não	Adicione um pixel para obter estatísticas de abertura. O valor por defeito é `true`.
trackClicks	boolean	Não	Monitorize os links para obter estatísticas de cliques. O valor por defeito é `true`.
otpConfig	object	Não	No caso de adicionar a variável `{OTP_CODE}` dentro do parâmetro "body", é possível especificar os parâmetros do código OTP. Por exemplo: `{"alpha": true, "length": 5}` `alpha`: indique se o código é alfanumérico ou numérico. O valor por defeito é `false`. `length`: tamanho do código. O valor mínimo é `3` e o valor máximo é `10`. O valor por defeito é `4`. `maxAttempts`: número máximo de tentativas. O valor mínimo é `1` e o valor máximo é `10`. O valor por defeito é `3`. `maxSecondsValidity`: número máximo de segundos entre a criação e a validação do código. O valor mínimo é `30` e o valor máximo é `600`. O valor por defeito é `60`. `appId`: o mesmo telefone ou e-mail pode ser validado ao mesmo tempo, desde que seja com um `appId` diferente. O valor por defeito é `""`. `rejectIfPendingCode`: impede a geração de um novo código OTP se existir um anterior em estado pendente. O valor por defeito é `false`.

Parâmetro	Tipo	Obrigatório	Descrição
message	string	Sim	Corpo da mensagem. Pode conter no máximo 500 caracteres. O texto deve ser codificado em `UTF-8`.
to	array	Sim	Número do telemóvel destinatário da mensagem. Deve incluir o prefixo (Ex.: em Espanha 34666666666). Este campo permite-lhe especificar vários destinatários.
language	string	Sim	Idioma para converter o texto, as opções são: 'en_GB': Inglês - Reino Unido, 'en_US': Inglês - Estados Unidos, 'es_ES': Espanhol - Espanha, 'es_US': Espanhol - Latino, 'pt_PT': Português - Portugal, 'pt_BR': Português - Brasil, 'cmn_CN': Chinês mandarim - China , 'arb': Árabe , 'de_DE': Alemão - Alemanha, 'fr_FR': Francês - França, 'it_IT': Italiano - Itália, 'hi_IN': Hindi - Índia . ` Disponível apenas no género feminino.`
gender	string	Sim	Género da voz, os valores permitidos são 'F' para voz de mulher e 'M' para voz de homem.
callers	object	Não	Objeto com a lista de remetentes personalizados por país para utilizar na chamada. Se o remetente não for especificado para um país específico, será utilizado o remetente predefinido. Para configurar um remetente personalizado, entre em contacto com o departamento de suporte. Exemplo: `{"ES": "6123456789", "PT": "6987654321"}`
scheduleDate	string	Não	Data de envio da mensagem em formato UTC. Caso seja necessário enviar mensagens programadas é possível especificar a data de envio indicando a data no formato `YYYYmmddHHiiss` (Exemplo: 20130215142000 seria 15 de fevereiro de 2013 às 14:20:00). Em caso de envio imediato não é necessário especificar este parâmetro.
retries	integer	Não	Número máximo de tentativas. Máximo 5. Se não for especificado, não haverá novas tentativas.
expirationDate	string	Não	Permite determinar a data máxima na qual a chamada pode ser realizada. Após este prazo, a chamada será cancelada. Especificar o período de validade ativará automaticamente as tentativas de chamada, voltando a realizá-la caso o destinatário não atenda. A data deve ter o formato `YYYYmmddHHiiss` (Exemplo: 20130215142000 seria 15 de fevereiro de 2013 às 14:20:00)
campaignName	string	Não	Nome da campanha. Caso seja especificado, será criada uma campanha com o nome indicado no painel de controlo, contendo as estatísticas do envio. Caso já exista uma campanha com este nome, as estatísticas de envio serão juntas à campanha existente.
tags	array	Não	`campaignName` é necessário caso este parâmetro seja especificado. Lista de tags a juntar à campanha. As tags podem ser utilizadas para filtrar as estatísticas no painel de controlo.
sub	array	Não	array com variáveis de substituição que serão aplicadas à mensagem.
amd	boolean	Não	Answer Machine Detection (AMD): Deteta se a chamada foi atendida por uma secretária eletrónica e, em caso afirmativo, encerra automaticamente a chamada. O valor por defeito é `false`.

Parâmetro	Tipo	Obrigatório	Descrição
to	array	Sim	Número do telemóvel destinatário da mensagem. Deve incluir o prefixo (Ex.: em Espanha 34666666666). Este campo permite-lhe especificar vários destinatários.
audioUrl	string	Sim	URL do áudio a enviar. Exemplo: https://example.com/audio.mp3.
callers	object	Não	Objeto com a lista de remetentes personalizados por país para utilizar na chamada. Se o remetente não for especificado para um país específico, será utilizado o remetente predefinido. Para configurar um remetente personalizado, entre em contacto com o departamento de suporte. Exemplo: `{"ES": "6123456789", "PT": "6987654321"}`
scheduleDate	string	Não	Data de envio da mensagem em formato UTC. Caso seja necessário enviar mensagens programadas é possível especificar a data de envio indicando a data no formato `YYYYmmddHHiiss` (Exemplo: 20130215142000 seria 15 de fevereiro de 2013 às 14:20:00). Em caso de envio imediato não é necessário especificar este parâmetro.
retries	integer	Não	Número máximo de tentativas. Máximo 5. Se não for especificado, não haverá novas tentativas.
expirationDate	string	Não	Permite determinar a data máxima na qual a chamada pode ser realizada. Após este prazo, a chamada será cancelada. Especificar o período de validade ativará automaticamente as tentativas de chamada, voltando a realizá-la caso o destinatário não atenda. A data deve ter o formato `YYYYmmddHHiiss` (Exemplo: 20130215142000 seria 15 de fevereiro de 2013 às 14:20:00)
campaignName	string	Não	Nome da campanha. Caso seja especificado, será criada uma campanha com o nome indicado no painel de controlo, contendo as estatísticas do envio. Caso já exista uma campanha com este nome, as estatísticas de envio serão juntas à campanha existente.
tags	array	Não	`campaignName` é necessário caso este parâmetro seja especificado. Lista de tags a juntar à campanha. As tags podem ser utilizadas para filtrar as estatísticas no painel de controlo.
amd	boolean	Não	Answer Machine Detection (AMD): Deteta se a chamada foi atendida por uma secretária eletrónica e, em caso afirmativo, encerra automaticamente a chamada. O valor por defeito é `false`.

Parâmetro	Tipo	Obrigatório	Descrição
message	string	Sim	Texto da mensagem. O máximo de caracteres permitidos é 160 se não for especificado que a mensagem é multipartes (consulte o parâmetro `parts`). O texto deverá estar codificado em UTF-8.
to	array	Sim	Número de telemóvel do destinatário da mensagem. Deve-se incluir o prefixo do país do destinatário (exemplo Portugal: 351912345678). Pode-se especificar diversos destinatários através deste parâmetro.
from	string	Sim	Nome do remetente da mensagem, este parâmetro é formado por 15 caracteres numéricos ou 11 caracteres alfanuméricos. Não é permitida a utilização de caracteres especiais.
encoding	string	Não	Os valores possíveis são 'gsm', 'gsm-pt' e 'utf-16'. O valor `gsm` deve ser utilizado para envios convencionais na codificação GSM7 com até 160 caracteres por mensagem. O valor `gsm-pt` deve ser utilizado para mensagens convencionais numa codificação variante GSM7 com caracteres adicionais e até 155 caracteres por mensagem. O valor `utf-16` deve ser utilizado para envios com caracteres especiais na codificação UCS2 (UTF16) com até 70 caracteres por mensagem. O valor por defeito deste parâmetro é `gsm`.
scheduleDate	string	Não	Data de envio das mensagens em UTC. Para envios de mensagens programadas, é possível especificar a data e hora do envio no formato `YYYYmmddHHiiss` (Exemplo: 20130215142000 seria 15 de fevereiro de 2013 às 14:20). Para envios imediatos, não especifique este parâmetro.
expirationDate	string	Não	Data de validade das mensagens em UTC. Formato `YYYYmmddHHiiss` (Exemplo: 20130215142000 seria 15 de fevereiro de 2013 às 14:20).
parts	integer	Não	Este parâmetro indica o número máximo de partes que a mensagem terá no momento do envio. O valor por defeito deste parâmetro é 1. Caso este parâmetro não seja especificado, ao enviar uma mensagem com mais de 160 caracteres em codificação GSM ou 70 caracteres na codificação UTF16, o processamento da mensagem falhará. É preciso ter em conta que mensagens concatenadas em GSM são fracionadas em partes com até 153 caracteres cada e em UTF16 em 67. Cada parte será processada e tarifada distintamente, mas ao destinatário chegará como uma única mensagem com a indicação de paginação de acordo com as limitações de cada operadora local. O nosso servidor utilizará o mínimo de partes necessárias para processar a mensagem, mesmo que seja indicado um valor alto de partes no parâmetro. Caso o número indicado seja inferior ao necessário, o envio falhará e será devolvido o código 105. O número máximo de partes permitidas é 8.
notificationUrl	string	Não	URL para o qual será feita a chamada GET com os parâmetros de resposta desejados.
trans	integer	Não	Os valores disponíveis são 1 ou 0. Ao indicar o valor 0 (este é o valor por defeito caso o parâmetro não seja especificado), o servidor não realizará nenhuma alteração nos caracteres especiais da mensagem. Com o valor 1 indicado, o servidor fará a alteração dos caracteres especiais para caracteres comuns de acordo com a seguinte regra de tradução: 'á' => 'a', 'í'=>'i', 'ó'=>'o', 'ú'=>'u', 'ç'=>'Ç', 'Á'=>'A', 'Í'=>'I', 'Ó'=>'O', 'Ú'=>'U', 'À'=>'A', 'È'=>'E', 'Ì'=>'I', 'Ò'=>'O', 'Ù'=>'U', 'º' => '', 'ª' => '', 'Õ' => 'O', 'õ' => 'o', 'â' => 'a', 'ê' => 'e', 'î'=>'i', 'ô'=>'o', 'û'=>'u', 'Â'=>'A', 'Ê'=>'E', 'Î'=>'I', 'Ô'=>'O', 'Û'=>'U', 'ã' => 'a', 'Ã' => 'A'
campaignName	string	Não	Nome da campanha. Se especificado, será criada uma campanha com o nome indicado no painel, que conterá as estatísticas de envio. Se já existir uma campanha com este nome, as estatísticas de entrega serão adicionadas à campanha existente. Existe um limite de 10 campanhas diárias com nome personalizado. A partir da décima campanha, os envios serão automaticamente agrupados numa campanha com nome genérico, por exemplo: API_SMS_2026_01.
tags	array	Não	`campaignName` é necessário se este parâmetro for especificado. Lista de tags para adicionar à campanha. As tags podem ser usadas para filtrar as estatísticas no painel.
certified	boolean	Não	Se for especificado como `true`, a mensagem será enviada como certificada. `* Mensagens certificadas têm custo adicional`
sub	array	Não	array com variáveis de substituição que serão aplicadas à mensagem.
splitParts	boolean	Não	Para mensagens que excedem o tamanho máximo do SMS, o servidor dividirá a mensagem em vários SMS, em vez de usar o SMS concatenado. O valor por defeito é `false`.
flash	boolean	Não	Um flash SMS é uma mensagem que aparece diretamente no ecrã do dispositivo. Dependendo do modelo e do sistema operativo, é possível armazená-lo na caixa de entrada e enviar mensagens concatenadas.
templateBody	string	Não	O conteúdo da página de destino em formato `HTML` e codificação `UTF-8`. Obrigatório sem templateId.
templateId	integer	Não	ID do modelo legacy para enviar como conteúdo da página de destino. Obrigatório sem templateBody. Este ID refere-se a modelos criados a partir da versão anterior ({{DASHBOARD_HOST}}) da aplicação {{NAME}}. Recomenda-se a utilização do parâmetro templateV2Id sempre que possível.
templateV2Id	integer	Não	ID do modelo para enviar como conteúdo da página de destino. Obrigatório sem templateBody. Este ID refere-se à versão atual ({{HOST}}) da aplicação {{NAME}}.

Filtro	Descrição	Exemplo	Resultado
lower	Devolve o texto em `minúsculas`.	{name\|lower}	my name
upper	Devolve o texto em `maiúsculas`.	{name\|upper}	MY NAME
capitalize	Devolve o texto com `a primeira letra da primeira palavra em maiúsculas`.	{name\|capitalize}	My name
capitalizeAll	Devolve o texto com `a primeira letra de cada palavra em maiúsculas`.	{name\|capitalizeAll}	My Name
formatDotComma	Devolve o número com um `ponto` como separador de milhares e `vírgula` como separador de decimais.	{number\|formatDotComma}	1.234,56
formatCommaDot	Devolve o número com uma `vírgula` como separador de milhares e `ponto` como separador de decimais.	{number\|formatCommaDot}	1,234.56
shorten	Devolve um URL `encurtado`. Deve ser um URL válido.	{url\|shorten}	https://sms.tl/xxxxxx

Parâmetro	Tipo	Obrigatório	Descrição
templateId	integer	Sim	ID do modelo WhatsApp a enviar. O modelo deve ser aprovado para envio a partir da plataforma.
from	string	Sim	Remetente da mensagem. O remetente deve estar registado na plataforma.
messages	array	Sim	Conjunto de mensagens a enviar.
messages.*.to	string	Sim	Número de telemóvel do destinatário da mensagem. Deve-se incluir o prefixo do país do destinatário (exemplo Portugal: 351912345678).
messages.*.headerFields	array	Não*	Matriz de variáveis de substituição posicionais a aplicar ao cabeçalho. Necessário para modelos com variáveis de cabeçalho.
messages.*.bodyFields	array	Não*	Matriz de variáveis de substituição posicionais a aplicar ao corpo da mensagem. Necessário para modelos com variáveis de mensagem.
messages.*.callToActionFields	array	Não*	Conjunto de variáveis de substituição posicionais a aplicar aos botões de interação. Necessário para modelos com variáveis de ação.
messages.*.defaultAnswer	array	Não	Resposta por defeito à primeira mensagem do utilizador.
messages.*.buttonAnswers	array	Não	Conjunto de respostas posicionais para botões de resposta rápida.
messages.*.location	object	Não*	Informações sobre a localização. Obrigatório para os modelos que contêm a localização.
messages.*.location.lat	string	Não*	Latitude do ponto geográfico. Obrigatório para os modelos que contêm a localização.
messages.*.location.long	string	Não*	Longitude do ponto geográfico. Obrigatório para os modelos que contêm a localização.
messages.*.location.name	string	Não	Nome da localização.
messages.*.location.address	string	Não	Endereço da localização.
campaignName	string	Não	Nome da campanha. Se especificado, será criada uma campanha com o nome indicado no painel, que conterá as estatísticas de envio. Se já existir uma campanha com este nome, as estatísticas de entrega serão adicionadas à campanha existente. Existe um limite de 10 campanhas diárias com nome personalizado. A partir da décima campanha, os envios serão automaticamente agrupados numa campanha com nome genérico, por exemplo: API_WHATSAPP_2026_01.
tags	array	Não	Lista de tags para adicionar à campanha. As tags podem ser usadas para filtrar as estatísticas no painel.

Parâmetro	Descrição
limit	Número total de conversas a apresentar num único pedido. Valor por defeito: `100`. Máximo: `1000`.
from	Filtrar por remetente.
to	Filtrar por destinatário.

Parâmetro	Descrição
limit	Número total de mensagens a apresentar num único pedido. Valor por defeito: `100`. Máximo: `1000`.

Parâmetro	Tipo	Obrigatório	Descrição
content	string	Sim	Conteúdo da mensagem. Pode alterar o formato de texto das suas mensagens.

Parâmetro	Descrição
limit	Número total de recursos a apresentar num único pedido. Valor por defeito: `100`. Máximo: `1000`.
beforeDate	Apresenta resultados `antes` da data especificada. A data deve ser especificada no formato `ISO 8601`. Exemplo: ?beforeDate=2019-01-01T00%3A00%3A00%2B00%3A00.
afterDate	Apresenta resultados `após` a data especificada. A data deve ser especificada no formato `ISO 8601`. Exemplo: ?afterDate=2019-01-01T00%3A00%3A00%2B00%3A00.
afterId	Apresenta os resultados após o ID especificado. Exemplo: ?afterId=12345
sourceAddr	Apresenta os resultados com o endereço de origem especificado. Exemplo: ?sourceAddr=34666666666
destAddr	Apresenta resultados com o endereço de destino especificado. Exemplo: ?destAddr=22001

Remetentes verificados

Listagem

Devolve a lista de remetentes (alias) verificados e registados na conta, indicando o canal para o qual estão ativados e o país a que corresponde o registo.

GET {{DASHBOARD_HOST}}/api/rest/senders

curl -X GET '{{DASHBOARD_HOST}}/api/rest/senders' \
-H 'Content-Type: application/json' \
-H 'Authorization: Basic YOUR_AUTH_TOKEN'

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => '{{DASHBOARD_HOST}}/api/rest/senders',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/json',
    'Authorization: Basic YOUR_AUTH_TOKEN',
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

import java.io.DataOutputStream;
import java.io.BufferedReader;
import java.io.InputStreamReader;
import java.net.URL;
import java.net.HttpsURLConnection;

public class App {
  public static void main(String[] args) {
    try {
      URL url = new URL("{{DASHBOARD_HOST}}/api/rest/senders");
      HttpsURLConnection connection = (HttpsURLConnection) url.openConnection();
      connection.setRequestMethod("GET");
      connection.setRequestProperty("Authorization", "Basic YOUR_AUTH_TOKEN");
      connection.setRequestProperty("Accept", "application/json");
      BufferedReader in = new BufferedReader(new InputStreamReader(connection.getInputStream()));
      String inputLine;
      StringBuffer response = new StringBuffer();
      while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
      }
      in.close();
      System.out.println(response.toString());
    } catch (Exception e) {
      // TODO: handle exception
    }
  }
}

var axios = require('axios');
var config = {
  method: 'get',
  url: '{{DASHBOARD_HOST}}/api/rest/senders',
  headers: {
    'Content-Type': 'application/json',
    'Authorization': 'Basic YOUR_AUTH_TOKEN'
  }
};

axios(config)
.then(function (response) {
  console.log(JSON.stringify(response.data));
})
.catch(function (error) {
  console.log(error);
});

import requests

url = "{{DASHBOARD_HOST}}/api/rest/senders"

payload = {}
headers = {
  'Content-Type': 'application/json',
  'Authorization': 'Basic YOUR_AUTH_TOKEN'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

require "uri"
require "net/http"

url = URI("{{DASHBOARD_HOST}}/api/rest/senders")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Content-Type"] = "application/json"
request["Authorization"] = "Basic YOUR_AUTH_TOKEN"

response = https.request(request)
puts response.read_body

using System;
using RestSharp;
namespace HelloWorldApplication {
  class HelloWorld {
    static void Main(string[] args) {
      var client = new RestClient("{{DASHBOARD_HOST}}/api/rest/senders");
      client.Timeout = -1;
      var request = new RestRequest(Method.GET);
      request.AddHeader("Authorization", "Basic YOUR_AUTH_TOKEN");
      request.AddHeader("Content-Type", "application/json");
      IRestResponse response = client.Execute(request);
      Console.WriteLine(response.Content);
    }
  }
}

Response

{
  "data": [
    {
      "sender": "MYBRAND",
      "type": "sms",
      "countryIso": "ES"
    }
  ]
}

Resposta

Campo	Descrição
sender	Nome do remetente registado.
type	Canal para o qual o remetente está registado. Valores possíveis: `sms`, `rcs`.
countryIso	Código ISO de 2 letras do país para o qual o remetente está registado.

Mensagens programadas

Listar

GET {{DASHBOARD_HOST}}/api/rest/scheduled

curl -X GET '{{DASHBOARD_HOST}}/api/rest/scheduled' \
-H 'Content-Type: application/json' \
-H 'Authorization: Basic YOUR_AUTH_TOKEN'

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => '{{DASHBOARD_HOST}}/api/rest/scheduled',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/json',
    'Authorization: Basic YOUR_AUTH_TOKEN',
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

import java.io.DataOutputStream;
import java.io.BufferedReader;
import java.io.InputStreamReader;
import java.net.URL;
import java.net.HttpsURLConnection;

public class App {
  public static void main(String[] args) {
    try {
      URL url = new URL("{{DASHBOARD_HOST}}/api/rest/scheduled");
      HttpsURLConnection connection = (HttpsURLConnection) url.openConnection();
      connection.setRequestMethod("GET");
      connection.setRequestProperty("Authorization", "Basic YOUR_AUTH_TOKEN");
      connection.setRequestProperty("Accept", "application/json");
      BufferedReader in = new BufferedReader(new InputStreamReader(connection.getInputStream()));
      String inputLine;
      StringBuffer response = new StringBuffer();
      while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
      }
      in.close();
      System.out.println(response.toString());
    } catch (Exception e) {
      // TODO: handle exception
    }
  }
}

var axios = require('axios');
var config = {
  method: 'get',
  url: '{{DASHBOARD_HOST}}/api/rest/scheduled',
  headers: {
    'Content-Type': 'application/json',
    'Authorization': 'Basic YOUR_AUTH_TOKEN'
  }
};

axios(config)
.then(function (response) {
  console.log(JSON.stringify(response.data));
})
.catch(function (error) {
  console.log(error);
});

import requests

url = "{{DASHBOARD_HOST}}/api/rest/scheduled"

payload = {}
headers = {
  'Content-Type': 'application/json',
  'Authorization': 'Basic YOUR_AUTH_TOKEN'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

require "uri"
require "net/http"

url = URI("{{DASHBOARD_HOST}}/api/rest/scheduled")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Content-Type"] = "application/json"
request["Authorization"] = "Basic YOUR_AUTH_TOKEN"

response = https.request(request)
puts response.read_body

using System;
using RestSharp;
namespace HelloWorldApplication {
  class HelloWorld {
    static void Main(string[] args) {
      var client = new RestClient("{{DASHBOARD_HOST}}/api/rest/scheduled");
      client.Timeout = -1;
      var request = new RestRequest(Method.GET);
      request.AddHeader("Authorization", "Basic YOUR_AUTH_TOKEN");
      request.AddHeader("Content-Type", "application/json");
      IRestResponse response = client.Execute(request);
      Console.WriteLine(response.Content);
    }
  }
}

Response

Multi GUID

{
  "result": [
    {
      "guid": "100",
      "type": "SMS",
      "sending_id": 123,
      "updated_at": "2017-09-18 10:49:12",
      "scheduled_at": "2017-11-11 10:10:10"
    },
    {
      "guid": "101",
      "type": "SMS",
      "sending_id": 123,
      "created_at": "2017-09-18 10:49:12",
      "updated_at": "2017-09-18 10:49:12",
      "scheduled_at": "2017-11-11 10:10:10"
    },
    {
      "guid": "102",
      "type": "SMS",
      "sending_id": 123,
      "created_at": "2017-09-18 10:49:12",
      "updated_at": "2017-09-18 10:49:12",
      "scheduled_at": "2017-11-11 10:10:10"
    }
  ],
  "total": 3
}

Single GUID

{
  "result": {
    "guid": "100",
    "type": "SMS",
    "content": {
        "to": "34666555444",
        "from": "SAMPLE",
        "encoding": "gsm",
        "message": "This is a test",
        "campaignId": 456,
        "sendingId": 123
    },
    "created_at": "2017-09-18 10:49:12",
    "updated_at": "2017-09-18 10:49:12",
    "scheduled_at": "2017-11-11 10:10:10"
  },
  "total": 1
}

Podem-se filtrar todos os envios programados. A lista poderá ser filtrada por tipo de envio (SMS ou MAILING) e também por GUID, relação de GUIDs ou para todos.

O conteúdo da mensagem não é mostrado na lista a não ser que seja especificado um único GUID.

Parâmetro	Tipo	Obrigatório	Descrição
guid	integer, array	Não	Identificador único de cada uma das mensagens. Podem-se indicar diversos guids agrupados num array ou nenhum para visualizar todos.
type	string	Não	`SMS` ou `MAILING`
sendingId	integer	Não	Identificador de envio.

Atualização

PUT {{DASHBOARD_HOST}}/api/rest/scheduled

curl -X PUT '{{DASHBOARD_HOST}}/api/rest/scheduled' \
-H 'Content-Type: application/json' \
-H 'Authorization: Basic YOUR_AUTH_TOKEN' \
-d '{
  "guid": [100,101],
  "scheduleDate": "20171011093000"
}'

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => '{{DASHBOARD_HOST}}/api/rest/scheduled',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => 'PUT',
  CURLOPT_POSTFIELDS => '{
  "guid": [100,101],
  "scheduleDate": "20171011093000"
}',
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/json',
    'Authorization: Basic YOUR_AUTH_TOKEN',
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

import java.io.DataOutputStream;
import java.io.BufferedReader;
import java.io.InputStreamReader;
import java.net.URL;
import java.net.HttpsURLConnection;

public class App {
  public static void main(String[] args) {
    try {
      URL url = new URL("{{DASHBOARD_HOST}}/api/rest/scheduled");
      HttpsURLConnection connection = (HttpsURLConnection) url.openConnection();
      connection.setRequestMethod("PUT");
      connection.setRequestProperty("Authorization", "Basic YOUR_AUTH_TOKEN");
      connection.setRequestProperty("Accept", "application/json");
      String requestBody = "{ \"guid\": [100,101], \"scheduleDate\": \"20171011093000\" }";
      connection.setDoOutput(true);
      DataOutputStream wr = new DataOutputStream(connection.getOutputStream());
      wr.writeBytes(requestBody);
      wr.flush();
      wr.close();
      BufferedReader in = new BufferedReader(new InputStreamReader(connection.getInputStream()));
      String inputLine;
      StringBuffer response = new StringBuffer();
      while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
      }
      in.close();
      System.out.println(response.toString());
    } catch (Exception e) {
      // TODO: handle exception
    }
  }
}

var axios = require('axios');
var config = {
  method: 'put',
  url: '{{DASHBOARD_HOST}}/api/rest/scheduled',
  headers: {
    'Content-Type': 'application/json',
    'Authorization': 'Basic YOUR_AUTH_TOKEN'
  },
  data: '{ "guid": [100,101], "scheduleDate": "20171011093000" }'
};

axios(config)
.then(function (response) {
  console.log(JSON.stringify(response.data));
})
.catch(function (error) {
  console.log(error);
});

import requests

url = "{{DASHBOARD_HOST}}/api/rest/scheduled"

payload = "{ \"guid\": [100,101], \"scheduleDate\": \"20171011093000\" }"
headers = {
  'Content-Type': 'application/json',
  'Authorization': 'Basic YOUR_AUTH_TOKEN'
}

response = requests.request("PUT", url, headers=headers, data=payload)

print(response.text)

require "uri"
require "net/http"

url = URI("{{DASHBOARD_HOST}}/api/rest/scheduled")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Content-Type"] = "application/json"
request["Authorization"] = "Basic YOUR_AUTH_TOKEN"
request.body = "{ \"guid\": [100,101], \"scheduleDate\": \"20171011093000\" }"

response = https.request(request)
puts response.read_body

using System;
using RestSharp;
namespace HelloWorldApplication {
  class HelloWorld {
    static void Main(string[] args) {
      var client = new RestClient("{{DASHBOARD_HOST}}/api/rest/scheduled");
      client.Timeout = -1;
      var request = new RestRequest(Method.PUT);
      request.AddHeader("Authorization", "Basic YOUR_AUTH_TOKEN");
      request.AddHeader("Content-Type", "application/json");
      request.AddParameter("application/json", "{ \"guid\": [100,101], \"scheduleDate\": \"20171011093000\" }",  ParameterType.RequestBody);
      IRestResponse response = client.Execute(request);
      Console.WriteLine(response.Content);
    }
  }
}

Response

{
  "result": true,
  "updated": 2
}

Atualiza a data de programação de um, vários ou todos os envios programados. Pode-se filtrar por GUID e/ou tipo de envio.

Parâmetro	Tipo	Obrigatório	Descrição
guid	integer, array	Não	Identificador da mensagem ou das mensagens. Pode indicar-se um identificador, um array de identificadores ou nenhum para os mostrar todos.
type	string	Não	`SMS` ou `MAILING`
scheduleDate	string	Sim	Data de envio da mensagem em formato UTC. Caso seja necessário enviar mensagens programadas, é possível especificar a data de envio indicando a data no formato `YYYYmmddHHiiss` (Ex.: 20130215142000 seria 15 de fevereiro de 2013 às 14:20:00). Em caso de envio imediato, não é necessário especificar este parâmetro.

Eliminar

DELETE {{DASHBOARD_HOST}}/api/rest/scheduled

curl -X DELETE '{{DASHBOARD_HOST}}/api/rest/scheduled' \
-H 'Content-Type: application/json' \
-H 'Authorization: Basic YOUR_AUTH_TOKEN' \
-d '{
  "guid": [100, 101]
}'

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => '{{DASHBOARD_HOST}}/api/rest/scheduled',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => 'DELETE',
  CURLOPT_POSTFIELDS => '{
  "guid": [100, 101]
}',
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/json',
    'Authorization: Basic YOUR_AUTH_TOKEN',
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

import java.io.DataOutputStream;
import java.io.BufferedReader;
import java.io.InputStreamReader;
import java.net.URL;
import java.net.HttpsURLConnection;

public class App {
  public static void main(String[] args) {
    try {
      URL url = new URL("{{DASHBOARD_HOST}}/api/rest/scheduled");
      HttpsURLConnection connection = (HttpsURLConnection) url.openConnection();
      connection.setRequestMethod("DELETE");
      connection.setRequestProperty("Authorization", "Basic YOUR_AUTH_TOKEN");
      connection.setRequestProperty("Accept", "application/json");
      String requestBody = "{ \"guid\": [100, 101] }";
      connection.setDoOutput(true);
      DataOutputStream wr = new DataOutputStream(connection.getOutputStream());
      wr.writeBytes(requestBody);
      wr.flush();
      wr.close();
      BufferedReader in = new BufferedReader(new InputStreamReader(connection.getInputStream()));
      String inputLine;
      StringBuffer response = new StringBuffer();
      while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
      }
      in.close();
      System.out.println(response.toString());
    } catch (Exception e) {
      // TODO: handle exception
    }
  }
}

var axios = require('axios');
var config = {
  method: 'delete',
  url: '{{DASHBOARD_HOST}}/api/rest/scheduled',
  headers: {
    'Content-Type': 'application/json',
    'Authorization': 'Basic YOUR_AUTH_TOKEN'
  },
  data: '{ "guid": [100, 101] }'
};

axios(config)
.then(function (response) {
  console.log(JSON.stringify(response.data));
})
.catch(function (error) {
  console.log(error);
});

import requests

url = "{{DASHBOARD_HOST}}/api/rest/scheduled"

payload = "{ \"guid\": [100, 101] }"
headers = {
  'Content-Type': 'application/json',
  'Authorization': 'Basic YOUR_AUTH_TOKEN'
}

response = requests.request("DELETE", url, headers=headers, data=payload)

print(response.text)

require "uri"
require "net/http"

url = URI("{{DASHBOARD_HOST}}/api/rest/scheduled")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Delete.new(url)
request["Content-Type"] = "application/json"
request["Authorization"] = "Basic YOUR_AUTH_TOKEN"
request.body = "{ \"guid\": [100, 101] }"

response = https.request(request)
puts response.read_body

using System;
using RestSharp;
namespace HelloWorldApplication {
  class HelloWorld {
    static void Main(string[] args) {
      var client = new RestClient("{{DASHBOARD_HOST}}/api/rest/scheduled");
      client.Timeout = -1;
      var request = new RestRequest(Method.DELETE);
      request.AddHeader("Authorization", "Basic YOUR_AUTH_TOKEN");
      request.AddHeader("Content-Type", "application/json");
      request.AddParameter("application/json", "{ \"guid\": [100, 101] }",  ParameterType.RequestBody);
      IRestResponse response = client.Execute(request);
      Console.WriteLine(response.Content);
    }
  }
}

Response

{
  "result": true,
  "deleted": 2
}

Elimine um, vários ou todos os envios programados. Pode-se filtrar por um ou vários GUID ou nenhum.

Parâmetro	Tipo	Obrigatório	Descrição
guid	integer, array	Não	Identificador único de cada uma das mensagens. Podem-se indicar diversos guids agrupados num array ou nenhum para eliminar todos.
type	string	Não	`SMS` ou `MAILING`

Lista de campanhas

GET {{DASHBOARD_HOST}}/api/rest/campaigns

curl -X GET '{{DASHBOARD_HOST}}/api/rest/campaigns' \
-H 'Content-Type: application/json' \
-H 'Authorization: Basic YOUR_AUTH_TOKEN'

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => '{{DASHBOARD_HOST}}/api/rest/campaigns',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/json',
    'Authorization: Basic YOUR_AUTH_TOKEN',
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

import java.io.DataOutputStream;
import java.io.BufferedReader;
import java.io.InputStreamReader;
import java.net.URL;
import java.net.HttpsURLConnection;

public class App {
  public static void main(String[] args) {
    try {
      URL url = new URL("{{DASHBOARD_HOST}}/api/rest/campaigns");
      HttpsURLConnection connection = (HttpsURLConnection) url.openConnection();
      connection.setRequestMethod("GET");
      connection.setRequestProperty("Authorization", "Basic YOUR_AUTH_TOKEN");
      connection.setRequestProperty("Accept", "application/json");
      BufferedReader in = new BufferedReader(new InputStreamReader(connection.getInputStream()));
      String inputLine;
      StringBuffer response = new StringBuffer();
      while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
      }
      in.close();
      System.out.println(response.toString());
    } catch (Exception e) {
      // TODO: handle exception
    }
  }
}

var axios = require('axios');
var config = {
  method: 'get',
  url: '{{DASHBOARD_HOST}}/api/rest/campaigns',
  headers: {
    'Content-Type': 'application/json',
    'Authorization': 'Basic YOUR_AUTH_TOKEN'
  }
};

axios(config)
.then(function (response) {
  console.log(JSON.stringify(response.data));
})
.catch(function (error) {
  console.log(error);
});

import requests

url = "{{DASHBOARD_HOST}}/api/rest/campaigns"

payload = {}
headers = {
  'Content-Type': 'application/json',
  'Authorization': 'Basic YOUR_AUTH_TOKEN'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

require "uri"
require "net/http"

url = URI("{{DASHBOARD_HOST}}/api/rest/campaigns")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Content-Type"] = "application/json"
request["Authorization"] = "Basic YOUR_AUTH_TOKEN"

response = https.request(request)
puts response.read_body

using System;
using RestSharp;
namespace HelloWorldApplication {
  class HelloWorld {
    static void Main(string[] args) {
      var client = new RestClient("{{DASHBOARD_HOST}}/api/rest/campaigns");
      client.Timeout = -1;
      var request = new RestRequest(Method.GET);
      request.AddHeader("Authorization", "Basic YOUR_AUTH_TOKEN");
      request.AddHeader("Content-Type", "application/json");
      IRestResponse response = client.Execute(request);
      Console.WriteLine(response.Content);
    }
  }
}

Response

{
  "data": [
    {
      "id": 1,
      "name": "My campaign",
      "type": "basic",
      "createdAt": "2018-12-27T11:31:16+00:00",
      "updatedAt": "2018-12-27T11:31:16+00:00",
      "links": {
        "self": "{{DASHBOARD_HOST}}/api/rest/campaigns/1",
        "sendings": "{{DASHBOARD_HOST}}/api/rest/campaigns/1/sendings"
      },
      "sendings": {
        "data": [
          {
            "id": 1,
            "campaignName": "My campaign",
            "status": "OPENED",
            "channel": "sms",
            "total": 2,
            "processed": 2,
            "totalSmsParts": 4,
            "cost": 0.02,
            "currency": "EUR",
            "tags": [],
            "scheduledAt": null,
            "expiresAt": null,
            "startedAt": null,
            "finishedAt": null,
            "createdAt": "2018-12-27T11:31:16+00:00",
            "updatedAt": "2018-12-27T11:31:22+00:00",
            "events": {
              "delivered": 2,
              "opened": 0,
              "opened_unique": 0,
              "clicked": 0,
              "clicked_unique": 0,
              "unsubscribed": 0,
              "hard_bounced": 0,
              "complaint": 0,
              "sent": 2,
              "soft_bounced": 0,
              "undelivered": 0,
              "rejected": 0,
              "expired": 0,
              "unsubscribed_landing": 0
            },
            "links": {
              "self": "{{DASHBOARD_HOST}}/api/rest/sendings/1",
              "eventsReport": "{{DASHBOARD_HOST}}/api/rest/sendings/1/reports/events"
            }
          }
        ]
      }
    }
  ]
}

Filtros

Parâmetro	Descrição
name	Filtrar por nome da campanha. É possível utilizar o carácter "" como "wildcard". Exemplo: ?name=CAMPAIGN_2020_
channel	Filtrar por canal. Valores disponíveis: `sms`, `mailing`, `landing`, `text2speech`, `voice-interactive`. Exemplo: ?channel=sms.
beforeDate	Mostrar resultados `antes` da data de criação indicada. A data deve ser especificada no formato `ISO 8601`. Exemplo: ?beforeDate=2019-01-01T00%3A00%3A00%2B00%3A00.
afterDate	Mostrar resultados `após` a data de criação indicada. A data deve ser especificada no formato `ISO 8601`. Exemplo: ?afterDate=2019-01-01T00%3A00%3A00%2B00%3A00.
updatedBeforeDate	Mostrar resultados cuja última atualização seja `antes` da data indicada. A data deve ser especificada no formato `ISO 8601`. Exemplo: ?updatedBeforeDate=2019-01-01T00%3A00%3A00%2B00%3A00.
updatedAfterDate	Mostrar resultados cuja última atualização seja `após` a data indicada. A data deve ser especificada no formato `ISO 8601`. Exemplo: ?updatedAfterDate=2019-01-01T00%3A00%3A00%2B00%3A00.

Os parâmetros devem ser codificados corretamente (urlencode) em relação ao padrão RFC 3986 para serem suportados pelo servidor.

Campos da resposta

Parâmetro	Descrição
name	Nome da campanha.
type	Tipo de campanha. Valores possíveis: `basic`, `automatic`, `trigger`, `testab`.
sendings	Listagem dos envios associados à campanha. Para campanhas do tipo `basic` e `automatic`, o número de envios será sempre 1.
sendings.*.status	Estado do envio. Valores possíveis: `PENDING`: Envio agendado para uma data futura. `SAVED`: Envio guardado. Não será enviado até que a campanha seja confirmada na plataforma. `SENDING`: Envio em processamento. `PAUSED`: Envio em pausa. `FINISHED`: Envio finalizado. `CANCELLED`: Envio cancelado. `EDITING`: O envio está a ser editado na plataforma. `OPENED`: Os envios por API indicarão este estado. Indica que o envio pode aceitar mais mensagens. `AUTOMATED`: Envio automatizado a aguardar que as condições de automação sejam cumpridas. `WAITING`: Envio `trigger` a aguardar que as condições de envio sejam cumpridas.
sendings.*.channel	Canal do envio. Valores possíveis: `sms`, `mailing`, `landing`, `text2speech`, `voice-interactive`.
sendings.*.total	Total de mensagens a enviar.
sendings.*.processed	Total de mensagens enviadas.
sendings.*.totalSmsParts	Aplicável apenas aos envios de SMS. No caso de envios concatenados, será indicado o número de partes de SMS enviadas.
sendings.*.cost	Custo do envio.
sendings.*.currency	Código da moeda para o custo.
sendings.*.tags	Tags atribuídas ao envio.
sendings.*.scheduledAt	Data de programação da campanha. Nenhuma mensagem será enviada antes desta data.
sendings.*.expiresAt	Data de expiração da campanha. Após esta data, nenhuma outra mensagem será enviada.
sendings.*.events	Resumo dos totais de eventos produzidos no envio. Eventos: `delivered`: A mensagem foi entregue ao contacto. `opened`: O contacto abriu a mensagem. Não aplicável a sms e voz. `opened_unique`: Total de aberturas únicas. Não aplicável a sms e voz. `clicked`: O contacto clicou num link incluído na mensagem. Não aplicável a sms e voz. `clicked_unique`: Total de cliques únicos. Não aplicável a sms e voz. `unsubscribed`: O contacto cancelou a subscrição da lista. `hard_bounced`: Total de hard bounces gerados pela campanha. Aplicável apenas ao envio de emails. `complaint`: O contacto marcou a mensagem como indesejada. `sent`: A mensagem foi enviada ao contacto. `soft_bounced`: Total de soft bounces gerados pela campanha. Aplicável apenas ao envio de emails. `undelivered`: Não foi possível entregar a mensagem ao contacto. `rejected`: A tentativa de enviar a mensagem foi rejeitada. `expired`: A mensagem foi rejeitada porque a data de expiração da campanha já foi atingida. `unsubscribed_landing`: O contacto cancelou a subscrição através da landing page incluída na mensagem.

Bases de dados

Contactos

Lista de contactos

GET {{DASHBOARD_HOST}}/api/rest/contacts

curl -X GET '{{DASHBOARD_HOST}}/api/rest/contacts?include=customFields,groups' \
-H 'Content-Type: application/json' \
-H 'Authorization: Basic YOUR_AUTH_TOKEN'

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => '{{DASHBOARD_HOST}}/api/rest/contacts?include=customFields,groups',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/json',
    'Authorization: Basic YOUR_AUTH_TOKEN',
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

import java.io.DataOutputStream;
import java.io.BufferedReader;
import java.io.InputStreamReader;
import java.net.URL;
import java.net.HttpsURLConnection;

public class App {
  public static void main(String[] args) {
    try {
      URL url = new URL("{{DASHBOARD_HOST}}/api/rest/contacts?include=customFields,groups");
      HttpsURLConnection connection = (HttpsURLConnection) url.openConnection();
      connection.setRequestMethod("GET");
      connection.setRequestProperty("Authorization", "Basic YOUR_AUTH_TOKEN");
      connection.setRequestProperty("Accept", "application/json");
      BufferedReader in = new BufferedReader(new InputStreamReader(connection.getInputStream()));
      String inputLine;
      StringBuffer response = new StringBuffer();
      while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
      }
      in.close();
      System.out.println(response.toString());
    } catch (Exception e) {
      // TODO: handle exception
    }
  }
}

var axios = require('axios');
var config = {
  method: 'get',
  url: '{{DASHBOARD_HOST}}/api/rest/contacts?include=customFields,groups',
  headers: {
    'Content-Type': 'application/json',
    'Authorization': 'Basic YOUR_AUTH_TOKEN'
  }
};

axios(config)
.then(function (response) {
  console.log(JSON.stringify(response.data));
})
.catch(function (error) {
  console.log(error);
});

import requests

url = "{{DASHBOARD_HOST}}/api/rest/contacts?include=customFields,groups"

payload = {}
headers = {
  'Content-Type': 'application/json',
  'Authorization': 'Basic YOUR_AUTH_TOKEN'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

require "uri"
require "net/http"

url = URI("{{DASHBOARD_HOST}}/api/rest/contacts?include=customFields,groups")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Content-Type"] = "application/json"
request["Authorization"] = "Basic YOUR_AUTH_TOKEN"

response = https.request(request)
puts response.read_body

using System;
using RestSharp;
namespace HelloWorldApplication {
  class HelloWorld {
    static void Main(string[] args) {
      var client = new RestClient("{{DASHBOARD_HOST}}/api/rest/contacts?include=customFields,groups");
      client.Timeout = -1;
      var request = new RestRequest(Method.GET);
      request.AddHeader("Authorization", "Basic YOUR_AUTH_TOKEN");
      request.AddHeader("Content-Type", "application/json");
      IRestResponse response = client.Execute(request);
      Console.WriteLine(response.Content);
    }
  }
}

Response

{
  "data": [
    {
      "id": 1,
      "email": "email@example.com",
      "phone": "34666666666",
      "countryIso": "ES",
      "landline": "900222222",
      "name": "Name",
      "surname": "Last name",
      "createdAt": "2018-03-13T14:32:25+00:00",
      "updatedAt": "2018-07-04T13:57:09+00:00",
      "customFields": {
        "data": [
          {
            "key": "color",
            "type": "string",
            "value": "green"
          }
        ]
      },
      "groups": {
        "data": [
          {
            "id": 1,
            "name": "My Contact List"
          }
        ]
      }
    }
  ],
  "meta": {
    "pagination": {
      "total": 500,
      "count": 100,
      "per_page": 100,
      "current_page": 1,
      "total_pages": 5,
      "links": {
        "next": "{{DASHBOARD_HOST}}/api/rest/contacts?include=customFields%2Cgroups&page=2"
      }
    }
  }
}

Filtros

Parâmetro	Descrição
limit	Total de contactos a exibir num único pedido. Valor por defeito: `100`. Máximo: `1000`.
include	Incluir os sub-recursos associados na resposta. É possível especificar vários valores separando-os por vírgulas. Valores disponíveis: `customFields`, `groups`.
email	Filtrar os contactos para um e-mail especificado: email=myemail@example.com.
phone	Filtrar os contactos para um telefone especificado: phone=34666666666.
landline	Filtrar os contactos para um telefone fixo especificado: landline=900222222.
countryIso	Filtrar os contactos para um país especificado: countryIso=ES.
externalId	Filtrar os contactos para um externalId especificado: externalId=EXT1.

Mostrar um contacto

GET {{DASHBOARD_HOST}}/api/rest/contacts/<ID>

curl -X GET '{{DASHBOARD_HOST}}/api/rest/contacts/1?include=customFields,groups' \
-H 'Content-Type: application/json' \
-H 'Authorization: Basic YOUR_AUTH_TOKEN'

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => '{{DASHBOARD_HOST}}/api/rest/contacts/1?include=customFields,groups',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/json',
    'Authorization: Basic YOUR_AUTH_TOKEN',
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

import java.io.DataOutputStream;
import java.io.BufferedReader;
import java.io.InputStreamReader;
import java.net.URL;
import java.net.HttpsURLConnection;

public class App {
  public static void main(String[] args) {
    try {
      URL url = new URL("{{DASHBOARD_HOST}}/api/rest/contacts/1?include=customFields,groups");
      HttpsURLConnection connection = (HttpsURLConnection) url.openConnection();
      connection.setRequestMethod("GET");
      connection.setRequestProperty("Authorization", "Basic YOUR_AUTH_TOKEN");
      connection.setRequestProperty("Accept", "application/json");
      BufferedReader in = new BufferedReader(new InputStreamReader(connection.getInputStream()));
      String inputLine;
      StringBuffer response = new StringBuffer();
      while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
      }
      in.close();
      System.out.println(response.toString());
    } catch (Exception e) {
      // TODO: handle exception
    }
  }
}

var axios = require('axios');
var config = {
  method: 'get',
  url: '{{DASHBOARD_HOST}}/api/rest/contacts/1?include=customFields,groups',
  headers: {
    'Content-Type': 'application/json',
    'Authorization': 'Basic YOUR_AUTH_TOKEN'
  }
};

axios(config)
.then(function (response) {
  console.log(JSON.stringify(response.data));
})
.catch(function (error) {
  console.log(error);
});

import requests

url = "{{DASHBOARD_HOST}}/api/rest/contacts/1?include=customFields,groups"

payload = {}
headers = {
  'Content-Type': 'application/json',
  'Authorization': 'Basic YOUR_AUTH_TOKEN'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

require "uri"
require "net/http"

url = URI("{{DASHBOARD_HOST}}/api/rest/contacts/1?include=customFields,groups")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Content-Type"] = "application/json"
request["Authorization"] = "Basic YOUR_AUTH_TOKEN"

response = https.request(request)
puts response.read_body

using System;
using RestSharp;
namespace HelloWorldApplication {
  class HelloWorld {
    static void Main(string[] args) {
      var client = new RestClient("{{DASHBOARD_HOST}}/api/rest/contacts/1?include=customFields,groups");
      client.Timeout = -1;
      var request = new RestRequest(Method.GET);
      request.AddHeader("Authorization", "Basic YOUR_AUTH_TOKEN");
      request.AddHeader("Content-Type", "application/json");
      IRestResponse response = client.Execute(request);
      Console.WriteLine(response.Content);
    }
  }
}

Response

{
  "data": {
    "id": 1,
    "email": "email@example.com",
    "phone": "34666666666",
    "countryIso": "ES",
    "landline": "900222222",
    "name": "Name",
    "surname": "Last name",
    "createdAt": "2018-03-13T14:32:25+00:00",
    "updatedAt": "2018-07-04T13:57:09+00:00",
    "customFields": {
      "data": [
        {
          "key": "color",
          "type": "string",
          "value": "green"
        }
      ]
    },
    "groups": {
      "data": [
        {
          "id": 1,
          "name": "My Contact List"
        }
      ]
    }
  }
}

Filtros

Parâmetro	Descrição
include	Incluir os sub-recursos associados na resposta. É possível especificar vários valores separando-os por vírgulas. Valores disponíveis: `customFields`, `groups`.

Criar um novo contacto

POST {{DASHBOARD_HOST}}/api/rest/contacts

curl -X POST '{{DASHBOARD_HOST}}/api/rest/contacts' \
-H 'Content-Type: application/json' \
-H 'Authorization: Basic YOUR_AUTH_TOKEN' \
-d '{
    "email": "new.contact@example.com",
    "phone": "3466666666",
    "countryIso": "ES",
    "groupsNames": ["My contact list"],
    "customFields": [
        {
            "key": "company",
            "value": "ACME inc."
        }
    ]
}'

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => '{{DASHBOARD_HOST}}/api/rest/contacts',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS => '{
    "email": "new.contact@example.com",
    "phone": "3466666666",
    "countryIso": "ES",
    "groupsNames": ["My contact list"],
    "customFields": [
        {
            "key": "company",
            "value": "ACME inc."
        }
    ]
}',
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/json',
    'Authorization: Basic YOUR_AUTH_TOKEN',
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

import java.io.DataOutputStream;
import java.io.BufferedReader;
import java.io.InputStreamReader;
import java.net.URL;
import java.net.HttpsURLConnection;

public class App {
  public static void main(String[] args) {
    try {
      URL url = new URL("{{DASHBOARD_HOST}}/api/rest/contacts");
      HttpsURLConnection connection = (HttpsURLConnection) url.openConnection();
      connection.setRequestMethod("POST");
      connection.setRequestProperty("Authorization", "Basic YOUR_AUTH_TOKEN");
      connection.setRequestProperty("Accept", "application/json");
      String requestBody = "{ \"email\": \"new.contact@example.com\", \"phone\": \"3466666666\", \"countryIso\": \"ES\", \"groupsNames\": [\"My contact list\"], \"customFields\": [ { \"key\": \"company\", \"value\": \"ACME inc.\" } ] }";
      connection.setDoOutput(true);
      DataOutputStream wr = new DataOutputStream(connection.getOutputStream());
      wr.writeBytes(requestBody);
      wr.flush();
      wr.close();
      BufferedReader in = new BufferedReader(new InputStreamReader(connection.getInputStream()));
      String inputLine;
      StringBuffer response = new StringBuffer();
      while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
      }
      in.close();
      System.out.println(response.toString());
    } catch (Exception e) {
      // TODO: handle exception
    }
  }
}

var axios = require('axios');
var config = {
  method: 'post',
  url: '{{DASHBOARD_HOST}}/api/rest/contacts',
  headers: {
    'Content-Type': 'application/json',
    'Authorization': 'Basic YOUR_AUTH_TOKEN'
  },
  data: '{ "email": "new.contact@example.com", "phone": "3466666666", "countryIso": "ES", "groupsNames": ["My contact list"], "customFields": [ { "key": "company", "value": "ACME inc." } ] }'
};

axios(config)
.then(function (response) {
  console.log(JSON.stringify(response.data));
})
.catch(function (error) {
  console.log(error);
});

import requests

url = "{{DASHBOARD_HOST}}/api/rest/contacts"

payload = "{ \"email\": \"new.contact@example.com\", \"phone\": \"3466666666\", \"countryIso\": \"ES\", \"groupsNames\": [\"My contact list\"], \"customFields\": [ { \"key\": \"company\", \"value\": \"ACME inc.\" } ] }"
headers = {
  'Content-Type': 'application/json',
  'Authorization': 'Basic YOUR_AUTH_TOKEN'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

require "uri"
require "net/http"

url = URI("{{DASHBOARD_HOST}}/api/rest/contacts")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = "application/json"
request["Authorization"] = "Basic YOUR_AUTH_TOKEN"
request.body = "{ \"email\": \"new.contact@example.com\", \"phone\": \"3466666666\", \"countryIso\": \"ES\", \"groupsNames\": [\"My contact list\"], \"customFields\": [ { \"key\": \"company\", \"value\": \"ACME inc.\" } ] }"

response = https.request(request)
puts response.read_body

using System;
using RestSharp;
namespace HelloWorldApplication {
  class HelloWorld {
    static void Main(string[] args) {
      var client = new RestClient("{{DASHBOARD_HOST}}/api/rest/contacts");
      client.Timeout = -1;
      var request = new RestRequest(Method.POST);
      request.AddHeader("Authorization", "Basic YOUR_AUTH_TOKEN");
      request.AddHeader("Content-Type", "application/json");
      request.AddParameter("application/json", "{ \"email\": \"new.contact@example.com\", \"phone\": \"3466666666\", \"countryIso\": \"ES\", \"groupsNames\": [\"My contact list\"], \"customFields\": [ { \"key\": \"company\", \"value\": \"ACME inc.\" } ] }",  ParameterType.RequestBody);
      IRestResponse response = client.Execute(request);
      Console.WriteLine(response.Content);
    }
  }
}

Response (HTTP 201)

{
  "data": {
    "id": 1,
    "email": "new.contact@example.com",
    "phone": "3466666666",
    "countryIso": "ES",
    "landline": null,
    "name": null,
    "surname": null,
    "createdAt": "2018-03-13T14:32:25+00:00",
    "updatedAt": "2018-03-13T14:32:25+00:00",
    "links": {
      "self": "{{DASHBOARD_HOST}}/api/rest/contacts/1"
    }
  }
}

Error response

{
  "error": {
    "code": 422,
    "description": "The email field is required."
  }
}

Parâmetros

Parâmetro	Tipo	Obrigatório	Descrição
email	string	Obrigatório quando o `phone` ou `landline` não é especificado.	E-mail do novo contacto.
phone	string	Obrigatório quando `email` ou `landline` não for especificado.	Número de telemóvel do contacto.
landline	string	Obrigatório quando `email` ou `phone` não for especificado.	Número de telefone fixo do contacto.
countryIso	string	Obrigatório quando `phone` ou `landline` não for especificado.	Código ISO de 2 letras do país do contacto.
groupsIds	array	Obrigatório se `groupsNames` não for especificado.	Lista de grupos aos quais será adicionado o novo contacto. Para obter os IDs dos grupos, consultar a documentação do endpoint correspondente.
groupsNames	array	Obrigatório se `groupsIds` não for especificado.	Em alternativa, caso não disponha da lista de IDs de grupos, é possível especificar uma lista com os nomes dos grupos aos quais será adicionado o contacto.
name	string	Não	Nome do contacto.
surname	string	Não	Apelidos do contacto.
customFields[]key	string	Não	Nome do campo personalizado a adicionar.
customFields[]type	string	Não	Tipo do campo personalizado. Valores possíveis: `string`, `date`, `decimal`. Para utilizar um campo de data, o valor deverá estar no formato ISO8601. Valor por defeito: `string`
customFields[]value	string	Não	Valor do campo personalizado.

Atualizar um contacto

PUT {{DASHBOARD_HOST}}/api/rest/contacts/<ID>

curl -X PUT '{{DASHBOARD_HOST}}/api/rest/contacts/1' \
-H 'Content-Type: application/json' \
-H 'Authorization: Basic YOUR_AUTH_TOKEN' \
-d '{
    "email": "new.contact@example.com",
    "phone": "3466666666",
    "countryIso": "ES",
    "groupsNames": ["My contact list"],
    "customFields": [
        {
            "key": "company",
            "value": "ACME inc."
        }
    ]
}'

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => '{{DASHBOARD_HOST}}/api/rest/contacts/1',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => 'PUT',
  CURLOPT_POSTFIELDS => '{
    "email": "new.contact@example.com",
    "phone": "3466666666",
    "countryIso": "ES",
    "groupsNames": ["My contact list"],
    "customFields": [
        {
            "key": "company",
            "value": "ACME inc."
        }
    ]
}',
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/json',
    'Authorization: Basic YOUR_AUTH_TOKEN',
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

import java.io.DataOutputStream;
import java.io.BufferedReader;
import java.io.InputStreamReader;
import java.net.URL;
import java.net.HttpsURLConnection;

public class App {
  public static void main(String[] args) {
    try {
      URL url = new URL("{{DASHBOARD_HOST}}/api/rest/contacts/1");
      HttpsURLConnection connection = (HttpsURLConnection) url.openConnection();
      connection.setRequestMethod("PUT");
      connection.setRequestProperty("Authorization", "Basic YOUR_AUTH_TOKEN");
      connection.setRequestProperty("Accept", "application/json");
      String requestBody = "{ \"email\": \"new.contact@example.com\", \"phone\": \"3466666666\", \"countryIso\": \"ES\", \"groupsNames\": [\"My contact list\"], \"customFields\": [ { \"key\": \"company\", \"value\": \"ACME inc.\" } ] }";
      connection.setDoOutput(true);
      DataOutputStream wr = new DataOutputStream(connection.getOutputStream());
      wr.writeBytes(requestBody);
      wr.flush();
      wr.close();
      BufferedReader in = new BufferedReader(new InputStreamReader(connection.getInputStream()));
      String inputLine;
      StringBuffer response = new StringBuffer();
      while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
      }
      in.close();
      System.out.println(response.toString());
    } catch (Exception e) {
      // TODO: handle exception
    }
  }
}

var axios = require('axios');
var config = {
  method: 'put',
  url: '{{DASHBOARD_HOST}}/api/rest/contacts/1',
  headers: {
    'Content-Type': 'application/json',
    'Authorization': 'Basic YOUR_AUTH_TOKEN'
  },
  data: '{ "email": "new.contact@example.com", "phone": "3466666666", "countryIso": "ES", "groupsNames": ["My contact list"], "customFields": [ { "key": "company", "value": "ACME inc." } ] }'
};

axios(config)
.then(function (response) {
  console.log(JSON.stringify(response.data));
})
.catch(function (error) {
  console.log(error);
});

import requests

url = "{{DASHBOARD_HOST}}/api/rest/contacts/1"

payload = "{ \"email\": \"new.contact@example.com\", \"phone\": \"3466666666\", \"countryIso\": \"ES\", \"groupsNames\": [\"My contact list\"], \"customFields\": [ { \"key\": \"company\", \"value\": \"ACME inc.\" } ] }"
headers = {
  'Content-Type': 'application/json',
  'Authorization': 'Basic YOUR_AUTH_TOKEN'
}

response = requests.request("PUT", url, headers=headers, data=payload)

print(response.text)

require "uri"
require "net/http"

url = URI("{{DASHBOARD_HOST}}/api/rest/contacts/1")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Content-Type"] = "application/json"
request["Authorization"] = "Basic YOUR_AUTH_TOKEN"
request.body = "{ \"email\": \"new.contact@example.com\", \"phone\": \"3466666666\", \"countryIso\": \"ES\", \"groupsNames\": [\"My contact list\"], \"customFields\": [ { \"key\": \"company\", \"value\": \"ACME inc.\" } ] }"

response = https.request(request)
puts response.read_body

using System;
using RestSharp;
namespace HelloWorldApplication {
  class HelloWorld {
    static void Main(string[] args) {
      var client = new RestClient("{{DASHBOARD_HOST}}/api/rest/contacts/1");
      client.Timeout = -1;
      var request = new RestRequest(Method.PUT);
      request.AddHeader("Authorization", "Basic YOUR_AUTH_TOKEN");
      request.AddHeader("Content-Type", "application/json");
      request.AddParameter("application/json", "{ \"email\": \"new.contact@example.com\", \"phone\": \"3466666666\", \"countryIso\": \"ES\", \"groupsNames\": [\"My contact list\"], \"customFields\": [ { \"key\": \"company\", \"value\": \"ACME inc.\" } ] }",  ParameterType.RequestBody);
      IRestResponse response = client.Execute(request);
      Console.WriteLine(response.Content);
    }
  }
}

Response (HTTP 200)

{
  "data": {
    "id": 1,
    "email": "new.contact@example.com",
    "phone": "3466666666",
    "countryIso": "ES",
    "landline": null,
    "name": null,
    "surname": null,
    "createdAt": "2018-03-13T14:32:25+00:00",
    "updatedAt": "2018-03-13T14:32:25+00:00",
    "links": {
      "self": "{{DASHBOARD_HOST}}/api/rest/contacts/1"
    }
  }
}

Error response

{
  "error": {
    "code": 422,
    "description": "The email field is required."
  }
}

Parâmetros

Parâmetro	Tipo	Obrigatório	Descrição
email	string	Obrigatório quando o `phone` ou `landline` não é especificado.	E-mail do novo contacto.
phone	string	Obrigatório quando `email` ou `landline` não for especificado.	Número de telemóvel do contacto.
landline	string	Obrigatório quando `email` ou `phone` não for especificado.	Número de telefone fixo do contacto.
countryIso	string	Obrigatório quando `phone` ou `landline` não for especificado.	Código ISO de 2 letras do país do contacto.
groupsIds	array	Obrigatório se `groupsNames` não for especificado.	Lista de grupos aos quais será adicionado o novo contacto. Para obter os IDs dos grupos, consultar a documentação do endpoint correspondente.
groupsNames	array	Obrigatório se `groupsIds` não for especificado.	Em alternativa, caso não disponha da lista de IDs de grupos, é possível especificar uma lista com os nomes dos grupos aos quais será adicionado o contacto.
name	string	Não	Nome do contacto.
surname	string	Não	Apelidos do contacto.
customFields[]key	string	Não	Nome do campo personalizado a adicionar.
customFields[]type	string	Não	Tipo do campo personalizado. Valores possíveis: `string`, `date`, `decimal`. Para utilizar um campo de data, o valor deverá estar no formato ISO8601. Valor por defeito: `string`.
customFields[]value	string	Não	Valor do campo personalizado.

Eliminar um contacto

DELETE {{DASHBOARD_HOST}}/api/rest/contacts/<ID>

curl -X DELETE '{{DASHBOARD_HOST}}/api/rest/contacts/1' \
-H 'Content-Type: application/json' \
-H 'Authorization: Basic YOUR_AUTH_TOKEN'

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => '{{DASHBOARD_HOST}}/api/rest/contacts/1',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => 'DELETE',
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/json',
    'Authorization: Basic YOUR_AUTH_TOKEN',
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

import java.io.DataOutputStream;
import java.io.BufferedReader;
import java.io.InputStreamReader;
import java.net.URL;
import java.net.HttpsURLConnection;

public class App {
  public static void main(String[] args) {
    try {
      URL url = new URL("{{DASHBOARD_HOST}}/api/rest/contacts/1");
      HttpsURLConnection connection = (HttpsURLConnection) url.openConnection();
      connection.setRequestMethod("DELETE");
      connection.setRequestProperty("Authorization", "Basic YOUR_AUTH_TOKEN");
      connection.setRequestProperty("Accept", "application/json");
      BufferedReader in = new BufferedReader(new InputStreamReader(connection.getInputStream()));
      String inputLine;
      StringBuffer response = new StringBuffer();
      while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
      }
      in.close();
      System.out.println(response.toString());
    } catch (Exception e) {
      // TODO: handle exception
    }
  }
}

var axios = require('axios');
var config = {
  method: 'delete',
  url: '{{DASHBOARD_HOST}}/api/rest/contacts/1',
  headers: {
    'Content-Type': 'application/json',
    'Authorization': 'Basic YOUR_AUTH_TOKEN'
  }
};

axios(config)
.then(function (response) {
  console.log(JSON.stringify(response.data));
})
.catch(function (error) {
  console.log(error);
});

import requests

url = "{{DASHBOARD_HOST}}/api/rest/contacts/1"

payload = {}
headers = {
  'Content-Type': 'application/json',
  'Authorization': 'Basic YOUR_AUTH_TOKEN'
}

response = requests.request("DELETE", url, headers=headers, data=payload)

print(response.text)

require "uri"
require "net/http"

url = URI("{{DASHBOARD_HOST}}/api/rest/contacts/1")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Delete.new(url)
request["Content-Type"] = "application/json"
request["Authorization"] = "Basic YOUR_AUTH_TOKEN"

response = https.request(request)
puts response.read_body

using System;
using RestSharp;
namespace HelloWorldApplication {
  class HelloWorld {
    static void Main(string[] args) {
      var client = new RestClient("{{DASHBOARD_HOST}}/api/rest/contacts/1");
      client.Timeout = -1;
      var request = new RestRequest(Method.DELETE);
      request.AddHeader("Authorization", "Basic YOUR_AUTH_TOKEN");
      request.AddHeader("Content-Type", "application/json");
      IRestResponse response = client.Execute(request);
      Console.WriteLine(response.Content);
    }
  }
}

Caso o pedido seja bem-sucedido, responderá com um código HTTP 204.

Grupos

Lista de grupos

GET {{DASHBOARD_HOST}}/api/rest/groups

curl -X GET '{{DASHBOARD_HOST}}/api/rest/groups' \
-H 'Content-Type: application/json' \
-H 'Authorization: Basic YOUR_AUTH_TOKEN'

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => '{{DASHBOARD_HOST}}/api/rest/groups',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/json',
    'Authorization: Basic YOUR_AUTH_TOKEN',
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

import java.io.DataOutputStream;
import java.io.BufferedReader;
import java.io.InputStreamReader;
import java.net.URL;
import java.net.HttpsURLConnection;

public class App {
  public static void main(String[] args) {
    try {
      URL url = new URL("{{DASHBOARD_HOST}}/api/rest/groups");
      HttpsURLConnection connection = (HttpsURLConnection) url.openConnection();
      connection.setRequestMethod("GET");
      connection.setRequestProperty("Authorization", "Basic YOUR_AUTH_TOKEN");
      connection.setRequestProperty("Accept", "application/json");
      BufferedReader in = new BufferedReader(new InputStreamReader(connection.getInputStream()));
      String inputLine;
      StringBuffer response = new StringBuffer();
      while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
      }
      in.close();
      System.out.println(response.toString());
    } catch (Exception e) {
      // TODO: handle exception
    }
  }
}

var axios = require('axios');
var config = {
  method: 'get',
  url: '{{DASHBOARD_HOST}}/api/rest/groups',
  headers: {
    'Content-Type': 'application/json',
    'Authorization': 'Basic YOUR_AUTH_TOKEN'
  }
};

axios(config)
.then(function (response) {
  console.log(JSON.stringify(response.data));
})
.catch(function (error) {
  console.log(error);
});

import requests

url = "{{DASHBOARD_HOST}}/api/rest/groups"

payload = {}
headers = {
  'Content-Type': 'application/json',
  'Authorization': 'Basic YOUR_AUTH_TOKEN'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

require "uri"
require "net/http"

url = URI("{{DASHBOARD_HOST}}/api/rest/groups")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Content-Type"] = "application/json"
request["Authorization"] = "Basic YOUR_AUTH_TOKEN"

response = https.request(request)
puts response.read_body

using System;
using RestSharp;
namespace HelloWorldApplication {
  class HelloWorld {
    static void Main(string[] args) {
      var client = new RestClient("{{DASHBOARD_HOST}}/api/rest/groups");
      client.Timeout = -1;
      var request = new RestRequest(Method.GET);
      request.AddHeader("Authorization", "Basic YOUR_AUTH_TOKEN");
      request.AddHeader("Content-Type", "application/json");
      IRestResponse response = client.Execute(request);
      Console.WriteLine(response.Content);
    }
  }
}

Response

{
  "data": [
    {
      "id": 1,
      "name": "My contact list"
    }
  ],
  "meta": {
    "pagination": {
      "total": 500,
      "count": 100,
      "per_page": 100,
      "current_page": 1,
      "total_pages": 5,
      "links": {
        "next": "{{DASHBOARD_HOST}}/api/rest/groups?page=2"
      }
    }
  }
}

Filtros

Parâmetro	Descrição
limit	Total de contactos a exibir num único pedido. Valor por defeito: `100`. Máximo: `1000`.

Mostrar um grupo

GET {{DASHBOARD_HOST}}/api/rest/groups/<ID>

curl -X GET '{{DASHBOARD_HOST}}/api/rest/groups/1' \
-H 'Content-Type: application/json' \
-H 'Authorization: Basic YOUR_AUTH_TOKEN'

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => '{{DASHBOARD_HOST}}/api/rest/groups/1',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/json',
    'Authorization: Basic YOUR_AUTH_TOKEN',
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

import java.io.DataOutputStream;
import java.io.BufferedReader;
import java.io.InputStreamReader;
import java.net.URL;
import java.net.HttpsURLConnection;

public class App {
  public static void main(String[] args) {
    try {
      URL url = new URL("{{DASHBOARD_HOST}}/api/rest/groups/1");
      HttpsURLConnection connection = (HttpsURLConnection) url.openConnection();
      connection.setRequestMethod("GET");
      connection.setRequestProperty("Authorization", "Basic YOUR_AUTH_TOKEN");
      connection.setRequestProperty("Accept", "application/json");
      BufferedReader in = new BufferedReader(new InputStreamReader(connection.getInputStream()));
      String inputLine;
      StringBuffer response = new StringBuffer();
      while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
      }
      in.close();
      System.out.println(response.toString());
    } catch (Exception e) {
      // TODO: handle exception
    }
  }
}

var axios = require('axios');
var config = {
  method: 'get',
  url: '{{DASHBOARD_HOST}}/api/rest/groups/1',
  headers: {
    'Content-Type': 'application/json',
    'Authorization': 'Basic YOUR_AUTH_TOKEN'
  }
};

axios(config)
.then(function (response) {
  console.log(JSON.stringify(response.data));
})
.catch(function (error) {
  console.log(error);
});

import requests

url = "{{DASHBOARD_HOST}}/api/rest/groups/1"

payload = {}
headers = {
  'Content-Type': 'application/json',
  'Authorization': 'Basic YOUR_AUTH_TOKEN'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

require "uri"
require "net/http"

url = URI("{{DASHBOARD_HOST}}/api/rest/groups/1")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Content-Type"] = "application/json"
request["Authorization"] = "Basic YOUR_AUTH_TOKEN"

response = https.request(request)
puts response.read_body

using System;
using RestSharp;
namespace HelloWorldApplication {
  class HelloWorld {
    static void Main(string[] args) {
      var client = new RestClient("{{DASHBOARD_HOST}}/api/rest/groups/1");
      client.Timeout = -1;
      var request = new RestRequest(Method.GET);
      request.AddHeader("Authorization", "Basic YOUR_AUTH_TOKEN");
      request.AddHeader("Content-Type", "application/json");
      IRestResponse response = client.Execute(request);
      Console.WriteLine(response.Content);
    }
  }
}

Response

{
  "data": {
    "id": 1,
    "name": "My contact list"
  }
}

Criar um novo grupo

POST {{DASHBOARD_HOST}}/api/rest/groups

curl -X POST '{{DASHBOARD_HOST}}/api/rest/groups' \
-H 'Content-Type: application/json' \
-H 'Authorization: Basic YOUR_AUTH_TOKEN' \
-d '{
    "name": "My new contact list"
}'

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => '{{DASHBOARD_HOST}}/api/rest/groups',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS => '{
    "name": "My new contact list"
}',
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/json',
    'Authorization: Basic YOUR_AUTH_TOKEN',
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

import java.io.DataOutputStream;
import java.io.BufferedReader;
import java.io.InputStreamReader;
import java.net.URL;
import java.net.HttpsURLConnection;

public class App {
  public static void main(String[] args) {
    try {
      URL url = new URL("{{DASHBOARD_HOST}}/api/rest/groups");
      HttpsURLConnection connection = (HttpsURLConnection) url.openConnection();
      connection.setRequestMethod("POST");
      connection.setRequestProperty("Authorization", "Basic YOUR_AUTH_TOKEN");
      connection.setRequestProperty("Accept", "application/json");
      String requestBody = "{ \"name\": \"My new contact list\" }";
      connection.setDoOutput(true);
      DataOutputStream wr = new DataOutputStream(connection.getOutputStream());
      wr.writeBytes(requestBody);
      wr.flush();
      wr.close();
      BufferedReader in = new BufferedReader(new InputStreamReader(connection.getInputStream()));
      String inputLine;
      StringBuffer response = new StringBuffer();
      while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
      }
      in.close();
      System.out.println(response.toString());
    } catch (Exception e) {
      // TODO: handle exception
    }
  }
}

var axios = require('axios');
var config = {
  method: 'post',
  url: '{{DASHBOARD_HOST}}/api/rest/groups',
  headers: {
    'Content-Type': 'application/json',
    'Authorization': 'Basic YOUR_AUTH_TOKEN'
  },
  data: '{ "name": "My new contact list" }'
};

axios(config)
.then(function (response) {
  console.log(JSON.stringify(response.data));
})
.catch(function (error) {
  console.log(error);
});

import requests

url = "{{DASHBOARD_HOST}}/api/rest/groups"

payload = "{ \"name\": \"My new contact list\" }"
headers = {
  'Content-Type': 'application/json',
  'Authorization': 'Basic YOUR_AUTH_TOKEN'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

require "uri"
require "net/http"

url = URI("{{DASHBOARD_HOST}}/api/rest/groups")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = "application/json"
request["Authorization"] = "Basic YOUR_AUTH_TOKEN"
request.body = "{ \"name\": \"My new contact list\" }"

response = https.request(request)
puts response.read_body

using System;
using RestSharp;
namespace HelloWorldApplication {
  class HelloWorld {
    static void Main(string[] args) {
      var client = new RestClient("{{DASHBOARD_HOST}}/api/rest/groups");
      client.Timeout = -1;
      var request = new RestRequest(Method.POST);
      request.AddHeader("Authorization", "Basic YOUR_AUTH_TOKEN");
      request.AddHeader("Content-Type", "application/json");
      request.AddParameter("application/json", "{ \"name\": \"My new contact list\" }",  ParameterType.RequestBody);
      IRestResponse response = client.Execute(request);
      Console.WriteLine(response.Content);
    }
  }
}

Response (HTTP 201)

{
  "data": {
    "id": 1,
    "name": "My new contact list"
  }
}

Error response

{
  "error": {
    "code": 422,
    "description": "The name field is required."
  }
}

Parâmetros

Parâmetro	Tipo	Obrigatório	Descrição
name	string	Sim	Nome do novo grupo.

Atualizar um grupo

PUT {{DASHBOARD_HOST}}/api/rest/groups/<ID>

curl -X PUT '{{DASHBOARD_HOST}}/api/rest/groups' \
-H 'Content-Type: application/json' \
-H 'Authorization: Basic YOUR_AUTH_TOKEN' \
-d '{
    "name": "My new contact list"
}'

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => '{{DASHBOARD_HOST}}/api/rest/groups',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => 'PUT',
  CURLOPT_POSTFIELDS => '{
    "name": "My new contact list"
}',
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/json',
    'Authorization: Basic YOUR_AUTH_TOKEN',
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

import java.io.DataOutputStream;
import java.io.BufferedReader;
import java.io.InputStreamReader;
import java.net.URL;
import java.net.HttpsURLConnection;

public class App {
  public static void main(String[] args) {
    try {
      URL url = new URL("{{DASHBOARD_HOST}}/api/rest/groups");
      HttpsURLConnection connection = (HttpsURLConnection) url.openConnection();
      connection.setRequestMethod("PUT");
      connection.setRequestProperty("Authorization", "Basic YOUR_AUTH_TOKEN");
      connection.setRequestProperty("Accept", "application/json");
      String requestBody = "{ \"name\": \"My new contact list\" }";
      connection.setDoOutput(true);
      DataOutputStream wr = new DataOutputStream(connection.getOutputStream());
      wr.writeBytes(requestBody);
      wr.flush();
      wr.close();
      BufferedReader in = new BufferedReader(new InputStreamReader(connection.getInputStream()));
      String inputLine;
      StringBuffer response = new StringBuffer();
      while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
      }
      in.close();
      System.out.println(response.toString());
    } catch (Exception e) {
      // TODO: handle exception
    }
  }
}

var axios = require('axios');
var config = {
  method: 'put',
  url: '{{DASHBOARD_HOST}}/api/rest/groups',
  headers: {
    'Content-Type': 'application/json',
    'Authorization': 'Basic YOUR_AUTH_TOKEN'
  },
  data: '{ "name": "My new contact list" }'
};

axios(config)
.then(function (response) {
  console.log(JSON.stringify(response.data));
})
.catch(function (error) {
  console.log(error);
});

import requests

url = "{{DASHBOARD_HOST}}/api/rest/groups"

payload = "{ \"name\": \"My new contact list\" }"
headers = {
  'Content-Type': 'application/json',
  'Authorization': 'Basic YOUR_AUTH_TOKEN'
}

response = requests.request("PUT", url, headers=headers, data=payload)

print(response.text)

require "uri"
require "net/http"

url = URI("{{DASHBOARD_HOST}}/api/rest/groups")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Content-Type"] = "application/json"
request["Authorization"] = "Basic YOUR_AUTH_TOKEN"
request.body = "{ \"name\": \"My new contact list\" }"

response = https.request(request)
puts response.read_body

using System;
using RestSharp;
namespace HelloWorldApplication {
  class HelloWorld {
    static void Main(string[] args) {
      var client = new RestClient("{{DASHBOARD_HOST}}/api/rest/groups");
      client.Timeout = -1;
      var request = new RestRequest(Method.PUT);
      request.AddHeader("Authorization", "Basic YOUR_AUTH_TOKEN");
      request.AddHeader("Content-Type", "application/json");
      request.AddParameter("application/json", "{ \"name\": \"My new contact list\" }",  ParameterType.RequestBody);
      IRestResponse response = client.Execute(request);
      Console.WriteLine(response.Content);
    }
  }
}

Response (HTTP 200)

{
  "data": {
    "id": 1,
    "name": "My new contact list"
  }
}

Error response

{
  "error": {
    "code": 422,
    "description": "The name field is required."
  }
}

Parâmetros

Parâmetro	Tipo	Obrigatório	Descrição
name	string	Sim	Nome do novo grupo.

Eliminar um grupo

DELETE {{DASHBOARD_HOST}}/api/rest/groups/<ID>

curl -X DELETE '{{DASHBOARD_HOST}}/api/rest/groups/1' \
-H 'Content-Type: application/json' \
-H 'Authorization: Basic YOUR_AUTH_TOKEN'

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => '{{DASHBOARD_HOST}}/api/rest/groups/1',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => 'DELETE',
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/json',
    'Authorization: Basic YOUR_AUTH_TOKEN',
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

import java.io.DataOutputStream;
import java.io.BufferedReader;
import java.io.InputStreamReader;
import java.net.URL;
import java.net.HttpsURLConnection;

public class App {
  public static void main(String[] args) {
    try {
      URL url = new URL("{{DASHBOARD_HOST}}/api/rest/groups/1");
      HttpsURLConnection connection = (HttpsURLConnection) url.openConnection();
      connection.setRequestMethod("DELETE");
      connection.setRequestProperty("Authorization", "Basic YOUR_AUTH_TOKEN");
      connection.setRequestProperty("Accept", "application/json");
      BufferedReader in = new BufferedReader(new InputStreamReader(connection.getInputStream()));
      String inputLine;
      StringBuffer response = new StringBuffer();
      while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
      }
      in.close();
      System.out.println(response.toString());
    } catch (Exception e) {
      // TODO: handle exception
    }
  }
}

var axios = require('axios');
var config = {
  method: 'delete',
  url: '{{DASHBOARD_HOST}}/api/rest/groups/1',
  headers: {
    'Content-Type': 'application/json',
    'Authorization': 'Basic YOUR_AUTH_TOKEN'
  }
};

axios(config)
.then(function (response) {
  console.log(JSON.stringify(response.data));
})
.catch(function (error) {
  console.log(error);
});

import requests

url = "{{DASHBOARD_HOST}}/api/rest/groups/1"

payload = {}
headers = {
  'Content-Type': 'application/json',
  'Authorization': 'Basic YOUR_AUTH_TOKEN'
}

response = requests.request("DELETE", url, headers=headers, data=payload)

print(response.text)

require "uri"
require "net/http"

url = URI("{{DASHBOARD_HOST}}/api/rest/groups/1")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Delete.new(url)
request["Content-Type"] = "application/json"
request["Authorization"] = "Basic YOUR_AUTH_TOKEN"

response = https.request(request)
puts response.read_body

using System;
using RestSharp;
namespace HelloWorldApplication {
  class HelloWorld {
    static void Main(string[] args) {
      var client = new RestClient("{{DASHBOARD_HOST}}/api/rest/groups/1");
      client.Timeout = -1;
      var request = new RestRequest(Method.DELETE);
      request.AddHeader("Authorization", "Basic YOUR_AUTH_TOKEN");
      request.AddHeader("Content-Type", "application/json");
      IRestResponse response = client.Execute(request);
      Console.WriteLine(response.Content);
    }
  }
}

Caso o pedido seja bem-sucedido, responderá com um código HTTP 204.

Parâmetro	Tipo	Obrigatório	Descrição
groupsIds	array	Não (sempre que houver emails)	Lista de grupos para validar (consultar o endpoint de grupos) dentro da API de contactos.
emails	array	Não (sempre que houver groupIds)	Lista de emails para validar.
force	boolean	Não	Se for `true`, serão verificados os emails que já foram verificados previamente. Valor por defeito `false`.
allowRisky	boolean	Não	Valor por defeito `false`. Se o valor for `false`, os e-mails duvidosos serão adicionados à lista negra, impedindo o seu envio. Se o valor for `true`, o envio destes e-mails será autorizado.
notificationUrl	string	Não	URL de retorno em que serão recebidas as notificações de progresso (consulte o anexo de notificação).

Lista negra

Listagem de contactos em lista negra

GET {{DASHBOARD_HOST}}/api/rest/v2/blacklist/{type}

curl -X GET '{{DASHBOARD_HOST}}/api/rest/v2/blacklist/sms' \
-H 'Content-Type: application/json' \
-H 'Authorization: Basic YOUR_AUTH_TOKEN'

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => '{{DASHBOARD_HOST}}/api/rest/v2/blacklist/sms',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/json',
    'Authorization: Basic YOUR_AUTH_TOKEN',
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

import java.io.DataOutputStream;
import java.io.BufferedReader;
import java.io.InputStreamReader;
import java.net.URL;
import java.net.HttpsURLConnection;

public class App {
  public static void main(String[] args) {
    try {
      URL url = new URL("{{DASHBOARD_HOST}}/api/rest/v2/blacklist/sms");
      HttpsURLConnection connection = (HttpsURLConnection) url.openConnection();
      connection.setRequestMethod("GET");
      connection.setRequestProperty("Authorization", "Basic YOUR_AUTH_TOKEN");
      connection.setRequestProperty("Accept", "application/json");
      BufferedReader in = new BufferedReader(new InputStreamReader(connection.getInputStream()));
      String inputLine;
      StringBuffer response = new StringBuffer();
      while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
      }
      in.close();
      System.out.println(response.toString());
    } catch (Exception e) {
      // TODO: handle exception
    }
  }
}

var axios = require('axios');
var config = {
  method: 'get',
  url: '{{DASHBOARD_HOST}}/api/rest/v2/blacklist/sms',
  headers: {
    'Content-Type': 'application/json',
    'Authorization': 'Basic YOUR_AUTH_TOKEN'
  }
};

axios(config)
.then(function (response) {
  console.log(JSON.stringify(response.data));
})
.catch(function (error) {
  console.log(error);
});

import requests

url = "{{DASHBOARD_HOST}}/api/rest/v2/blacklist/sms"

payload = {}
headers = {
  'Content-Type': 'application/json',
  'Authorization': 'Basic YOUR_AUTH_TOKEN'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

require "uri"
require "net/http"

url = URI("{{DASHBOARD_HOST}}/api/rest/v2/blacklist/sms")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Content-Type"] = "application/json"
request["Authorization"] = "Basic YOUR_AUTH_TOKEN"

response = https.request(request)
puts response.read_body

using System;
using RestSharp;
namespace HelloWorldApplication {
  class HelloWorld {
    static void Main(string[] args) {
      var client = new RestClient("{{DASHBOARD_HOST}}/api/rest/v2/blacklist/sms");
      client.Timeout = -1;
      var request = new RestRequest(Method.GET);
      request.AddHeader("Authorization", "Basic YOUR_AUTH_TOKEN");
      request.AddHeader("Content-Type", "application/json");
      IRestResponse response = client.Execute(request);
      Console.WriteLine(response.Content);
    }
  }
}

Response

{
  "data": [
    {
      "type": "sms",
      "recipient": "99000000000",
      "isDefinitive": false,
      "sendingId": 123,
      "campaignName": "TEST_CAMPAIGN",
      "createdAt": "2020-01-01T00:00:00+00:00"
    }
  ],
  "meta": {
    "pagination": {
      "total": 500,
      "count": 100,
      "per_page": 100,
      "current_page": 1,
      "total_pages": 5,
      "links": {
        "next": "{{DASHBOARD_HOST}}/api/rest/v2/blacklist/sms?page=2"
      }
    }
  }
}

Parâmetros de URL

Parâmetro	Descrição
type	Tipo de lista negra: `sms`, `mailing`, `voice`.

Filtros

Parâmetro	Descrição
limit	Total de contactos a apresentar num único pedido. Valor por defeito: `100`. Máximo: `1000`.
recipient	Filtrar por destinatário. Exemplo: ?recipient=test%40example.com
sendingId	Filtrar por sendingId. Exemplo: ?sendingId=123

Adicionar contacto à lista negra

PUT {{DASHBOARD_HOST}}/api/rest/v2/blacklist/{type}

curl -X PUT '{{DASHBOARD_HOST}}/api/rest/v2/blacklist/sms' \
-H 'Content-Type: application/json' \
-H 'Authorization: Basic YOUR_AUTH_TOKEN' \
-d '{
  "recipient": "99000000000"
}'

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => '{{DASHBOARD_HOST}}/api/rest/v2/blacklist/sms',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => 'PUT',
  CURLOPT_POSTFIELDS => '{
  "recipient": "99000000000"
}',
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/json',
    'Authorization: Basic YOUR_AUTH_TOKEN',
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

import java.io.DataOutputStream;
import java.io.BufferedReader;
import java.io.InputStreamReader;
import java.net.URL;
import java.net.HttpsURLConnection;

public class App {
  public static void main(String[] args) {
    try {
      URL url = new URL("{{DASHBOARD_HOST}}/api/rest/v2/blacklist/sms");
      HttpsURLConnection connection = (HttpsURLConnection) url.openConnection();
      connection.setRequestMethod("PUT");
      connection.setRequestProperty("Authorization", "Basic YOUR_AUTH_TOKEN");
      connection.setRequestProperty("Accept", "application/json");
      String requestBody = "{ \"recipient\": \"99000000000\" }";
      connection.setDoOutput(true);
      DataOutputStream wr = new DataOutputStream(connection.getOutputStream());
      wr.writeBytes(requestBody);
      wr.flush();
      wr.close();
      BufferedReader in = new BufferedReader(new InputStreamReader(connection.getInputStream()));
      String inputLine;
      StringBuffer response = new StringBuffer();
      while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
      }
      in.close();
      System.out.println(response.toString());
    } catch (Exception e) {
      // TODO: handle exception
    }
  }
}

var axios = require('axios');
var config = {
  method: 'put',
  url: '{{DASHBOARD_HOST}}/api/rest/v2/blacklist/sms',
  headers: {
    'Content-Type': 'application/json',
    'Authorization': 'Basic YOUR_AUTH_TOKEN'
  },
  data: '{ "recipient": "99000000000" }'
};

axios(config)
.then(function (response) {
  console.log(JSON.stringify(response.data));
})
.catch(function (error) {
  console.log(error);
});

import requests

url = "{{DASHBOARD_HOST}}/api/rest/v2/blacklist/sms"

payload = "{ \"recipient\": \"99000000000\" }"
headers = {
  'Content-Type': 'application/json',
  'Authorization': 'Basic YOUR_AUTH_TOKEN'
}

response = requests.request("PUT", url, headers=headers, data=payload)

print(response.text)

require "uri"
require "net/http"

url = URI("{{DASHBOARD_HOST}}/api/rest/v2/blacklist/sms")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Content-Type"] = "application/json"
request["Authorization"] = "Basic YOUR_AUTH_TOKEN"
request.body = "{ \"recipient\": \"99000000000\" }"

response = https.request(request)
puts response.read_body

using System;
using RestSharp;
namespace HelloWorldApplication {
  class HelloWorld {
    static void Main(string[] args) {
      var client = new RestClient("{{DASHBOARD_HOST}}/api/rest/v2/blacklist/sms");
      client.Timeout = -1;
      var request = new RestRequest(Method.PUT);
      request.AddHeader("Authorization", "Basic YOUR_AUTH_TOKEN");
      request.AddHeader("Content-Type", "application/json");
      request.AddParameter("application/json", "{ \"recipient\": \"99000000000\" }",  ParameterType.RequestBody);
      IRestResponse response = client.Execute(request);
      Console.WriteLine(response.Content);
    }
  }
}

Response (HTTP 200)

{
  "data": {
    "type": "sms",
    "recipient": "99000000000",
    "isDefinitive": false,
    "campaignName": null,
    "createdAt": "2020-01-01T00:00:00+00:00"
  }
}

Parâmetros de URL

Parâmetro	Descrição
type	Tipo de lista negra: `sms`, `mailing`, `voice`.

Parâmetros

Parâmetro	Tipo	Obrigatório	Descrição
recipient	string	Sim	Destinatário para adicionar à lista negra.

Eliminar contacto da lista negra

DELETE {{DASHBOARD_HOST}}/api/rest/v2/blacklist/{type}

curl -X DELETE '{{DASHBOARD_HOST}}/api/rest/v2/blacklist/sms' \
-H 'Content-Type: application/json' \
-H 'Authorization: Basic YOUR_AUTH_TOKEN' \
-d '{
  "recipient": "99000000000"
}'

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => '{{DASHBOARD_HOST}}/api/rest/v2/blacklist/sms',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => 'DELETE',
  CURLOPT_POSTFIELDS => '{
  "recipient": "99000000000"
}',
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/json',
    'Authorization: Basic YOUR_AUTH_TOKEN',
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

import java.io.DataOutputStream;
import java.io.BufferedReader;
import java.io.InputStreamReader;
import java.net.URL;
import java.net.HttpsURLConnection;

public class App {
  public static void main(String[] args) {
    try {
      URL url = new URL("{{DASHBOARD_HOST}}/api/rest/v2/blacklist/sms");
      HttpsURLConnection connection = (HttpsURLConnection) url.openConnection();
      connection.setRequestMethod("DELETE");
      connection.setRequestProperty("Authorization", "Basic YOUR_AUTH_TOKEN");
      connection.setRequestProperty("Accept", "application/json");
      String requestBody = "{ \"recipient\": \"99000000000\" }";
      connection.setDoOutput(true);
      DataOutputStream wr = new DataOutputStream(connection.getOutputStream());
      wr.writeBytes(requestBody);
      wr.flush();
      wr.close();
      BufferedReader in = new BufferedReader(new InputStreamReader(connection.getInputStream()));
      String inputLine;
      StringBuffer response = new StringBuffer();
      while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
      }
      in.close();
      System.out.println(response.toString());
    } catch (Exception e) {
      // TODO: handle exception
    }
  }
}

var axios = require('axios');
var config = {
  method: 'delete',
  url: '{{DASHBOARD_HOST}}/api/rest/v2/blacklist/sms',
  headers: {
    'Content-Type': 'application/json',
    'Authorization': 'Basic YOUR_AUTH_TOKEN'
  },
  data: '{ "recipient": "99000000000" }'
};

axios(config)
.then(function (response) {
  console.log(JSON.stringify(response.data));
})
.catch(function (error) {
  console.log(error);
});

import requests

url = "{{DASHBOARD_HOST}}/api/rest/v2/blacklist/sms"

payload = "{ \"recipient\": \"99000000000\" }"
headers = {
  'Content-Type': 'application/json',
  'Authorization': 'Basic YOUR_AUTH_TOKEN'
}

response = requests.request("DELETE", url, headers=headers, data=payload)

print(response.text)

require "uri"
require "net/http"

url = URI("{{DASHBOARD_HOST}}/api/rest/v2/blacklist/sms")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Delete.new(url)
request["Content-Type"] = "application/json"
request["Authorization"] = "Basic YOUR_AUTH_TOKEN"
request.body = "{ \"recipient\": \"99000000000\" }"

response = https.request(request)
puts response.read_body

using System;
using RestSharp;
namespace HelloWorldApplication {
  class HelloWorld {
    static void Main(string[] args) {
      var client = new RestClient("{{DASHBOARD_HOST}}/api/rest/v2/blacklist/sms");
      client.Timeout = -1;
      var request = new RestRequest(Method.DELETE);
      request.AddHeader("Authorization", "Basic YOUR_AUTH_TOKEN");
      request.AddHeader("Content-Type", "application/json");
      request.AddParameter("application/json", "{ \"recipient\": \"99000000000\" }",  ParameterType.RequestBody);
      IRestResponse response = client.Execute(request);
      Console.WriteLine(response.Content);
    }
  }
}

Parâmetros de URL

Parâmetro	Descrição
type	Tipo de lista negra: `sms`, `mailing`, `voice`.

Parâmetros

Parâmetro	Tipo	Obrigatório	Descrição
recipient	string	Sim	Destinatário a remover da lista negra.

Se o pedido for bem-sucedido, será respondido com um código HTTP 204.

Templates e ficheiros

Parâmetro	Tipo	Obrigatório	Descrição
name	string	Sim	Nome do template.
html	string	Sim	Conteúdo do template em formato HTML e codificação UTF-8.

Parâmetro	Tipo	Obrigatório	Descrição
name	string	Sim	Nome do template.
html	string	Sim	Conteúdo do template em formato HTML e codificação UTF-8.

Padrão	Descrição
[unsubscribe_link]	Link para a página de cancelamento da subscrição.
[form_{ID}]	Link para o formulário com id {ID}.
[show_link]	Link para visualizar o modelo no navegador da web. Útil para envio de tipo de correspondência.
[attachment_{ID}]	Link para o anexo com o ID {ID}.

Parâmetro	Tipo	Obrigatório	Descrição
name	string	Sim	Nome do template.
html	string	Sim	Conteúdo do template em formato HTML e codificação UTF-8.

Parâmetro	Tipo	Obrigatório	Descrição
name	string	Sim	Nome do template.
html	string	Sim	Conteúdo do template em formato HTML e codificação UTF-8.

Padrão	Descrição
[unsubscribe_link]	Link para a página de cancelamento da subscrição.
[form_{ID}]	Link para o formulário com id {ID}.
[show_link]	Link para visualizar o modelo no navegador da web. Útil para envio de tipo de correspondência.
[attachment_{ID}]	Link para o anexo com o ID {ID}.

Parâmetro	Tipo	Obrigatório	Descrição
name	string	Sim	Nome único do formulário
editable	boolean	Não	'true': uma vez enviado, o cliente pode enviá-lo novamente. 'false': uma vez enviado, o cliente não poderá enviá-lo novamente. Por defeito, `true`.
rejectButton	boolean	Não	'true': além do botão Enviar, o botão Rejeitar será mostrado. O botão Rejeitar não envia os dados. 'false': apenas o botão Enviar será mostrado. Por defeito, `false`.
backgroundUrl	string	Não	URL da imagem de fundo do formulário.
logoUrl	string	Não	URL da imagem do logótipo do formulário.
formFields	array	Sim	Conjunto de elementos que o formulário terá. Consulte o anexo para ver todos os elementos.

Parâmetro	Tipo	Obrigatório	Descrição
name	string	Sim	Nome único do formulário
editable	boolean	Não	'true': uma vez enviado, o cliente pode enviá-lo novamente. 'false': uma vez enviado, o cliente não poderá enviá-lo novamente. Por defeito, `true`.
rejectButton	boolean	Não	'true': além do botão Enviar, o botão Rejeitar será mostrado. O botão Rejeitar não envia os dados. 'false': apenas o botão Enviar será mostrado. Por defeito, `false`.
backgroundUrl	string	Não	URL da imagem de fundo do formulário.
logoUrl	string	Não	URL da imagem do logótipo do formulário.
formFields	array	Sim	Conjunto de elementos que o formulário terá. Consulte o anexo para ver todos os elementos.

Encurtador de URLs

Criação de URLs curtos

POST {{DASHBOARD_HOST}}/api/rest/shortener/shorten

Request

curl -X POST '{{DASHBOARD_HOST}}/api/rest/shortener/shorten' \
-H 'Content-Type: application/json' \
-H 'Authorization: Basic YOUR_AUTH_TOKEN' \
-d '{
  "urls": [
    {"longUrl": "https://example.com/test1"},
    {"longUrl": "https://example.com/test2"},
    {"longUrl": "invalidUrl"}
  ]
}'

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => '{{DASHBOARD_HOST}}/api/rest/shortener/shorten',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS => '{
  "urls": [
    {"longUrl": "https://example.com/test1"},
    {"longUrl": "https://example.com/test2"},
    {"longUrl": "invalidUrl"}
  ]
}',
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/json',
    'Authorization: Basic YOUR_AUTH_TOKEN',
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

import java.io.DataOutputStream;
import java.io.BufferedReader;
import java.io.InputStreamReader;
import java.net.URL;
import java.net.HttpsURLConnection;

public class App {
  public static void main(String[] args) {
    try {
      URL url = new URL("{{DASHBOARD_HOST}}/api/rest/shortener/shorten");
      HttpsURLConnection connection = (HttpsURLConnection) url.openConnection();
      connection.setRequestMethod("POST");
      connection.setRequestProperty("Authorization", "Basic YOUR_AUTH_TOKEN");
      connection.setRequestProperty("Accept", "application/json");
      String requestBody = "{ \"urls\": [ {\"longUrl\": \"https://example.com/test1\"}, {\"longUrl\": \"https://example.com/test2\"}, {\"longUrl\": \"invalidUrl\"} ] }";
      connection.setDoOutput(true);
      DataOutputStream wr = new DataOutputStream(connection.getOutputStream());
      wr.writeBytes(requestBody);
      wr.flush();
      wr.close();
      BufferedReader in = new BufferedReader(new InputStreamReader(connection.getInputStream()));
      String inputLine;
      StringBuffer response = new StringBuffer();
      while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
      }
      in.close();
      System.out.println(response.toString());
    } catch (Exception e) {
      // TODO: handle exception
    }
  }
}

var axios = require('axios');
var config = {
  method: 'post',
  url: '{{DASHBOARD_HOST}}/api/rest/shortener/shorten',
  headers: {
    'Content-Type': 'application/json',
    'Authorization': 'Basic YOUR_AUTH_TOKEN'
  },
  data: '{ "urls": [ {"longUrl": "https://example.com/test1"}, {"longUrl": "https://example.com/test2"}, {"longUrl": "invalidUrl"} ] }'
};

axios(config)
.then(function (response) {
  console.log(JSON.stringify(response.data));
})
.catch(function (error) {
  console.log(error);
});

import requests

url = "{{DASHBOARD_HOST}}/api/rest/shortener/shorten"

payload = "{ \"urls\": [ {\"longUrl\": \"https://example.com/test1\"}, {\"longUrl\": \"https://example.com/test2\"}, {\"longUrl\": \"invalidUrl\"} ] }"
headers = {
  'Content-Type': 'application/json',
  'Authorization': 'Basic YOUR_AUTH_TOKEN'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

require "uri"
require "net/http"

url = URI("{{DASHBOARD_HOST}}/api/rest/shortener/shorten")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = "application/json"
request["Authorization"] = "Basic YOUR_AUTH_TOKEN"
request.body = "{ \"urls\": [ {\"longUrl\": \"https://example.com/test1\"}, {\"longUrl\": \"https://example.com/test2\"}, {\"longUrl\": \"invalidUrl\"} ] }"

response = https.request(request)
puts response.read_body

using System;
using RestSharp;
namespace HelloWorldApplication {
  class HelloWorld {
    static void Main(string[] args) {
      var client = new RestClient("{{DASHBOARD_HOST}}/api/rest/shortener/shorten");
      client.Timeout = -1;
      var request = new RestRequest(Method.POST);
      request.AddHeader("Authorization", "Basic YOUR_AUTH_TOKEN");
      request.AddHeader("Content-Type", "application/json");
      request.AddParameter("application/json", "{ \"urls\": [ {\"longUrl\": \"https://example.com/test1\"}, {\"longUrl\": \"https://example.com/test2\"}, {\"longUrl\": \"invalidUrl\"} ] }",  ParameterType.RequestBody);
      IRestResponse response = client.Execute(request);
      Console.WriteLine(response.Content);
    }
  }
}

Response

{
  "data": [
    {
      "longUrl": "https://example.com/test1",
      "shortUrl": "https://sms.tl/dvRINN",
      "error": false
    },
    {
      "longUrl": "https://example.com/test2",
      "shortUrl": "https://sms.tl/GFA6Fm",
      "error": false
    },
    {
      "longUrl": "invalidUrl",
      "shortUrl": null,
      "error": true
    }
  ]
}

Gerador de imagem

Geração de imagens

POST {{DASHBOARD_HOST}}/api/rest/images/generate

Request

curl -X POST '{{DASHBOARD_HOST}}/api/rest/images/generate' \
-H 'Content-Type: application/json' \
-H 'Authorization: Basic YOUR_AUTH_TOKEN' \
-d '{
  "images": [
    {
        "externalId": "test1",
        "extension": "jpg",
        "base64": "BASE64_ENCODED_STRING"
    },
    {
        "externalId": "test2",
        "extension": "png",
        "base64": "BASE64_ENCODED_STRING"
    }
  ]
}'

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => '{{DASHBOARD_HOST}}/api/rest/images/generate',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS => '{
  "images": [
    {
        "externalId": "test1",
        "extension": "jpg",
        "base64": "BASE64_ENCODED_STRING"
    },
    {
        "externalId": "test2",
        "extension": "png",
        "base64": "BASE64_ENCODED_STRING"
    }
  ]
}',
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/json',
    'Authorization: Basic YOUR_AUTH_TOKEN',
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

import java.io.DataOutputStream;
import java.io.BufferedReader;
import java.io.InputStreamReader;
import java.net.URL;
import java.net.HttpsURLConnection;

public class App {
  public static void main(String[] args) {
    try {
      URL url = new URL("{{DASHBOARD_HOST}}/api/rest/images/generate");
      HttpsURLConnection connection = (HttpsURLConnection) url.openConnection();
      connection.setRequestMethod("POST");
      connection.setRequestProperty("Authorization", "Basic YOUR_AUTH_TOKEN");
      connection.setRequestProperty("Accept", "application/json");
      String requestBody = "{ \"images\": [ { \"externalId\": \"test1\", \"extension\": \"jpg\", \"base64\": \"BASE64_ENCODED_STRING\" }, { \"externalId\": \"test2\", \"extension\": \"png\", \"base64\": \"BASE64_ENCODED_STRING\" } ] }";
      connection.setDoOutput(true);
      DataOutputStream wr = new DataOutputStream(connection.getOutputStream());
      wr.writeBytes(requestBody);
      wr.flush();
      wr.close();
      BufferedReader in = new BufferedReader(new InputStreamReader(connection.getInputStream()));
      String inputLine;
      StringBuffer response = new StringBuffer();
      while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
      }
      in.close();
      System.out.println(response.toString());
    } catch (Exception e) {
      // TODO: handle exception
    }
  }
}

var axios = require('axios');
var config = {
  method: 'post',
  url: '{{DASHBOARD_HOST}}/api/rest/images/generate',
  headers: {
    'Content-Type': 'application/json',
    'Authorization': 'Basic YOUR_AUTH_TOKEN'
  },
  data: '{ "images": [ { "externalId": "test1", "extension": "jpg", "base64": "BASE64_ENCODED_STRING" }, { "externalId": "test2", "extension": "png", "base64": "BASE64_ENCODED_STRING" } ] }'
};

axios(config)
.then(function (response) {
  console.log(JSON.stringify(response.data));
})
.catch(function (error) {
  console.log(error);
});

import requests

url = "{{DASHBOARD_HOST}}/api/rest/images/generate"

payload = "{ \"images\": [ { \"externalId\": \"test1\", \"extension\": \"jpg\", \"base64\": \"BASE64_ENCODED_STRING\" }, { \"externalId\": \"test2\", \"extension\": \"png\", \"base64\": \"BASE64_ENCODED_STRING\" } ] }"
headers = {
  'Content-Type': 'application/json',
  'Authorization': 'Basic YOUR_AUTH_TOKEN'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

require "uri"
require "net/http"

url = URI("{{DASHBOARD_HOST}}/api/rest/images/generate")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = "application/json"
request["Authorization"] = "Basic YOUR_AUTH_TOKEN"
request.body = "{ \"images\": [ { \"externalId\": \"test1\", \"extension\": \"jpg\", \"base64\": \"BASE64_ENCODED_STRING\" }, { \"externalId\": \"test2\", \"extension\": \"png\", \"base64\": \"BASE64_ENCODED_STRING\" } ] }"

response = https.request(request)
puts response.read_body

using System;
using RestSharp;
namespace HelloWorldApplication {
  class HelloWorld {
    static void Main(string[] args) {
      var client = new RestClient("{{DASHBOARD_HOST}}/api/rest/images/generate");
      client.Timeout = -1;
      var request = new RestRequest(Method.POST);
      request.AddHeader("Authorization", "Basic YOUR_AUTH_TOKEN");
      request.AddHeader("Content-Type", "application/json");
      request.AddParameter("application/json", "{ \"images\": [ { \"externalId\": \"test1\", \"extension\": \"jpg\", \"base64\": \"BASE64_ENCODED_STRING\" }, { \"externalId\": \"test2\", \"extension\": \"png\", \"base64\": \"BASE64_ENCODED_STRING\" } ] }",  ParameterType.RequestBody);
      IRestResponse response = client.Execute(request);
      Console.WriteLine(response.Content);
    }
  }
}

Response

{
  "data": [
    {
      "externalId": "test1",
      "imageUrl": "{{DASHBOARD_HOST}}/uploads/UCuh4pdOsW58ZEXX/1b4f0e9851971998e732078544c96b36c3d01cedf7caa332359d6f1d83567014.jpg",
      "error": false
    },
    {
      "externalId": "test2",
      "imageUrl": "{{DASHBOARD_HOST}}/uploads/UCuh4pdOsW58ZEXX/60303ae22b998861bce3b28f33eec1be758a213c86c93c076dbe9f558c11c752.jpg",
      "error": false
    }
  ]
}

Parâmetros

Parâmetro	Tipo	Obrigatório	Descrição
externalId	string	Sim	ID externo para identificar a imagem na resposta.
extension	string	Sim	Extensão de imagem. Extensões permitidas: jpg, png.
base64	string	Sim	Imagem codificada em Base64.

Parâmetro	Tipo	Obrigatório	Descrição
id	string	Sim	Identificador da mensagem devolvido na resposta à chamada para `api/rest/sms` no campo `id`.

Parâmetro	Tipo	Obrigatório	Descrição
id	string	Sim	Identificador da mensagem devolvido na resposta à chamada para `api/rest/mailing` no campo `id`.

Eventos

Notificações de eventos

Introdução

O objetivo do serviço de notificação de estados é informar o servidor do cliente sobre os eventos que são gerados no serviço 360nrs. As notificações serão feitas para os envios feitos por qualquer tipo de canal. Desta forma, o cliente poderá monitorizar em tempo real cada envio efetuado.

Um único envio pode provocar múltiplos eventos, pelo que um envio em massa pode gerar um número significativo de notificações ao servidor do cliente. Para evitar a saturação do servidor, os eventos a notificar são colocados em fila na 360nrs, pelo que se podem verificar atrasos na entrega de notificações se o servidor do cliente não for capaz de gerir o volume de notificações gerado.

Para ativar esta funcionalidade, o cliente deve fornecer um URL onde serão feitos os pedidos http POST para notificar um evento.

Receber nova notificação de evento

HTTP METHOD: POST Content-Type: application/x-www-form-urlencoded

Parâmetros

Parâmetro	Tipo	Descrição
id	string	Identificador alfanumérico que foi entregue no envio por API da mensagem. Se a mensagem foi enviada pela web, não terá valor.
channel	string	Indica a que canal pertence o envio a que a notificação se refere. Os valores possíveis são: `sms`, `mailing`, `landing`, `text2speech`.
contactId	integer	Identificador único do contacto.
campaignId	integer	Identificador da campanha. Se foi enviado por API e não se especificou campaignName no envio, terá valor 0.
formId	integer	Identificador único do formulário. (Para eventos de formulário)
campaignName	string	Nome da campanha.
event	string	Indica o evento que ocorreu. Os valores possíveis são: `delivered`, `opened`, `clicked`, `unsubscribed`, `hard_bounced`, `complaint`, `sent`, `soft_bounced`, `undelivered`, `rejected`, `expired`, `unsubscribed_landing`, `form_opened`, `form_submitted`, `form_rejected`.
extra	string	Parâmetro extra com informações adicionais do evento no formato JSON. O evento "form_submitted" conterá os valores inseridos no formulário pelo utilizador no seguinte formato: `{"formValues":{"param1":"value1", "param2": "value2", ...}}` O evento "clicked" conterá o URL em que se clicou: `{"url":"url_encoded"}`
smtpResponse	string	Variável opcional definida para o canal de e-mail e os eventos `delivered`, `hard_bounced`, `soft_bounced`. A resposta do servidor SMTP do email destinatário é devolvida.
eventDate	string	Data em que aconteceu o evento.

As notificações são reenviadas 5 vezes caso o servidor do cliente responda com um código HTTP diferente de 200 OK.

O tempo de espera entre as notificações é progressivo, pelo que a primeira tentativa será feita após 1 minuto, a segunda após 2 minutos desde a tentativa anterior, a terceira após 3 minutos, etc.

Relatório de eventos por envio

Reporte de eventos

GET {{DASHBOARD_HOST}}/api/rest/sendings/<sendingId>/reports/events

curl -X GET '{{DASHBOARD_HOST}}/api/rest/sendings/1/reports/events' \
-H 'Authorization: Basic YOUR_AUTH_TOKEN'

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => '{{DASHBOARD_HOST}}/api/rest/sendings/1/reports/events',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_HTTPHEADER => array(
    'Authorization: Basic YOUR_AUTH_TOKEN',
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

import java.io.DataOutputStream;
import java.io.BufferedReader;
import java.io.InputStreamReader;
import java.net.URL;
import java.net.HttpsURLConnection;

public class App {
  public static void main(String[] args) {
    try {
      URL url = new URL("{{DASHBOARD_HOST}}/api/rest/sendings/1/reports/events");
      HttpsURLConnection connection = (HttpsURLConnection) url.openConnection();
      connection.setRequestMethod("GET");
      connection.setRequestProperty("Authorization", "Basic YOUR_AUTH_TOKEN");
      BufferedReader in = new BufferedReader(new InputStreamReader(connection.getInputStream()));
      String inputLine;
      StringBuffer response = new StringBuffer();
      while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
      }
      in.close();
      System.out.println(response.toString());
    } catch (Exception e) {
      // TODO: handle exception
    }
  }
}

var axios = require('axios');
var config = {
  method: 'get',
  url: '{{DASHBOARD_HOST}}/api/rest/sendings/1/reports/events',
  headers: {
    'Authorization': 'Basic YOUR_AUTH_TOKEN'
  }
};

axios(config)
.then(function (response) {
  console.log(JSON.stringify(response.data));
})
.catch(function (error) {
  console.log(error);
});

import requests

url = "{{DASHBOARD_HOST}}/api/rest/sendings/1/reports/events"

payload = {}
headers = {
  'Authorization': 'Basic YOUR_AUTH_TOKEN'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

require "uri"
require "net/http"

url = URI("{{DASHBOARD_HOST}}/api/rest/sendings/1/reports/events")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = "Basic YOUR_AUTH_TOKEN"

response = https.request(request)
puts response.read_body

using System;
using RestSharp;
namespace HelloWorldApplication {
  class HelloWorld {
    static void Main(string[] args) {
      var client = new RestClient("{{DASHBOARD_HOST}}/api/rest/sendings/1/reports/events");
      client.Timeout = -1;
      var request = new RestRequest(Method.GET);
      request.AddHeader("Authorization", "Basic YOUR_AUTH_TOKEN");
      IRestResponse response = client.Execute(request);
      Console.WriteLine(response.Content);
    }
  }
}

Filtros

Parâmetro	Descrição
beforeDate	Mostrar os resultados `anteriores` à data indicada. A data deve ser especificada no formato `ISO 8601`.
afterDate	Mostrar os resultados `posteriores` à data indicada. A data deve ser especificada no formato `ISO 8601`.
showCustomFields	Se for definido como 1, mostra os campos personalizados utilizados.

Os parâmetros devem ser corretamente codificados (urlencode) de acordo com a norma RFC 3986 para serem admitidos pelo servidor. Por exemplo, para consultar o relatório de eventos entre as datas 2019-01-01T00:00:00+00:00 e 2019-02-01T00:00:00+00:00:

{{DASHBOARD_HOST}}/api/rest/sendings/{sendingId}/reports/events?afterDate=2019-01-01T00%3A00%3A00%2B00%3A00&beforeDate=2019-02-01T00%3A00%3A00%2B00%3A00

Obter o relatório detalhado dos eventos gerados por um envio. A resposta estará no formato text/csv e conterá as seguintes colunas:

Para envios de voz: campaignName ,campaignId, sendingId, contactId, event, phone, email, landline, countryIso, callDurationSeconds, createdAt

Para o resto dos canais: campaignName, campaignId, sendingId, contactId, event, phone, email, landline, countryIso, browser, os, url, createdAt

Relatório de teclas premidas

Introdução

Devolve um relatório com os números de telefone, juntamente com a tecla premida e a mensagem da locução.

Url

GET {{DASHBOARD_HOST}}/api/rest/sendings/<sendingId>/reports/keys

curl -X GET '{{DASHBOARD_HOST}}/api/rest/sendings/1/reports/keys' \
-H 'Authorization: Basic YOUR_AUTH_TOKEN'

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => '{{DASHBOARD_HOST}}/api/rest/sendings/1/reports/keys',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_HTTPHEADER => array(
    'Authorization: Basic YOUR_AUTH_TOKEN',
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

import java.io.DataOutputStream;
import java.io.BufferedReader;
import java.io.InputStreamReader;
import java.net.URL;
import java.net.HttpsURLConnection;

public class App {
  public static void main(String[] args) {
    try {
      URL url = new URL("{{DASHBOARD_HOST}}/api/rest/sendings/1/reports/keys");
      HttpsURLConnection connection = (HttpsURLConnection) url.openConnection();
      connection.setRequestMethod("GET");
      connection.setRequestProperty("Authorization", "Basic YOUR_AUTH_TOKEN");
      BufferedReader in = new BufferedReader(new InputStreamReader(connection.getInputStream()));
      String inputLine;
      StringBuffer response = new StringBuffer();
      while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
      }
      in.close();
      System.out.println(response.toString());
    } catch (Exception e) {
      // TODO: handle exception
    }
  }
}

var axios = require('axios');
var config = {
  method: 'get',
  url: '{{DASHBOARD_HOST}}/api/rest/sendings/1/reports/keys',
  headers: {
    'Authorization': 'Basic YOUR_AUTH_TOKEN'
  }
};

axios(config)
.then(function (response) {
  console.log(JSON.stringify(response.data));
})
.catch(function (error) {
  console.log(error);
});

import requests

url = "{{DASHBOARD_HOST}}/api/rest/sendings/1/reports/keys"

payload = {}
headers = {
  'Authorization': 'Basic YOUR_AUTH_TOKEN'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

require "uri"
require "net/http"

url = URI("{{DASHBOARD_HOST}}/api/rest/sendings/1/reports/keys")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = "Basic YOUR_AUTH_TOKEN"

response = https.request(request)
puts response.read_body

using System;
using RestSharp;
namespace HelloWorldApplication {
  class HelloWorld {
    static void Main(string[] args) {
      var client = new RestClient("{{DASHBOARD_HOST}}/api/rest/sendings/1/reports/keys");
      client.Timeout = -1;
      var request = new RestRequest(Method.GET);
      request.AddHeader("Authorization", "Basic YOUR_AUTH_TOKEN");
      IRestResponse response = client.Execute(request);
      Console.WriteLine(response.Content);
    }
  }
}

Filtros

Parâmetro	Descrição
beforeDate	Mostrar os resultados `anteriores` à data indicada. A data deve ser especificada no formato `ISO 8601`.
afterDate	Mostrar os resultados `posteriores` à data indicada. A data deve ser especificada no formato `ISO 8601`.

{{DASHBOARD_HOST}}/api/rest/sendings/{sendingId}/reports/keys?afterDate=2019-01-01T00%3A00%3A00%2B00%3A00&beforeDate=2019-02-01T00%3A00%3A00%2B00%3A00

Obtenha o relatório detalhado das teclas premidas num envio de voz interativa. A resposta estará no formato text/csv e conterá as seguintes colunas: phonenumber, key, message

OTP

Gerar código

POST {{DASHBOARD_HOST}}/api/rest/otp/generate

curl -X POST '{{DASHBOARD_HOST}}/api/rest/otp/generate' \
-H 'Content-Type: application/json' \
-H 'Authorization: Basic YOUR_AUTH_TOKEN' \
-d '{
  "recipient": "34666555444"
}'

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => '{{DASHBOARD_HOST}}/api/rest/otp/generate',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS => '{
  "recipient": "34666555444"
}',
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/json',
    'Authorization: Basic YOUR_AUTH_TOKEN',
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

import java.io.DataOutputStream;
import java.io.BufferedReader;
import java.io.InputStreamReader;
import java.net.URL;
import java.net.HttpsURLConnection;

public class App {
  public static void main(String[] args) {
    try {
      URL url = new URL("{{DASHBOARD_HOST}}/api/rest/otp/generate");
      HttpsURLConnection connection = (HttpsURLConnection) url.openConnection();
      connection.setRequestMethod("POST");
      connection.setRequestProperty("Authorization", "Basic YOUR_AUTH_TOKEN");
      connection.setRequestProperty("Accept", "application/json");
      String requestBody = "{ \"recipient\": \"34666555444\" }";
      connection.setDoOutput(true);
      DataOutputStream wr = new DataOutputStream(connection.getOutputStream());
      wr.writeBytes(requestBody);
      wr.flush();
      wr.close();
      BufferedReader in = new BufferedReader(new InputStreamReader(connection.getInputStream()));
      String inputLine;
      StringBuffer response = new StringBuffer();
      while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
      }
      in.close();
      System.out.println(response.toString());
    } catch (Exception e) {
      // TODO: handle exception
    }
  }
}

var axios = require('axios');
var config = {
  method: 'post',
  url: '{{DASHBOARD_HOST}}/api/rest/otp/generate',
  headers: {
    'Content-Type': 'application/json',
    'Authorization': 'Basic YOUR_AUTH_TOKEN'
  },
  data: '{ "recipient": "34666555444" }'
};

axios(config)
.then(function (response) {
  console.log(JSON.stringify(response.data));
})
.catch(function (error) {
  console.log(error);
});

import requests

url = "{{DASHBOARD_HOST}}/api/rest/otp/generate"

payload = "{ \"recipient\": \"34666555444\" }"
headers = {
  'Content-Type': 'application/json',
  'Authorization': 'Basic YOUR_AUTH_TOKEN'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

require "uri"
require "net/http"

url = URI("{{DASHBOARD_HOST}}/api/rest/otp/generate")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = "application/json"
request["Authorization"] = "Basic YOUR_AUTH_TOKEN"
request.body = "{ \"recipient\": \"34666555444\" }"

response = https.request(request)
puts response.read_body

using System;
using RestSharp;
namespace HelloWorldApplication {
  class HelloWorld {
    static void Main(string[] args) {
      var client = new RestClient("{{DASHBOARD_HOST}}/api/rest/otp/generate");
      client.Timeout = -1;
      var request = new RestRequest(Method.POST);
      request.AddHeader("Authorization", "Basic YOUR_AUTH_TOKEN");
      request.AddHeader("Content-Type", "application/json");
      request.AddParameter("application/json", "{ \"recipient\": \"34666555444\" }",  ParameterType.RequestBody);
      IRestResponse response = client.Execute(request);
      Console.WriteLine(response.Content);
    }
  }
}

Response

HTTP Response Code 200 (OK)

{
  "data": {
    "recipient": "34666555444",
    "code": "1234",
    "attempts": 0,
    "maxAttempts": 3,
    "maxSecondsValidity": 60,
    "appId": "",
    "createdAt": "2020-01-01T12:00:00+00:00",
    "updatedAt": "2020-01-01T12:00:00+00:00",
    "expiresAt": "2020-01-01T12:01:00+00:00"
  }
}

Error response (HTTP 422)

{
  "error": {
    "code": 422,
    "description": "The recipient field must be a valid phone or email."
  }
}

Parâmetros

Parâmetro	Tipo	Obrigatório	Descrição
recipient	string	Sim	Número de telefone ou e-mail do utilizador.
alpha	boolean	Não	Indique se o código é alfanumérico ou numérico. O valor por defeito é `false`.
length	integer	Não	Tamanho do código. O valor mínimo é `3` e o valor máximo é `10`. O valor por defeito é `4`.
maxAttempts	integer	Não	Número máximo de tentativas. O valor mínimo é `1` e o valor máximo é `10`. O valor por defeito é `3`.
maxSecondsValidity	integer	Não	Número máximo de segundos entre a criação e validação do código. O valor mínimo é `30` e o valor máximo é `600`. O valor por defeito é `60`.
appId	string	Não	O mesmo telefone ou e-mail pode ser validado ao mesmo tempo, desde que seja com um `appId` diferente. O valor por defeito é `""`.
rejectIfPendingCode	boolean	Não	Impede a geração de um novo código OTP se existir um anterior em estado pendente. O valor por defeito é `false`.

Verificar código

POST {{DASHBOARD_HOST}}/api/rest/otp/check

curl -X POST '{{DASHBOARD_HOST}}/api/rest/otp/check' \
-H 'Content-Type: application/json' \
-H 'Authorization: Basic YOUR_AUTH_TOKEN' \
-d '{
  "recipient": "34666555444",
  "code": "1234"
}'

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => '{{DASHBOARD_HOST}}/api/rest/otp/check',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS => '{
  "recipient": "34666555444",
  "code": "1234"
}',
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/json',
    'Authorization: Basic YOUR_AUTH_TOKEN',
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

import java.io.DataOutputStream;
import java.io.BufferedReader;
import java.io.InputStreamReader;
import java.net.URL;
import java.net.HttpsURLConnection;

public class App {
  public static void main(String[] args) {
    try {
      URL url = new URL("{{DASHBOARD_HOST}}/api/rest/otp/check");
      HttpsURLConnection connection = (HttpsURLConnection) url.openConnection();
      connection.setRequestMethod("POST");
      connection.setRequestProperty("Authorization", "Basic YOUR_AUTH_TOKEN");
      connection.setRequestProperty("Accept", "application/json");
      String requestBody = "{ \"recipient\": \"34666555444\", \"code\": \"1234\" }";
      connection.setDoOutput(true);
      DataOutputStream wr = new DataOutputStream(connection.getOutputStream());
      wr.writeBytes(requestBody);
      wr.flush();
      wr.close();
      BufferedReader in = new BufferedReader(new InputStreamReader(connection.getInputStream()));
      String inputLine;
      StringBuffer response = new StringBuffer();
      while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
      }
      in.close();
      System.out.println(response.toString());
    } catch (Exception e) {
      // TODO: handle exception
    }
  }
}

var axios = require('axios');
var config = {
  method: 'post',
  url: '{{DASHBOARD_HOST}}/api/rest/otp/check',
  headers: {
    'Content-Type': 'application/json',
    'Authorization': 'Basic YOUR_AUTH_TOKEN'
  },
  data: '{ "recipient": "34666555444", "code": "1234" }'
};

axios(config)
.then(function (response) {
  console.log(JSON.stringify(response.data));
})
.catch(function (error) {
  console.log(error);
});

import requests

url = "{{DASHBOARD_HOST}}/api/rest/otp/check"

payload = "{ \"recipient\": \"34666555444\", \"code\": \"1234\" }"
headers = {
  'Content-Type': 'application/json',
  'Authorization': 'Basic YOUR_AUTH_TOKEN'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

require "uri"
require "net/http"

url = URI("{{DASHBOARD_HOST}}/api/rest/otp/check")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = "application/json"
request["Authorization"] = "Basic YOUR_AUTH_TOKEN"
request.body = "{ \"recipient\": \"34666555444\", \"code\": \"1234\" }"

response = https.request(request)
puts response.read_body

using System;
using RestSharp;
namespace HelloWorldApplication {
  class HelloWorld {
    static void Main(string[] args) {
      var client = new RestClient("{{DASHBOARD_HOST}}/api/rest/otp/check");
      client.Timeout = -1;
      var request = new RestRequest(Method.POST);
      request.AddHeader("Authorization", "Basic YOUR_AUTH_TOKEN");
      request.AddHeader("Content-Type", "application/json");
      request.AddParameter("application/json", "{ \"recipient\": \"34666555444\", \"code\": \"1234\" }",  ParameterType.RequestBody);
      IRestResponse response = client.Execute(request);
      Console.WriteLine(response.Content);
    }
  }
}

Response

HTTP Response Code 200 (OK)

{
  "data": {
    "valid": true,
    "reason": "Valid",
    "otp": {
      "data": {
        "recipient": "34666555444",
        "code": "1234",
        "attempts": 1,
        "maxAttempts": 3,
        "maxSecondsValidity": 60,
        "appId": "",
        "createdAt": "2020-01-01T12:00:00+00:00",
        "updatedAt": "2020-01-01T12:00:00+00:00",
        "expiresAt": "2020-01-01T12:01:00+00:00"
      }
    }
  }
}

{
  "data": {
    "valid": false,
    "reason": "Expired",
    "otp": {
      "data": {
        "recipient": "34666555444",
        "code": "1234",
        "attempts": 1,
        "maxAttempts": 3,
        "maxSecondsValidity": 60,
        "appId": "",
        "createdAt": "2020-01-01T12:00:00+00:00",
        "updatedAt": "2020-01-01T12:00:00+00:00",
        "expiresAt": "2020-01-01T12:01:00+00:00"
      }
    }
  }
}

Error response (HTTP 422)

{
  "error": {
    "code": 422,
    "description": "The recipient field is required."
  }
}

Parâmetros

Parâmetro	Tipo	Obrigatório	Descrição
recipient	string	Sim	Número de telefone ou e-mail do utilizador.
code	string	Sim	Código a verificar.
caseSensitive	boolean	Não	Diferencia maiúsculas de minúsculas na comparação de códigos. O valor por defeito é `false`.
appId	string	Não	O mesmo telefone ou e-mail pode ser validado ao mesmo tempo, desde que seja com um `appId` diferente. O valor por defeito é `""`.

Respostas

Razão	Válido	Descrição
Valid	Sim	O código é válido.
Invalid code	Não	O código não é válido.
Maximum attempts reached	Não	O número de tentativas excedeu o máximo.
Expired	Não	O tempo de validação excedeu o máximo.

Conta

Devolve informação da conta como nome de utilizador, email, fuso horário, idioma, saldo, data de criação, país e moeda.

GET {{DASHBOARD_HOST}}/api/rest/account

curl -X GET '{{DASHBOARD_HOST}}/api/rest/account' \
-H 'Content-Type: application/json' \
-H 'Authorization: Basic YOUR_AUTH_TOKEN'

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => '{{DASHBOARD_HOST}}/api/rest/account',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/json',
    'Authorization: Basic YOUR_AUTH_TOKEN',
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

import java.io.DataOutputStream;
import java.io.BufferedReader;
import java.io.InputStreamReader;
import java.net.URL;
import java.net.HttpsURLConnection;

public class App {
  public static void main(String[] args) {
    try {
      URL url = new URL("{{DASHBOARD_HOST}}/api/rest/account");
      HttpsURLConnection connection = (HttpsURLConnection) url.openConnection();
      connection.setRequestMethod("GET");
      connection.setRequestProperty("Authorization", "Basic YOUR_AUTH_TOKEN");
      connection.setRequestProperty("Accept", "application/json");
      BufferedReader in = new BufferedReader(new InputStreamReader(connection.getInputStream()));
      String inputLine;
      StringBuffer response = new StringBuffer();
      while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
      }
      in.close();
      System.out.println(response.toString());
    } catch (Exception e) {
      // TODO: handle exception
    }
  }
}

var axios = require('axios');
var config = {
  method: 'get',
  url: '{{DASHBOARD_HOST}}/api/rest/account',
  headers: {
    'Content-Type': 'application/json',
    'Authorization': 'Basic YOUR_AUTH_TOKEN'
  }
};

axios(config)
.then(function (response) {
  console.log(JSON.stringify(response.data));
})
.catch(function (error) {
  console.log(error);
});

import requests

url = "{{DASHBOARD_HOST}}/api/rest/account"

payload = {}
headers = {
  'Content-Type': 'application/json',
  'Authorization': 'Basic YOUR_AUTH_TOKEN'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

require "uri"
require "net/http"

url = URI("{{DASHBOARD_HOST}}/api/rest/account")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Content-Type"] = "application/json"
request["Authorization"] = "Basic YOUR_AUTH_TOKEN"

response = https.request(request)
puts response.read_body

using System;
using RestSharp;
namespace HelloWorldApplication {
  class HelloWorld {
    static void Main(string[] args) {
      var client = new RestClient("{{DASHBOARD_HOST}}/api/rest/account");
      client.Timeout = -1;
      var request = new RestRequest(Method.GET);
      request.AddHeader("Authorization", "Basic YOUR_AUTH_TOKEN");
      request.AddHeader("Content-Type", "application/json");
      IRestResponse response = client.Execute(request);
      Console.WriteLine(response.Content);
    }
  }
}

Organização

As APIs de organização permitem gerir os utilizadores que fazem parte da organização do utilizador autenticado: convidar novos utilizadores, consultá-los, ativá-los, desativá-los ou eliminá-los, distribuir saldo entre eles e consultar as campanhas de toda a organização.

Para as utilizar, o utilizador autenticado deve pertencer a uma organização e ter a permissão de gestão de utilizadores exigida por cada operação. São as mesmas permissões que se aplicam na gestão de utilizadores da plataforma:

Operação	Permissão necessária
Lista de convites	Ver convites
Criar e reenviar convites	Criar convites
Cancelar convites	Eliminar convites
Lista de utilizadores	Ver utilizadores
Ativar e desativar utilizadores	Editar utilizadores
Eliminar utilizadores	Eliminar utilizadores
Transferir saldo	Editar utilizadores
Lista de campanhas da organização	Ver utilizadores e Ver estatísticas

Se o utilizador não pertencer a uma organização, a resposta terá um código HTTP 403 e a descrição User does not belong to an organization. Se não tiver a permissão necessária, a resposta terá um código HTTP 403 e a descrição User is not allowed to perform this action.

As operações sobre um recurso concreto (um convite ou um utilizador) só podem ser realizadas sobre recursos da própria organização. Se o identificador não existir ou pertencer a outra organização, a resposta terá um código HTTP 404.

As listas são paginadas. O parâmetro limit indica o total de resultados por página (valor por defeito: 100, máximo: 1000) e o parâmetro page indica a página a consultar. A resposta inclui a informação de paginação no campo meta.pagination.

Convites

Lista de convites

GET {{DASHBOARD_HOST}}/api/rest/organization/invitations

curl -X GET '{{DASHBOARD_HOST}}/api/rest/organization/invitations?status=pending' \
-H 'Content-Type: application/json' \
-H 'Authorization: Basic YOUR_AUTH_TOKEN'

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => '{{DASHBOARD_HOST}}/api/rest/organization/invitations?status=pending',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/json',
    'Authorization: Basic YOUR_AUTH_TOKEN',
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

import java.io.DataOutputStream;
import java.io.BufferedReader;
import java.io.InputStreamReader;
import java.net.URL;
import java.net.HttpsURLConnection;

public class App {
  public static void main(String[] args) {
    try {
      URL url = new URL("{{DASHBOARD_HOST}}/api/rest/organization/invitations?status=pending");
      HttpsURLConnection connection = (HttpsURLConnection) url.openConnection();
      connection.setRequestMethod("GET");
      connection.setRequestProperty("Authorization", "Basic YOUR_AUTH_TOKEN");
      connection.setRequestProperty("Accept", "application/json");
      BufferedReader in = new BufferedReader(new InputStreamReader(connection.getInputStream()));
      String inputLine;
      StringBuffer response = new StringBuffer();
      while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
      }
      in.close();
      System.out.println(response.toString());
    } catch (Exception e) {
      // TODO: handle exception
    }
  }
}

var axios = require('axios');
var config = {
  method: 'get',
  url: '{{DASHBOARD_HOST}}/api/rest/organization/invitations?status=pending',
  headers: {
    'Content-Type': 'application/json',
    'Authorization': 'Basic YOUR_AUTH_TOKEN'
  }
};

axios(config)
.then(function (response) {
  console.log(JSON.stringify(response.data));
})
.catch(function (error) {
  console.log(error);
});

import requests

url = "{{DASHBOARD_HOST}}/api/rest/organization/invitations?status=pending"

payload = {}
headers = {
  'Content-Type': 'application/json',
  'Authorization': 'Basic YOUR_AUTH_TOKEN'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

require "uri"
require "net/http"

url = URI("{{DASHBOARD_HOST}}/api/rest/organization/invitations?status=pending")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Content-Type"] = "application/json"
request["Authorization"] = "Basic YOUR_AUTH_TOKEN"

response = https.request(request)
puts response.read_body

using System;
using RestSharp;
namespace HelloWorldApplication {
  class HelloWorld {
    static void Main(string[] args) {
      var client = new RestClient("{{DASHBOARD_HOST}}/api/rest/organization/invitations?status=pending");
      client.Timeout = -1;
      var request = new RestRequest(Method.GET);
      request.AddHeader("Authorization", "Basic YOUR_AUTH_TOKEN");
      request.AddHeader("Content-Type", "application/json");
      IRestResponse response = client.Execute(request);
      Console.WriteLine(response.Content);
    }
  }
}

Response

{
  "data": [
    {
      "id": 12,
      "email": "john.doe@example.com",
      "role": "user",
      "status": "pending",
      "createdAt": "2026-10-13T09:30:00+00:00",
      "expiresAt": "2026-10-14T09:30:00+00:00"
    }
  ],
  "meta": {
    "pagination": {
      "total": 1,
      "count": 1,
      "per_page": 100,
      "current_page": 1,
      "total_pages": 1,
      "links": []
    }
  }
}

Devolve os convites da organização em qualquer estado, incluindo os cancelados, ordenados do mais recente para o mais antigo.

Filtros

Parâmetro	Descrição
limit	Total de convites a mostrar num único pedido. Valor por defeito: `100`. Máximo: `1000`.
status	Filtrar pelo estado do convite. Valores disponíveis: `pending`, `accepted`, `cancelled`, `expired`. Exemplo: ?status=pending.
email	Filtrar pelo e-mail convidado. Deve coincidir exatamente. Exemplo: ?email=john.doe%40example.com.
role	Filtrar pela função do convite. Valores disponíveis: `admin`, `user`. Exemplo: ?role=admin.
beforeDate	Mostrar os convites criados `antes` da data indicada. A data deve ser especificada no formato `ISO 8601`. Exemplo: ?beforeDate=2026-01-01T00%3A00%3A00%2B00%3A00.
afterDate	Mostrar os convites criados `após` a data indicada. A data deve ser especificada no formato `ISO 8601`. Exemplo: ?afterDate=2026-01-01T00%3A00%3A00%2B00%3A00.

Os parâmetros devem ser codificados corretamente (urlencode) em relação ao padrão RFC 3986 para serem suportados pelo servidor.

Campos da resposta

Parâmetro	Descrição
id	Identificador do convite.
email	E-mail para o qual o convite foi enviado.
role	Função que o utilizador terá ao aceitar o convite. Valores possíveis: `admin`, `user`.
status	Estado do convite. Valores possíveis: `pending`: Convite enviado, por aceitar e ainda não expirado. `accepted`: O destinatário aceitou o convite. `cancelled`: O convite foi cancelado. `expired`: O convite expirou sem ter sido aceite.
createdAt	Data de criação do convite.
expiresAt	Data de expiração do convite. Após esta data, o convite já não pode ser aceite.

Criar um convite

POST {{DASHBOARD_HOST}}/api/rest/organization/invitations

curl -X POST '{{DASHBOARD_HOST}}/api/rest/organization/invitations' \
-H 'Content-Type: application/json' \
-H 'Authorization: Basic YOUR_AUTH_TOKEN' \
-d '{
  "email": "john.doe@example.com",
  "role": "user"
}'

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => '{{DASHBOARD_HOST}}/api/rest/organization/invitations',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS => '{
  "email": "john.doe@example.com",
  "role": "user"
}',
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/json',
    'Authorization: Basic YOUR_AUTH_TOKEN',
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

import java.io.DataOutputStream;
import java.io.BufferedReader;
import java.io.InputStreamReader;
import java.net.URL;
import java.net.HttpsURLConnection;

public class App {
  public static void main(String[] args) {
    try {
      URL url = new URL("{{DASHBOARD_HOST}}/api/rest/organization/invitations");
      HttpsURLConnection connection = (HttpsURLConnection) url.openConnection();
      connection.setRequestMethod("POST");
      connection.setRequestProperty("Authorization", "Basic YOUR_AUTH_TOKEN");
      connection.setRequestProperty("Accept", "application/json");
      String requestBody = "{ \"email\": \"john.doe@example.com\", \"role\": \"user\" }";
      connection.setDoOutput(true);
      DataOutputStream wr = new DataOutputStream(connection.getOutputStream());
      wr.writeBytes(requestBody);
      wr.flush();
      wr.close();
      BufferedReader in = new BufferedReader(new InputStreamReader(connection.getInputStream()));
      String inputLine;
      StringBuffer response = new StringBuffer();
      while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
      }
      in.close();
      System.out.println(response.toString());
    } catch (Exception e) {
      // TODO: handle exception
    }
  }
}

var axios = require('axios');
var config = {
  method: 'post',
  url: '{{DASHBOARD_HOST}}/api/rest/organization/invitations',
  headers: {
    'Content-Type': 'application/json',
    'Authorization': 'Basic YOUR_AUTH_TOKEN'
  },
  data: '{ "email": "john.doe@example.com", "role": "user" }'
};

axios(config)
.then(function (response) {
  console.log(JSON.stringify(response.data));
})
.catch(function (error) {
  console.log(error);
});

import requests

url = "{{DASHBOARD_HOST}}/api/rest/organization/invitations"

payload = "{ \"email\": \"john.doe@example.com\", \"role\": \"user\" }"
headers = {
  'Content-Type': 'application/json',
  'Authorization': 'Basic YOUR_AUTH_TOKEN'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

require "uri"
require "net/http"

url = URI("{{DASHBOARD_HOST}}/api/rest/organization/invitations")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = "application/json"
request["Authorization"] = "Basic YOUR_AUTH_TOKEN"
request.body = "{ \"email\": \"john.doe@example.com\", \"role\": \"user\" }"

response = https.request(request)
puts response.read_body

using System;
using RestSharp;
namespace HelloWorldApplication {
  class HelloWorld {
    static void Main(string[] args) {
      var client = new RestClient("{{DASHBOARD_HOST}}/api/rest/organization/invitations");
      client.Timeout = -1;
      var request = new RestRequest(Method.POST);
      request.AddHeader("Authorization", "Basic YOUR_AUTH_TOKEN");
      request.AddHeader("Content-Type", "application/json");
      request.AddParameter("application/json", "{ \"email\": \"john.doe@example.com\", \"role\": \"user\" }",  ParameterType.RequestBody);
      IRestResponse response = client.Execute(request);
      Console.WriteLine(response.Content);
    }
  }
}

Response (HTTP 201)

{
  "data": {
    "id": 12,
    "email": "john.doe@example.com",
    "role": "user",
    "status": "pending",
    "createdAt": "2026-10-13T09:30:00+00:00",
    "expiresAt": "2026-10-14T09:30:00+00:00"
  }
}

Error response (HTTP 429)

{
  "error": {
    "code": 429,
    "description": "Too many invitation emails to this address, try again later"
  }
}

Convida um novo utilizador a juntar-se à organização. O destinatário receberá um e-mail com uma ligação para aceitar o convite, definir a sua palavra-passe e completar o seu perfil. O convite expira ao fim de 24 horas.

Parâmetros

Parâmetro	Tipo	Obrigatório	Descrição
email	string	Sim	E-mail do utilizador a convidar. Comprimento máximo: 255 caracteres. Não pode ter outro convite pendente na organização nem estar em uso por outro utilizador da plataforma.
role	string	Sim	Função que o utilizador terá ao aceitar o convite. Valores disponíveis: `admin`, `user`.

Se o convite for criado com sucesso, a resposta terá um código HTTP 201 e o convite criado. Os campos da resposta são os mesmos da lista de convites.

Se algum parâmetro não for válido, a resposta terá um código HTTP 422.

Limites de envio

Para evitar o envio massivo de e-mails, o envio de convites está limitado:

Pode ser enviado um e-mail de convite a cada 10 minutos para o mesmo destinatário. O limite aplica-se tanto ao criar como ao reenviar convites, incluindo quando se volta a convidar um e-mail cujo convite acabou de ser cancelado.
Cada organização pode enviar um máximo de 25 e-mails de convite por hora.

Se algum destes limites for excedido, o convite não será criado nem reenviado e a resposta terá um código HTTP 429. O cabeçalho Retry-After indica os segundos que é necessário aguardar antes de tentar novamente.

Cancelar um convite

POST {{DASHBOARD_HOST}}/api/rest/organization/invitations/<ID>/cancel

curl -X POST '{{DASHBOARD_HOST}}/api/rest/organization/invitations/12/cancel' \
-H 'Content-Type: application/json' \
-H 'Authorization: Basic YOUR_AUTH_TOKEN'

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => '{{DASHBOARD_HOST}}/api/rest/organization/invitations/12/cancel',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/json',
    'Authorization: Basic YOUR_AUTH_TOKEN',
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

import java.io.DataOutputStream;
import java.io.BufferedReader;
import java.io.InputStreamReader;
import java.net.URL;
import java.net.HttpsURLConnection;

public class App {
  public static void main(String[] args) {
    try {
      URL url = new URL("{{DASHBOARD_HOST}}/api/rest/organization/invitations/12/cancel");
      HttpsURLConnection connection = (HttpsURLConnection) url.openConnection();
      connection.setRequestMethod("POST");
      connection.setRequestProperty("Authorization", "Basic YOUR_AUTH_TOKEN");
      connection.setRequestProperty("Accept", "application/json");
      BufferedReader in = new BufferedReader(new InputStreamReader(connection.getInputStream()));
      String inputLine;
      StringBuffer response = new StringBuffer();
      while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
      }
      in.close();
      System.out.println(response.toString());
    } catch (Exception e) {
      // TODO: handle exception
    }
  }
}

var axios = require('axios');
var config = {
  method: 'post',
  url: '{{DASHBOARD_HOST}}/api/rest/organization/invitations/12/cancel',
  headers: {
    'Content-Type': 'application/json',
    'Authorization': 'Basic YOUR_AUTH_TOKEN'
  }
};

axios(config)
.then(function (response) {
  console.log(JSON.stringify(response.data));
})
.catch(function (error) {
  console.log(error);
});

import requests

url = "{{DASHBOARD_HOST}}/api/rest/organization/invitations/12/cancel"

payload = {}
headers = {
  'Content-Type': 'application/json',
  'Authorization': 'Basic YOUR_AUTH_TOKEN'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

require "uri"
require "net/http"

url = URI("{{DASHBOARD_HOST}}/api/rest/organization/invitations/12/cancel")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = "application/json"
request["Authorization"] = "Basic YOUR_AUTH_TOKEN"

response = https.request(request)
puts response.read_body

using System;
using RestSharp;
namespace HelloWorldApplication {
  class HelloWorld {
    static void Main(string[] args) {
      var client = new RestClient("{{DASHBOARD_HOST}}/api/rest/organization/invitations/12/cancel");
      client.Timeout = -1;
      var request = new RestRequest(Method.POST);
      request.AddHeader("Authorization", "Basic YOUR_AUTH_TOKEN");
      request.AddHeader("Content-Type", "application/json");
      IRestResponse response = client.Execute(request);
      Console.WriteLine(response.Content);
    }
  }
}

Error response (HTTP 409)

{
  "error": {
    "code": 409,
    "description": "Only pending invitations can be cancelled"
  }
}

Cancela um convite pendente. A ligação enviada ao destinatário deixa de ser válida, mas o convite mantém-se na lista de convites com o estado cancelled.

Parâmetros de URL

Parâmetro	Descrição
ID	Identificador do convite.

Se o pedido for bem-sucedido, a resposta terá um código HTTP 204.

Só é possível cancelar convites com o estado pending. Em qualquer outro caso, a resposta terá um código HTTP 409.

Reenviar um convite

POST {{DASHBOARD_HOST}}/api/rest/organization/invitations/<ID>/resend

curl -X POST '{{DASHBOARD_HOST}}/api/rest/organization/invitations/12/resend' \
-H 'Content-Type: application/json' \
-H 'Authorization: Basic YOUR_AUTH_TOKEN'

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => '{{DASHBOARD_HOST}}/api/rest/organization/invitations/12/resend',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/json',
    'Authorization: Basic YOUR_AUTH_TOKEN',
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

import java.io.DataOutputStream;
import java.io.BufferedReader;
import java.io.InputStreamReader;
import java.net.URL;
import java.net.HttpsURLConnection;

public class App {
  public static void main(String[] args) {
    try {
      URL url = new URL("{{DASHBOARD_HOST}}/api/rest/organization/invitations/12/resend");
      HttpsURLConnection connection = (HttpsURLConnection) url.openConnection();
      connection.setRequestMethod("POST");
      connection.setRequestProperty("Authorization", "Basic YOUR_AUTH_TOKEN");
      connection.setRequestProperty("Accept", "application/json");
      BufferedReader in = new BufferedReader(new InputStreamReader(connection.getInputStream()));
      String inputLine;
      StringBuffer response = new StringBuffer();
      while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
      }
      in.close();
      System.out.println(response.toString());
    } catch (Exception e) {
      // TODO: handle exception
    }
  }
}

var axios = require('axios');
var config = {
  method: 'post',
  url: '{{DASHBOARD_HOST}}/api/rest/organization/invitations/12/resend',
  headers: {
    'Content-Type': 'application/json',
    'Authorization': 'Basic YOUR_AUTH_TOKEN'
  }
};

axios(config)
.then(function (response) {
  console.log(JSON.stringify(response.data));
})
.catch(function (error) {
  console.log(error);
});

import requests

url = "{{DASHBOARD_HOST}}/api/rest/organization/invitations/12/resend"

payload = {}
headers = {
  'Content-Type': 'application/json',
  'Authorization': 'Basic YOUR_AUTH_TOKEN'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

require "uri"
require "net/http"

url = URI("{{DASHBOARD_HOST}}/api/rest/organization/invitations/12/resend")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = "application/json"
request["Authorization"] = "Basic YOUR_AUTH_TOKEN"

response = https.request(request)
puts response.read_body

using System;
using RestSharp;
namespace HelloWorldApplication {
  class HelloWorld {
    static void Main(string[] args) {
      var client = new RestClient("{{DASHBOARD_HOST}}/api/rest/organization/invitations/12/resend");
      client.Timeout = -1;
      var request = new RestRequest(Method.POST);
      request.AddHeader("Authorization", "Basic YOUR_AUTH_TOKEN");
      request.AddHeader("Content-Type", "application/json");
      IRestResponse response = client.Execute(request);
      Console.WriteLine(response.Content);
    }
  }
}

Error response (HTTP 409)

{
  "error": {
    "code": 409,
    "description": "Only pending invitations can be resent"
  }
}

Volta a enviar o e-mail de convite ao destinatário e renova a sua expiração: o convite expirará 24 horas após o reenvio.

Parâmetros de URL

Parâmetro	Descrição
ID	Identificador do convite.

Se o pedido for bem-sucedido, a resposta terá um código HTTP 204.

Só é possível reenviar convites com o estado pending. Em qualquer outro caso, a resposta terá um código HTTP 409. Para voltar a convidar um e-mail cujo convite expirou ou foi cancelado, crie um novo convite.

O reenvio está sujeito aos mesmos limites de envio que a criação de convites.

Utilizadores

Lista de utilizadores

GET {{DASHBOARD_HOST}}/api/rest/organization/users

curl -X GET '{{DASHBOARD_HOST}}/api/rest/organization/users' \
-H 'Content-Type: application/json' \
-H 'Authorization: Basic YOUR_AUTH_TOKEN'

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => '{{DASHBOARD_HOST}}/api/rest/organization/users',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/json',
    'Authorization: Basic YOUR_AUTH_TOKEN',
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

import java.io.DataOutputStream;
import java.io.BufferedReader;
import java.io.InputStreamReader;
import java.net.URL;
import java.net.HttpsURLConnection;

public class App {
  public static void main(String[] args) {
    try {
      URL url = new URL("{{DASHBOARD_HOST}}/api/rest/organization/users");
      HttpsURLConnection connection = (HttpsURLConnection) url.openConnection();
      connection.setRequestMethod("GET");
      connection.setRequestProperty("Authorization", "Basic YOUR_AUTH_TOKEN");
      connection.setRequestProperty("Accept", "application/json");
      BufferedReader in = new BufferedReader(new InputStreamReader(connection.getInputStream()));
      String inputLine;
      StringBuffer response = new StringBuffer();
      while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
      }
      in.close();
      System.out.println(response.toString());
    } catch (Exception e) {
      // TODO: handle exception
    }
  }
}

var axios = require('axios');
var config = {
  method: 'get',
  url: '{{DASHBOARD_HOST}}/api/rest/organization/users',
  headers: {
    'Content-Type': 'application/json',
    'Authorization': 'Basic YOUR_AUTH_TOKEN'
  }
};

axios(config)
.then(function (response) {
  console.log(JSON.stringify(response.data));
})
.catch(function (error) {
  console.log(error);
});

import requests

url = "{{DASHBOARD_HOST}}/api/rest/organization/users"

payload = {}
headers = {
  'Content-Type': 'application/json',
  'Authorization': 'Basic YOUR_AUTH_TOKEN'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

require "uri"
require "net/http"

url = URI("{{DASHBOARD_HOST}}/api/rest/organization/users")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Content-Type"] = "application/json"
request["Authorization"] = "Basic YOUR_AUTH_TOKEN"

response = https.request(request)
puts response.read_body

using System;
using RestSharp;
namespace HelloWorldApplication {
  class HelloWorld {
    static void Main(string[] args) {
      var client = new RestClient("{{DASHBOARD_HOST}}/api/rest/organization/users");
      client.Timeout = -1;
      var request = new RestRequest(Method.GET);
      request.AddHeader("Authorization", "Basic YOUR_AUTH_TOKEN");
      request.AddHeader("Content-Type", "application/json");
      IRestResponse response = client.Execute(request);
      Console.WriteLine(response.Content);
    }
  }
}

Response

{
  "data": [
    {
      "id": 101,
      "username": "john",
      "email": "john@example.com",
      "roles": [
        "admin"
      ],
      "status": "active",
      "balance": 125.5,
      "balance_limit": 0,
      "effective_balance": 125.5,
      "language": "es",
      "createdAt": "2026-01-15T10:00:00+00:00"
    },
    {
      "id": 102,
      "username": "alice",
      "email": "alice@example.com",
      "roles": [
        "user"
      ],
      "status": "active",
      "balance": 48.2,
      "balance_limit": 0,
      "effective_balance": 48.2,
      "language": "en",
      "createdAt": "2026-03-02T08:45:00+00:00"
    }
  ],
  "meta": {
    "pagination": {
      "total": 2,
      "count": 2,
      "per_page": 100,
      "current_page": 1,
      "total_pages": 1,
      "links": []
    }
  }
}

Devolve os utilizadores ativos e desativados da organização, incluindo o utilizador autenticado. Os utilizadores eliminados não são incluídos.

Filtros

Parâmetro	Descrição
limit	Total de utilizadores a mostrar num único pedido. Valor por defeito: `100`. Máximo: `1000`.
role	Filtrar por função. Exemplo: ?role=admin.
status	Filtrar por estado. Valores disponíveis: `active`, `disabled`. Exemplo: ?status=active.
search	Pesquisar por nome de utilizador ou e-mail. Devolve os utilizadores cujo nome de utilizador ou e-mail contenha o texto indicado. Exemplo: ?search=alice.

Campos da resposta

Parâmetro	Descrição
id	Identificador do utilizador.
username	Nome de utilizador.
email	E-mail do utilizador.
roles	Funções atribuídas ao utilizador. Exemplo: `["admin"]`.
status	Estado do utilizador. Valores possíveis: `active`: O utilizador pode aceder à plataforma e à API. `disabled`: O utilizador está desativado e não pode aceder à plataforma nem à API.
balance	Saldo da conta do utilizador. Nos utilizadores pós-pagos pode ser negativo, uma vez que reflete o consumo realizado.
balance_limit	Limite de crédito do utilizador. Nos utilizadores pós-pagos é um valor negativo que indica o crédito concedido. Nos utilizadores pré-pagos é `0`.
effective_balance	Saldo disponível para realizar envios. Nos utilizadores pré-pagos coincide com `balance`. Nos utilizadores pós-pagos é o crédito disponível: `balance` menos `balance_limit`.
language	Idioma do utilizador. Exemplo: `pt`.
createdAt	Data de criação do utilizador.

Desativar um utilizador

POST {{DASHBOARD_HOST}}/api/rest/organization/users/<ID>/deactivate

curl -X POST '{{DASHBOARD_HOST}}/api/rest/organization/users/102/deactivate' \
-H 'Content-Type: application/json' \
-H 'Authorization: Basic YOUR_AUTH_TOKEN'

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => '{{DASHBOARD_HOST}}/api/rest/organization/users/102/deactivate',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/json',
    'Authorization: Basic YOUR_AUTH_TOKEN',
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

import java.io.DataOutputStream;
import java.io.BufferedReader;
import java.io.InputStreamReader;
import java.net.URL;
import java.net.HttpsURLConnection;

public class App {
  public static void main(String[] args) {
    try {
      URL url = new URL("{{DASHBOARD_HOST}}/api/rest/organization/users/102/deactivate");
      HttpsURLConnection connection = (HttpsURLConnection) url.openConnection();
      connection.setRequestMethod("POST");
      connection.setRequestProperty("Authorization", "Basic YOUR_AUTH_TOKEN");
      connection.setRequestProperty("Accept", "application/json");
      BufferedReader in = new BufferedReader(new InputStreamReader(connection.getInputStream()));
      String inputLine;
      StringBuffer response = new StringBuffer();
      while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
      }
      in.close();
      System.out.println(response.toString());
    } catch (Exception e) {
      // TODO: handle exception
    }
  }
}

var axios = require('axios');
var config = {
  method: 'post',
  url: '{{DASHBOARD_HOST}}/api/rest/organization/users/102/deactivate',
  headers: {
    'Content-Type': 'application/json',
    'Authorization': 'Basic YOUR_AUTH_TOKEN'
  }
};

axios(config)
.then(function (response) {
  console.log(JSON.stringify(response.data));
})
.catch(function (error) {
  console.log(error);
});

import requests

url = "{{DASHBOARD_HOST}}/api/rest/organization/users/102/deactivate"

payload = {}
headers = {
  'Content-Type': 'application/json',
  'Authorization': 'Basic YOUR_AUTH_TOKEN'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

require "uri"
require "net/http"

url = URI("{{DASHBOARD_HOST}}/api/rest/organization/users/102/deactivate")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = "application/json"
request["Authorization"] = "Basic YOUR_AUTH_TOKEN"

response = https.request(request)
puts response.read_body

using System;
using RestSharp;
namespace HelloWorldApplication {
  class HelloWorld {
    static void Main(string[] args) {
      var client = new RestClient("{{DASHBOARD_HOST}}/api/rest/organization/users/102/deactivate");
      client.Timeout = -1;
      var request = new RestRequest(Method.POST);
      request.AddHeader("Authorization", "Basic YOUR_AUTH_TOKEN");
      request.AddHeader("Content-Type", "application/json");
      IRestResponse response = client.Execute(request);
      Console.WriteLine(response.Content);
    }
  }
}

Error response (HTTP 409)

{
  "error": {
    "code": 409,
    "description": "Users can not deactivate themselves"
  }
}

Desativa um utilizador da organização. Enquanto estiver desativado, não poderá aceder à plataforma nem à API. O utilizador mantém o seu saldo e o seu limite de crédito.

Parâmetros de URL

Parâmetro	Descrição
ID	Identificador do utilizador.

Se o pedido for bem-sucedido, a resposta terá um código HTTP 204. Desativar um utilizador que já está desativado não produz qualquer alteração.

Um utilizador não se pode desativar a si próprio. Nesse caso, a resposta terá um código HTTP 409.

Ativar um utilizador

POST {{DASHBOARD_HOST}}/api/rest/organization/users/<ID>/activate

curl -X POST '{{DASHBOARD_HOST}}/api/rest/organization/users/102/activate' \
-H 'Content-Type: application/json' \
-H 'Authorization: Basic YOUR_AUTH_TOKEN'

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => '{{DASHBOARD_HOST}}/api/rest/organization/users/102/activate',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/json',
    'Authorization: Basic YOUR_AUTH_TOKEN',
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

import java.io.DataOutputStream;
import java.io.BufferedReader;
import java.io.InputStreamReader;
import java.net.URL;
import java.net.HttpsURLConnection;

public class App {
  public static void main(String[] args) {
    try {
      URL url = new URL("{{DASHBOARD_HOST}}/api/rest/organization/users/102/activate");
      HttpsURLConnection connection = (HttpsURLConnection) url.openConnection();
      connection.setRequestMethod("POST");
      connection.setRequestProperty("Authorization", "Basic YOUR_AUTH_TOKEN");
      connection.setRequestProperty("Accept", "application/json");
      BufferedReader in = new BufferedReader(new InputStreamReader(connection.getInputStream()));
      String inputLine;
      StringBuffer response = new StringBuffer();
      while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
      }
      in.close();
      System.out.println(response.toString());
    } catch (Exception e) {
      // TODO: handle exception
    }
  }
}

var axios = require('axios');
var config = {
  method: 'post',
  url: '{{DASHBOARD_HOST}}/api/rest/organization/users/102/activate',
  headers: {
    'Content-Type': 'application/json',
    'Authorization': 'Basic YOUR_AUTH_TOKEN'
  }
};

axios(config)
.then(function (response) {
  console.log(JSON.stringify(response.data));
})
.catch(function (error) {
  console.log(error);
});

import requests

url = "{{DASHBOARD_HOST}}/api/rest/organization/users/102/activate"

payload = {}
headers = {
  'Content-Type': 'application/json',
  'Authorization': 'Basic YOUR_AUTH_TOKEN'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

require "uri"
require "net/http"

url = URI("{{DASHBOARD_HOST}}/api/rest/organization/users/102/activate")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = "application/json"
request["Authorization"] = "Basic YOUR_AUTH_TOKEN"

response = https.request(request)
puts response.read_body

using System;
using RestSharp;
namespace HelloWorldApplication {
  class HelloWorld {
    static void Main(string[] args) {
      var client = new RestClient("{{DASHBOARD_HOST}}/api/rest/organization/users/102/activate");
      client.Timeout = -1;
      var request = new RestRequest(Method.POST);
      request.AddHeader("Authorization", "Basic YOUR_AUTH_TOKEN");
      request.AddHeader("Content-Type", "application/json");
      IRestResponse response = client.Execute(request);
      Console.WriteLine(response.Content);
    }
  }
}

Volta a ativar um utilizador desativado, que poderá aceder novamente à plataforma e à API.

Parâmetros de URL

Parâmetro	Descrição
ID	Identificador do utilizador.

Se o pedido for bem-sucedido, a resposta terá um código HTTP 204. Ativar um utilizador que já está ativo não produz qualquer alteração.

Eliminar um utilizador

DELETE {{DASHBOARD_HOST}}/api/rest/organization/users/<ID>

curl -X DELETE '{{DASHBOARD_HOST}}/api/rest/organization/users/102' \
-H 'Content-Type: application/json' \
-H 'Authorization: Basic YOUR_AUTH_TOKEN'

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => '{{DASHBOARD_HOST}}/api/rest/organization/users/102',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => 'DELETE',
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/json',
    'Authorization: Basic YOUR_AUTH_TOKEN',
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

import java.io.DataOutputStream;
import java.io.BufferedReader;
import java.io.InputStreamReader;
import java.net.URL;
import java.net.HttpsURLConnection;

public class App {
  public static void main(String[] args) {
    try {
      URL url = new URL("{{DASHBOARD_HOST}}/api/rest/organization/users/102");
      HttpsURLConnection connection = (HttpsURLConnection) url.openConnection();
      connection.setRequestMethod("DELETE");
      connection.setRequestProperty("Authorization", "Basic YOUR_AUTH_TOKEN");
      connection.setRequestProperty("Accept", "application/json");
      BufferedReader in = new BufferedReader(new InputStreamReader(connection.getInputStream()));
      String inputLine;
      StringBuffer response = new StringBuffer();
      while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
      }
      in.close();
      System.out.println(response.toString());
    } catch (Exception e) {
      // TODO: handle exception
    }
  }
}

var axios = require('axios');
var config = {
  method: 'delete',
  url: '{{DASHBOARD_HOST}}/api/rest/organization/users/102',
  headers: {
    'Content-Type': 'application/json',
    'Authorization': 'Basic YOUR_AUTH_TOKEN'
  }
};

axios(config)
.then(function (response) {
  console.log(JSON.stringify(response.data));
})
.catch(function (error) {
  console.log(error);
});

import requests

url = "{{DASHBOARD_HOST}}/api/rest/organization/users/102"

payload = {}
headers = {
  'Content-Type': 'application/json',
  'Authorization': 'Basic YOUR_AUTH_TOKEN'
}

response = requests.request("DELETE", url, headers=headers, data=payload)

print(response.text)

require "uri"
require "net/http"

url = URI("{{DASHBOARD_HOST}}/api/rest/organization/users/102")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Delete.new(url)
request["Content-Type"] = "application/json"
request["Authorization"] = "Basic YOUR_AUTH_TOKEN"

response = https.request(request)
puts response.read_body

using System;
using RestSharp;
namespace HelloWorldApplication {
  class HelloWorld {
    static void Main(string[] args) {
      var client = new RestClient("{{DASHBOARD_HOST}}/api/rest/organization/users/102");
      client.Timeout = -1;
      var request = new RestRequest(Method.DELETE);
      request.AddHeader("Authorization", "Basic YOUR_AUTH_TOKEN");
      request.AddHeader("Content-Type", "application/json");
      IRestResponse response = client.Execute(request);
      Console.WriteLine(response.Content);
    }
  }
}

Error response (HTTP 409)

{
  "error": {
    "code": 409,
    "description": "Users can not remove themselves from the organization"
  }
}

Elimina um utilizador da organização. O utilizador eliminado não poderá aceder à plataforma nem à API.

O saldo e o limite de crédito restantes do utilizador eliminado são transferidos para o utilizador que realiza o pedido. As suas campanhas continuam a ser mostradas na lista de campanhas da organização.

Parâmetros de URL

Parâmetro	Descrição
ID	Identificador do utilizador.

Se o pedido for bem-sucedido, a resposta terá um código HTTP 204.

Um utilizador não se pode eliminar a si próprio. Nesse caso, a resposta terá um código HTTP 409.

Transferências de saldo

Transferir saldo entre utilizadores

POST {{DASHBOARD_HOST}}/api/rest/organization/transfers/effective-balance

curl -X POST '{{DASHBOARD_HOST}}/api/rest/organization/transfers/effective-balance' \
-H 'Content-Type: application/json' \
-H 'Authorization: Basic YOUR_AUTH_TOKEN' \
-d '{
  "fromUserId": 101,
  "toUserId": 102,
  "amount": 50
}'

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => '{{DASHBOARD_HOST}}/api/rest/organization/transfers/effective-balance',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS => '{
  "fromUserId": 101,
  "toUserId": 102,
  "amount": 50
}',
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/json',
    'Authorization: Basic YOUR_AUTH_TOKEN',
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

import java.io.DataOutputStream;
import java.io.BufferedReader;
import java.io.InputStreamReader;
import java.net.URL;
import java.net.HttpsURLConnection;

public class App {
  public static void main(String[] args) {
    try {
      URL url = new URL("{{DASHBOARD_HOST}}/api/rest/organization/transfers/effective-balance");
      HttpsURLConnection connection = (HttpsURLConnection) url.openConnection();
      connection.setRequestMethod("POST");
      connection.setRequestProperty("Authorization", "Basic YOUR_AUTH_TOKEN");
      connection.setRequestProperty("Accept", "application/json");
      String requestBody = "{ \"fromUserId\": 101, \"toUserId\": 102, \"amount\": 50 }";
      connection.setDoOutput(true);
      DataOutputStream wr = new DataOutputStream(connection.getOutputStream());
      wr.writeBytes(requestBody);
      wr.flush();
      wr.close();
      BufferedReader in = new BufferedReader(new InputStreamReader(connection.getInputStream()));
      String inputLine;
      StringBuffer response = new StringBuffer();
      while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
      }
      in.close();
      System.out.println(response.toString());
    } catch (Exception e) {
      // TODO: handle exception
    }
  }
}

var axios = require('axios');
var config = {
  method: 'post',
  url: '{{DASHBOARD_HOST}}/api/rest/organization/transfers/effective-balance',
  headers: {
    'Content-Type': 'application/json',
    'Authorization': 'Basic YOUR_AUTH_TOKEN'
  },
  data: '{ "fromUserId": 101, "toUserId": 102, "amount": 50 }'
};

axios(config)
.then(function (response) {
  console.log(JSON.stringify(response.data));
})
.catch(function (error) {
  console.log(error);
});

import requests

url = "{{DASHBOARD_HOST}}/api/rest/organization/transfers/effective-balance"

payload = "{ \"fromUserId\": 101, \"toUserId\": 102, \"amount\": 50 }"
headers = {
  'Content-Type': 'application/json',
  'Authorization': 'Basic YOUR_AUTH_TOKEN'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

require "uri"
require "net/http"

url = URI("{{DASHBOARD_HOST}}/api/rest/organization/transfers/effective-balance")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = "application/json"
request["Authorization"] = "Basic YOUR_AUTH_TOKEN"
request.body = "{ \"fromUserId\": 101, \"toUserId\": 102, \"amount\": 50 }"

response = https.request(request)
puts response.read_body

using System;
using RestSharp;
namespace HelloWorldApplication {
  class HelloWorld {
    static void Main(string[] args) {
      var client = new RestClient("{{DASHBOARD_HOST}}/api/rest/organization/transfers/effective-balance");
      client.Timeout = -1;
      var request = new RestRequest(Method.POST);
      request.AddHeader("Authorization", "Basic YOUR_AUTH_TOKEN");
      request.AddHeader("Content-Type", "application/json");
      request.AddParameter("application/json", "{ \"fromUserId\": 101, \"toUserId\": 102, \"amount\": 50 }",  ParameterType.RequestBody);
      IRestResponse response = client.Execute(request);
      Console.WriteLine(response.Content);
    }
  }
}

Response (HTTP 201)

{
  "data": {
    "id": 98765,
    "status": "completed",
    "fromUserId": 101,
    "toUserId": 102,
    "amount": 50,
    "createdAt": "2026-10-13T11:15:00+00:00"
  }
}

Error response (HTTP 402)

{
  "error": {
    "code": 111,
    "description": "Not enough credits"
  }
}

Transfere saldo disponível para envios (effective_balance) de um utilizador da organização para outro. O utilizador de origem pode ser qualquer utilizador da organização, incluindo o utilizador autenticado.

A forma de transferir o saldo depende do tipo de faturação dos utilizadores:

Pré-pago: é transferido saldo da conta (balance).
Pós-pago: é transferido limite de crédito (balance_limit). O utilizador de origem não pode transferir mais limite de crédito do que aquele que tem.

Ambos os utilizadores devem ter o mesmo tipo de faturação. A transferência fica registada no histórico de movimentos dos dois utilizadores.

Parâmetros

Parâmetro	Tipo	Obrigatório	Descrição
fromUserId	integer	Sim	Identificador do utilizador de origem. Deve pertencer à organização.
toUserId	integer	Sim	Identificador do utilizador de destino. Deve pertencer à organização e ser diferente do utilizador de origem.
amount	number	Sim	Montante a transferir, na moeda da conta. Deve ser superior a 0 e ter no máximo 2 casas decimais.

Campos da resposta

Se a transferência for realizada com sucesso, a resposta terá um código HTTP 201 e os seguintes campos:

Parâmetro	Descrição
id	Identificador da transferência.
status	Estado da transferência. As transferências são realizadas de forma imediata, pelo que o seu valor é sempre `completed`.
fromUserId	Identificador do utilizador de origem.
toUserId	Identificador do utilizador de destino.
amount	Montante transferido.
createdAt	Data da transferência.

Erros da transferência

Código HTTP	Código de erro	Descrição
402	111	`Not enough credits`: O utilizador de origem não tem saldo disponível suficiente.
409	409	`Balance can only be transferred between users with the same billing type (prepaid or postpaid)`: Os utilizadores têm tipos de faturação diferentes.
409	409	`Balance can not be transferred between these users`: Não é possível transferir saldo entre os utilizadores indicados.
422	422	Algum parâmetro não é válido.

Campanhas da organização

Lista de campanhas da organização

GET {{DASHBOARD_HOST}}/api/rest/organization/campaigns

curl -X GET '{{DASHBOARD_HOST}}/api/rest/organization/campaigns?userId=102' \
-H 'Content-Type: application/json' \
-H 'Authorization: Basic YOUR_AUTH_TOKEN'

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => '{{DASHBOARD_HOST}}/api/rest/organization/campaigns?userId=102',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/json',
    'Authorization: Basic YOUR_AUTH_TOKEN',
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

import java.io.DataOutputStream;
import java.io.BufferedReader;
import java.io.InputStreamReader;
import java.net.URL;
import java.net.HttpsURLConnection;

public class App {
  public static void main(String[] args) {
    try {
      URL url = new URL("{{DASHBOARD_HOST}}/api/rest/organization/campaigns?userId=102");
      HttpsURLConnection connection = (HttpsURLConnection) url.openConnection();
      connection.setRequestMethod("GET");
      connection.setRequestProperty("Authorization", "Basic YOUR_AUTH_TOKEN");
      connection.setRequestProperty("Accept", "application/json");
      BufferedReader in = new BufferedReader(new InputStreamReader(connection.getInputStream()));
      String inputLine;
      StringBuffer response = new StringBuffer();
      while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
      }
      in.close();
      System.out.println(response.toString());
    } catch (Exception e) {
      // TODO: handle exception
    }
  }
}

var axios = require('axios');
var config = {
  method: 'get',
  url: '{{DASHBOARD_HOST}}/api/rest/organization/campaigns?userId=102',
  headers: {
    'Content-Type': 'application/json',
    'Authorization': 'Basic YOUR_AUTH_TOKEN'
  }
};

axios(config)
.then(function (response) {
  console.log(JSON.stringify(response.data));
})
.catch(function (error) {
  console.log(error);
});

import requests

url = "{{DASHBOARD_HOST}}/api/rest/organization/campaigns?userId=102"

payload = {}
headers = {
  'Content-Type': 'application/json',
  'Authorization': 'Basic YOUR_AUTH_TOKEN'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

require "uri"
require "net/http"

url = URI("{{DASHBOARD_HOST}}/api/rest/organization/campaigns?userId=102")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Content-Type"] = "application/json"
request["Authorization"] = "Basic YOUR_AUTH_TOKEN"

response = https.request(request)
puts response.read_body

using System;
using RestSharp;
namespace HelloWorldApplication {
  class HelloWorld {
    static void Main(string[] args) {
      var client = new RestClient("{{DASHBOARD_HOST}}/api/rest/organization/campaigns?userId=102");
      client.Timeout = -1;
      var request = new RestRequest(Method.GET);
      request.AddHeader("Authorization", "Basic YOUR_AUTH_TOKEN");
      request.AddHeader("Content-Type", "application/json");
      IRestResponse response = client.Execute(request);
      Console.WriteLine(response.Content);
    }
  }
}

Response

{
  "data": [
    {
      "id": 1,
      "name": "My campaign",
      "type": "basic",
      "createdAt": "2026-10-01T11:31:16+00:00",
      "updatedAt": "2026-10-01T11:31:16+00:00",
      "sendings": {
        "data": [
          {
            "id": 1,
            "campaignName": "My campaign",
            "status": "OPENED",
            "channel": "sms",
            "total": 2,
            "processed": 2,
            "totalSmsParts": 4,
            "cost": 0.02,
            "currency": "EUR",
            "tags": [],
            "scheduledAt": null,
            "expiresAt": null,
            "startedAt": null,
            "finishedAt": null,
            "createdAt": "2026-10-01T11:31:16+00:00",
            "updatedAt": "2026-10-01T11:31:22+00:00",
            "events": {
              "delivered": 2,
              "opened": 0,
              "opened_unique": 0,
              "clicked": 0,
              "clicked_unique": 0,
              "unsubscribed": 0,
              "hard_bounced": 0,
              "complaint": 0,
              "sent": 2,
              "soft_bounced": 0,
              "undelivered": 0,
              "rejected": 0,
              "expired": 0,
              "unsubscribed_landing": 0
            }
          }
        ]
      },
      "owner": {
        "data": {
          "id": 102,
          "username": "alice",
          "email": "alice@example.com"
        }
      }
    }
  ],
  "meta": {
    "pagination": {
      "total": 1,
      "count": 1,
      "per_page": 100,
      "current_page": 1,
      "total_pages": 1,
      "links": []
    }
  }
}

Devolve as campanhas de todos os utilizadores da organização, ordenadas da mais recente para a mais antiga. Também são incluídas as campanhas dos utilizadores eliminados.

Filtros

Parâmetro	Descrição
limit	Total de campanhas a mostrar num único pedido. Valor por defeito: `100`. Máximo: `1000`.
userId	Filtrar pelo utilizador proprietário da campanha. Exemplo: ?userId=102.
name	Filtrar por nome da campanha. É possível utilizar o carácter "" como "wildcard". Exemplo: ?name=CAMPAIGN_2020_.
channel	Filtrar por canal. Valores disponíveis: `sms`, `mailing`, `landing`, `text2speech`, `voice-interactive`. Exemplo: ?channel=sms.
beforeDate	Mostrar resultados `antes` da data de criação indicada. A data deve ser especificada no formato `ISO 8601`. Exemplo: ?beforeDate=2019-01-01T00%3A00%3A00%2B00%3A00.
afterDate	Mostrar resultados `após` a data de criação indicada. A data deve ser especificada no formato `ISO 8601`. Exemplo: ?afterDate=2019-01-01T00%3A00%3A00%2B00%3A00.
updatedBeforeDate	Mostrar resultados cuja última atualização seja `antes` da data indicada. A data deve ser especificada no formato `ISO 8601`. Exemplo: ?updatedBeforeDate=2019-01-01T00%3A00%3A00%2B00%3A00.
updatedAfterDate	Mostrar resultados cuja última atualização seja `após` a data indicada. A data deve ser especificada no formato `ISO 8601`. Exemplo: ?updatedAfterDate=2019-01-01T00%3A00%3A00%2B00%3A00.

Os parâmetros devem ser codificados corretamente (urlencode) em relação ao padrão RFC 3986 para serem suportados pelo servidor.

Campos da resposta

Os campos de cada campanha são os mesmos da lista de campanhas, exceto as ligações links das campanhas e dos seus envios, que não são incluídas. Além disso, é incluído o seguinte campo adicional:

Parâmetro	Descrição
owner.data.id	Identificador do utilizador proprietário da campanha.
owner.data.username	Nome de utilizador do proprietário da campanha.
owner.data.email	E-mail do proprietário da campanha.

Cobertura

Cobertura SMS por operadora

Devolve a cobertura completa de SMS por operadora.

GET {{DASHBOARD_HOST}}/api/rest/sms/coverage

curl -X GET '{{DASHBOARD_HOST}}/api/rest/sms/coverage' \
-H 'Content-Type: application/json' \
-H 'Authorization: Basic YOUR_AUTH_TOKEN'

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => '{{DASHBOARD_HOST}}/api/rest/sms/coverage',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/json',
    'Authorization: Basic YOUR_AUTH_TOKEN',
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

import java.io.DataOutputStream;
import java.io.BufferedReader;
import java.io.InputStreamReader;
import java.net.URL;
import java.net.HttpsURLConnection;

public class App {
  public static void main(String[] args) {
    try {
      URL url = new URL("{{DASHBOARD_HOST}}/api/rest/sms/coverage");
      HttpsURLConnection connection = (HttpsURLConnection) url.openConnection();
      connection.setRequestMethod("GET");
      connection.setRequestProperty("Authorization", "Basic YOUR_AUTH_TOKEN");
      connection.setRequestProperty("Accept", "application/json");
      BufferedReader in = new BufferedReader(new InputStreamReader(connection.getInputStream()));
      String inputLine;
      StringBuffer response = new StringBuffer();
      while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
      }
      in.close();
      System.out.println(response.toString());
    } catch (Exception e) {
      // TODO: handle exception
    }
  }
}

var axios = require('axios');
var config = {
  method: 'get',
  url: '{{DASHBOARD_HOST}}/api/rest/sms/coverage',
  headers: {
    'Content-Type': 'application/json',
    'Authorization': 'Basic YOUR_AUTH_TOKEN'
  }
};

axios(config)
.then(function (response) {
  console.log(JSON.stringify(response.data));
})
.catch(function (error) {
  console.log(error);
});

import requests

url = "{{DASHBOARD_HOST}}/api/rest/sms/coverage"

payload = {}
headers = {
  'Content-Type': 'application/json',
  'Authorization': 'Basic YOUR_AUTH_TOKEN'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

require "uri"
require "net/http"

url = URI("{{DASHBOARD_HOST}}/api/rest/sms/coverage")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Content-Type"] = "application/json"
request["Authorization"] = "Basic YOUR_AUTH_TOKEN"

response = https.request(request)
puts response.read_body

using System;
using RestSharp;
namespace HelloWorldApplication {
  class HelloWorld {
    static void Main(string[] args) {
      var client = new RestClient("{{DASHBOARD_HOST}}/api/rest/sms/coverage");
      client.Timeout = -1;
      var request = new RestRequest(Method.GET);
      request.AddHeader("Authorization", "Basic YOUR_AUTH_TOKEN");
      request.AddHeader("Content-Type", "application/json");
      IRestResponse response = client.Execute(request);
      Console.WriteLine(response.Content);
    }
  }
}

Response

{
    "data": [
        {
            "countryIso": "AD",
            "countryName": "Andorra",
            "networkName": "Default",
            "mcc": "213",
            "mnc": null,
            "cost": 0.065,
            "currencyCode": "EUR",
            "currencySymbol": "€"
        },
        {
            "countryIso": "AD",
            "countryName": "Andorra",
            "networkName": "Servei De Tele. DAndorra",
            "mcc": "213",
            "mnc": "003",
            "cost": 0.065,
            "currencyCode": "EUR",
            "currencySymbol": "€"
        },
        {
            "countryIso": "AE",
            "countryName": "United Arab Emirates",
            "networkName": "Default",
            "mcc": "424",
            "mnc": null,
            "cost": 0.0868,
            "currencyCode": "EUR",
            "currencySymbol": "€"
        }
    ]
}

Cobertura SMS por país

Devolve a cobertura SMS agrupada por país indicando o custo mínimo e máximo de cada país.

GET {{DASHBOARD_HOST}}/api/rest/sms/coverageByCountry

curl -X GET '{{DASHBOARD_HOST}}/api/rest/sms/coverageByCountry' \
-H 'Content-Type: application/json' \
-H 'Authorization: Basic YOUR_AUTH_TOKEN'

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => '{{DASHBOARD_HOST}}/api/rest/sms/coverageByCountry',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/json',
    'Authorization: Basic YOUR_AUTH_TOKEN',
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

import java.io.DataOutputStream;
import java.io.BufferedReader;
import java.io.InputStreamReader;
import java.net.URL;
import java.net.HttpsURLConnection;

public class App {
  public static void main(String[] args) {
    try {
      URL url = new URL("{{DASHBOARD_HOST}}/api/rest/sms/coverageByCountry");
      HttpsURLConnection connection = (HttpsURLConnection) url.openConnection();
      connection.setRequestMethod("GET");
      connection.setRequestProperty("Authorization", "Basic YOUR_AUTH_TOKEN");
      connection.setRequestProperty("Accept", "application/json");
      BufferedReader in = new BufferedReader(new InputStreamReader(connection.getInputStream()));
      String inputLine;
      StringBuffer response = new StringBuffer();
      while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
      }
      in.close();
      System.out.println(response.toString());
    } catch (Exception e) {
      // TODO: handle exception
    }
  }
}

var axios = require('axios');
var config = {
  method: 'get',
  url: '{{DASHBOARD_HOST}}/api/rest/sms/coverageByCountry',
  headers: {
    'Content-Type': 'application/json',
    'Authorization': 'Basic YOUR_AUTH_TOKEN'
  }
};

axios(config)
.then(function (response) {
  console.log(JSON.stringify(response.data));
})
.catch(function (error) {
  console.log(error);
});

import requests

url = "{{DASHBOARD_HOST}}/api/rest/sms/coverageByCountry"

payload = {}
headers = {
  'Content-Type': 'application/json',
  'Authorization': 'Basic YOUR_AUTH_TOKEN'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

require "uri"
require "net/http"

url = URI("{{DASHBOARD_HOST}}/api/rest/sms/coverageByCountry")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Content-Type"] = "application/json"
request["Authorization"] = "Basic YOUR_AUTH_TOKEN"

response = https.request(request)
puts response.read_body

using System;
using RestSharp;
namespace HelloWorldApplication {
  class HelloWorld {
    static void Main(string[] args) {
      var client = new RestClient("{{DASHBOARD_HOST}}/api/rest/sms/coverageByCountry");
      client.Timeout = -1;
      var request = new RestRequest(Method.GET);
      request.AddHeader("Authorization", "Basic YOUR_AUTH_TOKEN");
      request.AddHeader("Content-Type", "application/json");
      IRestResponse response = client.Execute(request);
      Console.WriteLine(response.Content);
    }
  }
}

Response

{
    "data": [
        {
            "countryIso": "AD",
            "countryName": "Andorra",
            "networks": [
                "Servei De Tele. DAndorra"
            ],
            "minCost": 0.065,
            "maxCost": 0.065,
            "currencyCode": "EUR",
            "currencySymbol": "€"
        },
        {
            "countryIso": "AE",
            "countryName": "United Arab Emirates",
            "networks": [
                "DU",
                "Etisalat"
            ],
            "minCost": 0.0868,
            "maxCost": 0.0868,
            "currencyCode": "EUR",
            "currencySymbol": "€"
        }
    ]
}

Erros

Error Code	HTTP Code	Description
0	202	Accepted for delivery
101	500	Internal Database error
102	400	No valid recipients
103	401	Username or password unknown
104	400	Text message missing
105	400	Text message too long
106	400	Sender missing
107	400	Sender too long
108	400	No valid Datetime for send
109	400	Notification URL incorrect
110	400	Exceeded maximum parts allowed or incorrect number of parts
111	402	Not enough credits
112	401	IP address not allowed
113	400	Invalid coding
114	400	Invalid subject
115	400	Sender is not verified
116	400	Invalid replyTo
117	400	ReplyTo is not verified
118	401	Email blocked for exceeding the hard-bounced limit allowed
119	400	Invalid expiration date
120	400	Invalid GUID
121	400	Invalid scheduled date
122	500	Update error
123	500	Delete error
125	400	Invalid JSON
126	400	Empty campaign name
130	400	Invalid voice language
131	400	Invalid voice gender
132	400	Invalid voice caller
133	400	Invalid audio URL
134	400	Unsupported audio format
140	400	Template missing
141	400	Missing landing placeholder
142	400	Can't split variable placeholders
150	400	Missing billing profile
151	400	Error retrieving TPV url
152	400	Invalid VAT
153	400	Invalid method
154	400	Invalid conversion rate
155	400	Max limit reached
156	400	Min limit reached
157	400	Error generating invoice
160	400	Invalid voice interactive language
161	400	Invalid voice interactive gender
162	400	Invalid voice interactive caller
163	400	Invalid voice interactive audio URL
164	400	Unsupported voice interactive audio format
165	400	Invalid voice interactive speech type
166	400	Ivalid voice interactive menu option type
167	400	Trying to save an existing campaign
168	400	Empty speech type
169	400	Empty menu
170	400	Empty phone key
171	400	Phone Key is not a number
172	400	Phone key out of range
173	400	Empty menu options for sub menu
174	400	Empty phone prefix for call transfer
175	400	Empty phone for call transfer
176	400	Call retries value is not an integer
177	400	Call retries value out of range
178	400	Cost limit value is not an integer
179	400	Speech retries value is not an integer
180	400	Speech retries value out of range
181	400	Speech timeout seconds value is not an integer
182	400	Speech timeout seconds value out of range
183	400	Available times value is not an array
184	400	Available times day is not an integer
185	400	Available times day out of range
186	400	Available times from hour format error
187	400	Available times to hour format error
188	400	Available times from hour is greater than to hour
189	400	Missing available time object property
190	400	Call Retries is specified but its value is empty
191	400	Cost limit is specified but its value is empty
192	400	Speech Retries is specified but its value is empty
193	400	Speech timeout seconds is specified but its value is empty
194	400	Available times is specified but its value is empty
195	400	No valid contacts external IDs
196	400	Available times range is too short
422	422	Input validation error

Anexos

Intervalos de IP

Para evitar problemas, se espera receber tráfego da nossa API (notificações de relatórios de entrega), deverá adicionar os seguintes intervalos de IP à sua firewall:

89.17.205.192/26
89.17.219.128/26

Conjunto de caracteres GSM

Conjunto de caracteres `básico` GSM

	0x00	0x10	0x20	0x30	0x40	0x50	0x60	0x70
0x00	@	Δ	SP	0	¡	P	¿	p
0x01	£	_	!	1	A	Q	a	q
0x02	$	Φ	"	2	B	R	b	r
0x03	¥	Γ	#	3	C	S	c	s
0x04	è	Λ	¤	4	D	T	d	t
0x05	é	Ω	%	5	E	U	e	u
0x06	ù	Π	&	6	F	V	f	v
0x07	ì	Ψ	'	7	G	W	g	w
0x08	ò	Σ	(	8	H	X	h	x
0x09	Ç	Θ	)	9	I	Y	i	y
0x0A	LF	Ξ	*	:	J	Z	j	z
0x0B	Ø	ESC	+	;	K	Ä	k	ä
0x0C	ø	Æ	,	<	L	Ö	l	ö
0x0D	CR	æ	-	=	M	Ñ	m	ñ
0x0E	Å	ß	.	>	N	Ü	n	ü
0x0F	å	É	/	?	O	§	o	à

* Caracteres especiais

Conjunto de caracteres `estendidos` GSM

	0x00	0x10	0x20	0x30	0x40	0x50	0x60	0x70
0x00					\|
0x01
0x02
0x03
0x04		^
0x05							€
0x06
0x07
0x08			{
0x09			}
0x0A	FF
0x0B		SS2
0x0C				[
0x0D	CR2			~
0x0E				]
0x0F			\

* Caracteres especiais

Conjunto de caracteres GSM-PT

Conjunto de caracteres `básico` GSM-PT

	0x00	0x10	0x20	0x30	0x40	0x50	0x60	0x70
0x00	@	Δ	SP	0	Í	P	~	p
0x01	£	_	!	1	A	Q	a	q
0x02	$	ª	"	2	B	R	b	r
0x03	¥	Ç	#	3	C	S	c	s
0x04	ê	À	º	4	D	T	d	t
0x05	é	∞	%	5	E	U	e	u
0x06	ú	^	&	6	F	V	f	v
0x07	í	\	'	7	G	W	g	w
0x08	ó	€	(	8	H	X	h	x
0x09	ç	Ó	)	9	I	Y	i	y
0x0A	LF	\|	*	:	J	Z	j	z
0x0B	Ô	ESC	+	;	K	Ã	k	ã
0x0C	ô	Â	,	<	L	Õ	l	õ
0x0D	CR	â	-	=	M	Ú	m	`
0x0E	Á	Ê	.	>	N	Ü	n	ü
0x0F	á	É	/	?	O	§	o	à

* Caracteres especiais ** Caracteres diferentes de GSM

Conjunto de caracteres `estendidos` GSM-PT

	0x00	0x10	0x20	0x30	0x40	0x50	0x60	0x70
0x00					\|
0x01					À		Â
0x02		Φ
0x03		Γ
0x04		^
0x05	ê	Ω				Ú	€	ú
0x06		Π
0x07		Ψ
0x08		Σ	{
0x09	ç	Θ	}		Í		í
0x0A	FF
0x0B	Ô	SS2				Ã		ã
0x0C	ô			[		Õ		õ
0x0D	CR2			~
0x0E	Á			]
0x0F	á	Ê	\		Ó		ó	â

* Caracteres especiais ** Caracteres diferentes de GSM

Restrições de Envio por País

Muitos países possuem regulamentos destinados a proteger os utilizadores de comunicações indesejadas, tanto por SMS como por chamadas de voz. Para garantir que as suas campanhas chegam ao destino corretamente e evitar bloqueios ou penalizações, é essencial cumprir estas regras.

Cada país define as suas próprias condições e restrições em relação às comunicações comerciais, pelo que é importante compreender e respeitar as especificidades de cada um. É importante relembrar que estas condições e restrições estão sujeitas à legislação em vigor de cada país e podem sofrer alterações. A {{NAME}} não se responsabiliza pelo incumprimento destas políticas; a responsabilidade é do cliente.

Abaixo encontrará as restrições para os principais países para que possa operar de forma segura e eficaz. Caso tenha alguma dúvida ou se o país destinatário não estiver listado abaixo, recomendamos que contacte a nossa equipa de atendimento ao cliente.

Considerações Preliminares

Em todos os países, é necessário o consentimento do cliente para receber SMS ou chamadas de voz.
Para mensagens SMS promocionais, deve ser incluída uma opção de cancelamento de subscrição no conteúdo da SMS.

🇫🇷 França

As mensagens SMS comerciais ou promocionais enviadas para França devem obedecer a determinadas regulamentações legais, descritas abaixo. As mensagens transacionais, no entanto, não estão sujeitas a estas restrições.

Conteúdo Proibido

O envio de mensagens relacionadas com política, religião, jogo ou promoções não solicitadas é estritamente proibido.

Restrições de Horário

As mensagens SMS de marketing só podem ser enviadas de segunda-feira a sábado, entre as 8h e as 22h. Quaisquer mensagens enviadas fora deste horário serão automaticamente bloqueadas e agendadas para reenvio no próximo horário permitido. Ou seja, se tentar enviar uma SMS no domingo às 14h00, esta só será enviada na segunda-feira às 8h00.

Condições do Remetente

Contacte {{SUPPORT_EMAIL}} para obter mais informações e validar o seu remetente.

Cancelar subscrição do destinatário

É obrigatório adicionar STOP au [STOP_CODE] como instrução de cancelamento no final das suas mensagens SMS de marketing para França.

🇪🇸 Espanha

As mensagens SMS enviadas para Espanha têm determinadas condições legais. Qualquer SMS identificada como conteúdo de marketing estará sujeito às condições listadas nas secções abaixo.

Conteúdo Proibido

O envio de mensagens relacionadas com temas políticos ou religiosos, jogos de azar ou promoções não solicitadas é estritamente proibido.

🇬🇧 Reino Unido

As mensagens SMS enviadas para o Reino Unido estão limitadas a determinadas condições regulamentares. Qualquer mensagem SMS identificada como conteúdo de marketing estará sujeita às condições listadas abaixo.

Conteúdo Proibido

O envio de mensagens relacionadas com temas políticos ou religiosos ou promoções não solicitadas é estritamente proibido.

Se enviar conteúdo para adultos ou para jogos de azar, certifique-se de que a idade do destinatário foi verificada em conformidade com as Diretrizes da PSA e da Ofcom.

🇺🇸 Estados Unidos

As mensagens SMS comerciais ou promocionais enviadas para os Estados Unidos devem obedecer a determinadas regulamentações legais, descritas abaixo. As mensagens transacionais, no entanto, não estão sujeitas a estas restrições.

Conteúdo Restrito

O uso de encurtadores de URL públicos, como bit.ly ou tinyurl, não é permitido. No entanto, é permitido o uso de domínios personalizados nestes serviços. Portanto, pode utilizar o encurtador de URL próprio da {{NAME}}.

Além disso, é estritamente proibido o envio de mensagens com conteúdo sexualmente explícito ou pornográfico, material abusivo ou de assédio, informações relacionadas com armas de fogo, incluindo fogos de artifício, ou referências a álcool, tabaco ou drogas ilícitas. É também proibido o envio de mensagens sobre jogo, oportunidades de investimento, envio ou receção repetida de códigos de acesso único (OTPs) em nome de outros fornecedores, atividades consideradas de elevado risco financeiro, empréstimos ou perdão de empréstimos, serviços de recuperação de crédito, cobrança de dívidas ou questões fiscais. Da mesma forma, o conteúdo ligado a criptomoedas, incluindo aqueles relacionados com OTPs, consultas imobiliárias não solicitadas, como WeBuyHomes, ou promoções associadas a marketing multinível, não é permitido.

Condições do Remetente

Contacte {{SUPPORT_EMAIL}} para obter mais informações e validar o seu remetente.

🇨🇴 Colômbia

Restrições de Horário

As mensagens SMS de marketing só podem ser enviadas de segunda a sexta-feira, das 7h às 19h, e aos sábados, das 8h às 15h. O envio de mensagens promocionais não é permitido aos domingos e feriados. Quaisquer mensagens enviadas fora deste horário serão automaticamente bloqueadas e agendadas para reencaminhamento no próximo horário permitido. Isto significa que, se tentar enviar uma mensagem SMS no domingo às 14h00, esta só será enviada às 8h00 de segunda-feira.

Conteúdo Restrito

O conteúdo promocional em SMS pode, em alguns casos, exigir um registo prévio antes do envio. Além disso, a plataforma {{NAME}} pode adicionar automaticamente o nome do remetente ao início da mensagem ou incluir um URL no final, dependendo das condições do canal ou do país de destino.

Conteúdo Proibido

O envio de mensagens relacionadas com temas políticos ou religiosos, jogo ou promoções não solicitadas é estritamente proibido.

🇮🇪 Irlanda

Antes de enviar qualquer tráfego de marketing, é necessário o consentimento expresso (opt-in) dos utilizadores de dispositivos móveis.

Conteúdo Restrito

O envio de mensagens relacionadas com política, religião, jogo ou promoções não solicitadas é estritamente proibido.

Termos do Remetente

Contacte {{SUPPORT_EMAIL}} para obter mais informações e validar o seu remetente.

Integrações

Autenticação

Autenticação básica HTTP

API Key

Campanhas

SMS

Envio SMS

Parâmetros

Variáveis de substituição

Vários URLs de notificação

Filtros para variáveis personalizadas

Avisos de receção/DLR

Informação de SMS por id de mensagem

Email

Envio de email

Parâmetros

Variáveis de substituição

Voz

Envio de pedido de Voz

Parâmetros

Variáveis de substituição

Pedido de envio de Voz com URL para ficheiro de áudio

Parâmetros

Política de tentativas

Landing SMS

Pedido de envio de SMS

Parâmetros

Variáveis de substituição

Filtros para variáveis personalizadas

WhatsApp

Enviar modelo do WhatsApp

Parâmetros

Exemplos de envio

Lista de conversas

Filtros

Mostrar uma conversa

Mostrar as mensagens numa conversa

Filtros

Enviar uma mensagem para uma conversa

Parâmetros

Two-Way inbox

Listagem de Respostas Bidirecionais

Filtros

Apresentar uma resposta bidirecional

Remetentes verificados

Listagem

Resposta

Mensagens programadas

Listar

Atualização

Eliminar

Lista de campanhas

Filtros

Campos da resposta

Bases de dados

Contactos

Lista de contactos

Filtros

Mostrar um contacto

Filtros

Criar um novo contacto

Parâmetros

Atualizar um contacto

Parâmetros

Eliminar um contacto

Grupos

Lista de grupos

Filtros

Mostrar um grupo

Criar um novo grupo

Parâmetros

Atualizar um grupo

Parâmetros

Eliminar um grupo

Validação de emails

Listar todas as validações

Listar uma validação

Resultados de uma validação (CSV)

Validar emails

Parâmetros