Introdução API Rest

Bem vindo DEV! A API da Comtele é construída no padrão REST. Nossa API possui URLs previsíveis de acordo com todos recursos servidos por cada endpoint, aceita requisições e retorna utilizando padrão JSON e também usa códigos de resposta HTTP padrão, a autenticação é feita via Header e todas as requisições também devem conter ‘Content-Type’: 'application/json’.

Além da API Rest, a Comtele mantem oficialmente pacotes de software para facilitar o desenvolvimento e a vida dos nossos amigos devs. Na Seção SDK fornecemos instruções básicas sobre como instalar e começar a trabalhar com esses pacotes.

GitHub

Oficialmente nós damos suporte apenas para nossa API REST, mas também criamos alguns EXEMPLOS de SDK OpenSource que podem ser encontradas no GitHub pelos links: Python, .NET, .NET Core, Node, Java, Ruby, PHP via composer e importação de arquivos. Com isto, você pode montar seu próprio código/SDK se baseando em nossos exemplos e usando a linguagem de programação que desejar.

URL Base da API

https://sms.comtele.com.br/api/v2/

Autenticação

Todas as requisições direcionadas a qualquer recurso da API Rest devem ser autenticadas, a chave de integração está disponível na sua conta em https://sms.comtele.com.br. No menu lateral, dentro da seção API, clique em Chave de API e você irá para a página de Informações do Desenvolvedor e lá irá encontrar o campo nomeado como Sua Chave de API. Ela deve ser informada via Header no seguinte formato: auth-key: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX

Códigos de Erro

Os retornos de erro usam códigos padrões de status HTTP para indicar o tipo de erro que está acontecendo. Na maior parte dos casos, também será retornado via Body no formato JSON um campo que contém uma descrição detalhada sobre o erro. Todos os códigos de erros estão alinhados com a específicação padrão

Exemplo de erro HTTP 401 - Unauthorized

Neste caso por exemplo, não será retonado corpo em JSON. Apenas o HTTP Status: 401 - Unauthorized

Erros Comuns

Envio de SMS

Nesta seção, são abordados todos os recursos disponíveis para envio de SMS. Mais detalhes sobre cada recurso, pode ser encontrado em uma breve descrição logo abaixo do título de cada endpoint.

Enviar SMS

Com este recurso, é possivel enviar SMS de forma instantânea.
URL do Endpoint: https://sms.comtele.com.br/api/v2/send
Autenticação via Header: auth-key: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
Método: POST

  curl --request POST \
    --url https://sms.comtele.com.br/api/v2/send \
    --header 'auth-key: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX' \
    --header 'content-type: application/json' \
    --data '{"Sender":"sender_id","Receivers":"phone_number","Content":"message"}'

  var request = require("request");

  var options = {
    method: 'POST',
    url: 'https://sms.comtele.com.br/api/v2/send',
    headers: {
      'content-type': 'application/json',
      'auth-key': 'XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX'
    },
    body: '{"Sender":"sender_id","Receivers":"phone_number","Content":"message"}'
  };

  request(options, function (error, response, body) {
    if (error) throw new Error(error);

    console.log(body);
  });

  require 'uri'
  require 'net/http'
  require 'openssl'

  url = URI("https://sms.comtele.com.br/api/v2/send")

  http = Net::HTTP.new(url.host, url.port)
  http.use_ssl = true
  http.verify_mode = OpenSSL::SSL::VERIFY_NONE

  request = Net::HTTP::Post.new(url)
  request["content-type"] = 'application/json'
  request["auth-key"] = 'XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX'
  request.body = "{\"Sender\":\"sender_id\",\"Receivers\":\"phone_number\",\"Content\":\"message\"}"

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

  var data = "{\"Sender\":\"sender_id\",\"Receivers\":\"phone_number\",\"Content\":\"message\"}";

  var xhr = new XMLHttpRequest();

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

  xhr.open("POST", "https://sms.comtele.com.br/api/v2/send");
  xhr.setRequestHeader("content-type", "application/json");
  xhr.setRequestHeader("auth-key", "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX");

  xhr.send(data);

  import requests

  url = "https://sms.comtele.com.br/api/v2/send"

  payload = "{\"Sender\":\"sender_id\",\"Receivers\":\"phone_number\",\"Content\":\"message\"}"
  headers = {
      'content-type': "application/json",
      'auth-key': "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"
      }

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

  print(response.text)

Exemplo de Retorno de Sucesso

  {
    "Success": true, 
    "Object": {
      "requestUniqueId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"
    }
    "Message": "A requisicao de envio foi encaminhada para processamento com sucesso. Voce podera acompanhar o status pelos relatorios."
  }

Campos do Retorno

Retornos Previsíveis

Enviar SMS / Regra de Resposta Automática

Com este recurso, é possivel enviar SMS de forma instantânea e quando o SMS for respondido, é possivel enviar uma resposta de forma automática, baseado em um contexto previamente configurado.
Para utilizar este recurso, é necessário que você acesse a opção “Resposta Automática” no menu “Configurações” no painel de SMS, cadastre uma regra de resposta automática e informe o nome que foi cadastrado no campo ContextRuleName no momento que for usar o endpoint.
URL do Endpoint: https://sms.comtele.com.br/api/v2/sendcontextmessage
Autenticação via Header: auth-key: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
Método: POST

  curl --request POST \
    --url https://sms.comtele.com.br/api/v2/sendcontextmessage \
    --header 'auth-key: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX' \
    --header 'content-type: application/json' \
    --data '{"Sender":"sender_id","Receivers":"phone_number","ContextRuleName":"rule_name","ForceContent":"force_content"}'

  var request = require("request");

  var options = {
    method: 'POST',
    url: 'https://sms.comtele.com.br/api/v2/sendcontextmessage',
    headers: {
      'content-type': 'application/json',
      'auth-key': 'XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX'
    },
    body: '{"Sender":"sender_id","Receivers":"phone_number","ContextRuleName":"rule_name","ForceContent":"force_content"}'
  };

  request(options, function (error, response, body) {
    if (error) throw new Error(error);

    console.log(body);
  });

  require 'uri'
  require 'net/http'
  require 'openssl'

  url = URI("https://sms.comtele.com.br/api/v2/sendcontextmessage")

  http = Net::HTTP.new(url.host, url.port)
  http.use_ssl = true
  http.verify_mode = OpenSSL::SSL::VERIFY_NONE

  request = Net::HTTP::Post.new(url)
  request["content-type"] = 'application/json'
  request["auth-key"] = 'XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX'
  request.body = "{\"Sender\":\"sender_id\",\"Receivers\":\"phone_number\",\"ContextRuleName\":\"rule_name\",\"ForceContent\":\"force_content\"}"

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

  var data = "{\"Sender\":\"sender_id\",\"Receivers\":\"phone_number\",\"ContextRuleName\":\"rule_name\",\"ForceContent\":\"force_content\"}";

  var xhr = new XMLHttpRequest();

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

  xhr.open("POST", "https://sms.comtele.com.br/api/v2/sendcontextmessage");
  xhr.setRequestHeader("content-type", "application/json");
  xhr.setRequestHeader("auth-key", "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX");

  xhr.send(data);

  import requests

  url = "https://sms.comtele.com.br/api/v2/sendcontextmessage"

  payload = "{\"Sender\":\"sender_id\",\"Receivers\":\"phone_number\",\"ContextRuleName\":\"rule_name\",\"ForceContent\":\"force_content\"}"
  headers = {
      'content-type': "application/json",
      'auth-key': "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"
      }

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

  print(response.text)

Exemplo de Retorno de Sucesso

  {
    "Success": true, 
    "Object": null, 
    "Message": "A requisicao de envio foi encaminhada para processamento com sucesso. Voce podera acompanhar o status pelos relatorios."
  }

Campos do Retorno

Retornos Previsíveis

Enviar SMS / Grupos de Contatos

Com este recurso, é possivel enviar SMS de forma instantânea para um grupo de contatos.
Para usar este recuso, é necessário ter grupos de contatos já cadastrados em nossa aplicação, caso ainda não tenha feito isso, dê uma olhadinha no recurso Cadastrar / Grupos de Contatos e Cadastrar Contatos / Grupos de Contatos
URL do Endpoint: https://sms.comtele.com.br/api/v2/sendcontactmessage
Autenticação via Header: auth-key: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
Método: POST

  curl --request POST \
    --url https://sms.comtele.com.br/api/v2/sendcontactmessage \
    --header 'auth-key: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX' \
    --header 'content-type: application/json' \
    --data '{"Sender":"sender_id","Content":"message","GroupName":"group_name"}'

  var request = require("request");

  var options = {
    method: 'POST',
    url: 'https://sms.comtele.com.br/api/v2/sendcontactmessage',
    headers: {
      'content-type': 'application/json',
      'auth-key': 'XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX'
    },
    body: '{"Sender":"sender_id","Content":"message","GroupName":"group_name"}'
  };

  request(options, function (error, response, body) {
    if (error) throw new Error(error);

    console.log(body);
  });

  require 'uri'
  require 'net/http'
  require 'openssl'

  url = URI("https://sms.comtele.com.br/api/v2/sendcontactmessage")

  http = Net::HTTP.new(url.host, url.port)
  http.use_ssl = true
  http.verify_mode = OpenSSL::SSL::VERIFY_NONE

  request = Net::HTTP::Post.new(url)
  request["content-type"] = 'application/json'
  request["auth-key"] = 'XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX'
  request.body = "{\"Sender\":\"sender_id\",\"Content\":\"message\",\"GroupName\":\"group_name\"}"

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

  var data = "{\"Sender\":\"sender_id\",\"Content\":\"message\",\"GroupName\":\"group_name\"}";

  var xhr = new XMLHttpRequest();

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

  xhr.open("POST", "https://sms.comtele.com.br/api/v2/sendcontactmessage");
  xhr.setRequestHeader("content-type", "application/json");
  xhr.setRequestHeader("auth-key", "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX");

  xhr.send(data);

  import requests

  url = "https://sms.comtele.com.br/api/v2/sendcontactmessage"

  payload = "{\"Sender\":\"sender_id\",\"Content\":\"message\",\"GroupName\":\"group_name\"}"
  headers = {
      'content-type': "application/json",
      'auth-key': "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"
      }

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

  print(response.text)

Exemplo de Retorno de Sucesso

  {
    "Success": true, 
    "Object": null, 
    "Message": "A requisicao de envio foi encaminhada para processamento com sucesso. Voce podera acompanhar o status pelos relatorios."
  }

Campos do Retorno

Retornos Previsíveis

Agendamento de SMS

Nesta seção, são abordados todos os recursos disponíveis para envio de SMS agendado. Mais detalhes sobre cada recurso, pode ser encontrado em uma breve descrição logo abaixo do título de cada endpoint.

Agendar SMS

Com este recurso, é possivel programar a data e horário de envio de SMS para serem enviados.
URL do Endpoint: https://sms.comtele.com.br/api/v2/schedule
Autenticação via Header: auth-key: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
Método: POST

curl --request POST \
  --url https://sms.comtele.com.br/api/v2/schedule \
  --header 'auth-key: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX' \
  --header 'content-type: application/json' \
  --data '{"Sender":"sender_id","Receivers":"phone_number","Content":"message","ScheduleDate":"send_in"}'

  var request = require("request");

  var options = {
    method: 'POST',
    url: 'https://sms.comtele.com.br/api/v2/schedule',
    headers: {
      'content-type': 'application/json',
      'auth-key': 'XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX'
    },
    body: '{"Sender":"sender_id","Receivers":"phone_number","Content":"message","ScheduleDate":"send_in"}'
  };

  request(options, function (error, response, body) {
    if (error) throw new Error(error);

    console.log(body);
  });

  require 'uri'
  require 'net/http'
  require 'openssl'

  url = URI("https://sms.comtele.com.br/api/v2/schedule")

  http = Net::HTTP.new(url.host, url.port)
  http.use_ssl = true
  http.verify_mode = OpenSSL::SSL::VERIFY_NONE

  request = Net::HTTP::Post.new(url)
  request["content-type"] = 'application/json'
  request["auth-key"] = 'XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX'
  request.body = "{\"Sender\":\"sender_id\",\"Receivers\":\"phone_number\",\"Content\":\"message\",\"ScheduleDate\":\"send_in\"}"

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

  var data = "{\"Sender\":\"sender_id\",\"Receivers\":\"phone_number\",\"Content\":\"message\",\"ScheduleDate\":\"send_in\"}";

  var xhr = new XMLHttpRequest();

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

  xhr.open("POST", "https://sms.comtele.com.br/api/v2/schedule");
  xhr.setRequestHeader("content-type", "application/json");
  xhr.setRequestHeader("auth-key", "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX");

  xhr.send(data);

  import requests

  url = "https://sms.comtele.com.br/api/v2/schedule"

  payload = "{\"Sender\":\"sender_id\",\"Receivers\":\"phone_number\",\"Content\":\"message\",\"ScheduleDate\":\"send_in\"}"
  headers = {
      'content-type': "application/json",
      'auth-key': "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"
      }

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

  print(response.text)

Exemplo de Retorno de Sucesso

  {
    "Success": true, 
    "Object": {
      "requestUniqueId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"
    }
    "Message": "A requisicao de envio foi encaminhada para processamento com sucesso. Voce podera acompanhar o status pelos relatorios."
  }

Campos do Retorno

Retornos Previsíveis

Agendar SMS / Regra de Resposta Automática

Com este recurso, é possivel programar a data e horário de envio de SMS para serem enviados, e quando o SMS for respondido, é possivel enviar uma resposta de forma automática, baseado em um contexto previamente configurado.
Para utilizar este recurso, é necessário que você acesse a opção “Resposta Automática” no menu “Configurações” no painel de SMS, cadastre uma regra de resposta automática e informe o nome que foi cadastrado no campo ContextRuleName no momento que for usar o endpoint.
URL do Endpoint: https://sms.comtele.com.br/api/v2/schedulecontextmessage
Autenticação via Header: auth-key: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
Método: POST

  curl --request POST \
    --url https://sms.comtele.com.br/api/v2/schedulecontextmessage \
    --header 'auth-key: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX' \
    --header 'content-type: application/json' \
    --data '{"Sender":"sender_id","Receivers":"phone_number","ScheduleDate":"send_in","ContextRuleName":"rule_name","ForceContent":"force_content"}'

  var request = require("request");

  var options = {
    method: 'POST',
    url: 'https://sms.comtele.com.br/api/v2/schedulecontextmessage',
    headers: {
      'content-type': 'application/json',
      'auth-key': 'XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX'
    },
    body: '{"Sender":"sender_id","Receivers":"phone_number","ScheduleDate":"send_in","ContextRuleName":"rule_name","ForceContent":"force_content"}'
  };

  request(options, function (error, response, body) {
    if (error) throw new Error(error);

    console.log(body);
  });

  require 'uri'
  require 'net/http'
  require 'openssl'

  url = URI("https://sms.comtele.com.br/api/v2/schedulecontextmessage")

  http = Net::HTTP.new(url.host, url.port)
  http.use_ssl = true
  http.verify_mode = OpenSSL::SSL::VERIFY_NONE

  request = Net::HTTP::Post.new(url)
  request["content-type"] = 'application/json'
  request["auth-key"] = 'XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX'
  request.body = "{\"Sender\":\"sender_id\",\"Receivers\":\"phone_number\",\"ScheduleDate\":\"send_in\",\"ContextRuleName\":\"rule_name\",\"ForceContent\":\"force_content\"}"

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

  var data = "{\"Sender\":\"sender_id\",\"Receivers\":\"phone_number\",\"ScheduleDate\":\"send_in\",\"ContextRuleName\":\"rule_name\",\"ForceContent\":\"force_content\"}";

  var xhr = new XMLHttpRequest();

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

  xhr.open("POST", "https://sms.comtele.com.br/api/v2/schedulecontextmessage");
  xhr.setRequestHeader("content-type", "application/json");
  xhr.setRequestHeader("auth-key", "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX");

  xhr.send(data);

  import requests

  url = "https://sms.comtele.com.br/api/v2/schedulecontextmessage"

  payload = "{\"Sender\":\"sender_id\",\"Receivers\":\"phone_number\",\"ScheduleDate\":\"send_in\",\"ContextRuleName\":\"rule_name\",\"ForceContent\":\"force_content\"}"
  headers = {
      'content-type': "application/json",
      'auth-key': "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"
      }

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

  print(response.text)

Exemplo de Retorno de Sucesso

  {
    "Success": true, 
    "Object": null, 
    "Message": "A requisicao de envio foi encaminhada para processamento com sucesso. Voce podera acompanhar o status pelos relatorios."
  }

Retornos Previsíveis

Agendar SMS / Grupos de Contatos

Com este recurso, é possivel programar a data e horário de envio de SMS para um grupo de contatos.
Para usar este recuso, é necessário ter grupos de contatos já cadastrados em nossa aplicação, caso ainda não tenha feito isso, dê uma olhadinha no recurso Cadastrar Grupos e Adicionar Contatos / Grupos
URL do Endpoint: https://sms.comtele.com.br/api/v2/schedulecontactmessage
Autenticação via Header: auth-key: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
Método: POST

curl --request POST \
  --url https://sms.comtele.com.br/api/v2/schedulecontactmessage \
  --header 'auth-key: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX' \
  --header 'content-type: application/json' \
  --data '{"Sender":"sender_id","Content":"message","GroupName":"group_name","ScheduleDate":"send_in"}'

var request = require("request");

var options = {
  method: 'POST',
  url: 'https://sms.comtele.com.br/api/v2/schedulecontactmessage',
  headers: {
    'content-type': 'application/json',
    'auth-key': 'XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX'
  },
  body: '{"Sender":"sender_id","Content":"message","GroupName":"group_name","ScheduleDate":"send_in"}'
};

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

require 'uri'
require 'net/http'
require 'openssl'

url = URI("https://sms.comtele.com.br/api/v2/schedulecontactmessage")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Post.new(url)
request["content-type"] = 'application/json'
request["auth-key"] = 'XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX'
request.body = "{\"Sender\":\"sender_id\",\"Content\":\"message\",\"GroupName\":\"group_name\",\"ScheduleDate\":\"send_in\"}"

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

var data = "{\"Sender\":\"sender_id\",\"Content\":\"message\",\"GroupName\":\"group_name\",\"ScheduleDate\":\"send_in\"}";

var xhr = new XMLHttpRequest();

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

xhr.open("POST", "https://sms.comtele.com.br/api/v2/schedulecontactmessage");
xhr.setRequestHeader("content-type", "application/json");
xhr.setRequestHeader("auth-key", "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX");

xhr.send(data);

import requests

url = "https://sms.comtele.com.br/api/v2/schedulecontactmessage"

payload = "{\"Sender\":\"sender_id\",\"Content\":\"message\",\"GroupName\":\"group_name\",\"ScheduleDate\":\"send_in\"}"
headers = {
    'content-type': "application/json",
    'auth-key': "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"
    }

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

print(response.text)

Exemplo de Retorno de Sucesso

  {
    "Success": true, 
    "Object": null, 
    "Message": "A requisicao de envio foi encaminhada para processamento com sucesso. Voce podera acompanhar o status pelos relatorios."
  }

Retornos Previsíveis

Cancelar Agendamento de SMS

Com este recurso, é possível cancelar o agendamento de SMS

URL do Endpoint: https://sms.comtele.com.br/api/v2/cancelrequest
Autenticação via Header: auth-key: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
Método: POST

curl --request POST \
  --url https://sms.comtele.com.br/api/v2/cancelrequest \
  --header 'auth-key: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX' \
  --header 'content-type: application/json' \
  --data '{"RequestUniqueId":"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"}'

var request = require("request");

var options = {
  method: 'POST',
  url: 'https://sms.comtele.com.br/api/v2/cancelrequest',
  headers: {
    'content-type': 'application/json',
    'auth-key': 'XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX'
  },
  body: '{"RequestUniqueId":"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"}'
};

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

require 'uri'
require 'net/http'
require 'openssl'

url = URI("https://sms.comtele.com.br/api/v2/cancelrequest")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Post.new(url)
request["content-type"] = 'application/json'
request["auth-key"] = 'XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX'
request.body = "{\"RequestUniqueId\":\"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX\"}"

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

var data = "{\"RequestUniqueId\":\"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX\"}";

var xhr = new XMLHttpRequest();

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

xhr.open("POST", "https://sms.comtele.com.br/api/v2/cancelrequest");
xhr.setRequestHeader("content-type", "application/json");
xhr.setRequestHeader("auth-key", "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX");

xhr.send(data);

import requests

url = "https://sms.comtele.com.br/api/v2/cancelrequest"

payload = "{\"RequestUniqueId\":\"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX\"}"
headers = {
    'content-type': "application/json",
    'auth-key': "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"
    }

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

print(response.text)

Exemplo de Retorno de Sucesso

  {
    "Success": true, 
    "Object": {
      "requestUniqueId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"
    }
    "Message": "As mensagens do token informado que ainda estavam em rota de processamento foram canceladas."
  }

Retornos Previsíveis

Autenticação Dois Fatores via SMS

Nesta seção, são abordados dois recursos disponíveis para envio de SMS no cenário de autenticacão em dois fatores, por meio destes recursos, a Comtele automaticamente gera o código, envia e valida de acordo com o retorno do seu destinatário, dispensando você ter que desenvolver este controle em sua aplicação. Mais detalhes sobre cada recurso, pode ser encontrado em uma breve descrição logo abaixo do título de cada endpoint.

Enviar SMS / Dois Fatores

Com este recurso, é possivel enviar via SMS de forma instantânea um código de autenticação para o destinatário, que pode ser validado posteriormente no endpoint a seguir: Validar Código / Dois Fatores.

URL do Endpoint: https://sms.comtele.com.br/api/v2/tokenmanager
Autenticação via Header: auth-key: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
Método: POST

  curl --request POST \
    --url https://sms.comtele.com.br/api/v2/tokenmanager \
    --header 'auth-key: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX' \
    --header 'content-type: application/json' \
    --data '{
       "PhoneNumber":"phone_number",
       "Prefix":"company_from",
       "EnforceSecureValidation":bool,
       "ExpireInMinutes":"minute"
      }'

  var request = require("request");

  var options = {
    method: 'POST',
    url: 'https://sms.comtele.com.br/api/v2/tokenmanager',
    headers: {
      'content-type': 'application/json',
      'auth-key': 'XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX'
    },
    body: '{
       "PhoneNumber":"phone_number",
       "Prefix":"company_from",
       "EnforceSecureValidation":bool, 
       "ExpireInMinutes":"minute"
      }'
  };

  request(options, function (error, response, body) {
    if (error) throw new Error(error);

    console.log(body);
  });

  require 'uri'
  require 'net/http'
  require 'openssl'

  url = URI("https://sms.comtele.com.br/api/v2/tokenmanager")

  http = Net::HTTP.new(url.host, url.port)
  http.use_ssl = true
  http.verify_mode = OpenSSL::SSL::VERIFY_NONE

  request = Net::HTTP::Post.new(url)
  request["content-type"] = 'application/json'
  request["auth-key"] = 'XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX'
  request.body = "{\"PhoneNumber\":\"phone_number\",\"Prefix\":\"company_from\"\"EnforceSecureValidation\":\"bool\"\"ExpireInMinutes\":\"minute\"}"
  response = http.request(request)
  puts response.read_body

  var data = "{\"PhoneNumber\":\"phone_number\",\"Prefix\":\"company_from\",\"EnforceSecureValidation\":\"bool\",\"ExpireInMinutes\":\"minute\"}";

  var xhr = new XMLHttpRequest();

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

  xhr.open("POST", "https://sms.comtele.com.br/api/v2/tokenmanager");
  xhr.setRequestHeader("content-type", "application/json");
  xhr.setRequestHeader("auth-key", "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX");

  xhr.send(data);

  import requests

  url = "https://sms.comtele.com.br/api/v2/tokenmanager"

  payload = "{
  \"PhoneNumber\":\"phone_number\",
  \"Prefix\":\"company_from\",
  \"EnforceSecureValidation\":\"bool\",
  \"ExpireInMinutes\":\"minute\"
  }"
  headers = {
      'content-type': "application/json",
      'auth-key': "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"
      }

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

  print(response.text)

Exemplo de Retorno de Sucesso

{
  "Success": true, 
  "Object": {
    "Prefix": "", 
    "PhoneNumber : "",
    "ExpireInMinutes": "",
    "EnforceSecureValidation": ""
    }, 
  "Message": 
  "O token foi criado com sucesso."
}

Campos do Retorno

Retornos Previsíveis

Validar Código / Dois Fatores

Com este recurso, é possivel validar o token recebido e informado pelo usuário que recebeu o SMS, enviado pelo endpoint anterior anterior: Enviar SMS / Dois Fatores.

URL do Endpoint: https://sms.comtele.com.br/api/v2/tokenmanager
Autenticação via Header: auth-key: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
Método: PUT

  curl --request PUT \
    --url https://sms.comtele.com.br/api/v2/tokenmanager \
    --header 'auth-key: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX' \
    --header 'content-type: application/json' \
    --data '{"TokenCode":"inputed_user_token","PhoneNumber":"phone_number"}'

  var request = require("request");

  var options = {
    method: 'PUT',
    url: 'https://sms.comtele.com.br/api/v2/tokenmanager',
    headers: {
      'content-type': 'application/json',
      'auth-key': 'XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX'
    },
    body: '{"TokenCode":"inputed_user_token","PhoneNumber":"phone_number"}'
  };

  request(options, function (error, response, body) {
    if (error) throw new Error(error);

    console.log(body);
  });

  require 'uri'
  require 'net/http'
  require 'openssl'

  url = URI("https://sms.comtele.com.br/api/v2/tokenmanager")

  http = Net::HTTP.new(url.host, url.port)
  http.use_ssl = true
  http.verify_mode = OpenSSL::SSL::VERIFY_NONE

  request = Net::HTTP::Put.new(url)
  request["content-type"] = 'application/json'
  request["auth-key"] = 'XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX'
  request.body = "{\"TokenCode\":\"inputed_user_token\",\"PhoneNumber\":\"phone_number}"

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

  var data ="{\"TokenCode\":\"inputed_user_token\",\"PhoneNumber\":\"phone_number\"}";

  var xhr = new XMLHttpRequest();

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

  xhr.open("PUT", "https://sms.comtele.com.br/api/v2/tokenmanager");
  xhr.setRequestHeader("content-type", "application/json");
  xhr.setRequestHeader("auth-key", "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX");

  xhr.send(data);

  import requests

  url = "https://sms.comtele.com.br/api/v2/tokenmanager"

  payload = "{\"TokenCode\":\"inputed_user_token\",PhoneNumber\":\"phone_number\"}"
  headers = {
      'content-type': "application/json",
      'auth-key': "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"
      }

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

  print(response.text)

Exemplo de Retorno de Sucesso

{
  "Success": true, 
  "Object": {
    "TokenCode": "XXXXXX",
    "PhoneNumber: "DDD+Telefone"
    },
  "Message": "O token informado foi validado com sucesso."
}

Campos do Retorno

Retornos Previsíveis

Relatórios

Nesta seção, são abordados todos os recursos disponíveis para consulta de SMS enviados. Mais detalhes sobre cada recurso, pode ser encontrado em uma breve descrição logo abaixo do título de cada endpoint.

Consultar Relatório / Detalhado.

Com este recurso, é possivel consultar todos os detalhes disponíveis dos SMS enviados.
Este recurso possui um cooldown de 30 segundos que é compartilhando entre os recursos de Relatório de Regra de Resposta Automática, Relatório de Respostas e Histórico de Recargas, ou seja, somente uma chamada a cada 30 segundos a estes recursos podem ser realizadas.
URL do Endpoint: https://sms.comtele.com.br/api/v2/detailedreporting
Autenticação via Header: auth-key: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
Método: GET

  curl --request GET \
    --url 'https://sms.comtele.com.br/api/v2/detailedreporting?StartDate=begin_search_data&EndDate=end_search_data&Delivered=filter_status&Receiver=receiver&RequestUniqueId=unique_id' \
    --header 'auth-key: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX'

  var request = require("request");

  var options = {
    method: 'GET',
    url: 'https://sms.comtele.com.br/api/v2/detailedreporting',
    qs: {
      StartDate: 'begin_search_data',
      EndDate: 'end_search_data',
      Delivered: 'filter_status',
      Receiver: 'receiver',
      RequestUniqueId: 'unique_id'
    },
    headers: {'auth-key': 'XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX'}
  };

  request(options, function (error, response, body) {
    if (error) throw new Error(error);

    console.log(body);
  });

  require 'uri'
  require 'net/http'
  require 'openssl'

  url = URI("https://sms.comtele.com.br/api/v2/detailedreporting?StartDate=begin_search_data&EndDate=end_search_data&Delivered=filter_status&Receiver=receiver&RequestUniqueId=unique_id")

  http = Net::HTTP.new(url.host, url.port)
  http.use_ssl = true
  http.verify_mode = OpenSSL::SSL::VERIFY_NONE

  request = Net::HTTP::Get.new(url)
  request["auth-key"] = 'XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX'

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

  var data = null;

  var xhr = new XMLHttpRequest();

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

  xhr.open("GET", "https://sms.comtele.com.br/api/v2/detailedreporting?StartDate=begin_search_data&EndDate=end_search_data&Delivered=filter_status&Receiver=receiver&RequestUniqueId=unique_id");
  xhr.setRequestHeader("auth-key", "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX");

  xhr.send(data);

  import requests

  url = "https://sms.comtele.com.br/api/v2/detailedreporting"

  querystring = {"StartDate":"begin_search_data","EndDate":"end_search_data","Delivered":"filter_status","Receiver":"receiver","RequestUniqueId":"unique_id"}

  headers = {'auth-key': 'XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX'}

  response = requests.request("GET", url, headers=headers, params=querystring)

  print(response.text)

Exemplo de Retorno de Sucesso

{
  "Success": true, 
  "Object": [
    {
      "Receiver": "", 
      "Content": "", 
      "Status": "", 
      "ScheduleDate": "", 
      "RequestDate": "", 
      "SystemMessage": "", 
      "DlrStatus": "", 
      "Sender": ""
    }
  ],
  "Message": null
}

Campos do Retorno

Retornos Previsíveis

Consultar Relatório / Regra de resposta automática

Com este recurso, é possivel consultar todos os detalhes disponíveis dos SMS enviados/recebidos utilizando a funcionalidade de regra de resposta automatica.
Este recurso possui um cooldown de 30 segundos que é compartilhando entre os recursos de Relatório Detalhado, Relatório de Respostas e Histórico de Recargas, ou seja, somente uma chamada a cada 30 segundos a estes recursos podem ser realizadas.

URL do Endpoint: https://sms.comtele.com.br/api/v2/contextreporting
Autenticação via Header: auth-key: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
Método: GET

  curl --request GET \
    --url 'https://sms.comtele.com.br/api/v2/contextreporting?StartDate=begin_search_data&EndDate=end_search_data&ContextRuleName=rule_name' \
    --header 'auth-key: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX'

  var request = require("request");

  var options = {
    method: 'GET',
    url: 'https://sms.comtele.com.br/api/v2/contextreporting',
    qs: {
      StartDate: 'begin_search_data',
      EndDate: 'end_search_data',
      ContextRuleName: 'rule_name'
    },
    headers: {'auth-key': 'XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX'}
  };

  request(options, function (error, response, body) {
    if (error) throw new Error(error);

    console.log(body);
  });

  require 'uri'
  require 'net/http'
  require 'openssl'

  url = URI("https://sms.comtele.com.br/api/v2/contextreporting?StartDate=begin_search_data&EndDate=end_search_data&ContextRuleName=rule_name")

  http = Net::HTTP.new(url.host, url.port)
  http.use_ssl = true
  http.verify_mode = OpenSSL::SSL::VERIFY_NONE

  request = Net::HTTP::Get.new(url)
  request["auth-key"] = 'XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX'

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

  var data = null;

  var xhr = new XMLHttpRequest();

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

  xhr.open("GET", "https://sms.comtele.com.br/api/v2/contextreporting?StartDate=begin_search_data&EndDate=end_search_data&ContextRuleName=rule_name");
  xhr.setRequestHeader("auth-key", "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX");

  xhr.send(data);

  import requests

  url = "https://sms.comtele.com.br/api/v2/contextreporting"

  querystring = {"StartDate":"begin_search_data","EndDate":"end_search_data","ContextRuleName":"rule_name"}

  headers = {'auth-key': 'XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX'}

  response = requests.request("GET", url, headers=headers, params=querystring)

  print(response.text)

Exemplo de Retorno de Sucesso

{
  "Success": true,
  "Object":  [
    {
      "Sender": "", 
      "Content": "", 
      "Received": "", 
      "ContextRuleName": "", 
      "StatusMessage": ""
    }
  ],
  "Message": null
}

Campos do Retorno

Retornos Previsíveis

Consultar Relatório / Respostas

Com este recurso, é possivel consultar todos os detalhes disponíveis dos SMS recebidos utilizando a funcionalidade de recebimento de respostas.
Este recurso possui um cooldown de 30 segundos que é compartilhando entre os recursos de Relatório Detalhado, Relatório de Regra de Resposta Automática e Histórico de Recargas, ou seja, somente uma chamada a cada 30 segundos a estes recursos podem ser realizadas.

URL do Endpoint: https://sms.comtele.com.br/api/v2/replyreporting
Autenticação via Header: auth-key: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
Método: GET

  curl --request GET \
    --url 'https://sms.comtele.com.br/api/v2/replyreporting?StartDate=begin_search_data&EndDate=end_search_data&Sender=phone_number&SenderName=sender \
    --header 'auth-key: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX'

  var request = require("request");

  var options = {
    method: 'GET',
    url: 'https://sms.comtele.com.br/api/v2/replyreporting',
    qs: {
      StartDate: 'begin_search_data',
      EndDate: 'end_search_data',
      Sender: 'phone_number'
      SenderName: 'sender'
    },
    headers: {'auth-key': 'XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX'}
  };

  request(options, function (error, response, body) {
    if (error) throw new Error(error);

    console.log(body);
  });

  require 'uri'
  require 'net/http'
  require 'openssl'

  url = URI("https://sms.comtele.com.br/api/v2/replyreporting?StartDate=begin_search_data&EndDate=end_search_data&Sender=phone_number&SenderName=sender")

  http = Net::HTTP.new(url.host, url.port)
  http.use_ssl = true
  http.verify_mode = OpenSSL::SSL::VERIFY_NONE

  request = Net::HTTP::Get.new(url)
  request["auth-key"] = 'XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX'

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

  var data = null;

  var xhr = new XMLHttpRequest();

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

  xhr.open("GET", "https://sms.comtele.com.br/api/v2/replyreporting?StartDate=begin_search_data&EndDate=end_search_data&Sender=phone_number&SenderName=sender");
  xhr.setRequestHeader("auth-key", "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX");

  xhr.send(data);

  import requests

  url = "https://sms.comtele.com.br/api/v2/replyreporting"

  querystring = {"StartDate":"begin_search_data","EndDate":"end_search_data","Sender":"phone_number","SenderName":"sender"}

  headers = {'auth-key': 'XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX'}

  response = requests.request("GET", url, headers=headers, params=querystring)

  print(response.text)

Exemplo de Retorno de Sucesso

{
  "Success": true,
  "Object": [
    {
      "Sender": "",
      "SentContent": "",
      "ReceivedContent": "",
      "ReceivedDate": "",
      "SenderName": ""
    }
  ],
  "Message": null
}

Campos do Retorno

Retornos Previsíveis

Receber Respostas / Callback

Com este recurso, é possivel receber ao invés de consultar todos os detalhes disponíveis dos SMS recebidos utilizando a funcionalidade de recebimento de respostas.

Configuração da URL

Antes de mais nada, para receber as respostas via callback, é necessário que você ja tenha construído em sua aplicação um webhook para receber a resposta no padrão a seguir, além disso é necessário que o endpoint do seu webhook seja público e que você tenha configurado em sua conta seguindo os seguintes passos:
1 - Acessar o painel em https://sms.comtele.com.br, e inserir os dados de acesso de sua conta.
2 - Na opção Configurações do menu lateral, clique em Alterar Meus Dados.
3 - Na tela de edição dos seus dados pessoais, localize a seção CONFIGURAÇÕES e a opção URL de Callback de Respostas, insira a URL do webhook que irá receber as respostas e clique no botão salvar.
Feito esses passos, em um intervalo máximo de 30 minutos, todas as respostas que estiverem atrelados aos SMS enviados pelo seu usuário serão retornados via callback.

Exemplo do objeto da resposta

  {
    "Sender":string,
    "SentContent":string,
    "ReceivedContent":string,
    "ReceiveDate":"YYYY-MM-DDThh:mm:ss.sTZD",
    "SenderName":string
  }

Campos do Retorno

Receber Status / Callback

Com este recurso, é possivel receber os Status do seu SMS em tempo real.

Configuração da URL

Antes de mais nada, para receber os status via callback, é necessário que você ja tenha construído em sua aplicação um webhook para receber a resposta no padrão a seguir, além disso é necessário que o endpoint do seu webhook seja público e que você tenha configurado em sua conta seguindo os seguintes passos:
1 - Acessar o painel em https://sms.comtele.com.br, e inserir os dados de acesso de sua conta.
2 - Na opção Configurações do menu lateral, clique em Alterar Meus Dados.
3 - Na tela de edição dos seus dados pessoais, localize a seção CONFIGURAÇÕES e a opção URL de Callback de Status, insira a URL do webhook que irá receber as respostas e clique no botão salvar.
Feito esses passos, em um intervalo máximo de 30 minutos, todas os status que estiverem atrelados aos SMS enviados pelo seu usuário serão retornados via callback.

Exemplo do objeto da resposta

  {
    "Sender":string,
    "Status":string,
    "PhoneNumber":string,
    "StatusDate":"YYYY-MM-DDThh:mm:ss.sTZD",
  }

Campos do Retorno

Respostas Automáticas

Nesta seção é abordada a criação de regras de resposta automática, que podem ser utilizadas na hora do envio para criar um fluxo automatizado de acordo com a resposta do cliente para a mensagem enviada.

Cadastrar / Respostas Automáticas

Com este recurso, é possivel cadastrar respostas automáticas que podem ser usadas no momento do envio.
URL do Endpoint: https://sms.comtele.com.br/api/v2/sendingcontextrules
Autenticação via Header: auth-key: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
Método: POST

  curl --request POST \
    --url https://sms.comtele.com.br/api/v2/sendingcontextrules \
    --header 'auth-key: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX' \
    --header 'content-type: application/json' \
    --data '{"Name":"rule_name","Message":"message","PositiveContext":"positive_input","PositiveResponse":"response_for_positive_input","NegativeContext":"negative_input","NegativeResponse":"response_for_negative_input","DefaultResponse":"default_response"}'

  var request = require("request");

  var options = {
    method: 'POST',
    url: 'https://sms.comtele.com.br/api/v2/sendingcontextrules',
    headers: {
      'content-type': 'application/json',
      'auth-key': 'XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX'
    },
    body: '{"Name":"rule_name","Message":"message","PositiveContext":"positive_input","PositiveResponse":"response_for_positive_input","NegativeContext":"negative_input","NegativeResponse":"response_for_negative_input","DefaultResponse":"default_response"}'
  };

  request(options, function (error, response, body) {
    if (error) throw new Error(error);

    console.log(body);
  });

  require 'uri'
  require 'net/http'
  require 'openssl'

  url = URI("https://sms.comtele.com.br/api/v2/sendingcontextrules")

  http = Net::HTTP.new(url.host, url.port)
  http.use_ssl = true
  http.verify_mode = OpenSSL::SSL::VERIFY_NONE

  request = Net::HTTP::Post.new(url)
  request["content-type"] = 'application/json'
  request["auth-key"] = 'XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX'
  request.body = "{\"Name\":\"rule_name\",\"Message\":\"message\":\"PositiveContext\":\"positive_input\":\"PositiveResponse\":\"response_for_positive_input\":\"NegativeContext\":\"negative_input\":\"NegativeResponse\":\"response_for_negative_input\":\"DefaultResponse\":\"default_response\"}"

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

  var data = "{"Name\":\"rule_name\",\"Message\":\"message\",\"PositiveContext\":\"positive_input\",\"PositiveResponse\":\"response_for_positive_input\",\"NegativeContext\":\"negative_input\",\"NegativeResponse\":\"response_for_negative_input\",\"DefaultResponse\":\"default_response\"}";

  var xhr = new XMLHttpRequest();

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

  xhr.open("POST", "https://sms.comtele.com.br/api/v2/sendingcontextrules");
  xhr.setRequestHeader("content-type", "application/json");
  xhr.setRequestHeader("auth-key", "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX");

  xhr.send(data);

  import requests

  url = "https://sms.comtele.com.br/api/v2/sendingcontextrules"

  payload = "{\"Name\":\"rule_name\",\"Message\":\"message\":\"PositiveContext\":\"positive_input\":\"PositiveResponse\":\"response_for_positive_input\":\"NegativeContext\":\"negative_input\":\"NegativeResponse\":\"response_for_negative_input\":\"DefaultResponse\":\"default_response\"}"
  headers = {
      'content-type': "application/json",
      'auth-key': "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"
      }

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

  print(response.text)

Exemplo de Retorno de Sucesso

  {
    "Success": true,
    "Object": {
      "Name": "rule_name",
      "Message": "message",
      "PositiveContext": "positive_input",
      "PositiveResponse": "response_for_positive_input",
      "NegativeContext": "negative_input",
      "NegativeResponse": "response_for_negative_input",
      "DefaultResponse": "default_response"
    },
    "Message": "A resposta automatica foi criada com sucesso."
  }

Campos do Retorno

Retornos Previsíveis

Grupo de Contatos

Nesta seção, são abordados recursos disponíveis para segmentação de contatos por grupos, que podem ser utilizados na hora do envio, facilitando tanto a rotina de armazemento destes telefones, quanto a de envio posteriormente para os contatos. Mais detalhes sobre cada recurso, pode ser encontrado em uma breve descrição logo abaixo do título de cada endpoint.

Cadastrar / Grupos de Contatos

Com este recurso, é possivel cadastrar grupos de contatos para segmentar contatos em listas que podem ser usadas no momento do envio.
URL do Endpoint: https://sms.comtele.com.br/api/v2/contactgroup
Autenticação via Header: auth-key: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
Método: POST

  curl --request POST \
    --url https://sms.comtele.com.br/api/v2/contactgroup \
    --header 'auth-key: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX' \
    --header 'content-type: application/json' \
    --data '{"Name":"group_name","Description":"group_description"}'

  var request = require("request");

  var options = {
    method: 'POST',
    url: 'https://sms.comtele.com.br/api/v2/contactgroup',
    headers: {
      'content-type': 'application/json',
      'auth-key': 'XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX'
    },
    body: '{"Name":"group_name","Description":"group_description"}'
  };

  request(options, function (error, response, body) {
    if (error) throw new Error(error);

    console.log(body);
  });

  require 'uri'
  require 'net/http'
  require 'openssl'

  url = URI("https://sms.comtele.com.br/api/v2/contactgroup")

  http = Net::HTTP.new(url.host, url.port)
  http.use_ssl = true
  http.verify_mode = OpenSSL::SSL::VERIFY_NONE

  request = Net::HTTP::Post.new(url)
  request["content-type"] = 'application/json'
  request["auth-key"] = 'XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX'
  request.body = "{\"Name\":\"group_name\",\"Description\":\"group_description\"}"

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

  var data = "{\"Name\":\"group_name\",\"Description\":\"group_description\"}";

  var xhr = new XMLHttpRequest();

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

  xhr.open("POST", "https://sms.comtele.com.br/api/v2/contactgroup");
  xhr.setRequestHeader("content-type", "application/json");
  xhr.setRequestHeader("auth-key", "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX");

  xhr.send(data);

  import requests

  url = "https://sms.comtele.com.br/api/v2/contactgroup"

  payload = "{\"Name\":\"group_name\",\"Description\":\"group_description\"}"
  headers = {
      'content-type': "application/json",
      'auth-key': "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"
      }

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

  print(response.text)

Exemplo de Retorno de Sucesso

  {
    "Success": true,
    "Object": {
      "Name": "group_name",
      "Description": "group_description"
    },
    "Message": "O grupo de contatos foi criado com sucesso."
  }

Campos do Retorno

Retornos Previsíveis

Consultar / Grupos de Contatos

Com este recurso, é possivel consultar os grupos de contatos cadastrados.
URL do Endpoint: https://sms.comtele.com.br/api/v2/contactgroup/
Autenticação via Header: auth-key: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
Método: GET

  curl --request GET \
    --url 'https://sms.comtele.com.br/api/v2/contactgroup/{group_name}' \
    --header 'auth-key: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX'

  var request = require("request");

  var options = {
    method: 'GET',
    url: 'https://sms.comtele.com.br/api/v2/contactgroup/{group_name}',
    headers: {'auth-key': 'XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX'}
  };

  request(options, function (error, response, body) {
    if (error) throw new Error(error);

    console.log(body);
  });

  require 'uri'
  require 'net/http'
  require 'openssl'

  url = URI("https://sms.comtele.com.br/api/v2/contactgroup/{group_name}")

  http = Net::HTTP.new(url.host, url.port)
  http.use_ssl = true
  http.verify_mode = OpenSSL::SSL::VERIFY_NONE

  request = Net::HTTP::Get.new(url)
  request["auth-key"] = 'XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX'

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

  var data = null;

  var xhr = new XMLHttpRequest();

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

  xhr.open("GET", "https://sms.comtele.com.br/api/v2/contactgroup/{group_name}");
  xhr.setRequestHeader("auth-key", "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX");

  xhr.send(data);

  import requests

  url = "https://sms.comtele.com.br/api/v2/contactgroup/{group_name}"

  headers = {'auth-key': 'XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX'}

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

  print(response.text)

Exemplo de Retorno de Sucesso

{
  "Success": true,
  "Object": [
    {
      "Id": comtele_group_id,
      "Name": "group_name",
      "Description": "group_description",
      "TotalContacts": 1,
      "LastUsed": "yyyy-MM-dd HH:mm:ss.ms"
    }
  ],
  "Message": null
}

Campos do Retorno

Retornos Previsíveis

Excluir / Grupos de Contatos

Com este recurso, é possivel excluir grupos de contatos cadastrados.
URL do Endpoint: https://sms.comtele.com.br/api/v2/contactgroup
Autenticação via Header: auth-key: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
Método: POST

  curl --request DELETE \
    --url 'https://sms.comtele.com.br/api/v2/contactgroup/{group_name}' \
    --header 'auth-key: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX'

  var request = require("request");

  var options = {
    method: 'DELETE',
    url: 'https://sms.comtele.com.br/api/v2/contactgroup/{group_name}',
    headers: {'auth-key': 'XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX'}
  };

  request(options, function (error, response, body) {
    if (error) throw new Error(error);

    console.log(body);
  });

  require 'uri'
  require 'net/http'
  require 'openssl'

  url = URI("https://sms.comtele.com.br/api/v2/contactgroup/{group_name}")

  http = Net::HTTP.new(url.host, url.port)
  http.use_ssl = true
  http.verify_mode = OpenSSL::SSL::VERIFY_NONE

  request = Net::HTTP::Delete.new(url)
  request["auth-key"] = 'XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX'

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

  var data = null;

  var xhr = new XMLHttpRequest();

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

  xhr.open("DELETE", "https://sms.comtele.com.br/api/v2/contactgroup/{group_name}");
  xhr.setRequestHeader("auth-key", "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX");

  xhr.send(data);

  import requests

  url = "https://sms.comtele.com.br/api/v2/contactgroup/{group_name}"

  headers = {'auth-key': 'XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX'}

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

  print(response.text)

Exemplo de Retorno de Sucesso

{
  "Success": true,
  "Object": null,
  "Message": "O grupo de contatos foi removido com sucesso"
}

Campos do Retorno

Retornos Previsíveis

Cadastrar Contatos / Grupos de Contatos

Com este recurso, é possivel cadastrar contatos em grupos para segmentar estes contatos em listas que podem ser usadas no momento do envio.
URL do Endpoint: https://sms.comtele.com.br/api/v2/contactgroup
Autenticação via Header: auth-key: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
Método: PUT

  curl --request PUT \
    --url https://sms.comtele.com.br/api/v2/contactgroup \
    --header 'auth-key: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX' \
    --header 'content-type: application/json' \
    --data '{"GroupName":"group_name","Action":"add_number","ContactName":"contact_name","ContactPhone":"phone_number"}'

  var request = require("request");

  var options = {
    method: 'PUT',
    url: 'https://sms.comtele.com.br/api/v2/contactgroup',
    headers: {
      'content-type': 'application/json',
      'auth-key': 'XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX'
    },
    body: '{"GroupName":"group_name","Action":"add_number","ContactName":"contact_name","ContactPhone":"phone_number"}'
  };

  request(options, function (error, response, body) {
    if (error) throw new Error(error);

    console.log(body);
  });

  require 'uri'
  require 'net/http'
  require 'openssl'

  url = URI("https://sms.comtele.com.br/api/v2/contactgroup")

  http = Net::HTTP.new(url.host, url.port)
  http.use_ssl = true
  http.verify_mode = OpenSSL::SSL::VERIFY_NONE

  request = Net::HTTP::Put.new(url)
  request["content-type"] = 'application/json'
  request["auth-key"] = 'XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX'
  request.body = "{\"GroupName\":\"group_name\",\"Action\":\"add_number\",\"ContactName\":\"contact_name\",\"ContactPhone\":\"phone_number\"}"

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

  var data = "{\"GroupName\":\"group_name\",\"Action\":\"add_number\",\"ContactName\":\"contact_name\",\"ContactPhone\":\"phone_number\"}";

  var xhr = new XMLHttpRequest();

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

  xhr.open("PUT", "https://sms.comtele.com.br/api/v2/contactgroup");
  xhr.setRequestHeader("content-type", "application/json");
  xhr.setRequestHeader("auth-key", "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX");

  xhr.send(data);

  import requests

  url = "https://sms.comtele.com.br/api/v2/contactgroup"

  payload = "{\"GroupName\":\"group_name\",\"Action\":\"add_number\",\"ContactName\":\"contact_name\",\"ContactPhone\":\"phone_number\"}"
  headers = {
      'content-type': "application/json",
      'auth-key': "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"
      }

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

  print(response.text)

Exemplo de Retorno de Sucesso

  {
    "Success": true,
    "Object": {
      "GroupName": "group_name",
      "Action": "add_number",
      "ContactPhone": "phone_number",
      "ContactName": "contact_name"
    },
    "Message": "O contato foi inserido no grupo com sucesso."
  }

Campos do Retorno

Retornos Previsíveis

Excluir Contatos / Grupos de Contatos

Com este recurso, é possivel remover contatos em grupos segmentados, para que estes contatos não recebam mais SMS destas listas quando usadas no momento do envio.
URL do Endpoint: https://sms.comtele.com.br/api/v2/contactgroup
Autenticação via Header: auth-key: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
Método: PUT