电子邮件联系我们
  1. bob客服端下载获取API V2文档
  2. 估计API
  3. 估计消息

估计消息

估计消息对象

属性 类型 描述
id 整数 消息的唯一ID。
sent_by 字符串 创建消息的用户名。
sent_by_email 字符串 创建消息的用户的电子邮件。
sent_from 字符串 发送消息的用户名。
sent_from_email 字符串 发送该消息的用户的电子邮件。
收件人 数组 的数组估计邮件收件人．
主题 字符串 消息主题。
身体 字符串 消息体。
send_me_a_copy 布尔 是否将邮件副本通过电子邮件发送给当前用户。
event_type 字符串 与消息一起发生的估计事件的类型:发送、接受、拒绝、重新打开、查看或开具发票。
created_at datetime 创建消息的日期和时间。
updated_at datetime 最后更新消息的日期和时间。

估计消息接收者对象

属性 类型 描述
的名字 字符串 消息接收者的名称。
电子邮件 字符串 邮件收件人的电子邮件。

需要的权限

您必须是具有创建和编辑估算权限的管理员或经理，才能与/ v2 /评估/ {estimate_ID} /消息端点。权限不足将导致403年被禁止的状态码。

列出所有消息进行评估

返回与给定估算相关联的消息列表。评估消息按创建日期排序返回，最近创建的消息出现在前面。

响应包含一个对象estimate_messages属性，该属性包含最多到的数组per_page消息。数组中的每个条目都是一个单独的消息对象。如果没有更多可用的消息，则生成的数组将为空。响应中包含了几个额外的分页属性，以简化对消息的分页。

GET / v2 /估计/ {estimate_ID} /消息
参数 类型 描述
updated_since datetime 只返回自给定日期和时间以来更新过的估计消息。
页面 整数 在分页中使用的页码。例如，如果您提出一个列表请求并收到2000条记录，您的后续呼叫可以包括页面= 2检索列表的下一页。(默认值:1)
per_page 整数 每页要返回的记录数。取值范围为1 ~ 2000。(默认:2000)

示例请求:

curl "https://api.bob客服端下载harvestapp.com/v2/estimates/1439818/messages" \ -H "授权:持有者$ACCESS_TOKEN" \ -H "收获帐户id: $ACCOUNT_ID" \ -H "User-Agent: MyApp (yourname@example.com)"

示例响应:

｛“estimate_messages”:【｛“id”：2666236，“sent_by”：“鲍勃·鲍威尔”，“sent_by_email”：“bobpowell@example.com”，“sent_from”：“鲍勃·鲍威尔”，“sent_from_email”：“bobpowell@example.com”，“send_me_a_copy”：真正的，“created_at”：“2017 - 08 - 25 - t21:23:40z”，“updated_at”：“2017 - 08 - 25 - t21:23:40z”，“收件人”:【｛“名称”：“某乙”，“电子邮件”：“richardroe@example.com”}，｛“名称”：“鲍勃·鲍威尔”，“电子邮件”：“bobpowell@example.com”｝),“event_type”：零，“主题”：“从API示例中估算#1001”，“身体”："---------------------------------------------\ r \ n评估总结\ r \ n---------------------------------------------\ r \ n估计ID: 1001\ r \ n预计时间:2017.06.01\ r \ n客户:123 Industries\ r \ n订单号码:5678\ r \ n数量:9630美元\ r \ n \ r \ n你可以在这里查看预算:\ r \ n \ r \ n% estimate_url %\ r \ n \ r \ n谢谢你！\ r \ n---------------------------------------------"｝),“per_page”：2000，“total_pages”：1，“total_entries”：1，“next_page”：零，“previous_page”：零，“页面”：1，“链接”: {“第一”：“https://api.bob客服端下载harvestapp.com/v2/estimates/1439818/messages?page=1&per_page=2000”，“下一个”：零，“以前”：零，“最后一次”：“https://api.bob客服端下载harvestapp.com/v2/estimates/1439818/messages?page=1&per_page=2000”｝｝

创建一个评估消息

创建一个新的估计消息对象。返回估计消息对象和201年创建调用成功时的响应代码。

POST / v2 /估计/ {estimate_ID} /消息
参数 类型 要求 描述
收件人 数组 要求 接收方参数数组。详情见下文。
主题 字符串 可选 消息主题。
身体 字符串 可选 消息体。
send_me_a_copy 布尔 可选 如果设置为真正的时，消息电子邮件的副本将发送给当前用户。默认为假．
event_type 字符串 可选 如果提供，则根据评估运行事件。选项:“接受”、“拒绝”、“重新打开”或“发送”。
接收参数 类型 要求 描述
的名字 字符串 可选 消息接收者的名称。
电子邮件 字符串 要求 邮件收件人的电子邮件。

示例请求:

curl "https://api.bob客服端下载harvestapp.com/v2/estimates/1439818/messages" \ -H "授权:持有者$ACCESS_TOKEN" \ -H "收获帐户id: $ACCOUNT_ID" \ -H "User-Agent: MyApp (yourname@example.com)"\ -X POST \ -H "Content-Type: application/json" \ -d '{"subject":"Estimate #1001"，"body":"Here is our Estimate ."，"send_me_a_copy":true，"收件人":[{"name":"Richard Roe"，"email":"richardroe@example.com"}]}'

示例响应:

｛“id”：2666240，“sent_by”：“鲍勃·鲍威尔”，“sent_by_email”：“bobpowell@example.com”，“sent_from”：“鲍勃·鲍威尔”，“sent_from_email”：“bobpowell@example.com”，“send_me_a_copy”：真正的，“created_at”：“2017 - 08 - 25 - t21:27:52z”，“updated_at”：“2017 - 08 - 25 - t21:27:52z”，“收件人”:【｛“名称”：“某乙”，“电子邮件”：“richardroe@example.com”}，｛“名称”：“鲍勃·鲍威尔”，“电子邮件”：“bobpowell@example.com”｝),“event_type”：零，“主题”：“估计# 1001”，“身体”：“这是我们的估计。”｝

删除估算消息

删除估算消息。返回一个200好了调用成功时的响应代码。

删除/ v2 /评估/ {estimate_ID} /信息/ {message_ID}

示例请求:

curl "https://api.bob客服端下载harvestapp.com/v2/estimates/1439818/messages/2666240" \ -H "授权:持有者$ACCESS_TOKEN" \ -H "收获帐户id: $ACCOUNT_ID" \ -H "User-Agent: MyApp (yourname@example.com)"\ -x删除

在发送时标记估算草案

创建一个新的评估消息对象，并将评估标记为已发送。返回估计消息对象和201年创建调用成功时的响应代码。

POST / v2 /估计/ {estimate_ID} /消息
参数 类型 要求 描述
event_type 字符串 要求 传递“send”以将评估标记为已发送。

示例请求:

curl "https://api.bob客服端下载harvestapp.com/v2/estimates/1439818/messages" \ -H "授权:持有者$ACCESS_TOKEN" \ -H "收获帐户id: $ACCOUNT_ID" \ -H "User-Agent: MyApp (yourname@example.com)"\ -X POST \ -H "Content-Type: application/json" \ -d '{"event_type":"send"}'

示例响应:

｛“id”：2666241，“sent_by”：“鲍勃·鲍威尔”，“sent_by_email”：“bobpowell@example.com”，“sent_from”：“鲍勃·鲍威尔”，“sent_from_email”：“bobpowell@example.com”，“send_me_a_copy”：假，“created_at”：“2017 - 08 - 23 - t22:25:59z”，“updated_at”：“2017 - 08 - 23 - t22:25:59z”，“event_type”：“发送”，“收件人”:[],“主题”：零，“身体”：零｝

将公开估价标记为已接受

创建一个新的评估消息对象，并将评估标记为已接受。返回估计消息对象和201年创建调用成功时的响应代码。

POST / v2 /估计/ {estimate_ID} /消息
参数 类型 要求 描述
event_type 字符串 要求 传递“accept”以将评估标记为已接受。

示例请求:

curl "https://api.bob客服端下载harvestapp.com/v2/estimates/1439818/messages" \ -H "授权:持有者$ACCESS_TOKEN" \ -H "收获帐户id: $ACCOUNT_ID" \ -H "User-Agent: MyApp (yourname@example.com)"\ -X POST \ -H "Content-Type: application/json" \ -d '{"event_type":"accept"}'

示例响应:

｛“id”：2666244，“sent_by”：“鲍勃·鲍威尔”，“sent_by_email”：“bobpowell@example.com”，“sent_from”：“鲍勃·鲍威尔”，“sent_from_email”：“bobpowell@example.com”，“send_me_a_copy”：假，“created_at”：“2017 - 08 - 25 - t21:31:55z”，“updated_at”：“2017 - 08 - 25 - t21:31:55z”，“收件人”:[],“event_type”：“接受”，“主题”：零，“身体”：零｝

将公开估价标记为已拒绝

创建一个新的评估消息对象，并将评估标记为已拒绝。返回估计消息对象和201年创建调用成功时的响应代码。

POST / v2 /估计/ {estimate_ID} /消息
参数 类型 要求 描述
event_type 字符串 要求 通过“decline”标记评估已被接受。

示例请求:

curl "https://api.bob客服端下载harvestapp.com/v2/estimates/1439818/messages" \ -H "授权:持有者$ACCESS_TOKEN" \ -H "收获帐户id: $ACCOUNT_ID" \ -H "User-Agent: MyApp (yourname@example.com)"\ -X POST \ -H "Content-Type: application/json" \ -d '{"event_type":"decline"}'

示例响应:

｛“id”：2666245，“sent_by”：“鲍勃·鲍威尔”，“sent_by_email”：“bobpowell@example.com”，“sent_from”：“鲍勃·鲍威尔”，“sent_from_email”：“bobpowell@example.com”，“send_me_a_copy”：假，“created_at”：“2017 - 08 - 25 - t21:31:55z”，“updated_at”：“2017 - 08 - 25 - t21:31:55z”，“收件人”:[],“event_type”：“下降”，“主题”：零，“身体”：零｝

重新打开封闭评估

创建一个新的评估消息对象并重新打开一个关闭的评估。返回估计消息对象和201年创建调用成功时的响应代码。

POST / v2 /估计/ {estimate_ID} /消息
参数 类型 要求 描述
event_type 字符串 要求 通过“重新打开”来重新打开评估。

示例请求:

curl "https://api.bob客服端下载harvestapp.com/v2/estimates/1439818/messages" \ -H "授权:持有者$ACCESS_TOKEN" \ -H "收获帐户id: $ACCOUNT_ID" \ -H "User-Agent: MyApp (yourname@example.com)"\ -X POST \ -H "Content-Type: application/json" \ -d '{"event_type":"re-open"}'

示例响应:

｛“id”：2666246，“sent_by”：“鲍勃·鲍威尔”，“sent_by_email”：“bobpowell@example.com”，“sent_from”：“鲍勃·鲍威尔”，“sent_from_email”：“bobpowell@example.com”，“send_me_a_copy”：假，“created_at”：“2017 - 08 - 25 - t21:31:55z”，“updated_at”：“2017 - 08 - 25 - t21:31:55z”，“收件人”:[],“event_type”：“重新打开”，“主题”：零，“身体”：零｝

还有问题吗?我们很乐意帮忙!

联系我们
Baidu
map