PARÂMETROS | origem obrigatório Número de quem esta enviando o SMS, formato exemplo: 554199xx2010 (DDI DDD NUMERO) destino obrigatório Número de destino do SMS, formato exemplo: 554199xx2010 (DDI DDD NUMERO) Notas sobre este parâmetro: - Para enviar para mais do que um destinatário basta incluir um ; no meio de cada número, por exemplo: 554199xx2010;554199xx2030, mas esta alternativa não deve ser utilizada para enviar SMS para mais do que 10 destinatários.
- Quando você precisar enviar para mais do que 10 destinatários prefira informar os números via arquivo csv +Inf.
texto obrigatório Texto a ser enviado na mensagem pode ter até 700 caracteres, mas "importante": 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.
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: Informar este parâmetro se você deseja enviar SMS SEM SHORT NUMBER. Se o parâmetro short_number não for informado 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" Caso você queira receber a resposta deste envio com SHORT NUMER no seu e-mail, envie o endereço de e-mail, quando o destinatário do SMS responder a resposta vai direto ao e-mail informado. Formato: [email protected] Importante ler: - Se esta opção for habilitada o usuário será avisado por email sobre cada SMS recebido, com copia da mensagem que originou a mensagem recebida e com recursos que permitirão que responder a mensagem facilmente, a aprtir do email.
- Esta versão trata apenas as mensagens recebidas em resposta a SMS enviados ha menos de 24h.
- O email remetente de cada aviso será: [email protected], sendo que esta conta de email "não recebe mensagens".
- Esta opção não impede que você continue consultando mensagens recebidas no Histórico de SMS recebido, através da API de extrato.
DICA: - Para facilitar alertas online sobre SMS recebido na tela do computador do seu usuário, 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 nela 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 callerid Código identificador da mensagem Exemplo de resposta em JSON |
---|
{ "api":"sms", "modulo":"enviar", "status":"ok", "codigo":"000", "msg":"001 - Mensagem enviada com sucessso - CALLER-ID: 62925845049598", "callerid":"62925845049598" } |
|