Pessoas e relacionados (SmsRequest (Envio de SMS))
A API de SmsRequest é responsável pelo envio de SMS (via API) para as pessoas ou locais cadastrados no uMov.me.
Descrição de um SmsRequest
Envio de um SmsRequest para um Agente
POST /CenterWeb/api/{$apiKey}/smsRequest.xml
Esta operação serve para enviar SMS para uma pessoa cadastrada no uMov.me. Existe um mínimo de informações que o sistema espera receber para poder realizar o envio de SMS. Confira a descrição de um smsRequest para identificar os campos obrigatórios. Veja um exemplo da requisição com dados em XML:
<smsRequest>
<agent>
<id>123</id>
</agent>
<message>Teste de mensagem SMS</message>
<sendDownloadLink>false</sendDownloadLink>
</smsRequest>
ou
<smsRequest>
<agent>
<alternativeIdentifier>agente 123</alternativeIdentifier>
</agent>
<message>Teste de mensagem SMS</message>
<sendDownloadLink>false</sendDownloadLink>
</smsRequest>
Importante:
- Se realizado o post informando o alternativeIdentifier, o sistema somente irá enviar o SMS se for encontrado apenas um agente com o identificador alternativo informado.
- Para enviar o SMS via API, o agente informado na requisição deve possuir um telefone celular cadastrado corretamente.
Envio de um SmsRequest para um Local
POST /CenterWeb/api/{$apiKey}/smsRequest.xml
Esta operação serve para enviar SMS para um local cadastrado no uMov.me. Existe um mínimo de informações que o sistema espera receber para poder realizar o envio de SMS. Confira a descrição de um smsRequest para identificar os campos obrigatórios. Veja um exemplo da requisição com dados em XML:
<smsRequest>
<serviceLocal>
<alternativeIdentifier>Local 123</alternativeIdentifier>
</serviceLocal>
<message>Teste de mensagem SMS</message>
<sendDownloadLink>false</sendDownloadLink>
</smsRequest>
OBSERVAÇÃO
Para utilizar este recurso, é necessário que o cliente possua uma conta Zenvia para cobrança dos custos de envio do SMS, então é necessário solicitar ao time de Help Desk a configuração dessa conta, nos enviando os dados de acesso ao Zenvia.