Help Center/ Customer Engagement Center/ API Reference/ Adapter Class Interface Reference/ Interface Description/ Data Access Interfaces/ WhatsApp Channel/ Receiving and Processing Reports Sent on Infobip
Updated on 2025-11-13 GMT+08:00
View PDF
Share

Receiving and Processing Reports Sent on Infobip

Function

This interface is invoked to receive and process reports sent on Infobip. The reports are classified into the following types: status reports of messages sent by agents, reports of read messages, and reports of canceled messages.

Usage Description

  • Prerequisites

    The WhatsApp channel configuration has been created and the service provider has been set to Infobip.

  • For details, see the official document at https://www.infobip.com/docs.

Interface Authentication

This authentication mode is used for WhatsApp access through the Infobip integrator.

Instructions:

In the AICC, the webhook password is configured on the Channel Configuration page.

The WhatsAppAdapter interface is invoked to add the request header AccountKey to the request. The value of AccountKey is the webhook password.

Table 1 Interface authentication description (interface invocation method)

Method

POST

URL

https://{IP address}:{Port number}/social/on/whatsapp/{whatsAppBsp}/report/**

{IP address}:{Port number} indicates the IP address and port number of the NSLB exposed externally. {whatsAppBsp} indicates the integrator.
Table 2 Request header parameters

Parameter

Mandatory or Not

Type

Default Value

Description

Content-Type

Yes

String

None

The value is fixed at application/json; charset=UTF-8.

AccountKey

Yes

String

None

Webhook authentication password configured in the channel configuration in the AICC.

Interface Prototype

Table 3 Interface prototype description

Method

POST

URL

https://{IP address}:{Port number}/social/on/whatsapp/{whatsAppBsp}/report/{channelId}

{IP address}:{Port number} indicates the IP address and port number of the NSLB exposed externally. {whatsAppBsp} indicates the integrator.

{channelId} indicates the channel ID.

Request Parameters

Table 4 Request body parameter

Parameter

Mandatory or Not

Type

Description

results

Yes

Array[]

Report message list. For details, see Table 5.
Table 5 results parameters

Parameter

Mandatory or Not

Type

Description

messageId

Yes

String

Unique code of a user message.

bulkId

No

String

Status information (status of messages sent by agents).

deletedAt

No

Timestamp

Deletion time (reports of deleted messages pushed by Infobip after messages are deleted by users).

seenAt

No

Timestamp

Read time (reports of read messages pushed by Infobip after messages are read by users).

to

Yes

String

User ID.

status

No

JSON object

Status of messages sent by agents. For details, see Table 6.
Table 6 status parameters

Parameter

Mandatory or Not

Type

Description

groupName

Yes

String

Report type. The value can be DELIVERED (sending success): 0, PENDING (waiting): 1, UNDELIVERABLE (sending failure): 2, EXPIRED (timeout): 2, or REJECTED (rejected): 2.

groupId

Yes

String

Report type ID.

description

Yes

String

Status description.

Response Parameters

No response is returned when this interface is invoked.

Example

  • Request 
    POST /social/on/whatsapp/infobip/report/202105102694809992

host: 10.10.10.2:18446
connection: Keep-Alive
x-forwarded-for: 10.10.10.3, 10.10.10.4
x-real-ip: 10.10.10.5
content-length: 401
remote-host: 10.10.10.6
user-agent: java/socket
accountkey: ***************
content-type: application/json; charset=utf-8
cookie: JSESSION*****#*#*****3
accept: */*

{
    "results": [
        {
            "messageId": "742f868d-c9e9-4eda-b5c0-2747cb7ef773",
            "bulkId": "111111",
            "to": "8618257518838",
            "status": {
                "groupName": "UNDELIVERABLE",
                "groupId": 4,
                "description": "UNDELIVERABLE"
            }
        }
    ]
}
Parent topic: WhatsApp Channel