Senders

GET ack: Retorna o IP da máquina que realizou a requisição

www.oneview.com.br/api/senders/ack

Retorno da Chamada (JSON)

  • "ip" => IP da máquina que fez a solicitação.

Exemplo

Request: http://www.oneview.com.br/api/senders/ack?access_token=952300dd6adjo868583897cfe09abcd5

200 OK

Response Body: {"ip":"184.113.225.213"}

POST send_sms: Envia uma mensagem de SMS para um ou mais celulares de destino

www.oneview.com.br/api/senders/send_sms

Parâmetros de Entrada (JSON)

  • :access_token => Token de acesso - (string)
  • :message => Mensagem de envio - (string)
  • :numbers => Números de celulares de destino separados por vírgula - (string)
  • :schedule => Data e hora para o envio dos SMS, no padrão "dd/mm/aaaa hh:mm timezone" [se omitido, o envio é imediato] - (string)

Retorno da Chamada (JSON)

    Sucesso
  • 000:send_success => Mensagem enviada com sucesso
    Erros de envio
  • 010:empty_message => Mensagem vazia
  • 013:incorrect_number => Número de destinatário inválido
  • 014:empty_number => Mensagem sem número de destinatário
    Erros gerais
  • 900:invalid_account => Conta inválida
  • 990:payment_required => A conta não possui créditos para envio de sms

Exemplo

Request: http://www.oneview.com.br/api/senders/send_sms; Content-Type: application/json;

Request Body: {"access_token":"952300dd6adjo868583897cfe09abcd5","message":"Teste", "numbers": "5512999999999,5512999999998", "schedule": "28/04/2014 16:46 -0300"}

Response: 200 OK

Response Body: {"status":"000","message":"Mensagem enviada com sucesso"}

POST send_email: Envia uma mensagem de email para um ou mais destinatários

www.oneview.com.br/api/senders/send_email

Parâmetros de Entrada (JSON)

  • :access_token => Token de acesso - (string)
  • :from => Remetente do email - (string)
  • :to => Destinatários do email separados por vírgula - (string)
  • :subject => Título do email - (string)
  • :body => Corpo do email, pode conter tags HTML - (string)
  • :schedule => Data e hora para o envio dos SMS, no padrão "dd/mm/aaaa hh:mm timezone" [se omitido, o envio é imediato] - (string)

Retorno da Chamada (JSON)

    Sucesso
  • 000:send_success => Email enviado com sucesso
    Erros de envio
  • 020:empty_message => Corpo do email vazio
  • 021:empty_subject => Título do email vazio
  • 023:incorrect_email => Email de destinatário/remetente inválido
  • 024:empty_receipts => Email sem destinatários
  • 025:empty_from => Remetente vazio
    Erros gerais
  • 900:invalid_account => Conta inválida
  • 990:payment_required => A conta não possui créditos para envio de email

Exemplo

Request: http://www.oneview.com.br/api/senders/send_email; Content-Type: application/json;

Request Body: {"access_token": "952300dd6adjo868583897cfe09abcd5", "body": "Se você recebeu isso, a API funciona!", "subject": "Envio Email via API", "from": "contato@empresa.com", "to": "cliente@empresa.com.br,cliente@empresa2.com.br", "schedule": "28/04/2014 16:46 -0300"}

Response: 200 OK

Response Body: {"status":"000","message":"Mensagem enviada com sucesso"}

Como encontrar o Token de Acesso?

Acessar o detalhe conta: http://oneview.com.br/edit