GetMessages.

检索包含初始消息的单个前后线程的消息数组和后续回复。

GetMessages输入

GetMessages是一个安全的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. 要求您提交用户令牌,以便我们知道您代表的用户帐户。 有关设置和提交用户令牌的详细信息,请参阅我们的 介绍用户令牌.

您请求的名称应该是 GetMessages. Request..

以下是可用的输入参数 序列化为json.:

争论 类型 发生 意义
呼叫特定的输入字段
MessageId. i NTEGER. 必需的 将返回包含给定消息ID的消息集的消息。通常,这应该是在调用getMessages时的结果中包含的ID,但它不必是该组消息中的第一消息的ID。

GetMessages输出

从此请求返回的输出的名称是GetMessagesResponse。因此,在将序列化响应解析为JSON之后,您可以使用类似的东西访问数据:

my_json_hash[' GetMessages. 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”类型。
呼叫特定的输出字段
消息 容器 总是,重复:[0 .. *] 包含返回的消息数组。
消息[n]。 ID 整数 总是 消息的ID。这可以用作GetMessages的输入,以获取此消息所属的消息集中的所有消息。
消息[n]。 细绳 总是 发送消息的用户的用户名。
消息[n]。 细绳 总是 发送消息的用户的用户名。
消息[n]。 senderpictureul. 细绳 总是 发件人个人资料图片的URL
消息[n]。 receiverpictureurl. 细绳 总是 接收者的个人资料图片的网址
消息[n]。 Sentat. 约会时间 总是 发送消息的日期和时间。
消息[n]。 学科 细绳 总是 消息的主题行。
消息[n]。 身体 细绳 总是 信息的主体。请注意,主体可能包含HTML。
消息[n]。 布尔基 总是

消息是否已被接收用户读取。

消息[n]。 保存 布尔基 总是 消息是否已被接收用户保存。