Criar Mensagens

Introdução

Esta seção detalha como criar e consultar mensagens de protocolo no ambiente de sandbox como testar cenários de erro.

Pré-requisitos para Criação de Mensagens

Para criar mensagens no ambiente de sandbox, é necessário observar as seguintes regras:

1. O protocolo referente a mensagem deve existir previamente no sistema e deve estar aberto

Cenários de Erros Imediatos

Estes são erros retornados imediatamente como resposta à requisição.

Cenário	Código de Resposta	Condições para emular o cenário
"Ticket '{ticket_id}' não encontrado."	404	Tente criar uma mensagem utilizando um ticket_id inexistente.
"Não é possível adicionar mensagens em tickets fechados."	400	Tente criar uma mensagem utilizando um ticket_id referente a um protocolo que já foi encerrado.
"Unprocessable entity"	422	Tente criar uma mensagem informando valores com tipos de dados inválidos nos campos da requisição.
"Value error, File name 'string' does not end with the expected extension '.{file_extension}'."	422	Tente criar uma mensagem identificando um anexo cujo nome não termine com a extensão esperada para o tipo de arquivo informado.
"Value error, O tipo de destinatário seller não é permitido para o remetente {destination}."	422	Tente criar uma mensagem informando o destinatário como seller.

Tabela de Cenários de Erro Assíncronos

São erros assíncronos encontrados ao consultar a transação referente ao transaction_id retornado como resposta da requisição.

Não há cenários de erros assíncronos para a criação de mensagens no ambiente de sandbox.

Exemplo de Criação de Mensagem

curl -L 'https://api-sandbox.magalu.com/v0/tickets/:ticket_id/messages' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <token>' \
-d '{
  "attachments": [
    {
      "file_extension": "png",
      "file_name": "file_name.png",
      "file_type": "image/png"
    }
  ],
  "code": "fake_code",
  "destination": "customer",
  "message": "mensagem teste",
  "owner": {
    "code": "LvDSO",
    "name": "John Doe"
  }
}'

Para mais detalhes, consulte a documentação do endpoint.

Consultar Mensagens

Pré-requisitos para Consulta de Protocolo

Os endpoints de consulta estão disponíveis no ambiente de sandbox e funcionam da mesma forma que no ambiente de produção. Importante ressaltar:

• Nenhum dado é pré-carregado no ambiente de sandbox
• Os endpoints retornarão apenas os dados criados pelo próprio usuário durante os testes

Exemplo de Consulta de Mensagens

curl -L 'https://api-sandbox.magalu.com/seller/v0/tickets/:ticket_id/messages' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <token>'

Para mais detalhes, consulte a documentação do endpoint.

Exemplo de Consulta de Mensagem por ID

curl -L 'https://api-sandbox.magalu.com/seller/v0/tickets/:ticket_id/messages/:message_id' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <token>'

Para mais detalhes, consulte a documentação do endpoint.

Exemplo de Consulta de Arquivo por ID

curl -L 'https://api-sandbox.magalu.com/seller/v0/tickets/:ticket_id/messages/:message_id/attachments/:attachment_id' \
-H 'Accept: */*' \
-H 'Authorization: Bearer <token>'

Para mais detalhes, consulte a documentação do endpoint.