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 Mensagens de voz em lote pela API. Este método é o mesmo do envio padrão, muda apenas o parâmetro "destino_csv" que deve ser enviado 

 
 
DESCRIÇÃOCom este método podemos enviar Mensagem de voz em massa para telefones fixos ou móveis - A partir de um "texto" ou de um "arquivo de áudio" .
ESTRUTURA DA URLhttps://api.directcallsoft.com/sms/send
VERSÃO2
MÉTODOPOST
PARÂMETROS

origem obrigatório Número de quem esta enviando a Mensagem de Voz, formato exemplo: 554130600300 (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.
  • Os telefones podem ser separados por qualquer caracter não numérico, por exemplo: 5541xx99792010;554199xx2030.
  • Quando você precisar enviar Mensagem de voz para lotes pequenos de destinatários (até 10), você pode utilizar o parâmetro destino e incluir um "ponto e virgula" no meio de cada número, por exemplo: 554199xx2010;554199xx2030 +Inf. 

texto obrigatório  obrigatório, se o parâmetro áudio, abaixo, não for utilizado. Texto a ser enviado na mensagem

Notas sobre este parâmetro: 

Esta
  • Por padrão será aceito até 700 caracteres em cada mensagem, no entanto, indicamos que sejam enviados "textos curtos" para serem convertidos para voz.
  • Em caso de "mensagem longa" , indicamos que seja enviado um arquivo de áudio, gerado por algum estúdio de gravação +Inf.
audio opcional
  • indicamos você utilize o parâmetro áudio, abaixo.

audio obrigatório, se o parâmetro texto, acima, não for utilizado. Este parâmetro deve ser enviado um arquivo no formato MP3, caso seja enviado não precisa ser informado a variável texto.

Notas sobre este parâmetro: 

  • Recomendamos o uso de mensagens de áudio curtas, com menos de 60s. 
  • Mensagens maiores costumam ter baixa audiência, os destinatários desligam antes de terminar.
  • Recomendamos ainda que seja utilizado um áudio gerado por algum estúdio de gravação, isso costuma aumentar a audiência completa das mensagens.

tipo obrigatorio "texto".

cron 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

envio_de opcional Valor inteiro da hora podendo ser de 0 a 23

envio_ate opcional Valor inteiro da hora podendo ser de 0 a 23

Notas sobre este parâmetro: 

  • Se você enviar as variáveis envio_de e envio_ate os envios só serão efetivados dentro desta faixa de horário.

format opcional Opção de retorno da API podendo ser JSON ou XML, se não informado JSON será o padrã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.