Envio de SMS
/sms/send
|
|
---|---|
DESCRIÇÃO | Este método permite enviar SMS para telefones móveis e Mensagem de Voz para telefones fixos (opcional).
|
ESTRUTURA DA URL | |
VERSÃO | 1 |
MÉTODO | POST |
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:
texto obrigatório Texto a ser enviado na mensagem pode ter até 700 caracteres, mas "importante": Notas sobre este parâmetro:
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
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 Indique um endereço de e-mail nesta opção se você deseja receber resposta de SMS em um e-mail, ex.: meuemail@minhaempresa.com.br NOTAS:
DICA:
|
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"
}
]
} |
Exemplos:
Linguagem | Descrição | Arquivo |
---|---|---|
PHP | Arquivo em PHP com exemplo de como requisitar o access_token por meio da API | |
PHP | Arquivo em PHP com exemplo de como enviar um SMS via API |
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:
HELPER para facilitar o envio de SMS na sua aplicação
Acelere a implantação com este miniaplicativo baseado em HTML e Javascript, com interfaces prontas para os usuários da sua aplicação utilizarem esta API.