KingSMS - API SMS

Bem-vindo à API SMS da KingSMS. Com ela você pode fazer Envio de SMS para todas as operadoras de forma simples e prática.

Visão Geral

Este documento descreve as características técnicas da API para integração com a KingSMS, visando permitir o desenvolvimento da comunicação entre as plataformas envolvidas.

Definição do Protocolo

O protocolo está baseado em comunicação REST entre a KingSMS e a plataforma do Cliente.

As mensagens deverão ser enviadas via GET ou POST. O retorno para cada chamada será um objeto JSON.

Host Base

https://painel.kingsms.com.br/kingsms/api

Enviar SMS

GET POST

Campo	Descrição	Valor
acao	Identificador do Serviço	sendsms ou bulksms
login	Login de acesso	(Obrigatório)
token	Token de acesso	(Obrigatório)
numero	Número de destino (DDnumero)	Vírgula para bulksms
msg	Mensagem	Até 160 caracteres (sem acentos)

Exemplo de Requisição

https://painel.kingsms.com.br/kingsms/api?acao=sendsms&login=seulogin&token=seutoken&numero=11999999999&msg=teste

Exemplo de Resposta (JSON)

Resposta: Sucesso

{
  "status": "success",
  "cause": "SMS Add Queue",
  "id": "189"
}

Resposta: Erro

{
  "status": "error",
  "cause": "Without Credit"
}

Status de Retorno

GET

Campo	Descrição	Valor
acao	Identificador do Serviço	reportsms
login	Login de acesso	(Obrigatório)
id	Identificador da mensagem	(Obrigatório)

Exemplo de Requisição

https://painel.kingsms.com.br/kingsms/api?acao=reportsms&login=seulogin&id=181

Exemplo de Resposta (JSON)

Resposta: Enviado

{"status":"success","cause":"SendingOK"}

Resposta: Pendente

{"status":"pending":"SMS still in queue"}

Consulta de Saldo

GET

Campo	Descrição	Valor
acao	Identificador do Serviço	saldo
login	Login de acesso	(Obrigatório)
token	Token de acesso	(Obrigatório)

Exemplo de Requisição

https://painel.kingsms.com.br/kingsms/api?acao=saldo&login=seulogin&token=seutoken

Exemplo de Resposta (JSON)

Resposta JSON

{
  "status": "success",
  "cause": "Credit 1 SMS"
}

Resposta SMS (Inbound)

GET POST

Campo	Descrição	Valor
acao	Identificador do Serviço	resposta
login	Login de acesso	(Obrigatório)
token	Token de acesso	(Obrigatório)
flag	Lista Respostas	read ou unread

Exemplo de Requisição

https://painel.kingsms.com.br/kingsms/api?acao=resposta&login=seulogin&token=seutoken&flag=unread

Dica sobre Flag:

read: Lista as respostas que já foram lidas pela API anteriormente.
unread: Lista apenas as mensagens novas que ainda não foram capturadas.

Exemplo de Resposta (JSON)

Sucesso: Mensagem Recebida

[
  {
    "ID": "4523244",
    "ReceivingDateTime": "2018-11-16 11:31:02",
    "SenderNumber": "11999999999",
    "Text": "Ok"
  }
]

Erro: Falha na Autenticação

{"status":"error","cause":"Incorrect Token"}

Exemplos de Implementação

PHP Envio via PHP

sendsms.php

<?php
$login = 'seulogin';
$token = 'seutoken';
$numero = 'seunumero';
$msg = urlencode("teste sms");

$url = "https://painel.kingsms.com.br/kingsms/api?acao=sendsms";
$url .= "&login=$login&token=$token&numero=$numero&msg=$msg";

$send = file_get_contents($url);
echo $send;
?>

PY Envio via Python

sendsms.py

#!/usr/bin/python
import urllib

# Substitua pelas suas credenciais
api_url = "https://painel.kingsms.com.br/kingsms/api?acao=sendsms"
params = "&login=seulogin&token=seutoken&numero=dddnumero&msg=teste+sms"

response = urllib.urlopen(api_url + params)
print response.read()

KingSMS

Provedor de SMS no Brasil focado em soluções de baixo custo e alta eficiência. Ideal para alertas, avisos de cobrança, agendamentos e marketing direto.

Visite Nosso Site Oficial KingSMS Logo