云客服-发送消息 (send):请求说明

时间:2024-09-24 14:46:20

请求说明

表1 请求头参数

序号

名称

参数类型

是否必选

说明

1

ccmessaging-token

string

True

applyToken接口生成的ccmessaging-token

2

x-app-key

string

True

appKey字段,用户标识,在ApiFabric工具上配置

3

Authorization

string

True

鉴权字段,内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken(Bearer后有空格)

表2 请求体参数

序号

名称

参数类型

是否必选

说明

1

reqBody

sendMsgReq

True

请求体

表3 sendMsgReq参数结构

序号

名称

参数类型

是否必选

说明

1.1

channel

string

True

客户端发送消息的所属渠道类型,如WEB(WEB客服接入渠道)

1.2

content

string

False

消息内容,视mediaType而定,例如:

  • mediaType是TEXT,content就是发送的文本内容,文本内容大小不能超过1K。
  • mediaType是IMAGE、AUDIO、VIDEO,content是fileId,fileId为/ccmessaging/uploadFileStream接口返回的objectKey。
  • mediaType是FILE,content是拼接后的字符串,以英文逗号分割,固定格式如下:"fileName,fileSize(单位:B),fileId,fileType",其中fileId为/ccmessaging/uploadFileStream接口返回的objectKey,示例:"test_txt.txt,6,7d9fbcdd-e306-4b84-9831-163fb760cca9,txt"。
  • mediaType是FILE_IMAGE、FILE_VIDEO,content是拼接后的字符串,以英文逗号分割,固定格式:"fileId,mediaType",其中为/ccmessaging/uploadFileStream接口返回的objectKey,如图片为"objectKey,jpg",视频为"objectKey,mp4",音频为"objectKey,mp3",位置为"objectKey,txt",文件下载接口会使用此fileId做文件下载用。
  • 如果mediaType值为WEBCARD,content的值为JSON结构转换的字符串,例如JSON固定结构如下:{"title":"卡片标题","description":"卡片描述","mediaFileId":"卡片媒体文件ID,通过upload接口返回","mediaFileType":"当前仅支持固定值img,img/png,img/jpg,不填类型默认按jpg","redirectUrl":"跳转地址"},其中redirectUrl和mediaFileId为二选一必填项,其他项不填可以为空值。

1.3

controlType

string

True

消息控制类型,如连接(CONNECT),聊天(CHAT),转人工(TRANS2AGENT),用户输入中(INPUT),断开连接(DISCONNECT),已读(READ)

1.4

from

string

True

渠道下发送消息的用户ID,取值范围:1到24位字符串。

1.5

mediaType

string

True

消息媒体类型,如文本类型(TEXT),图片类型(IMAGE),音频类型(AUDIO),视频类型(VIDEO),文件类型(FILE),文件图片(FILE_IMAGE),文件视频(FILE_VIDEO),网页卡片消息(WEBCARD)

1.6

senderNickname

string

False

消息发送者的昵称

1.7

sourceType

string

True

消息来源类型,需配置为:CUSTOMER

1.8

timestamp

string

False

消息发送时间

1.9

to

string

True

渠道配置ID

1.10

userAgent

string

False

用户客户端类型,取自UserAgent

1.11

senderAvatar

string

False

消息发送者的头像,渠道传输头像URL,最长1024字符

1.12

messageId

string

False

用于标识发送的消息用户的唯一值。最大长度为32。值不能包含逗号“,”。

1.13

transData

string

False

json格式数据,连接机器人的时候传给机器人流程。

support.huaweicloud.com/api-ccfs-cec/cec_07_2204.html