Help Center/ Customer Engagement Center/ API Reference/ Adapter Class Interface Reference/ Interface Description/ Data Access Interfaces/ WhatsApp Channel/ Interface for receiving and processing report messages sent by KooMessage
Updated on 2025-11-13 GMT+08:00
View PDF
Share

Interface for receiving and processing report messages sent by KooMessage

Function

This interface is invoked to receive and process report messages sent by KooMessage.

Usage Description

  • Prerequisites

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

Interface Authentication

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

Instructions:

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

The request header Authorization is added to the request and the WhatsAppAdapter interface is invoked. The value of Authorization is the webhook password.

Request Header Parameters

Table 1 Request header parameters

Parameter

Mandatory

Type

Default Value

Description

Content-Type

Yes

String

None

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

Authorization

Yes

String

None

Webhook authentication password configured on the Channel Configuration page in the AICC.

Interface Prototype

Table 2 Interface prototype description

Method

POST

URL

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

IP address:Port number indicates the IP address and port number of the NSLB exposed externally. {channelId} indicates the channel ID.

Request Body Parameters

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

message_id

Yes

String

ID returned when a message is sent.

sender

Yes

String

Merchant mobile number.

user_number

Yes

String

Recipient WhatsApp ID.

status

Yes

String

Status of a message.

delivered: The message has been delivered.

read: The message has been read.

failed: The message fails to be sent.

Response Parameters

No response is returned when this interface is invoked.

Example

  • Request 
    POST /social/on/whatsapp/koomessage/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
Authorization: *************
content-type: application/json; charset=utf-8
accept: */*

{
    "sender": "86173xxxx4526",
    "user_number": "86187xxxx5632", 
    "message_id": "044852ee407b40ec88ea65adb73ff5c27",
    "status": "read"
}
Parent topic: WhatsApp Channel