Skip to main content

Update Message Status

EVENT 
webhook

This endpoint is triggered to send notifications regarding changes in the message's status, such as when a message is read, delivered, or fails to send on the connected WhatsApp account.

Request​

Header Parameters

    x-businessId stringrequired

    Identificador do negócio

    x-instanceId stringrequired

    Identificador da instanceia

    x-whatsappId stringrequired

    Identificador do whatsapp conectado

Body

    event string

    Possible values: [messages.update]

    instance object
    instanceId string
    name string
    state string

    Possible values: [active, inactive]

    connection string

    Possible values: [refused, close, open]

    createdAt date-time
    WhatsApp object
    whatsappId string
    remoteJid string
    pictureUrl string
    pushName string
    createdAt date-time
    Business object
    businessId string
    name string
    data object
    messageStatusId string
    status string

    Possible values: [PENDING, ERROR, SERVER_ACK, DELIVERY_ACK, READ, PLAYED]

    Default value: PENDING

    dateTime date-time
    messageMessageId string

    Foreign Key Id da mensagem que está tendo o seu status modificado.

Responses​

The API successfully processed the status update and returned a status of 200, confirming successful receipt and handling of the information.

Loading...