Jump to Content

SMS MO

Webhook de Respostas SMS (MO)

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

Callback das mensagens SMS respondidas.

Payload

Campo	Tipo	Descrição
`phone`	integer	Número de telefone que respondeu.
`message`	string	Mensagem original que originou a resposta.
`answer`	string	Conteúdo da resposta.
`attendance`	object	Dados do atendimento (se habilitado).

Objeto `attendance`

Campo	Tipo	Descrição
`status`	string	Status de sucesso ou falha.
`action`	string	Status do atendimento.
`attendance_id`	string	ID do atendimento (UUID).

Exemplo

{
  "phone": 5567898765544,
  "message": "A mensagem enviado que originou a resposta.",
  "answer": "A mensagem contendo a resposta",
  "attendance": {
    "status": "success",
    "action": "already_open",
    "attendance_id": "ca89cb30-9bd9-11ed-bf38-6bf49d3b6bc6"
  }
}

Exemplo - Sem atendimento

{
  "phone": 5567898765544,
  "message": "Por favor, confirme sua presença.",
  "answer": "Confirmado",
  "attendance": null
}

Webhook de Respostas SMS (MO)

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

Payload

Campo	Tipo	Descrição
`phone`	integer	Número de telefone que respondeu.
`message`	string	Mensagem original que originou a resposta.
`answer`	string	Conteúdo da resposta.
`attendance`	object	Dados do atendimento (se habilitado).

Objeto `attendance`

Campo	Tipo	Descrição
`status`	string	Status de sucesso ou falha.
`action`	string	Status do atendimento.
`attendance_id`	string	ID do atendimento (UUID).

Exemplo

{
  "phone": 5567898765544,
  "message": "A mensagem enviado que originou a resposta.",
  "answer": "A mensagem contendo a resposta",
  "attendance": {
    "status": "success",
    "action": "already_open",
    "attendance_id": "ca89cb30-9bd9-11ed-bf38-6bf49d3b6bc6"
  }
}

Exemplo - Sem atendimento

{
  "phone": 5567898765544,
  "message": "Por favor, confirme sua presença.",
  "answer": "Confirmado",
  "attendance": null
}