Envio múltiplo de SMS – HTTP

Descrição
Enviar, em uma mesma chamada, até 10 mil SMS para múltiplos destinatários.
A lista de destinatários pode ser enviada de duas formas: como uma variável HTTP POST ou como um arquivo em um formulário HTML. Veja a seguir.

 

[SISTEMA CLIENTE] ←→[ZENVIA]

→ no retorno, identificar linha geral e específica de cada SMS.

Parâmetros de entrada
Parâmetro Obrigatório Formato Descrição
Account Sim String (20) Nome da conta utilizada pelo cliente.
Code Sim String (20) Senha de integração da conta.
Dispatch Sim Nome da operação
(sendMultiple)
Deve conter o valor sendMultiple.
Type Sim A, B, C, D, E Layout do arquivo ou lista enviado no parâmetro “file” ou “list” (ver os formatos de layout no quadro a seguir).
CallbackOption Não 0 – nenhuma resposta (padrão)
1 – envia o status final da mensagem (recomendado)
2 – envia status intermediários e final da mensagem
Opção para habilitar a notificação do status de cada SMS ao sistema do cliente, em uma URL de retorno personalizada.
Obs.: para habilitar o retorno de status, é preciso utilizar layouts que contenham o parâmetro ID para cada SMS e configurar uma URL de retorno na conta utilizada.
File Não Arquivo csv Arquivo em formato csv, de acordo com os layouts descritos no quadro a seguir.
List Não String csv String em formato csv, de acordo com os layouts descritos no quadro a seguir.

 

Quadro: layout

Layout Formato da linha
A to;msg
B to;msg;from
C to;msg;id
D to;msg;id;from
E to;msg;id;from;schedule

 

O conjunto de linhas para envio pode ser enviado por uma lista ou por um arquivo de formulário HTML.

Os parâmetros a serem enviados em cada linha são:

Parâmetro Obrigatório Formato Descrição
To Sim código de país + código de área + número (até 15 dígitos) Celular de destino. Exemplo: 555199887766.
Msg Sim String(160) Texto do SMS. Junto com o parâmetro “from”, deve ter no máximo 160 caracteres (140 para destinatários Nextel).
Id Não String(50) Identificador único para o SMS.
From Não String(20) Nome do remetente. Se não informado, utiliza-se o remetente-padrão da conta.
Schedule Não dd/mm/aaaa hh:mm:ss Detalhes ou observações extras.

 

Exemplo de linhas no layout E

555199999999;Mensagem de teste 1;id0001; XPTO Ltda;01/01/2012 15:00:00
5511999999999;Mensagem de teste 2;id0002; XPTO Ltda;01/01/2012 15:10:00

 

O retorno tem a seguinte estrutura:

  • Linha 1: retorno da chamada
  • Demais linhas: um linha para cada SMS enviado

A resposta deve ser interpretada em duas partes: a primeira linha traz o retorno geral da chamada; as demais linhas trazem o retorno para cada SMS da lista enviada.

Retorno da chamada
Retorno Descrição
Sucesso na chamada
200 – Messages sent Requisição aceita pela API. Verifique, nas linhas seguintes, o retorno específico de cada SMS enviado.
Envio parcial
210 – Messages scheduled but account limit reached – please contact support Durante o envio, o limite de créditos de sua conta foi atingido. Contate nosso suporte para verificação/liberação.
Erro no arquivo
240 – File empty of not sent Arquivo vazio ou não identificado. Verifique o parâmetro “file”, conforme tabela acima.
241 – File too large Arquivo muito grande (mais de 1 Mbyte). Verifique o parâmetro “file”, conforme tabela acima.
242 – File read error Arquivo corrompido ou mal formatado. Verifique o parâmetro “file”, conforme tabela acima.
Erros gerais
900 – Authentication error Erro de autenticação. Verifique os parâmetros “account” e “code”.
990 – account limit reached O limite de créditos de sua conta foi atingido. Contate nosso suporte para verificação/liberação.
998 – Wrong operation requested Operação de chamada inexistente. Verifique o parâmetro “dispatch”, conforme tabela acima.
999 – Unknown error Erro desconhecido. Por favor, contate nosso suporte.

 

Retorno de cada SMS da lista de envio
Retorno Descrição
Envio com sucesso
000 – Message sent SMS enviado com sucesso
Erro no envio do SMS
010 – Empty message content Conteúdo do SMS vazio. Verifique parâmetro “msg”.
011 – Message body invalid Conteúdo do SMS inválido. Verifique o parâmetro “msg”.
012 – Message content overflow Conteúdo do SMS muito longo. Verifique se o tamanho dos parâmetros “msg” e “from” juntos não ultrapassam 160 caracteres.
013 – Incorrect or incomplete ‘to’ mobile number Celular destinatário está incompleto ou inválido. Verifique o formato do parâmetro “to”, conforme tabela acima.
014 – Empty ‘to’ mobile number Celular destinatário vazio. Verifique o formato do parâmetro “to”, conforme tabela acima.
015 – Scheduling date invalid or incorrect Data de agendamento mal formatada. Verifique o formato do parâmetro “schedule”, conforme tabela acima.
016 – ID overflow Identificador com tamanho maior que o limite máximo. Verifique o parâmetro “id”, conforme tabela acima.
080 – Message with same ID already sent Identificador do SMS já foi utilizado nas últimas 24 horas.
141 – International sending not allowed A conta não permite o envio de SMS internacional.
Erro no arquivo
240 – File empty of not sent Arquivo vazio ou não identificado. Verifique o parâmetro “file”, conforme tabela acima.
241 – File too large Arquivo muito grande (mais de 1 Mbyte). Verifique o parâmetro “file”, conforme tabela acima.
242 – File read error Arquivo corrompido ou mal formatado. Verifique o parâmetro “file”, conforme tabela acima.
Erros gerais
900 – Authentication error Erro de autenticação. Verifique os parâmetros “account” e “code”.
990 – account limit reached O limite de créditos de sua conta foi atingido. Contate nosso suporte para verificação/liberação.
998 – Wrong operation requested Operação de chamada inexistente. Verifique o parâmetro “dispatch”, conforme tabela acima.
999 – Unknown error Erro desconhecido. Por favor, contate nosso suporte.