文档首页/5G消息 Message over 5G/API参考/状态报告通知
更新时间：2024-11-05 GMT+08:00
查看PDF
分享

状态报告通知

消息用途

5G消息云服务平台向SP业务应用chatbot推送消息发送结果状态报告（回执消息）。

方法

  • HTTPS POST
  • URL：下行状态报告通知URL；
  • 配置方式：登录5G消息console，进入“应用管理”查看

消息关键参数

发送消息体关键字

序号

字段

数据类型

可选属性

描述

HTTP 请求,响应消息体部分（遵循RFC2616）

1

deliveryInfo

DeliveryInfo

M

状态报告信息，对应表1

6

link

Link数组

O

可选字段，对应源消息resourceURL。

表1 DeliveryInfo(消息报告通知)

序号

字段

数据类型

可选属性

描述

1

address

String

M

发送回执消息的发送方地址（原消息的目的方地址）

2

deliveryStatus

Enum

M

消息发送状态

  • MessageSent 消息已发送到平台，由MaaP产生。
  • DeliveredToTerminal RCS消息达到终端
  • DeliveryImpossible 发送失败
  • DeliveredToNetwork 运营商网络已转短消息发送
  • MessageDisplayed 消息已阅
  • DeliveredToVms 转视频短信发送成功
  • DeliveredToVmsFailed 转视频短信发送失败
  • DeliveredToSMS 通道转短信下发成功
  • DeliveredToSMSFailed 通道转短信下发失败

参见表2详细描述

3

messageId

string

O

源消息ID

4

description

String

O

状态报告相关描述，成功和失败回执都通过description增加细分描述信息。

  • DeliveryImpossible回执填写应用层错误码，具体请参见错误码。
  • DeliveredToTerminal回执填写，发送UP2.4成功回执填写UP2。
  • DeliveredToNetwork回执填写，转短成功回执填写 SMS

5

text

String

O

状态报告相关描述，全部回执都通过此字段增加细分描述信息。

DeliveryImpossible回执填写错误描述，具体请参见错误码。

表2 Chatbot下行消息的状态报告

deliveryStatus

deliveryStatus含义

description

业务含义

MessageSent

消息已发出

-

消息已发送到5GMC，由MaaP平台转发到5GMC时产生。

DeliveredToTerminal

以消息的形态达到终端，包括MaaP消息和普通P2P消息送达。

UP2

以Chatbot消息形态投递到终端

DeliveryImpossible

下行消息投递失败

800

不提供网络自动回落的Chatbot消息在5GMC已超过最大可撤回时间

SVCXXX错误码

网络自动回落短信，但发送失败

DeliveredToNetwork

已转短消息发送，即转短信发送到短息终端成功。

SMS

已转短信投递到终端

MessageDisplayed

消息已阅

UP2

终端已点击打开消息

发送状态报告通知请求示例

POST /openchatbot/v2/DeliveryInfoNotification HTTP/1.1
Authorization: Username="chatbottest12swt70",Password="******"
Content-Type: application/json
Date: Sun, 28 Jun 2020 06:23:33 GMT
Accept: */*
Accept-Encoding: gzip, deflate, br
Cookie: JSESSIONID=A4F1AE0967E87AD57CF106D295505CA4
traceUniqueID: 504021504652012181433190002002
Host: 10.179.126.105:8451
Connection: close
Content-Length: 358
{
"deliveryInfo": {
"address": "tel:+8612345678911",
"messageId": "2827c3a6-ee61-11ea-a172-fa163e6a8a4e",
"deliveryStatus": "DeliveredToTerminal",
"description": "SVC5001"
},
"link": [
{
"rel": "OutboundMessageRequest",
"href": "http://example.com/exampleAPI/messaging/v1/outbound/sip%3A12599%40botplatform.rcs.chinamobile.com/requests/27437fcf-aa6e-4656-bdb1-695477cdddd9"
}
]
}

发送状态报告通知响应

HTTP/1.1 204 No Content
Server: Apache-Coyote/1.1
Content-length: 0
Content-Type: application/json
Date: Fri, 18 Dec 2020 06:29:06 GMT
Connection: close

相关文档