文档首页/ 5G消息 Message over 5G/ API参考/ 消息接收通知接口
更新时间:2024-11-05 GMT+08:00
分享

消息接收通知接口

消息用途

5G消息云服务平台向SP业务应用APP转发终端用户上行消息。

方法

  • HTTPS POST
  • URL:上行消息接收URL;
  • 配置方式:登录5G消息console,进入“应用管理”查看。

发送消息URL关键字段

序号

字段

数据类型

可选属性

描述

HTTP URL 部分(遵循RFC2616)

1

notifyURL

string

M

接收消息的地址根路径

消息上报通知消息关键字段

序号

字段

数据类型

可选属性

描述

HTTP 消息体 部分(遵循RFC2616)

1

destinationAddress

string

M

要接收消息通知的目的地址To

2

senderAddress

string

M

消息发送方地址From

3

origUser

string

O

原始消息发送方PAI

4

dateTime

string

O

消息接收时间

5

resourceURL

string

O

可选字段,指向以创建资源的URL。

路径中最后一节是消息的messageId。

6

link

Link数组

O

可选字段,要接收消息的匹配原则。

7

messageId

string

O

消息ID

8

priority

ENUM

O

消息优先级

9

imFormat

ENUM

O

IM消息格式,可选值包括

IM

10

contentType

Emun

O

  • text/plain 普通文本(包含地理位置推送回落消息)。
  • application/vnd.gsma.rcs-ft-http+xml,普通文件消息,可以是图片、音频、视频消息。
  • application/vnd.gsma.botsuggestion.response.v1.0+json 基于建议回复消息的回复。
  • application/vnd.gsma.botsharedclientdata.v1.0+json 终端共享配置数据。
  • application/vnd.gsma.rcsspam-report+xml 投诉消息。

11

contentEncoding

Enum

O

消息内容(bodyText元素的内容)编码方式。

  • 缺省,utf8字符编码。
  • base64,base64编码。

12

serviceCapability

ServiceCapability

数组

O

业务能力,如Chatbot版本号。消息结构参考“表1”。

13

bodyText

string

O

消息内容。

14

conversationID

string

M

conversationID, 会话ID,建议使用UUID,同一个会话中conversationID需保持一致。同一用户同一chatbot,会话ID保持唯一。

15

contributionID

string

M

contributionID,与inReplyToContributionID字段配合使用,用户回复消息、点击按钮时,会在inReplyToContributionID字段携带被回复消息的contributionID,建议使用UUID,且每个消息需要重新生成一个新的uuid。

16

inReplyToContributionID

string

O

inReplyToContributionID,与contributionID配合使用,用户回复消息、点击按钮时,会在inReplyToContributionID字段携带被回复消息的contributionID。

17

reportRequest

ENUM数组

O

状态事件报告列表,每个状态事件的可选值为:

  • Delivered: 消息以发送到被叫侧用户
  • Failed: 消息没有发送到被叫侧

递送报告由MaaP平台生成

18

messageId

string

O

消息ID,采用UUID算法生成。

上行消息该参数由终端生成。

表1 serviceCapability

序号

字段

数据类型

可选属性

描述

1

capabilityId

string

M

值为 ChatbotSA。

2

version

String

M

版本号,如 +g.gsma.rcs.botversion="#=2"

相关文档