文档首页/ 云消息服务 KooMessage/ 用户指南/ 使用Email消息服务/ 通过Webhook地址接收Email消息回执信息
更新时间：2024-12-12 GMT+08:00
查看PDF
分享

通过Webhook地址接收Email消息回执信息

用户需要将Webhook地址（即回调地址）提供给运营人员，运营人员会在对应系统中配置该地址，用户发送邮件后，KooMessage会自动将收件人信息发送给用户，用户会自动接收该回执信息。

回调地址

回调地址遵循以下格式：

POST https://{customerDomain}/{addressPath}

其中，{customerDomain}代表用户的域名地址；{addressPath}代表用户回执地址中的路径，如下示例：

POST https://{customerDomain}/customer/webhook/path

回执信息

表1 回执信息的参数

参数

类型

描述

messageId

String

消息ID。

status

String

收件人接收消息状态。

  • PENDING：处理中
  • UNDELIVERABL：未送达
  • DELIVERED： 成功触达
  • EXPIRED：过期
  • REJECTED：拒收

to

String

收件人地址。

sendAt

String

发送时间，格式：yyyy-MM-dd'T'HH:mm:ss.SSSZ。

doneAt

String

送达时间，格式：yyyy-MM-dd'T'HH:mm:ss.SSSZ。

回执信息格式示例，如下：

{
        "messageId": "hgtesn8bcmc71pujp92d",
        "status": "DELIVERED",
        "to": "example@ex.com",
        "sendAt": " 2024-09-08T05:27:57.628Z",
        "doneAt": "2024-09-08T05:27:57.628Z "
}