Consultar mensagens

Listar mensagens por ticket

Este endpoint permite recuperar todas as mensagens de um determinado ticket

Escopo requerido

Valor	Descrição
open:ticket-messages-seller:read	Permite a utilização das APIs de leitura.

Parâmetros da URL

Campo	Tipo	Descrição	Obrigatório
ticket_uuid	string	Chave para identificaçāo do elemento.	Sim

Chamada:

curl -X 'GET' \
  'https://api.magalu.com/seller/v0/tickets/{ticket_uuid}/messages' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer <Access Token>' \
  -H 'Content-Type: application/json' \

Resposta:

{
  "meta": {
    "page": {
      "limit": 1,
      "offset": 1,
      "count": 1,
      "max_limit": 10
    },
    "links": {
      "previous": "?_offset=0&_limit=1",
      "self": "?_offset=1&_limit=1",
      "next": "?_offset=2&_limit=1"
      }
    },
    "results": [
      {
        "id": "3b5444b9-6fbb-40fd-b800-6c24176fb5ea",
        "message": "Envio em andamento.",
        "code": "msg-2",
        "ticket": {
          "id": "80b31c59-6d31-4d93-982a-7a6f51e335f5"
        },
        "sender": {
          "id": "sellerId",
          "name": "SellerName",
          "type": "seller",
          "owner": {
            "name": "j.doe",
            "code": "John Doe"
          }
        },
        "moderation": {
          "id": null,
          "status": "approved",
          "block_rules": [],
          "updated_at": "2024-08-07T14:21:58.024000"
        },
        "destination": "customer",
        "created_at": "2024-08-07T14:21:54"
      }      
    ]
}

Códigos de retorno

Código	Descrição
200	OK
400	Bad Request
401	Unauthorized
403	Forbidden
404	Not Found
500	Internal Server Error

Buscar mensagem de um ticket por ID

Este endpoint permite recuperar uma mensagem de um determinado ticket, utilizando o id da mensagem e o id do ticket, como referência.

Escopo requerido

Valor	Descrição
open:ticket-messages-seller:read	Permite a utilização das APIs de leitura.

Parâmetros da URL

Campo	Tipo	Descrição	Obrigatório
ticket_uuid	string	Identificador UUID do ticket.	Sim
message_uuid	string	Identificador UUID da mensagem.	Sim

Chamada:

curl -X 'GET' \
  'https://api.magalu.com/seller/v0/tickets/{ticket_uuid}/messages/{message_uuid}' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer <Access Token>' \
  -H 'Content-Type: application/json' \

Resposta:

{
    "id": "bf3bd437-492c-4a32-b3a0-484238002356",
    "message": "Envio em andamento.",
    "code": null,
    "ticket": {
        "id": "80b31c59-6d31-4d93-982a-7a6f51e335f5"
    },
    "sender": {
        "id": "sellerId",
        "name": "SellerName",
        "type": "seller",
        "owner": {
            "name": "helena",
            "code": "helena"
        }
    },
    "moderation": {
        "id": null,
        "status": "new",
        "block_rules": [],
        "updated_at": "2024-08-07T15:02:10.081000"
    },
    "destination": "seller",
    "created_at": "2024-08-07T15:02:02"
}

Códigos de retorno

Código	Descrição
200	OK
400	Bad Request
401	Unauthorized
404	Not Found
500	Internal Server Error