Versões comparadas

Versão Versão antiga 21 Nova versão Atual
Alterações feitas por

Former user

Leanderson Correia

Gravado em

Chave

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

/sms/send

DESCRIÇÃO

Este método permite enviar SMS em lote para telefones móveis e Mensagem de Voz para telefones fixos (opcional).

  • O texto é automaticamente transformado em áudio antes de ser entregue, quando a opção de Mensagem de Voz é habilitada.

Para o envio no formato JSON deve ser enviado o "Header Content-Type: application/json"

ESTRUTURA DA URL

https://api.directcallsoft.com/sms/lot-send

VERSÃO

1

MÉTODO

POST

PARÂMETROS

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

destinatarios obrigatório. Deve conter um array de destinatário com os seguintes campos.

id_destinatario obrigatório Identificador único para o destinatário

destino obrigatório Número de destino do SMS, formato exemplo: 551199990002 (DDI DDD NUMERO)

texto obrigatório Texto a ser enviado na mensagem

  • Notas sobre este parâmetro:

    • Um SMS pode ter até 160 caracteres para envio

"sem short number" e 140 para envio "com short number";

    • .

    • Mensagens maiores serão divididas em "multiplos SMS" e chegarão com complemento simiar a 1/2, 2/2, etc.;

    • A cobrança será proporcional ao número de SMS utilizado em cada envio. 

IMPORTANTE: 

  • 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

  • com "no máximo" 10.000 destinatários. 

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 

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ãoshort_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_origemopcional 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

     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

    • 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. 

    codetitle

    languagejs

    Exemplo de requisição em JSON
    Bloco de código
    linenumbers
    language
    true
    js
    {
    "origem": "558",
    "tipo": "texto",
    "access_token": "670769a9d4061b103a80080614216302c77e98b",
    "format": "json",
    "short_number": "s",
    "entregar_como_mensagem_de_voz_em_tel_fixo": "n",
    "id_origem": "n",
    "callbackEmail": "meuemail@minhaempresa.com.br",
    "destinatarios": [
        {
            "id_destinatario": "1",
            "destino": "551199990001",
            "texto": "Envio em lote"
        },
        {
            "id_destinatario": "2",
            "destino": "551199990002",
            "texto": "Envio em lote"
        }
    ]
}
     
    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
    destino Array com os destinos enviados
    id_destinatario Identificador único para o destinatário
     
    id_mensagem Identificador único para a mensagem
    entregue_como Se a mensagem foi entregue como texto ou voz
     Bloco de códigolanguagejstitle
    Exemplo de resposta em JSON
    linenumbers
     Bloco de código
    language
    true
    js
    {
  "api": "sms",
  "modulo": "enviar",
  "status": "ok",
  "codigo": "000",
  "msg": "001 - Mensagem enviada com sucessso - CALLER-ID: 62925845049598",
  "callerid": "62925845049598",
  "destino": [
    {
      "id_destinatario": "1",
      "id_mensagem": 70006274618573,
      "entregue_como": "texto"
    },
    {
      "id_destinatario": "2",
      "id_mensagem": 70006274635131,
      "entregue_como": "texto"
    }
  ]
}
     Informações
    ...
    Validade 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.
    Veja também: