序列
Sequences API提供了一个读取Sequences的简单接口。只有您购买了我们的Reach产品,才能使用这种自动化。管理员可以直接在序列部分下的web设置中管理(添加、更新和删除)序列。
序列是一组步骤及其执行的及时性。每个步骤可以是automated_email
或者一个任务
并且可以定义为在X个工作日或小时内在上一步之后执行。可以把它看作是一个模板,以后用于为特定的潜在客户或联系人启动序列(有关详细信息,请参阅:序列登记部分)。
SequenceStep属性
的名字 | 类型 | 只读 | 描述 |
---|---|---|---|
id |
数量 | 真正的 | 步骤的唯一标识符。 |
位置 |
数量 | 真正的 | 以零为基础的步长顺序的位置。 |
delay_from_previous_step |
数量 | 假 | 执行这个步骤和执行前一个步骤之间应该经过的时间 |
delay_from_previous_step_unit |
字符串 | 假 | 在执行此步骤和执行前一个步骤之间应经过的时间单位。可能的值:小时 ,工作日 -星期一至星期五之间的天数 |
action_properties |
对象 | 假 | 对象,该对象包含配置此步骤的序列的属性。在弹出的菜单,自动电子邮件:email_template_id -在此步骤中发送的电子邮件模板id,is_reply -布尔值(true, false) -电子邮件是否应该作为回复或作为一个新线程发送。属性任务:task_content -将为该步骤创建的任务的内容。 |
JSON格式
的名字 | 类型 | 只读 | 描述 |
---|---|---|---|
id |
数量 | 真正的 | 序列的唯一标识符。 |
creator_id |
数量 | 真正的 | 创建序列的用户的唯一标识符。 |
的名字 |
字符串 | 假 | 序列的名称。 |
steps_total |
数量 | 真正的 | 序列中的总步数。 |
步骤 |
数组 | 假 | 此序列所包含的步骤的数组。步骤的属性在上表中解释。 |
unsubscribe_settings |
对象 | 真正的 | 退订设置指示电子邮件是否包含退订链接。例子:{"enabled": true, "locale": "en-US"} |
created_at |
字符串 | 真正的 | 以UTC (ISO8601格式)创建序列的日期和时间。 |
updated_at |
字符串 | 真正的 | 上一次更新的UTC (ISO8601格式)日期和时间。 |
检索所有序列
得到/v2/序列
根据提供的参数返回用户可用的所有序列。
的名字 | 类型 | 在 | 要求 | 描述 |
---|---|---|---|---|
页面 |
数量 | 查询 | 假 | 开始的页码。页编号从1开始,并省略页面 参数将返回第一页。如。? page = 2 |
per_page |
数量 | 查询 | 假 | 每页要返回的记录数。默认限制为25 可以返回的最大数目是One hundred. .如。? per_page = 20 |
id |
数量 | 查询 | 假 | 请求中要返回的以逗号分隔的id列表。如。id = 1、2、3 |
的名字 |
数量 | 查询 | 假 | 序列的名称子字符串。将返回所有匹配的序列。如。?名字= 1 |
允许
- 代理
使用旋度
旋度-v -X GET https://api.getbase.com/v2/sequences\
- h“接受:application / json”\
- h“授权:持票人ACCESS_TOKEN美元"
示例响应
HTTP /1.1200好吧
内容类型:application / json;charset = utf8
内容语言:在
{
“项目”:[
{
“数据”:{
“id”:3.,
“名称”:“网络研讨会后的热情态度”,
“steps_total”:2,
“creator_id”:1,
“updated_at”:“2020 - 06 - 22 t12:41:45z”,
“created_at”:“2020 - 06 - 22 t12:41:45z”,
“步骤”:{
“项目”:[
{
“数据”:{
“id”:3.,
“action_type”:“automated_email”,
“delay_from_previous_step”:0,
“delay_from_previous_step_unit”:“工作日”,
“位置”:0,
“action_properties”:{
“email_template_id”:7,
“is_reply”:假
}
},
“元”:{
“类型”:“步骤”
}
},
{
“数据”:{
“id”:5,
“action_type”:“任务”,
“delay_from_previous_step”:6,
“delay_from_previous_step_unit”:“小时”,
“位置”:1,
“action_properties”:{
“task_content”:“移动”
}
},
“元”:{
“类型”:“步骤”
}
}
],
“元”:{
“类型”:“收集”,
“数”:2
}
},
“unsubscribe_settings”:{
“启用”:真正的,
“场所”:“en - us”
}
},
“元”:{
“类型”:“序列”
}
}
],
“元”:{
“类型”:“收集”,
“数”:1,
“链接”:{
“自我”:“http://api.getbase.com/v2/sequences”
}
}
}