API推出
创建一个Viber活动
创建一个Viber活动,发送一个POST请求到:
https://api.半岛客户端下载官网www.ekobsc.com/viber |
请求参数:
参数 | 类型 | 描述 | |||||
task_name | 字符串 | 活动名称 | 要求 | ||||
message_type * | int | 消息类型:2 ——促销,3. ——系统 |
要求 | ||||
sender_id | int | 活动发件人名称ID,您从中发送广告系列;你可以得到sender_id 在“获取发送者名称列表方法,要使用它,您必须在服务设置 |
要求 | ||||
message_live_time | int | 消息生存时间(秒),最小60s,最大86400秒(24小时) | 要求 | ||||
send_date | 字符串 | 发送时间。使用现在 如果您需要立即发送消息,或以格式指定时间YYYY-MM-DD HH: MM: SS 如果你需要把它安排到未来 |
要求 | ||||
address_book * | int | 邮件列表ID | 要求 | ||||
收件人* | 数组 | 电话号码列表(180931111111, 180931111111, 180931111111) 格式 |
要求 | ||||
信息* | 字符串 | 消息文本(最大长度为1000个字符) | 要求 | ||||
stretch_time | int | 逐步发送信息。您可以将值设置为0到5小时,您的广告系列将在指定的时间范围内以较小的部分发送给所有收件人。 | 可选 | ||||
额外的 | 对象 | 其他参数: | 可选 | ||||
按钮* | 按钮的参数: | ||||||
文本 | 字符串 | 按钮文字 | 可选 | ||||
链接 | 字符串 | 按钮链接 | 可选 | ||||
图像* | 图像参数: | ||||||
链接 | 字符串 | 链接到您上传的图片 | 可选 | ||||
resend_sms | 通过短信服务重新发送短信的功能: | ||||||
状态 | 布尔 | 真正的 如果启用,假 如果禁用 |
可选 | ||||
sms_text | 字符串 | 短信文本 | 可选 | ||||
sms_sender_name | 字符串 | 短信发送人ID | 可选 |
两者都可以address_book
,或收件人
参数指定收件人列表时,需要其中一个参数。
您可以发送以下类型的消息:
- 系统或促销(仅限文字):
消息
参数; - 宣传片(文字+按钮+图片):
消息
,按钮
,图像
参数; - 促销(文字+按钮):
消息
,按钮
参数; - 推广(图片):
图像
参数。
请注意:当您发送系统消息(“message_type”:3
),文本在消息
参数被检查。它必须与批准的模板的文本相匹配。你可以添加模板并提交审批在您的个人账户之后注册发件人.
请求示例发送文本+按钮+图像格式的消息:
{"收件人":[//收件人数组380931111111,380931111112,380931111113],"address_book":null, //有两种选项可供选择:发送地址簿ID或发送收件人数组(最多1000个收件人)"message":"Margaret,您已被批准购买化妆品类别中所有商品的50%折扣","message_type":2, "message_live_time":1000, //秒(最少60秒,最多86400秒(24小时))," send_id ":1, //活跃用户的id,活动将从"send_date":"now", //或以下格式的日期YYYY-MM-DD HH:ii:ss "additional":{"button":{"text":"Buy all Cosmetics ", "link":"//www.ekobsc.com/"}发送,半岛客户端下载官网"image":{"link":"https://s半岛客户端下载官网endpulse.com/images/image.png"}, "resend_sms":{"status":true, "sms_text":"短信文本","sms_sender_name":"sendpulse"}}}
请求示例发送只包含文本的消息:
{"收件人":[//收件人数组380931111111,380931111112,380931111113],"address_book": null, //有两个选项:要么发送地址簿ID,要么发送收件人数组,最多1000个收件人"消息":"玛格丽特,您已被批准对'化妆品'类别中的所有商品进行50%的折扣",
//最大长度为1000个字符"message_type": 2, "message_live_time": 1000, //秒(最小60秒,最大86400秒(24小时)),"sender_id": 1, //活动发送方的id" send_date": "now", //或日期格式如下YYYY-MM-DD HH:ii:ss "additional": {"resend_sms": {
//正在重发状态status: true, //短信文本sms_text:短信文本,//发件人名短信sms_sender_name: sendpulse}}}半岛客户端下载官网
请求示例发送一个只包含图像的消息:
{"收件人":[//收件人数组380931111111,380931111112,380931111113],"address_book": null, //发送地址本ID或发送收件人数组,1000个收件人最大"message": null, "message_type": 2, "message_live_time": 1000, //秒(最小60s,最大86400s(24小时))"sender_id": 1, //活动发送方的ID "send_date": "now", //或日期格式如下YYYY-MM-DD HH:ii:ss "additional":{//附加数据"image":{//消息中的图像"link": "//www.ekobsc.com/images/image.png" //图像链接},"resend_sms": {//status表示重发选项已打开"statu半岛客户端下载官网s": true, //短信文本"sms_text": "短信文本",//短信发送方名称"sms_sender_name": "sendpulse"}}
请求示例发送包含文本+按钮的消息:
{"收件人":[//收件人数组380931111111,380931111112,380931111113],"address_book":null, //要么发送地址簿ID,要么发送收件人数组,"message":"Margaret,您已被批准对"化妆品""类别"中的所有商品给予50%的折扣,//最大长度为1000个符号
"message_type":2, "message_live_time":1000, //秒(最小60秒,最大86400秒(24小时),"sender_id":1, "send_date":"now", "additional":{"button":{"text":"Buy all cosmetics", "link":"//www.ekobsc.com"}, "resend_sms":{"s半岛客户端下载官网tatus":true, "sms_text":" sms文本","sms_sender_name":"sendpulse"}}
请求示例渐发:
{"收件人":[380683850429],"message":"Test", "message_type":2, "message_live_time":1000, "sender_id":4647, "send_date":"now", "stretch_time":1}
如果请求成功,您将收到一个响应:
{"result": true, "data": {"address_book_id": null, "button_link": null, "button_text": null, "image_link": null, "message": "Margaret,您已被批准对"化妆品"类别中的所有商品进行50%的折扣","message_live_time": "1000", "message_type": 3, "resend_sms": 0, "send_date": "2019-03-26 12:40:05", "sender_id": 4501, "sms_sender_name": null, "sms_text": null, "task_id": 90241, "task_name": "Viber campaign for personal list on 2019-03-26 12:40"}}
编辑一个Viber活动
编辑一个Viber活动,发送一个POST请求到:
https://api.半岛客户端下载官网www.ekobsc.com/viber/update |
请求参数:
参数 | 类型 | 描述 | |
main_task_id | int | 活动ID | 要求 |
task_name | 字符串 | 活动名称 | 可选 |
消息 | 字符串 | 消息文本 | 可选 |
message_type | int | 消息类型:2 ——bd体育中国官方入口市场营销、3. ——事务 |
要求 |
button_text | 字符串 | 按钮文本;如果未指定,零 随后会有回应 |
可选 |
button_link | 字符串 | 转让链接;如果未指定,零 随后会有回应 |
可选 |
image_link | 字符串 | 形象定位;如果未指定,零 随后会有回应 |
可选 |
address_book | int | 邮件列表;如果未指定,零 随后会有回应 |
可选 |
sender_id | int | 发送者ID(发送时);你可以把它弄进去。”获取发送者名称列表”方法; 确保用户已注册发件人id服务设置 |
要求 |
message_live_time | int | 消息生存期(以秒为单位) | 可选 |
send_date | 字符串 | 发送日期 | 可选 |
如果请求成功,您将收到一个响应:
{"result": true, "data": {"address_book_id": null, "button_link": null, "button_text": null, "image_link": null, "message": "Margaret,您已被批准对"化妆品"类别中的所有商品享受50%的折扣","message_live_time": "1000", "message_type": "3", "send_date": "2019-03-26 15:16:00", "sender_id": "4495", "task_id": 9380939, "task_name": "Viber campaign for personal list on 2019-03-26 15:15"}}
取消Viber活动
要取消预定的Viber活动,请向以下地址发送PUT请求:
https://api.半岛客户端下载官网www.ekobsc.com/v2/viber-service/tasks/cancel |
请求参数:
参数 | 类型 | 描述 | |
task_id | int | 活动ID | 要求 |
如果请求成功,您将收到一个响应:
{"data": {"result": true}}
获取活动列表
要获取活动列表,请发送get请求到:
https://api.半岛客户端下载官网www.ekobsc.com/viber/task |
请求参数:
参数 | 类型 | 描述 | |
限制 | int | 记录数 | 可选 |
抵消 | int | 偏移量(要显示的第一条记录) | 可选 |
如果请求成功,您将收到一个响应:
[{"id": 9380939, "name": "Viber campaign for personal list on 2019-03-26 15:02", "message": "Jane,您已被批准对"化妆品"类别中的所有商品享受五折优惠","button_text": null, "button_link": null, "image_link": null, "address_book": null, " send_name ": "YAMAMAY", " send_id ": 4495, "message_live_time": 1000, "send_date": "2019-03-29 10:00:00", "status": "moderation", "created": "2019-03-26 12:50:02"}, {"id": 9380926, "name":“Viber活动在2019-03-26 14:48的个人列表”,“消息”:“玛格丽特,您已被批准对“化妆品”类别中的所有商品进行50%的折扣”,“button_text”:null,“button_link”:null,“image_link”:null,“address_book”:0,“sender_name”:“YAMAMAY”,“sender_id”:4495,“message_live_time”:1000,“send_date”:“2019-03-29 10:00:00”,“status”:null,“created”:“2019-03-26 12:48:23”}]
反应参数:
参数 | 类型 | 描述 |
id | int | 活动ID |
名字 | 字符串 | 活动名称 |
消息 | 字符串 | 消息文本 |
button_text | 字符串 | 按钮上的文本-如果未指定,将返回零 |
button_link | 字符串 | 点击通过链接,-如果没有指定,将返回零 |
image_link | 字符串 | 图像链接,-如果未指定,将返回零 |
address_book_id | int | 邮件列表ID,-如果手动输入,将返回零 |
sender_name | 字符串 | 发件人名称,用于发送活动 |
sender_id | int | 发件人ID |
message_live_time | int | 消息的生存期(以秒为单位) |
send_date | 字符串 | 广告发送的日期 |
状态 | 字符串 | 任务状态 |
创建 | 字符串 | 活动创建日期 |
获取活动的统计数据
要获取一个活动的统计数据,发送一个get请求到:
https://api.半岛客户端下载官网www.ekobsc.com/viber/task/ {id} |
请求参数:
参数 | 类型 | 描述 | |
id | int | 活动ID | 要求 |
如果请求成功,您将收到一个响应:
{"id": 38, "name": "Viber_Campaign_38", "message": "Viber message text", "button_text": "Button", "button_link": "https://s半岛客户端下载官网endpulse.com", "image_link": null, "address_book": null, " send_name ": "infoservice", "send_date": "2017-06-22 09:51:35", "status": "send", "statistic": {"send": 1, "delivered": 1, "read": 0, "redirected": 0, "undelivered": 0, "errors": 0}, "created": "2017-06-22 09:51:22"}
反应参数:
参数 | 类型 | 描述 | ||
id | int | 活动ID | ||
名字 | 字符串 | 活动名称 | ||
消息 | 字符串 | 消息文本 | ||
button_text | 字符串 | 按钮的文本,-如果未指定,将返回零 |
||
button_link | 字符串 | 点击通过链接,-如果没有指定,将返回零 |
||
image_link | 字符串 | 图像链接,-如果未指定,将返回零 |
||
address_book_id | int | 邮件列表ID,-如果手动输入,将返回零 |
||
sender_name | 字符串 | 发件人名称,用于发送活动 | ||
sender_id | int | 发件人ID | ||
message_live_time | int | 消息的生存期(以秒为单位) | ||
send_date | 字符串 | 广告发送的日期 | ||
状态 | 字符串 | 任务状态 | ||
统计数据 | 对象 | 活动数据: | ||
发送 | int | 发送消息数 | ||
交付 | int | 传递的消息数 | ||
读 | int | 已读消息数 | ||
重定向 | int | 按钮点击率 | ||
未交付的 | int | 未传递的消息数 | ||
错误 | int | 错误数 | ||
创建 | 字符串 | 活动创建的日期 |
获取发送者名称列表
要获取发送者名称的列表,发送一个get请求到:
https://api.半岛客户端下载官网www.ekobsc.com/viber/senders |
如果请求成功,您将收到一个响应:
[{"id": 1, "status": "verified", "name": "myName", "service_type": "Test service", "web_site": "https://www.se半岛客户端下载官网ndpulse.com", "description": "We are testing the final variant of the message", "country": "UK", "traffic_type": "Public information", "admin_comment": "您的名称已通过审核,感谢您选择我们的服务。"半岛客户端下载官网Sendpulse team"}]
反应参数:
参数 | 类型 | 描述 |
id | int | 发件人ID |
状态 | 字符串 | 当前发送方状态 |
名字 | 字符串 | 发送者的名字 |
service_type | 字符串 | 服务类型 |
web_site | 字符串 | 网站 |
描述 | 字符串 | 服务描述 |
国家 | 字符串 | 收件人的国家 |
traffic_type | 字符串 | 流量类型 |
admin_comment | 字符串 | 管理员的注释,-如果评论存在,将返回文本,否则,API将返回零 |
获取发件人名称
要获取发送方名称,发送一个get请求到:
https://api.半岛客户端下载官网www.ekobsc.com/viber/senders/ {id} |
请求参数:
参数 | 类型 | 描述 | |
id | int | 发件人ID | 要求 |
如果请求成功,您将收到一个响应:
{"id": 1, "status": "verified", "name": "infoservice", "service_type": "Test service", "web_site": "https://www.s半岛客户端下载官网endpulse.com", "description": "我们正在测试消息的最终版本",
country: UK, traffic_type:公共信息,
"admin_comment": "您的名字已通过审核,感谢您选择我们的服务。半岛客户端下载官网Sendpulse团队”
}
反应参数:
参数 | 类型 | 描述 |
id | int | 发件人ID |
状态 | 字符串 | 当前发送方状态 |
名字 | 字符串 | 发送者的名字 |
service_type | 字符串 | 服务类型 |
web_site | 字符串 | 网站 |
描述 | 字符串 | 服务描述 |
国家 | 字符串 | 收件人的国家 |
traffic_type | 字符串 | 流量类型 |
admin_comment | 字符串 | 管理员的注释,-如果评论存在,将返回文本,否则,API将返回零 |
获取Viber活动接收者列表
要获取Viber活动接收者的列表,请发送get请求到:
https://api.半岛客户端下载官网www.ekobsc.com/viber/task/ {id} /接受者 |
请求参数:
参数 | 类型 | 描述 | |
id | int | 活动ID | 要求 |
如果请求成功,您将收到一个响应:
{"task_id": 44, "收件人":[{"phone": 380934760182, "address_book_id": 850852, "status": "send", "send_date": "2017-06-23 08:54:01", "price": 0.74, "currency": "RUR", "last_update": "2017-06-23 08:53:38"}]}
反应参数:
参数 | 类型 | 描述 | ||
task_id | int | 活动ID | ||
收件人 | 数组 | 受助人名单: | ||
电话 | int | 收件人电话号码 | ||
address_book_id | int | 包含电话号码的邮件列表ID,在手动输入的情况下,API将返回零 |
||
状态 | 字符串 | 发送到该号码的消息状态(send;交付;交付并打开;交付和阅读;交付;阅读和点击通过;不交付;错误) | ||
send_date | 字符串 | 发送时间 | ||
价格 | 浮动 | 信息的价格 | ||
货币 | 字符串 | 消息的实际用户货币和价格以该货币显示 | ||
last_update | 字符串 | 最新统计数字 |
获取黑名单中的联系人列表
获取黑名单中的联系人列表,发送GET请求到:
https://api.半岛客户端下载官网www.ekobsc.com/v2/viber-service/phone-exception |
请求参数:
参数 | 类型 | 描述 | |
限制 | int | 记录数 | 可选 |
抵消 | int | 偏移量(要显示的第一条记录) | 可选 |
如果请求成功,您将收到一个响应:
{“数据”:{“列表”:[{" id ": 164年,“user_id”:7046460,电话:73832370050,“描述”:“”,“add_date”:“2021-11-05 13:34:03 "},{" id ": 165年,“user_id”:7046460,电话:73912050915,“描述”:“”,“add_date”:“2021-11-05”13:34:03}],“总”:29}}
将“电话号码”加入黑名单
将电话号码加入黑名单,发送POST请求到:
https://api.半岛客户端下载官网www.ekobsc.com/v2 / viber-service / phone-exception |
请求参数:
参数 | 类型 | 描述 | |
手机 | 数组 | 例如,电话号码列表["380977217975", "380977217977", "380977217978"] | 要求 |
描述 | 字符串 | 号码加入黑名单的原因说明 | 可选 |
如果请求成功,您将收到一个响应:
{“结果”:真的,“计数器”:{“添加”:7,“存在”:0}}
从黑名单中删除电话号码
要从黑名单中删除电话号码,请发送DELETE请求到:
https://api.半岛客户端下载官网www.ekobsc.com/v2 / viber-service / phone-exception |
请求参数:
参数 | 类型 | 描述 | |
手机 | 数组 | 例如,电话号码列表["380977217975", "380977217977", "380977217978"] | 要求 |
如果请求成功,您将收到一个响应:
{"result": true, "deleted": 7}
与…签约
登录Facebook 用谷歌登录