5G消息 MESSAGE OVER 5G-发送消息接口:消息关键参数
下载5G消息 MESSAGE OVER 5G用户手册完整版
消息关键参数
发送消息消息体关键字段
|
序号 |
字段 |
数据类型 |
可选属性 |
描述 |
|---|---|---|---|---|
|
1 |
address |
String |
M |
接受方地址Request-URI，群发时填群发列表中第一个地址。 |
|
2 |
destinationAddress |
String |
M |
接收方地址To。 |
|
3 |
senderAddress |
String |
M |
发送方地址From，群发时填写Chatbot的URI，广播时填写Chatbot的URI（暂不提供） |
|
4 |
senderName |
String |
O |
发送方名称 |
|
5 |
productType |
String |
O |
5G产品类型，不传默认为1。 1：通知 2：营销 |
|
6 |
clientCorrelator |
string |
O |
用户端关联数据，需要networkAPI在响应中带回内容。 |
|
7 |
outboundIMMessage |
OutboundIMMessage |
M |
复合类型对应表1 |
|
8 |
taskId |
string |
O |
任务 id，由北向传入。 |
|
9 |
taskName |
string |
O |
任务名称，由北向传入。 |
|
序号 |
字段 |
数据类型 |
可选属性 |
描述 |
|---|---|---|---|---|
|
1 |
contentType |
Enum |
M |
消息类型。
|
|
2 |
conversationID |
string |
M |
conversationID， 会话ID，建议使用UUID，同一个会话中conversationID需保持一致。同一用户同一chatbot，会话ID保持唯一。 |
|
3 |
contributionID |
string |
M |
contributionID，与inReplyToContributionID字段配合使用，用户回复消息、点击按钮时，会在inReplyToContributionID字段携带被回复消息的contributionID，建议使用UUID，且每个消息需要重新生成一个新的uuid。 |
|
4 |
bodyText |
string |
M |
消息内容。
|
|
5 |
subject |
string |
O |
主题 |
|
6 |
destinationTerminal |
string |
O |
目的终端 |
|
7 |
reportRequest |
Enum数组 |
O |
状态事件报告列表，每个状态事件的可选值为:
|
|
8 |
inReplyToContributionID |
string |
O |
标识是对一条上行消息的回复，主动下发消息时不用携带，由上行消息触发的下行消息必须携带，值是上行消息中的contributionID。上行消息存在有效期，若超过有效期则本条交互消息无法下发，当前为30分钟。 |
|
9 |
contentEncoding |
Enum |
O |
消息内容(bodyText元素的内容)编码方式。
|
|
10 |
shortMessageSupported |
string |
O |
是否转短信。 false:不转，true:转，缺省false |
|
11 |
storeSupported |
string |
O |
是否离线存储。 false:不存也不重试，true:存，缺省true |
|
12 |
serviceCapability |
ServiceCapability数组 |
O |
由SAG赋默认值。 capabilityId=”chatbotSA” version=” +g.gsma.rcs.botversion="#=2"” |
|
13 |
imFormat |
Enum |
O |
IM消息格式，可选值包括IM |
|
14 |
smsBodyText |
string |
O |
转短消息时的短信内容。 转短标志为false时此字段无效。 |
|
15 |
trafficType |
string |
O |
流量类型标识，值如 advertisement、payment、premium、subscription、plugin |
