开始使用前,请先创建应用,申请“message-push-service” scope,并成功完成审批
接口描述
请求地址
POST http://apigate.hsifue.cn/chatbot/api/front/thirdParty/message/push
请求的header参数
| 参数 | 参数类型 | 是否必传 | 示例值 | 描述 |
|---|---|---|---|---|
| Authorization | 字符串 | 是 | Bearer cn-236f6e4f-6db5-46c2-97ec-19b4f5d499d3 | 从用户中心获取的ACCESS_TOKEN |
请求的body参数
| 参数 | 参数类型 | 是否必传 | 示例值 | 描述 |
|---|---|---|---|---|
| messageId | 字符串 | 是 | EQFEQ234TFQRFV54GHTE4HG4 | 消息内容对应的id |
| content | 字符串 | 是 | 您好,您有一条新消息 | 消息内容,支持富文本 |
| expireTime | 整型 | 是 | 1 | 消息存储在服务端的时间,超过此时间,用户仍然没有登陆,将删除对应该用户的此条消息,不再推送 |
| userIds | 字符串 | 是 | 6557578274821898321,6557192726348112377 | 消息推送目标用户ID以英文逗号拼接而成 |
请求body示例
{
"userIds": "6557578274821898321,6557192726348112377",
"content": "您好,您有一条新消息",
"messageId": "EQFEQ234TFQRFV54GHTE4HG4",
"expireTime": 1
}
请求成功返回的数据示例
{
"code": 200,
"message": "success"
}
请求失败返回的数据示例
{
"code": 500,
"message": "system error"
}
{
"code": 400,
"message": "parse access_token from Authorization error"
}
{
"code": 400,
"message": "check access_token error"
}
{
"code": 400,
"message": "Required parameter 'userIds' is not present"
}
{
"code": 400,
"message": "Required parameter 'content' is not present"
}
{
"code": 400,
"message": "Required parameter 'expireTime' is not present"
}
{
"code": 400,
"message": "Required parameter 'messageId' is not present"
}
{
"code": 400,
"message": "messsagePush.userIds: size exceeds the max value [100]"
}
{
"code": 400,
"message": "messsagePush.userIds: element length exceeds the max value [60]"
}
{
"code": 400,
"message": "messsagePush.content: length exceeds the max value [32768]"
}
{
"code": 400,
"message": "messsagePush.expireTime: value must be between 1 and 168"
}
{
"code": 400,
"message": "messsagePush.messageId: Length exceeds the max value [64]"
}