基础 qianmi.qmcs.messages.confirm(确认消费消息的状态)
消息消费成功,调用此接口确认消费消息的状态。
用户授权类型
不需要授权
公共参数
请求地址:
系统级请求参数:
环境 | HTTP请求地址 | HTTPS请求地址 | 正式环境 | http://gw.api.qianmi.com/api | https://api.qianmi.com/api |
---|
名称 | 类型 | 是否必须 | 描述 |
---|---|---|---|
method | String | 必须 | API接口名称 |
access_token | String | 可选 | 用户登录授权以后,QMOP颁发给应用的授权信息,详细介绍请点击这里,当前API的用户授权类型标明:"需要授权",则此参数必传,"不需要授权",则此参数不需要传。 |
format | String | 必须 | 指定响应格式,目前支持格式为json |
appKey | String | 必须 | 分配给应用的AppKey |
v | String | 必须 | API协议版本,当前可选值:1.1 |
sign | String | 必须 | API输入参数签名结果 |
timestamp | String | 必须 | 请求时间戳,时区为GMT+8(北京时间),格式:"yyyy-MM-dd HH:mm:ss",例如"2012-12-20 10:20:35",开放平台允许客户端请求的最大时间误差为10分钟 |
业务参数
名称 | 类型 | 是否必须 | 示例值 | 默认值 | 描述 |
---|---|---|---|---|---|
s_message_ids | String | 必须 | MU20150428094534689,MU20150428094534690 | 处理成功的消息ID列表,最多100个ID,多个消息ID以","分隔 |
请求示例
OpenClient client = new DefaultOpenClient(url, appKey, appSecret); QmcsMessagesConfirmRequest req = new QmcsMessagesConfirmRequest(); req.setSMessageIds("s_message_ids"); QmcsMessagesConfirmResponse response = client.execute(req, accessToken);
$client = new OpenClient; $client->appKey = appKey; $client->appSecret = appSecret; $req = new QmcsMessagesConfirmRequest; $req->setSMessageIds("s_message_ids"); $res = $client->execute($req, $accessToken);
IOpenClient client = new DefaultOpenClient(url, appKey, appSecret); QmcsMessagesConfirmRequest req = new QmcsMessagesConfirmRequest(); req.SMessageIds = "s_message_ids"; QmcsMessagesConfirmResponse response = client.Execute(req, accessToken);
响应参数
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
is_success | Boolean | true | 是否成功 |
响应示例
异常示例
{ "errorToken": "@@$-ERROR_TOKEN$-@@", "code": "33", "message": "非法的参数", "solution": "请查看根据服务接口对参数格式的要求", "subErrors": { "subError": [{ "code": "isv.invalid-paramete:XXXX", "message": "参数XXXX无效,格式不对、非法值、越界等" }] }
错误码
API工具
FAQ
Q:为什么需要确认消息? |
A:ISV应用消费完消息,并且处理消息以后,请调用此接口,将已经成功消费的消息置确认成功状态,后续服务端将不会再次推送这些消息,如果不确认,服务端会每隔10分钟将消费中未确认的消息重新推送,客户端还会消费到。直至确认消息。 |