UpdateMessage.

更新现有(个人)消息的属性。此调用中设置的属性可用作GetMessageList调用中的过滤器 - 但请注意,此调用设置单个消息的属性,而不是用于一组消息中的所有消息。

UpdateMessage输入

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

您请求的名称应该是 updatemessagreequest..

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

争论 类型 发生 意义
呼叫特定的输入字段
MessageId. i NTEGER. 必需的

要更新的消息的ID。

布尔基 选修的 可以设置为true以标记消息 - 以及授权用户的线程中的所有消息 - 如读取。将忽略非真实值 - 您无法将消息设置为未读。
保存 布尔基 选修的 消息是否保存(true)(false)(false) - 请注意,未保存的消息通常在接收用户的收件箱中显示。这将影响授权用户是接收器的线程中的所有消息。

UpdateMessage输出

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

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

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

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