Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

/sms/send

Método que faz o envio o de SMS em lote pela API. Este método é o mesmo utilizado no envio padrão de SMS em lote, o que muda aqui é o "tipo de parâmetro" que pode ser enviado a partir de "destino_csv".

Em linhas gerais o usuário pode incluir até 10 variaveis a mais no CSV que envia para este serviço e referenciar estas variáveis no corpo do email. 

...

  •  Se nome codigo "constarem no header do CSV enviado para este serviço" a mensagem será personalizada antes de ser enviada para cada destinatário, {nome} {codigo} na mensagem serão substituidos pelas variáveis associadas a cada destinatário.
  • Se no header do CSV você incluir outros titulos (ex. rua;cep;cidade), eles também poderão ser chamados na mensagem a ser entregue para cada destinatário.

Sobre a capacidade de entrega de SMS em lote e unitário:

  • Capacidade de até 12 milhões de SMS por hora no envio em lote, nas seguintes condições: Tamanho máximo de cada lote: 10 mil SMS. Número máximo de requisições de SMS em lote por minuto: 20.
  • Capacidade de até 2.5 mil SMS por hora no envio unitário, nas seguintes condições: Número máximo de requisições de SMS unitário por minuto 42. 

 
 
DESCRIÇÃOCom este método podemos enviar um lote lotes de SMS para telefones móveis ou de Mensagens de Voz para telefones fixos, personalizando o nome de cada destinatário no corpo da mensagem (opcional) e um código (também opcional).
ESTRUTURA DA URLhttps://api.directcallsoft.com/sms/send
VERSÃO1
MÉTODOPOST
PARÂMETROS

origem obrigatório Número de quem esta enviando o SMS, formato exemplo: 554199990001 (DDI DDD NUMERO)

destino_csv obrigatório. Deve conter o Arquivo CSV com os números de destino.

Notas sobre este parâmetro:

  • Este arquivo deve ser enviado por multipart/form-data.
  • O formato CSV deve ser igual ao que esta indicado no exemplo abaixo, com header e um numero abaixo do outro: 
    ------------------------
    numero;nome;codigo
    554199990002;Joao da Silva;09309390
    554199990003;Maria de Souza;0394029
    ------------------------ 

IMPORTANTE:  

  • Caso utilize o Microsoft Office Excel para editação dos seus arquivos CSV, sempre salve seu arquivo formatando as células dos números de telefone para formato "número" com 0 casas decimais.
  • Este serviço aceita lotes com "no máximo" 10.000 destinatários, se você precisa enviar para mais destinatários deve dividir o envio em lotes, com "no máximo" 10.000 destinatários.
  • Os Headers do CSV devem ser em minúsculo e sem espaços ou caracteres especiais. 

texto obrigatório Texto a ser enviado na mensagem

- Exemplo de mensagem personalizada: "Ola {nome}, seu pedido foi enviado e seu codigo de rastreamento e {codigo}"

Notas sobre estes parâmetros:

  • Um SMS pode ter até 140 caracteres para envio "sem short number" e 160 para envio "com short number" (envio sem e com short number são descritos posteriormente);
  • Mensagens maiores serão divididas em "multiplos SMS", antes de serem entregues;
  • A cobrança será proporcional ao número de SMS utilizado em cada envio. 

tipo opcional Opção para enviar como texto ou voz podendo ser ("voz" para torpedo de voz | "texto" para sms), por padrão é texto.

cron opcional Em caso de envio agendado esta variável deve ser enviada no formato <dia-mes-ano-hora-minuto-segundo> "d-m-Y-H-i-s"

access_token obrigatório Chave de acesso ao método, para saber como obter clique aqui

format opcional Opção de retorno da API podendo ser JSON ou XML, se não informado JSON será o padrão

short_number opcional para envio "com short number" Configure n para enviar o SMS sem short number ou s para enviar o SMS com short number.

IMPORTANTE: Se este parâmetro não for informado ou se for informado algo diferente de n (minusculo), as mensagens serão enviadas "COM SHORT NUMBER", por padrão.

  • SMS COM SHORT NUMBER tem "custo maior" do que SMS SEM SHORT NUMBER, mas é um serviço mais confiável uma vez que é direto com as operadoras móveis, sem envolver chips de celulares, além disso o destinatário verá sempre o mesmo número de remetente ( short number ), o que pode estabelecer uma identidade para o seu negócio.
  • SMS SEM SHORT NUMBER tem "custo menor" do que SMS COM SHORT NUMBER, mas é um serviço menos confiável uma vez que utiliza chips de celulares, além disso o destinatário verá sempre um número de remetente "aleatório".

id_origem opcional Opção para envio do número de origem no início do SMS podendo ser s para enviar e n para não enviar.

entregar_como_mensagem_de_voz_em_tel_fixo opcional Opção para entrega de mensagem de texto como voz para telefones fixos, podendo ser s para enviar (padrão) e n para não enviar.

callbackEmail opcional para envio "com short number" Indique um endereço de email nesta opção se você deseja receber resposta de SMS enviado via email, ex.meuemail@minhaempresa.com.br 

NOTAS:

  • O email indicado será avisado caso o destinatário de cada SMS responda, com recursos que permitirão responder a mensagem rapidamente a partir do email recebido, além de ver histórico SMS Recebido x Enviado no ESTILO CHAT.

  • Esta opção garante apenas a resposta de SMS enviados ha menos de 24h, sem a necessidade de palavra chave.

  • A resposta de SMS será gratuita para quem responde a partir do seu celular, mas terá o mesmo de um SMS enviado para quem recebe a resposta na sua aplicação.

DICAS:

    • Cada SMS recebido poderá ser consultado também a partir da API de SMS que permite Consultar dados de SMS recebido e da API de SMS que permite Consultar dados de SMS Recebido x Enviado no ESTILO CHAT.
    • Para facilitar alertas online sobre SMS recebido na tela do computador, mesmo quando o usuário não estiver na sua aplicação, instale a: Directcall APP Desktop.
      Além de SMS esta APP facilita ligação com opção de gravação, de histórico na sua aplicação, etc., mesmo quando o usuário não estiver na sua aplicação. 


RETORNO

api Origem API que esta sendo usada

modulo Módulo que está sendo chamado

status Mensagem de status

codigo Código de retorno - Clique aqui para listar os códigos e suas descrições

msg Texto de resposta da API

 

Exemplo de resposta em JSON
{
   "api":"sms",
   "modulo":"enviar",
   "status":"ok",
   "codigo":"000",
   "msg":"001 - Mensagem enviada com sucessso - CALLER-ID: 62925845049598",
   "callerid":"62925845049598"
}
Informações
titleValidade dos tokens: Os tokens de acesso têm uma validade limitada, por isso convém que o sistema criado tenha em conta estes timings para que possa desenvolver rotinas de requisação de novos tokens.