- 参考
- API.调用列表
- AddFixedPriceItem.
- AddMultipleFixedPriceItems.
- 完成
- createmessage.
- EndFixedPriceItem.
- fetchtoken.
- findItemsbycategory.
- findItemsbyKeywords.
- Getbooth.
- GetboothItems.
- Getboothstats.
- get类别
- getCategorytraits.
- getCheckoutlink.
- GetMessages.
- GetMessagesList.
- getMultipleItems.
- GetMultipleUnlistedItems.
- getNotificationPreferences.
- 使是
- getsingleitem.
- getTokenStatus.
- getunlisteditem
- GetUser.
- GetUserProfile.
- ReviseFixedPriceItem.
- RevIsemultiplipleFixedPriceItems.
- setnotificationPreferences.
- updatebooth.
- UpdateInventory.
- UpdateMessage.
GetMessagesList.
检索经过身份验证的令牌的拥有用户的消息列表数组。 “消息列表”对应于两个用户之间的前后消息的单个线程,其中初始消息和后续消息彼此回复。
GetMessagesList输入
GetMessagesList是一种安全的API方法,具有以下URL和HTTP标头要求:
提交给URL: | //api.sanyili.com/api_requests/secure_request |
HTTP标题中需要: | x-bonanzle-api-dev-name设置为dev_id |
x-bonanzle-api-cert-name设置为您的cert_id |
请注意,除此之外的所有安全方法 fetchtoken. 和 GetboothItems. 要求您提交用户令牌,以便我们知道您代表的用户帐户。 有关设置和提交用户令牌的详细信息,请参阅我们的 介绍用户令牌.
您请求的名称应该是 GetMessagesList.request..
以下是可用的输入参数 序列化为json.:
争论 | 类型 | 发生 | 意义 |
---|---|---|---|
呼叫特定的输入字段 | |||
筛选 | 容器 | 选修的 | 从匹配指定的ItemStatus值匹配的展位获取项目。 重要的: 如果使用“for_sale”以外的项目状态提交请求,则还必须使用您的请求提交用户令牌。看看 介绍用户令牌. 有效状态:for_sale,dreader_to_post,missing_fields,保留,销售和pending_pickup 默认:for_sale. |
筛选。读 | 布尔基 | 选修的 | 过滤结果消息列表仅包含消息列表,其中已读取所有消息或具有至少一个未读消息的消息列表(FALSE)。 |
筛选。保存 | 布尔基 | 选修的 | 过滤结果消息列表只包含消息列表,其中所有消息已保存(真实)或消息列表,其中包含至少一个未保存的消息(false)。 |
分页。entriesperpage. | 整数 | 选修的 | 要返回的消息列表数。 最大限度: 200 默认: 20 |
分页。Pagenumber. | 整数 | 选修的 | 页码获取。 默认: 1 |
GetMessagesList.输出
此请求返回的输出的名称是GetMessagesListResponse。因此,在将序列化响应解析为JSON之后,您可以使用类似的东西访问数据:
my_json_hash['GetMessagesList.Response']
以下是所有可能的输出参数:
争论 | 类型 | 发生 | 意义 |
---|---|---|---|
标准输出字段 | |||
错误信息 | 容器 | Conditionally | 当Bonanza处理请求时发生错误或警告的描述。如果ACK值为成功,则不返回。 |
errorMessage.错误 | 容器 |
Conditionally, repeatable: [0..*] |
|
errorMessage.error.类别 | ErrorCategory | Conditionally | Currently unused. |
errorMessage.error.信息 | string | Conditionally | 错误描述 |
errorMessage.error.类型 | 纠刊 | Conditionally | 错误的唯一描述性名称。 |
时间戳 | 约会时间 | 总是 | 该值表示Bonanza处理请求的日期和时间。此值的时区为GMT,格式为ISO 8601日期和时间格式(YYYY-MM-DDTHH:MM:SS.SSZ)。有关此时间格式和转换为GMT时区的信息,请参阅“DateTime”类型。 |
呼叫特定的输出字段 | |||
Pagenumber. | 整数 | 总是 | 页码用于获取结果。 |
entriesperpage. | 整数 | 总是 | 每个页面的消息数量用于获取结果。 |
税前 | 整数 | 总是 | 匹配当前过滤器(如果有)匹配的消息列表总数。 |
消息列表 | 容器 | 总是,重复:[0 .. *] | 包含返回的消息列表数组。 |
消息列表[n]。MessageCount. | 整数 | 总是 | 该组消息中的消息总数。 |
消息列表[n]。lastmessageentat | 约会时间 | 总是 | 发送了一组消息中的上一条消息的日期和时间。 |
消息列表[n]。lastmessageread. | 布尔基 | 总是 | 接收器是否读取了该组中的最后消息。 |
消息列表[n]。lastmessageto. | 细绳 | 总是 | 将上一条消息发送到的用户的用户名。 |
第一个消息中的字段 | |||
消息列表[n]。ID | 整数 | 总是 | 消息的ID。这可以用作GetMessages的输入,以获取此消息所属的消息集中的所有消息。 |
消息列表[n]。从 | 细绳 | 总是 | 发送消息的用户的用户名。 |
消息列表[n]。到 | 细绳 | 总是 | 发送消息的用户的用户名。 |
消息列表[n]。senderpictureul. | 细绳 | 总是 | 发件人个人资料图片的URL |
消息列表[n]。receiverpictureurl. | 细绳 | 总是 | 接收者的个人资料图片的网址 |
消息列表[n]。Sentat. | 约会时间 | 总是 | 发送消息的日期和时间。 |
消息列表[n]。学科 | 细绳 | 总是 | 消息的主题行。 |
消息列表[n]。身体 | 细绳 | 总是 | 信息的主体。请注意,主体可能包含HTML。 |
消息列表[n]。读 | 布尔基 | 总是 |
消息是否已被接收用户读取。 |
消息列表[n]。保存 | 布尔基 | 总是 | 消息是否已被接收用户保存。 |
Â