Jump to Content

SMS DLR

Webhook de Envios SMS (DLR)

Configuração: Informar no corpo da requisição POST /sms/messages/ o campo url_callback_dlr

Callback das mensagens SMS enviadas.

Payload

Campo	Tipo	Descrição
`phone`	integer	Número de telefone destinatário.
`message`	string	Mensagem enviada.
`status`	string	Status do envio (ver tabela abaixo).
`reference`	string	Reference informado no envio.
`reason_error`	string	Motivo do erro, se houver.

Status possíveis

Status	Descrição
`PROCESSED`	Mensagem enviada para processamento.
`SENT_TO_COMPANY`	Enviado para operadora.
`DELIVERED_TO_CELLPHONE`	Entregue no aparelho.
`NOT_DELIVERED_TO_CELLPHONE`	Não entregue no aparelho.
`INVALID`	Número sintaticamente correto mas não ativo na rede.
`ERROR`	Erro no envio (ver `reason_error`).
`BLACKLIST_USER`	Número na blacklist personalizada.
`BLACKLIST_NEXUS`	Número na blacklist do Nexus.
`NOT_IN_WHITELIST`	Número não está na whitelist.

Exemplo - Sucesso

{
  "phone": 5567898765544,
  "message": "Mensagem enviada",
  "status": "DELIVERED_TO_CELLPHONE",
  "reference": "refId2",
  "reason_error": null
}

Exemplo - Erro

{
  "phone": 5567898765544,
  "message": "Mensagem enviada",
  "status": "ERROR",
  "reference": "refId2",
  "reason_error": "Invalid syntax for phone number"
}

Exemplo - Blacklist

{
  "phone": 5567898765544,
  "message": "Mensagem enviada",
  "status": "BLACKLIST_USER",
  "reference": "refId2",
  "reason_error": null
}

Webhook de Envios SMS (DLR)

Callback das mensagens SMS enviadas. A URL deve ser informada no campo url_callback_dlr ao enviar a mensagem.

Payload

Campo	Tipo	Descrição
`phone`	integer	Número de telefone destinatário.
`message`	string	Mensagem enviada.
`status`	string	Status do envio (ver tabela abaixo).
`reference`	string	Reference informado no envio.
`reason_error`	string	Motivo do erro, se houver.

Status possíveis

Status	Descrição
`PROCESSED`	Mensagem enviada para processamento.
`SENT_TO_COMPANY`	Enviado para operadora.
`DELIVERED_TO_CELLPHONE`	Entregue no aparelho.
`NOT_DELIVERED_TO_CELLPHONE`	Não entregue no aparelho.
`INVALID`	Número sintaticamente correto mas não ativo na rede.
`ERROR`	Erro no envio (ver `reason_error`).
`BLACKLIST_USER`	Número na blacklist personalizada.
`BLACKLIST_NEXUS`	Número na blacklist do Nexus.
`NOT_IN_WHITELIST`	Número não está na whitelist.

Exemplo - Sucesso

{
  "phone": 5567898765544,
  "message": "Mensagem enviada",
  "status": "DELIVERED_TO_CELLPHONE",
  "reference": "refId2",
  "reason_error": null
}

Exemplo - Erro

{
  "phone": 5567898765544,
  "message": "Mensagem enviada",
  "status": "ERROR",
  "reference": "refId2",
  "reason_error": "Invalid syntax for phone number"
}

Exemplo - Blacklist

{
  "phone": 5567898765544,
  "message": "Mensagem enviada",
  "status": "BLACKLIST_USER",
  "reference": "refId2",
  "reason_error": null
}