Consultar mensagens

Recuperar mensagens

Este endpoint permite que o vendedor (seller) recupere uma coleção de mensagens por conversa utilizando filtros como referência.

Escopo requerido

Valor	Descrição
services:conversations-seller:read	Permite a utilização das APIs de leitura.

Parâmetros da URL

Campo	Tipo	Descrição	Obrigatorio
conversation_id	String	Identificador único da conversa	Sim
_limit	Inteiro	Determina a quantidade de registros a serem retornados. Valor padrão 10.	Nāo
_offset	Inteiro	Posição de registro de referência, a partir dele serão retornados os próximos N registros. Valor padrão 0.	Nāo

Chamada:

curl -X 'GET' \
  'https://services.magalu.com/v0/conversations/{conversation_id}/messages?_offset=150&_limit=20' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer <Access Token>' \
  -H 'Content-Type: application/json' \

Resposta:

Domínio: PaginatedResponse[Message]:

{
    "meta": {
        "page": {
            "limit": 20,
            "offset": 150,
            "max_limit": 100
        },
        "links": {
            "previous": "?_offset=130&_limit=20",
            "next": "?_offset=170&_limit=20",
            "self": "?_offset=150&_limit=20"
        }
    },
    "results": [
        {
            "id": "630e3bbc950b052e8724491a",
            "from_user": {
                "id": "6628d7a3c01daebde56f5598",
                "full_name": "John Doe",
                "full_name_normalized": "johndoe",
                "ref_key": "e8528120-fc36-43e9-bd01-fd453d938da7",
                "type": "CUSTOMER"
            },
            "to_user": {
                "id": "6628d7a3c01daebde56f5599",
                "full_name": "Z Store",
                "full_name_normalized": "zstore",
                "ref_key": "zstore",
                "type": "SELLER"
            },
            "content": "Como faz para montar ? Onde encontramos montador?",
            "attachments": [
                "https://docs.com/doc.pdf"
            ],
            "read_by": [
                "6628d7a3c01daebde56f5599"
            ],
            "moderation": {
                "status": "APPROVED",
                "when_at": {
                    "$date": "2024-04-24T09:57:57.620Z"
                },
                "block_rules": []
            },
            "when_at": "2024-04-24T09:57:56.851Z",
            "custom_fields": [
                {
                    "name": "field name",
                    "value": "field value"
                }
            ],
            "metadata": {
                "coupom": {
                    "id": "uuid",
                    "seller": "z",
                    "expires": "2099-01-01",
                    "client": {
                        "id": "uuid",
                        "name": "J. Climbler"
                    }
                }
            },
            "integration": false
        }
    ]
}

Códigos de retorno

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

Recuperar mensagens pelo ID

Este endpoint permite que o vendedor (seller) recupere uma mensagem de uma conversa pelo ID da conversa e ID da mensagem

Escopo requerido

Valor	Descrição
services:conversations-seller:read	Permite a utilização das APIs de leitura.

Parâmetros da URL

Campo	Tipo	Descrição	Obrigatorio
conversation_id	String	Identificador da conversa	Sim
message_id	String	Identificador da mensagem	Sim

Chamada:

curl -X 'GET' \
  'https://services.magalu.com/v0/conversations/{conversation_id}/messages/{message_id}' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer <Access Token>' \
  -H 'Content-Type: application/json' \

Resposta:

Domínio: Message:

{
    "id": "630e3bbc950b052e8724491a",
    "from_user": {
        "id": "6628d7a3c01daebde56f5598",
        "full_name": "John Doe",
        "full_name_normalized": "johndoe",
        "ref_key": "e8528120-fc36-43e9-bd01-fd453d938da7",
        "type": "CUSTOMER"
    },
    "to_user": {
        "id": "6628d7a3c01daebde56f5599",
        "full_name": "Z Store",
        "full_name_normalized": "zstore",
        "ref_key": "zstore",
        "type": "SELLER"
    },
    "content": "Como faz para montar ? Onde encontramos montador?",
    "attachments": [
        "https://docs.com/doc.pdf"
    ],
    "read_by": [
        "6628d7a3c01daebde56f5599"
    ],
    "moderation": {
        "status": "APPROVED",
        "when_at": {
            "$date": "2024-04-24T09:57:57.620Z"
        },
        "block_rules": []
    },
    "when_at": "2024-04-24T09:57:56.851Z",
    "custom_fields": [
        {
            "name": "field name",
            "value": "field value"
        }
    ],
    "metadata": {
        "coupom": {
            "id": "uuid",
            "seller": "z",
            "expires": "2099-01-01",
            "client": {
                "id": "uuid",
                "name": "J. Climbler"
            }
        }
    },
    "integration": false
}

Códigos de retorno

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