PARÂMETROS | origem obrigatório Número de quem está enviando o SMS, formato exemplo: 554199990001 (DDI DDD NUMERO) destino obrigatório Número de destino do SMS, formato exemplo: 551199990002 (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: 554199990002;554199990003, 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.
- Para números internacionais acrescente 00 na frente do numero. Ex.: 0011234567890
texto obrigatório Texto a ser enviado na mensagem pode ter até 700 caracteres, mas "importante": Notas sobre este parâmetro: - Cada SMS pode ter no máximo 140 caracteres, sendo contabilizado parâmetro texto mais parâmetro origem;
- Mensagens maiores serão divididas em "múltiplos SMS" e chegarão com complemento similar 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: Se este parâmetro não for informado ou se for informado algo diferente de n (minúsculo), 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 n para não enviar (padrão) e s para 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 e-mail nesta opção se você deseja receber resposta de SMS em um e-mail, ex.: [email protected] NOTAS: O e-mail indicado será avisado caso o destinatário de cada SMS responda, com recursos que permitirão responder a mensagem rapidamente a partir do e-mail 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.
DICA: - 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 callerid Código identificador da mensagem id_mensagem: Identificador único para a mensagem destino: Destino da mensagem
Exemplo de resposta em JSON |
---|
{
"api": "sms",
"modulo": "enviar",
"status": "ok",
"codigo": "000",
"msg": "001 - Mensagem enviada com sucessso - CALLER-ID: 55694775188625",
"destino": [
"5541987654321",
"5541912345678"
],
"callerid": "55694775188625",
"detalhe": [
{
"id_mensagem": 55694762999823,
"destino": "5541987654321"
},
{
"id_mensagem": 55694775188733,
"destino": "5541912345678"
}
]
}
|
|