Skip to main content

Manage Call State Updates

EVENT 
webhook

Handles updates related to the state of calls in the system, such as starting, updating, or completing a call. This endpoint is crucial for maintaining real-time status of calls between participants. It receives data regarding the specifics of a call, including details such as caller ID, participant identifiers, whether the call is a group or direct call, and the current state of the call (e.g., ringing, accepted, rejected).

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: [call.upsert]

    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
    chatId string
    from string
    isGroup boolean
    id string
    data date-time
    isVideo boolean
    status string

    Possible values: [offer, ringing, timeout, reject, accept]

    offiline boolean
    latencyMs number

Responses​

The API has successfully received the notification, returning a 200 status to confirm the successful reception.

Loading...