批量短信服务API
将电话号码添加到没有变量的邮件列表中
要将电话号码添加到邮件列表中,请发送POST请求到:
https://api.半岛客户端下载官网www.ekobsc.com/sms/numbers |
请求参数:
参数 | 类型 | 描述 | |
addressBookId | int | 邮件列表ID | 要求 |
手机 | 数组 | 电话号码一览表 | 要求 |
请求示例:
{"addressBookId": 434443, "phones": ["380986235698", "3800685321598"]}
如果请求成功,您将收到一个响应:
{"result": true, "counters": {"added": 2, "exceptions": 0, "exists": 0}}
将电话号码添加到带有变量的邮件列表中
要将电话号码添加到带有变量的邮件列表中,请发送POST请求到:
https://api.半岛客户端下载官网www.ekobsc.com/sms/numbers/variables |
请求参数:
参数 | 类型 | 描述 | |
addressBookId | int | 邮件列表ID | 要求 |
手机 | 对象 | 电话号码一览表 | 要求 |
请求示例:
{"手机":{“380632631234”:[[{“名称”:“日期”、“类型”:“日期”、“价值”:“2018-10-10”},{“名称”:“名字”,“类型”:“弦”、“价值”:“名字 " } ] ], " 38063333333”:[[{“名称”:“日期”、“类型”:“日期”、“价值”:“2018-10-10”},{“名称”:“名字”,“类型”:“弦”、“价值”:“名字 " } ] ] }, " addressBookId”:434443}
注意d的值吃了
变量不能包含时间,例如:2018-10-10 23:00:00
值格式是否不正确,以及2018-10-10
是正确的。
如果请求成功,您将收到一个响应:
[{“结果”:真的,“计数器”:{“添加”:2,“例外”:0,“存在”:83}})
更新一个电话号码的变量列表
要通过电话号码更新变量列表,请发送PUT请求到:
https://api.半岛客户端下载官网www.ekobsc.com/sms/numbers |
请求参数:
参数 | 类型 | 描述 | |
addressBookId | int | 邮件列表ID | 要求 |
手机 | 数组 | 电话号码一览表 | 要求 |
变量 | 数组 | 变量列表 | 要求 |
手机
参数的例子:
(“380933170413”、“380988365096”、“380956045455”,“380635962561”)
变量
参数的例子:
(
{" name ": " test1”、“类型”:“日期”、“价值”:“2018-10-10”},{“名称”:“test2”,“类型”:“弦”、“价值”:“czxczxczx”},{“名称”:“test3”,“类型”:“数量”,“价值”:12312312312}
]
如果请求成功,您将收到一个响应:
[{“结果”:真的,“计数器”:{“更新”:4}})
从邮件列表中删除电话号码
要从邮件列表中删除电话号码,请发送DELETE请求至:
https://api.半岛客户端下载官网www.ekobsc.com/sms/numbers |
请求参数:
参数 | 类型 | 描述 | |
手机 | 数组 | 电话号码一览表 | 要求 |
addressBookId | int | 邮件列表ID | 要求 |
请求示例:
{"addressBookId": 434443, "phones": ["380986235698", "380685321598"]}
如果请求成功,您将收到一个响应:
{"result": true, "counters": {"deleted": 2}}
修改电话联系人变量
要更改电话号码的变量,发送POST请求到:
https://api.半岛客户端下载官网www.ekobsc.com/addressbooks/ {id} /手机/变量 |
请求参数:
参数 | 类型 | 描述 | |
id | int | 包含必要电话联系人的邮件列表ID | 要求 |
电话 | 字符串 | 接收者,它有变量 | 要求 |
变量 | 数组 | 变量列表 | 要求 |
请求示例:
{“电话”:“380931112233”,“变量”:[{“名称”:“名字”,“价值”:“约翰”},{“名称”:“日期”、“价值”:“2019-02-01”}]}
变量字符串
格式接受数字值,或以以下格式表示日期的值:YYYY-MM-DD
。数量
变量只接受数字和日期
变量,格式如下:YYYY-MM-DD
。不支持其他格式。体育彩票半岛例如:有效日期;2017-01-01
,无效日期:2017-1-1
。
如果请求成功,您将收到一个响应:
{"result": true}
获取特定电话号码的信息
要获取特定电话号码的信息,发送get请求到:
https://api.半岛客户端下载官网www.ekobsc.com/sms/numbers/info/ {addressBookId} / {phoneNumber} |
请求参数:
参数 | 类型 | 描述 | |
phoneNumber | 字符串 | 电话号码 | 要求 |
addressBookId | int | 邮件列表ID | 要求 |
如果请求成功,您将收到一个响应:
[{“结果”:真的,“数据”:{“状态”:1、“变量”:{“test1”:“2018-10-10”,“test2”:“czxczxczx”、“test3”:12312312312},“说”:“2017-02-21 13:19:47”}})
将“电话号码”加入黑名单
将电话号码加入黑名单,发送POST请求到:
https://api.半岛客户端下载官网www.ekobsc.com/sms/black_list |
请求参数:
参数 | 类型 | 描述 | |
手机 | 数组 | 电话号码一览表 | 要求 |
描述 | 字符串 | 描述 | 要求 |
请求示例:
{"phones": ["350905623479", "350915623471"], "description": "description"}
如果请求成功,您将收到一个响应:
[{“结果”:真的,“计数器”:{“存在”“添加”:2日:3}})
从黑名单中删除电话号码
要从黑名单中删除电话号码,请发送DELETE请求到:
https://api.半岛客户端下载官网www.ekobsc.com/sms/black_list |
请求参数:
参数 | 类型 | 描述 | |
手机 | 数组 | 电话号码一览表 | 要求 |
如果请求成功,您将收到一个响应:
[{
"result": true, "counters": {"removed": 3}}]
获取黑名单中的联系人列表
要获取黑名单中的联系人列表,发送get请求到:
https://api.半岛客户端下载官网www.ekobsc.com/sms/black_list |
如果请求成功,您将收到一个响应:
{"result": true, "data": [{"phone": "350965623471", "description": "description", "add_date": "2021-08-02 12:10:25"}, {"phone": "350965623479", "description": "description", "add_date": "2021-08-02 12:10:25"}]}
获取黑名单电话号码信息
要获取黑名单中的电话号码信息,请向以下地址发送get请求:
https://api.半岛客户端下载官网www.ekobsc.com/sms/black_list/by_numbers |
请求参数:
参数 | 类型 | 描述 | |
手机 | 数组 | 电话号码一览表 | 要求 |
如果请求成功,您将收到一个响应:
{"result": true, "data": [{"phone": "350965623471", "description": "description", "add_date": "2021-08-02 12:10:25"}]}
创建一个活动
创建一个活动,发送一个POST请求到:
https://api.半岛客户端下载官网www.ekobsc.com/sms/campaigns |
请求参数:
参数 | 类型 | 描述 | |
发送方 | 字符串 | 字母数字值,最多11个符号 | 要求 |
addressBookId | int | 邮件列表ID | 要求 |
身体 | 字符串 | 消息体 | 要求 |
直译 | int | 音译的身体,可以取0 或1 值 |
要求 |
路线* | 对象 | 例如,JSON格式的各个国家的路由列表{“UA”:“国家”、“通过”:“国际”} |
可选 |
日期 | 字符串 | 活动日期YYYY-MM-DD HH: MM: SS 格式 |
可选 |
模仿 | int | 该参数激活测试模式:if模仿= 1 ,竞选活动会形成,但不会发送,也不会在用户面板中显示; 在API回复中,活动id将为 0 |
可选 |
*请注意,有些运营商要求指定消息传递路线:国内或国际。一些国家的运营商还要求提供注册的发送人ID。如果您没有这些国家的注册发件人ID,则必须使用国际路线。
所有的短信都经过审核,所以可能需要几分钟才能把你的短信发送给收件人。
请求示例:
{“发件人”:“发件人”、“addressBookId”:422325年,“身体”:“身体”、“直译”:1、“路线”:{“UA”:“sim_ua”},“日期”:“2021-07-07 10:00:00”,“模仿”:0}
如果请求成功,您将收到一个响应:
{"result": true, "campaign_id": 5033111}
创建一个电话号码列表的活动
要为电话号码列表创建一个活动,请发送POST请求到:
https://api.半岛客户端下载官网www.ekobsc.com/sms/send |
请求参数:
参数 | 类型 | 描述 | |
发送方 | 字符串 | 发送方信息为字母数字值,最多11个符号 | 要求 |
手机 | 数组 | JSON格式的批量电话邮件列表 | 要求 |
身体 | 字符串 | 消息体 | 要求 |
日期 | 字符串 | 活动日期YYYY-MM-DD HH: MM: SS 格式 |
可选 |
路线* | 对象 | JSON格式的各个国家的路由列表 | 可选 |
模仿 | int | 该参数激活测试模式:if模仿= 1 ,运动会形成,但不会发送,也不会在用户面板中显示; 在API回复中,活动id将是 0 |
可选 |
use_dynamic_list | 布尔 | 用于发送到计划活动的动态列表。动态列表包括在创建活动之后但在发送活动之前添加到邮件列表中的联系人。可在任何付费定价计划。默认情况下,假 |
可选 |
*请注意,有些运营商要求指定消息传递路线:国内或国际。一些国家的运营商还要求提供注册的发送人ID。如果您没有这些国家的注册发件人ID,则必须使用国际路线。
所有的短信都经过审核,所以可能需要几分钟才能把你的短信发送给收件人。
请求示例:
{“发件人”:“发件人”、“手机”:“380986158966”,“380930452313”,“身体”:“身体”、“直译”:1、“路线”:{“UA”:“sim_ua”},“模仿”:0,“use_dynamic_list”:真的,“日期”:“2021-07-07 10:00:00”}
如果请求成功,您将收到一个响应:
{"result": true, "campaign_id": 503422, "counters": {"exceptions": 0, " sending ": 2}}
按日期获取活动列表
要按日期获取活动列表,请发送get请求到:
https://api.半岛客户端下载官网www.ekobsc.com/sms/campaigns/list |
请求参数:
参数 | 类型 | 描述 | |
dateFrom | 字符串 | 年的日期YYYY-MM-DD HH: MM: SS 格式 |
可选 |
dateTo | 字符串 | 截止日期YYYY-MM-DD HH: MM: SS 格式 |
可选 |
带有附加参数的URL示例:
https://api.半岛客户端下载官网www.ekobsc.com/sms/campaigns/list?dateFrom=2021-07-05 07:48:22& dateto = 20121-07-07 07:48:22 |
如果请求成功,您将收到一个响应:
{"result":true, "data":[{"id":508962, "address_book_id":0, "company_price":"1.28000", "company_currency":"UAH", "send_date":"2021-07-07 07:00:00", "date_created":"2021-07-06 11:20:01", "sender_name":"Sender"}, {"id":503358, "address_book_id":4225856, "company_price":"0.64000", "company_currency":"UAH", "send_date":"2021-07-07 07:48:22", "date_created":"2021-07-06 11:04:52", "sender_name":"Sender"}]}
获取活动信息
要获取活动信息,请发送get请求到:
https://api.半岛客户端下载官网www.ekobsc.com/sms/campaigns/info/ {id} |
请求参数:
参数 | 类型 | 描述 | |
id | int | 活动ID | 要求 |
如果请求成功,您将收到一个响应:
[{"result":true, "data":{"id":7520226, "address_book_id":12458, "currency":"USD", "company_price":0.044, "send_date":"2018-09-13 11:03:22", "date_created":"2018-09-13 11:03:22", " send_name ":"111111", "task_phones_info":[{"phone":18085426859, "status":2, "status_explain":"Delivered", " ountry_code":"USA", "money_spent":0.022}, {"phone":18037080295, "status":2, "status_explain":"Delivered", " ountry_code":"USA", "money_spent":0.022}]
发送到手机的状态描述:
状态码 | 状态 | 状态描述 |
0 | 准备发送 | 消息已经准备好可以发送了 |
1 | 发送 | 消息已经发出 |
2 | 交付 | 消息已发送 |
12 | 没有交付 | 该消息未发送 |
在发送开始之前取消活动
要在发送开始之前取消活动,请发送PUT请求到:
https://api.半岛客户端下载官网www.ekobsc.com/sms/campaigns/cancel/ {id} |
请求参数:
参数 | 类型 | 描述 | |
id | int | 活动ID | 要求 |
如果请求成功,您将收到一个响应:
{"result": true}
计算一个活动的成本
要计算广告活动的成本,请发送GET请求到:
https://api.半岛客户端下载官网www.ekobsc.com/sms/campaigns/cost |
请求参数:
参数 | 类型 | 描述 | |
addressBookId | int | 邮件列表ID | 要求* |
手机 | 数组 | JSON格式的电话号码列表 | 要求* |
身体 | 字符串 | 消息体 | 要求 |
发送方 | 字符串 | 发送方 | 要求 |
路线 | 对象 | JSON格式的各国路线列表,例如:{“UA”:“国家”、“通过”:“国际”} |
可选 |
请注意,参数需要编码为URL格式。
*如未指定邮寄名单,则应指定电话号码名单,反之亦然。
请求示例:
{“addressBookId”:422325年,“身体”:“身体”、“发件人”:“发件人”、“路线”:{“UA”:“国家”}}
一个示例回答:
{“结果”:真的,“数据”:{“价格”:0.05,“货币”:“UA}}
获取发件人id列表
要获取关于发送方id的信息,发送一个get请求到:
https://api.半岛客户端下载官网www.ekobsc.com/sms/senders |
如果请求成功,您将收到一个响应:
[{"id": 4786, "sender": "iQA", "country": "Turkey", "country_code": "TR", "status": 1, "status_explain": "Active"}, {"id": 4787, "sender": "iQA", "country": "Turkey", "country_code": "TR", "status": 1, "status_explain": "Active"}, {"id": 18027, "sender": "reject ", "country": "Turkey", "country_code": "TR", "status": 0, "status_explain": "On moderation"}]
状态码说明:
代码 | 描述 |
0 | 适量的 |
1 | 活跃的 |
2 | 拒绝了 |
删除活动
要删除广告系列,请发送delete请求至:
https://api.半岛客户端下载官网www.ekobsc.com/sms/campaigns |
请求参数:
参数 | 类型 | 描述 | |
id | int | 活动ID | 要求 |
如果请求成功,您将收到一个响应:
{"result": true}
与…签约
登录Facebook 用谷歌登录