ClickSend
已送达的业务短信的 ClickSend;警报、通知、邀请、营销消息等。 ClickSend 是业务通信软件，使所有形状和规模的公司都能够轻松发送和接收短信、电子邮件、语音，甚至通过 Web 应用或 API 在全球发布。 ClickSend 的核心是短信，通过直接路由为全球数十亿条消息提供支持，但已扩展为提供一套完整的产品，为业务通信提供选择和上下文。
此连接器在以下产品和区域中可用：
| 服务 | Class | 区域 |
|---|---|---|
| Copilot Studio | 高级 | 除以下各项外的所有 Power Automate 区域 ： - 美国政府 （GCC） - 美国政府 （GCC High） - 由世纪互联运营的中国云 - 美国国防部（DoD） |
| 逻辑应用程序 | 标准 | 除以下各项外的所有 逻辑应用区域 ： - Azure 政府区域 - Azure 中国区域 - 美国国防部（DoD） |
| Power Apps | 高级 | 除以下各项外的所有 Power Apps 区域 ： - 美国政府 （GCC） - 美国政府 （GCC High） - 由世纪互联运营的中国云 - 美国国防部（DoD） |
| Power Automate | 高级 | 除以下各项外的所有 Power Automate 区域 ： - 美国政府 （GCC） - 美国政府 （GCC High） - 由世纪互联运营的中国云 - 美国国防部（DoD） |
| 联系人 | |
|---|---|
| Name | ClickSend SMS 支持 |
| URL | https://www.clicksend.com/au/help |
| Support@clicksend.com |
| 连接器元数据 | |
|---|---|
| 发布者 | 辛奇瑞典 AB |
| 网站 | https://www.clicksend.com |
| 隐私策略 | https://www.clicksend.com/us/legal/privacy-policy |
| 类别 | 通信;营销 |
适用于 Microsoft Power Automate 的 ClickSend 连接器
使用 Microsoft Power Automate 在应用程序之间创建自动化工作流，以同步文件、获取通知、收集数据等。 将 ClickSend 与 Power Automate 连接，将自动化消息添加到工作流中， 几乎在任何系统中。
使用 ClickSend 添加消息传递
ClickSend 连接器使你能够将强大的消息传送功能集成到自动化工作流中。 只需单击几下鼠标，即可将 ClickSend 连接到超过 700 个Microsoft Power Automate 连接器，以创建无缝通信流。
主要功能
- 发送短信 — 自动发送由其他应用中的事件触发的短信（例如表单提交、日历更新、电子邮件）。
- 发送彩信 — 通过自动化工作流共享多媒体内容（如图像或文件）。
- 发送语音 - 使用文本转语音或音频文件传送语音呼叫。
- 发送传真 - 直接从流发送数字传真。
- 发送邮件 - 通过邮政服务自动发送信件或明信片。
示例用例
- 在日历中添加或更改会议时接收短信。
- 从 VIP 客户收到电子邮件时，获取文本通知。
- 将新文件上传到 Dropbox 时，从 ClickSend 发送彩信。
- 使用模板化消息传递工作流自动进行营销或客户参与。
- 使用自定义触发器管理联系人列表或响应传入的短信。
使用预生成的模板简化设置，或轻松创建自己的自定义自动化。
如何连接 ClickSend 帐户
- 导航到 Power Automate 仪表板。
- 转到 “数据 > 连接 > ”新建连接。
- 搜索 ClickSend 短信。
- 输入 ClickSend API 凭据：
-
username：ClickSend 帐户用户名 -
api_key：ClickSend 仪表板中的 API 密钥
-
- 单击“ 创建 ” - 你的帐户现已连接！
要求
- ClickSend 帐户（clicksend.com 注册）。
- API 凭据（用户名和 API 密钥）。
了解详细信息
访问 ClickSend 开发人员门户 ，了解完整的 API 功能和用例。
使用由 ClickSend 和 Microsoft Power Automate 提供支持的自动化消息传递来增强工作流。
正在创建连接
连接器支持以下身份验证类型：
| 默认 | 用于创建连接的参数。 | 所有区域 | 不可共享 |
违约
适用：所有区域
用于创建连接的参数。
这是不可共享的连接。 如果 Power App 与另一个用户共享，系统会提示其他用户显式创建新连接。
| Name | 类型 | Description | 必选 |
|---|---|---|---|
| 用户名 | securestring | 此 API 的用户名 | True |
| API 密钥 | securestring | 此 API 的 API 密钥 | True |
限制
| 名称 | 调用 | 续订期 |
|---|---|---|
| 每个连接的 API 调用数 | 100 | 60 秒 |
操作
| 创建新的联系人列表 |
创建新的联系人列表 |
| 创建新联系人 |
创建新联系人 |
| 删除列表 |
删除特定联系人列表 |
| 删除联系人 |
删除联系人 |
| 发送传真 |
发送传真 |
| 发送信函 |
发送信函 |
| 发送彩信 |
发送彩信 |
| 发送明信片 |
发送一个或多个明信片 |
| 发送短信 |
每 160 个字符 = 1 条短信。 最多可以发送 1,224 个标准字符。 |
| 发送语音消息 |
每 300 个字符 = 1 条语音消息。 最多可以发送 1,200 个标准字符 |
| 搜索联系人列表 |
获取已搜索联系人列表的列表 |
| 获取列表中的联系人 |
获取列表中的所有联系人 |
| 获取联系人列表 |
获取所有联系人列表，除非在高级选项中指定 |
| 转换媒体文件格式 |
转换媒体文件格式 |
创建新的联系人列表
创建新的联系人列表
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
列表名称
|
list_name | True | string |
联系人列表名称 |
返回
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
Http 代码
|
http_code | integer |
Http 代码 |
|
响应代码
|
response_code | string |
响应代码 |
|
响应消息
|
response_msg | string |
响应消息 |
|
列表 ID
|
data.list_id | integer |
列表 ID |
|
列表名称
|
data.list_name | string |
列表名称 |
|
列出电子邮件 ID
|
data.list_email_id | string |
列出电子邮件 ID |
|
联系人计数
|
data._contacts_count | integer |
联系人计数 |
创建新联系人
创建新联系人
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
列表 ID
|
list_id | True | integer |
可以使用“搜索联系人列表”作或“获取联系人列表”作获取列表 ID |
|
名字
|
first_name | True | string |
联系人的名字。 |
|
姓氏
|
last_name | True | string |
联系人的姓氏。 |
|
电话号码
|
phone_number | True | string |
本地或国际格式的联系人电话，例如 +61411111111。 |
|
Email
|
string |
联系人的电子邮件地址。 |
||
|
传真号码
|
fax_number | string |
联系人的电话号码。 |
|
|
组织名称
|
organization_name | string |
联系人的组织名称。 |
|
|
国家
|
address_country | string |
联系人所在的国家/地区。 |
|
|
State
|
address_state | string |
State |
|
|
City
|
address_city | string |
地址城市 |
|
|
自定义 1
|
custom_1 | string |
自定义 1 |
|
|
自定义 3
|
custom_3 | string |
自定义 3 |
|
|
邮政编码
|
address_postal_code | string | ||
|
自定义 2
|
custom_2 | string |
自定义 2 |
|
|
自定义 4
|
custom_4 | string |
自定义 4 |
|
|
地址行 1
|
address_line_1 | string |
地址行 1 |
|
|
地址行 2
|
address_line_2 | string |
地址行 2 |
返回
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
Http 代码
|
http_code | integer |
Http 代码 |
|
响应代码
|
response_code | string |
响应代码 |
|
响应消息
|
response_msg | string |
响应消息 |
|
触点 ID
|
data.contact_id | integer |
触点 ID |
|
列表 ID
|
data.list_id | integer |
列表 ID |
|
电话号码
|
data.phone_number | string |
电话号码 |
|
名字
|
data.first_name | string |
名字 |
|
姓氏
|
data.last_name | string |
姓氏 |
|
自定义 1
|
data.custom_1 | string |
自定义 1 |
|
自定义 2
|
data.custom_2 | string |
自定义 2 |
|
自定义 3
|
data.custom_3 | string |
自定义 3 |
|
自定义 4
|
data.custom_4 | string |
自定义 4 |
|
已添加日期
|
data.date_added | integer |
已添加日期 |
|
传真号码
|
data.fax_number | string |
传真号码 |
|
组织名称
|
data.organization_name | string |
组织名称 |
|
Email
|
data.email | string |
|
|
地址行 1
|
data.address_line_1 | string |
地址行 1 |
|
地址行 2
|
data.address_line_2 | string |
地址行 2 |
|
地址城市
|
data.address_city | string |
地址城市 |
|
地址状态
|
data.address_state | string |
地址状态 |
|
地址邮政编码
|
data.address_postal_code | string |
地址邮政编码 |
|
地址国家/地区
|
data.address_country | string |
地址国家/地区 |
|
列表名称
|
data._list_name | string |
列表名称 |
删除列表
删除特定联系人列表
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
列表 ID
|
list_id | True | integer |
可以使用“搜索联系人列表”作或“获取联系人列表”作获取列表 ID |
返回
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
Http 代码
|
http_code | integer |
Http 代码 |
|
响应代码
|
response_code | string |
响应代码 |
|
响应消息
|
response_msg | string |
响应消息 |
删除联系人
删除联系人
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
列表 ID
|
list_id | True | integer |
可以使用“搜索联系人列表”作或“获取联系人列表”作获取列表 ID |
|
触点 ID
|
contact_id | True | integer |
触点 ID |
返回
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
Http 代码
|
http_code | integer |
Http 代码 |
|
响应代码
|
response_code | string |
响应代码 |
|
响应消息
|
response_msg | string |
响应消息 |
发送传真
发送传真
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
到
|
to | True | string |
E.164 格式的电话号码。 Eg. +61261111111. |
|
自定义字符串
|
custom_string | string |
这是你的参考。 它将在所有报表上显示，并将随任何答复一起传回。 |
|
|
PDF 文件 URL
|
file_url | True | string |
最大文件大小为 4 MB。 所有页面都应以纵向显示。 与 ClickSend 支持聊天以获取完整规范 |
返回
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
Http 代码
|
http_code | integer |
Http 代码 |
|
响应代码
|
response_code | string |
响应代码 |
|
响应消息
|
response_msg | string |
响应消息 |
|
总价格
|
data.total_price | float |
总价格 |
|
总数
|
data.total_count | integer |
总数 |
|
排队计数
|
data.queued_count | integer |
排队计数 |
|
messages
|
data.messages | array of object |
messages |
|
用户 ID
|
data.messages.user_id | integer |
用户 ID |
|
子帐户 ID
|
data.messages.subaccount_id | integer |
子帐户 ID |
|
列表 ID
|
data.messages.list_id | string |
列表 ID |
|
消息 ID
|
data.messages.message_id | string |
消息 ID |
|
到
|
data.messages.to | string |
到 |
|
来自
|
data.messages.from | string |
来自 |
|
Carrier
|
data.messages.carrier | string |
Carrier |
|
国家
|
data.messages.country | string |
国家 |
|
自定义字符串
|
data.messages.custom_string | string |
自定义字符串 |
|
消息页
|
data.messages.message_pages | integer |
消息页 |
|
消息价格
|
data.messages.message_price | string |
消息价格 |
|
状态代码
|
data.messages.status_code | string |
状态代码 |
|
状态文本
|
data.messages.status_text | string |
状态文本 |
|
已添加日期
|
data.messages.date_added | integer |
已添加日期 |
|
从电子邮件
|
data.messages.from_email | string |
从电子邮件 |
|
文件 URL
|
data.messages._file_url | string |
文件 URL |
|
状态
|
data.messages.status | string |
状态 |
|
货币名称短
|
data._currency.currency_name_short | string |
货币名称短 |
|
货币前缀 D
|
data._currency.currency_prefix_d | string |
货币前缀 D |
|
货币前缀 C
|
data._currency.currency_prefix_c | string |
货币前缀 C |
|
货币名称长
|
data._currency.currency_name_long | string |
货币名称长 |
发送信函
发送信函
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
PDF 文件 URL
|
file_url | True | string |
最大文件大小为 10 MB。 所有页面都应以纵向显示。 与 ClickSend 支持聊天以获取完整的规范。 |
|
使用的模板
|
template_used | integer |
是否使用字母模板。 标志值必须为 1 表示是或 0 表示否。 |
|
|
颜色
|
colour | True | integer |
选择使用颜色或 B&W 打印。 （黑白 = 0，颜色 = 1） |
|
双工
|
duplex | True | integer |
选择使用双工 = 1 （双面） 或 Simplex = 0（单面） 打印。 |
|
Priority Post
|
priority_post | integer |
字母是否为优先级，标志值必须为 1 表示是或 0 表示否。 |
|
|
Name
|
address_name | True | string |
地址名称 |
|
City
|
address_city | True | string |
City |
|
State
|
address_state | True | string |
State |
|
邮政编码
|
address_postal_code | True | string |
邮政编码 |
|
国家
|
address_country | True | string |
国家 |
|
选择返回地址
|
return_address_id | True | integer |
返回要使用的地址 ID |
|
地址行 1
|
address_line_1 | True | string |
第一行地址 |
|
地址行 2
|
address_line_2 | string |
第二行地址 |
返回
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
Http 代码
|
http_code | integer |
Http 代码 |
|
响应代码
|
response_code | string |
响应代码 |
|
响应消息
|
response_msg | string |
响应消息 |
|
总价格
|
data.total_price | float |
总价格 |
|
总数
|
data.total_count | integer |
总数 |
|
排队计数
|
data.queued_count | integer |
排队计数 |
|
recipients
|
data.recipients | array of object |
项 |
|
用户 ID
|
data.recipients.user_id | integer |
用户 ID |
|
子帐户 ID
|
data.recipients.subaccount_id | integer |
子帐户 ID |
|
消息 ID
|
data.recipients.message_id | string |
消息 ID |
|
地址名称
|
data.recipients.address_name | string |
地址名称 |
|
地址行 1
|
data.recipients.address_line_1 | string |
地址行 1 |
|
地址行 2
|
data.recipients.address_line_2 | string |
地址行 2 |
|
地址城市
|
data.recipients.address_city | string |
地址城市 |
|
地址状态
|
data.recipients.address_state | string |
地址状态 |
|
地址邮政编码
|
data.recipients.address_postal_code | string |
地址邮政编码 |
|
地址国家/地区
|
data.recipients.address_country | string |
地址国家/地区 |
|
返回地址 ID
|
data.recipients.return_address_id | integer |
返回地址 ID |
|
自定义字符串
|
data.recipients.custom_string | string |
自定义字符串 |
|
来源
|
data.recipients.source | string |
来源 |
|
颜色
|
data.recipients.colour | integer |
颜色 |
|
双工
|
data.recipients.duplex | integer |
双工 |
|
帖子页
|
data.recipients.post_pages | integer |
帖子页 |
|
Post Price
|
data.recipients.post_price | string |
Post Price |
|
Priority Post
|
data.recipients.priority_post | integer |
Priority Post |
|
已添加日期
|
data.recipients.date_added | integer |
已添加日期 |
|
状态
|
data.recipients.status | string |
状态 |
|
文件 URL
|
data.recipients._file_url | string |
文件 URL |
|
返回地址 ID
|
data.recipients._return_address.return_address_id | integer |
返回地址 ID |
|
用户 ID
|
data.recipients._return_address.user_id | integer |
用户 ID |
|
地址名称
|
data.recipients._return_address.address_name | string |
地址名称 |
|
地址行 1
|
data.recipients._return_address.address_line_1 | string |
地址行 1 |
|
地址行 2
|
data.recipients._return_address.address_line_2 | string |
地址行 2 |
|
地址城市
|
data.recipients._return_address.address_city | string |
地址城市 |
|
地址状态
|
data.recipients._return_address.address_state | string |
地址状态 |
|
地址邮政编码
|
data.recipients._return_address.address_postal_code | string |
地址邮政编码 |
|
地址国家/地区
|
data.recipients._return_address.address_country | string |
地址国家/地区 |
|
API 用户名
|
data.recipients._api_username | string |
API 用户名 |
|
货币名称短
|
data._currency.currency_name_short | string |
货币名称短 |
|
货币前缀 D
|
data._currency.currency_prefix_d | string |
货币前缀 D |
|
货币前缀 C
|
data._currency.currency_prefix_c | string |
货币前缀 C |
|
货币名称长
|
data._currency.currency_name_long | string |
货币名称长 |
发送彩信
发送彩信
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
到
|
to | True | string |
移动电话号码。 可以采用本地或国际格式。 如果发送到另一个国家，则必须采用国际（E.164）格式。 例如 +61411111111。 |
|
主题
|
subject | True | string |
主题行。 最多 20 个字符。 |
|
消息
|
body | True | string |
消息正文。 最多 1500 个字符或 500 个 Unicode 字符 |
|
自定义字符串
|
custom_string | string |
这是你的参考。 它将在所有报表上显示，并将随任何答复一起传回。 |
|
|
媒体 URL
|
media_file | True | string |
支持最大文件大小为 250kB，仅当 GIF 文件大小低于 100 kB 时，才能支持 Gif |
返回
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
Http 代码
|
http_code | integer |
Http 代码 |
|
响应代码
|
response_code | string |
响应代码 |
|
响应消息
|
response_msg | string |
响应消息 |
|
总价格
|
data.total_price | float |
总价格 |
|
总数
|
data.total_count | integer |
总数 |
|
排队计数
|
data.queued_count | integer |
排队计数 |
|
messages
|
data.messages | array of object |
味精 |
|
列表 ID
|
data.messages.list_id | integer |
列表 ID |
|
触点 ID
|
data.messages.contact_id | integer |
触点 ID |
|
消息 ID
|
data.messages.message_id | string |
消息 ID |
|
到
|
data.messages.to | string |
到 |
|
Subject
|
data.messages.subject | string |
Subject |
|
来自
|
data.messages.from | string |
来自 |
|
Body
|
data.messages.body | string |
Body |
|
国家
|
data.messages.country | string |
国家 |
|
自定义字符串
|
data.messages.custom_string | string |
自定义字符串 |
|
消息部件
|
data.messages.message_parts | integer |
消息部件 |
|
消息价格
|
data.messages.message_price | string |
消息价格 |
|
媒体文件 URL
|
data.messages._media_file_url | string |
媒体文件 URL |
|
状态
|
data.messages.status | string |
状态 |
发送明信片
发送一个或多个明信片
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
Name
|
address_name | True | string |
地址名称 |
|
City
|
address_city | True | string |
City |
|
State
|
address_state | True | string |
State |
|
邮政编码
|
address_postal_code | True | string |
邮政编码 |
|
国家
|
address_country | True | string |
国家 |
|
返回地址 ID
|
return_address_id | True | integer |
返回要使用的地址 ID |
|
地址行 1
|
address_line_1 | True | string |
第一行地址 |
|
地址行 2
|
address_line_2 | string |
第二行地址 |
|
|
file_urls
|
file_urls | True | array of string |
PDF 文件 URL |
返回
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
Http 代码
|
http_code | integer |
Http 代码 |
|
响应代码
|
response_code | string |
响应代码 |
|
响应消息
|
response_msg | string |
响应消息 |
|
总价格
|
data.total_price | double |
总价格 |
|
总数
|
data.total_count | integer |
总数 |
|
排队计数
|
data.queued_count | integer |
排队计数 |
|
recipients
|
data.recipients | array of object |
Recipient |
|
用户 ID
|
data.recipients.user_id | integer |
用户 ID |
|
子帐户 ID
|
data.recipients.subaccount_id | integer |
子帐户 ID |
|
消息 ID
|
data.recipients.message_id | string |
消息 ID |
|
地址名称
|
data.recipients.address_name | string |
地址名称 |
|
地址行 1
|
data.recipients.address_line_1 | string |
地址行 1 |
|
地址行 2
|
data.recipients.address_line_2 | string |
地址行 2 |
|
地址城市
|
data.recipients.address_city | string |
地址城市 |
|
地址状态
|
data.recipients.address_state | string |
地址状态 |
|
地址邮政编码
|
data.recipients.address_postal_code | string |
地址邮政编码 |
|
地址国家/地区
|
data.recipients.address_country | string |
地址国家/地区 |
|
返回地址 ID
|
data.recipients.return_address_id | integer |
返回地址 ID |
|
时间表
|
data.recipients.schedule | integer |
时间表 |
|
Post Price
|
data.recipients.post_price | string |
Post Price |
|
状态
|
data.recipients.status | string |
状态 |
|
已添加日期
|
data.recipients.date_added | integer |
已添加日期 |
|
文件 URL
|
data.recipients._file_url | string |
文件 URL |
|
返回地址 ID
|
data.recipients._return_address.return_address_id | integer |
返回地址 ID |
|
用户 ID
|
data.recipients._return_address.user_id | integer |
用户 ID |
|
地址名称
|
data.recipients._return_address.address_name | string |
地址名称 |
|
地址行 1
|
data.recipients._return_address.address_line_1 | string |
地址行 1 |
|
地址行 2
|
data.recipients._return_address.address_line_2 | string |
地址行 2 |
|
地址城市
|
data.recipients._return_address.address_city | string |
地址城市 |
|
地址状态
|
data.recipients._return_address.address_state | string |
地址状态 |
|
地址邮政编码
|
data.recipients._return_address.address_postal_code | string |
地址邮政编码 |
|
地址国家/地区
|
data.recipients._return_address.address_country | string |
地址国家/地区 |
|
Api 用户名
|
data.recipients._api_username | string |
Api 用户名 |
|
货币名称短
|
data._currency.currency_name_short | string |
货币名称短 |
|
货币前缀 D
|
data._currency.currency_prefix_d | string |
货币前缀 D |
|
货币前缀 C
|
data._currency.currency_prefix_c | string |
货币前缀 C |
|
货币名称长
|
data._currency.currency_name_long | string |
货币名称长 |
发送短信
每 160 个字符 = 1 条短信。 最多可以发送 1,224 个标准字符。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
到
|
to | True | string |
移动电话号码。 可以采用本地或国际格式。 如果发送到另一个国家，则必须采用国际（E.164）格式。 例如 +61411111111。 |
|
Body
|
body | True | string |
160 个字符是 1 个短信。 最多可以发送 1,224 个标准字符。 |
|
自定义字符串
|
custom_string | string |
这是你的参考。 它将在所有报表上显示，并将随任何答复一起传回。 |
返回
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
Http 代码
|
http_code | integer |
Http 代码 |
|
响应代码
|
response_code | string |
响应代码 |
|
响应消息
|
response_msg | string |
响应消息 |
|
总价格
|
data.total_price | float |
总价格 |
|
总数
|
data.total_count | integer |
总数 |
|
排队计数
|
data.queued_count | integer |
排队计数 |
|
messages
|
data.messages | array of object |
Message |
|
方向
|
data.messages.direction | string |
方向 |
|
日期
|
data.messages.date | integer |
日期 |
|
到
|
data.messages.to | string |
到 |
|
Body
|
data.messages.body | string |
Body |
|
来自
|
data.messages.from | string |
来自 |
|
消息 ID
|
data.messages.message_id | string |
消息 ID |
|
消息部件
|
data.messages.message_parts | integer |
消息部件 |
|
消息价格
|
data.messages.message_price | string |
消息价格 |
|
从电子邮件
|
data.messages.from_email | string |
从电子邮件 |
|
列表 ID
|
data.messages.list_id | string |
列表 ID |
|
自定义字符串
|
data.messages.custom_string | string |
自定义字符串 |
|
联系人 ID
|
data.messages.contact_id | string |
联系人 ID |
|
用户 ID
|
data.messages.user_id | integer |
用户 ID |
|
子帐户 ID
|
data.messages.subaccount_id | integer |
子帐户 ID |
|
国家
|
data.messages.country | string |
国家 |
|
Carrier
|
data.messages.carrier | string |
Carrier |
|
状态
|
data.messages.status | string |
状态 |
|
货币名称短
|
data._currency.currency_name_short | string |
货币名称短 |
|
货币前缀 D
|
data._currency.currency_prefix_d | string |
货币前缀 D |
|
货币前缀 C
|
data._currency.currency_prefix_c | string |
货币前缀 C |
|
货币名称长
|
data._currency.currency_name_long | string |
货币名称长 |
发送语音消息
每 300 个字符 = 1 条语音消息。 最多可以发送 1,200 个标准字符
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
到
|
to | True | string |
本地或国际格式的移动或内联电话号码。 如果发送到其他国家/地区，则必须采用国际格式（E.164）+61411111111. |
|
Body
|
body | True | string |
要读出的消息正文。 |
|
语言
|
lang | True | string |
选择要使用的语言。 |
|
Voice
|
voice | True | string |
选择要在女性男性语音中读出的消息。 |
|
自定义字符串
|
custom_string | string |
这是你的参考。 它将在所有报表上显示，并将随任何答复一起传回。 |
|
|
需要输入
|
require_input | integer |
接收收件人的密钥压缩。 标志值必须为 1 表示是或 0 表示否。 |
|
|
计算机检测
|
machine_detection | integer |
检测应答计算机或语音邮件并留下消息。 标志值必须为 1 表示是或 0 表示否。 |
返回
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
Http 代码
|
http_code | integer |
Http 代码 |
|
响应代码
|
response_code | string |
响应代码 |
|
响应消息
|
response_msg | string |
响应消息 |
|
总价格
|
data.total_price | float |
总价格 |
|
总数
|
data.total_count | integer |
总数 |
|
排队计数
|
data.queued_count | integer |
排队计数 |
|
messages
|
data.messages | array of object |
messages |
|
用户 ID
|
data.messages.user_id | integer |
用户 ID |
|
子帐户 ID
|
data.messages.subaccount_id | integer |
子帐户 ID |
|
消息 ID
|
data.messages.message_id | string |
消息 ID |
|
到
|
data.messages.to | string |
到 |
|
To Type
|
data.messages.to_type | string |
To Type |
|
来自
|
data.messages.from | string |
来自 |
|
Voice
|
data.messages.voice | string |
Voice |
|
语言
|
data.messages.lang | string |
语言 |
|
Body
|
data.messages.body | string |
Bddy |
|
Carrier
|
data.messages.carrier | string |
Carrier |
|
国家
|
data.messages.country | string |
国家 |
|
自定义字符串
|
data.messages.custom_string | string |
自定义字符串 |
|
时间表
|
data.messages.schedule | integer |
时间表 |
|
消息部件
|
data.messages.message_parts | integer |
消息部件 |
|
消息价格
|
data.messages.message_price | string |
消息价格 |
|
已添加日期
|
data.messages.date_added | integer |
已添加日期 |
|
需要输入
|
data.messages.require_input | integer |
需要输入 |
|
计算机检测
|
data.messages.machine_detection | integer |
计算机检测 |
|
状态
|
data.messages.status | string |
状态 |
|
货币名称短
|
data._currency.currency_name_short | string |
货币名称短 |
|
货币前缀 D
|
data._currency.currency_prefix_d | string |
货币前缀 D |
|
货币前缀 C
|
data._currency.currency_prefix_c | string |
货币前缀 C |
|
货币名称长
|
data._currency.currency_name_long | string |
货币名称长 |
搜索联系人列表
获取已搜索联系人列表的列表
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
列表名称
|
q | True | string |
搜索内容 |
返回
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
Http 代码
|
http_code | integer |
Http 代码 |
|
响应代码
|
response_code | string |
响应代码 |
|
响应消息
|
response_msg | string |
响应消息 |
|
Total
|
data.total | integer |
Total |
|
每页
|
data.per_page | integer |
每页 |
|
当前页
|
data.current_page | integer |
当前页 |
|
最后一页
|
data.last_page | integer |
最后一页 |
|
下一页 URL
|
data.next_page_url | string |
下一页 URL |
|
上一页 URL
|
data.prev_page_url | string |
上一页 URL |
|
来自
|
data.from | integer |
来自 |
|
到
|
data.to | integer |
到 |
|
数据
|
data.data | array of object |
数据 |
|
Id
|
data.data.id | integer |
Id |
|
Name
|
data.data.name | string |
Name |
|
联系人
|
data.data.contact | string |
联系人 |
|
类型
|
data.data.type | string |
类型 |
|
联系人计数
|
data.data.contacts_count | integer |
联系人计数 |
获取列表中的联系人
获取列表中的所有联系人
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
列表 ID
|
list_id | True | integer |
可以使用“搜索联系人列表”作或“获取联系人列表”作获取列表 ID |
返回
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
Http 代码
|
http_code | integer |
Http 代码 |
|
响应代码
|
response_code | string |
响应代码 |
|
响应消息
|
response_msg | string |
响应消息 |
|
Total
|
data.total | integer |
Total |
|
每页
|
data.per_page | integer |
每页 |
|
当前页
|
data.current_page | integer |
当前页 |
|
最后一页
|
data.last_page | integer |
最后一页 |
|
下一页 URL
|
data.next_page_url | string |
下一页 URL |
|
上一页 URL
|
data.prev_page_url | string |
上一页 URL |
|
来自
|
data.from | integer |
来自 |
|
到
|
data.to | integer |
到 |
|
数据
|
data.data | array of object |
数据 |
|
触点 ID
|
data.data.contact_id | integer |
触点 ID |
|
列表 ID
|
data.data.list_id | integer |
列表 ID |
|
电话号码
|
data.data.phone_number | string |
电话号码 |
|
名字
|
data.data.first_name | string |
名字 |
|
姓氏
|
data.data.last_name | string |
姓氏 |
|
自定义 1
|
data.data.custom_1 | string |
自定义 1 |
|
自定义 2
|
data.data.custom_2 | string |
自定义 2 |
|
自定义 3
|
data.data.custom_3 | string |
自定义 3 |
|
自定义 4
|
data.data.custom_4 | string |
自定义 4 |
|
date_added
|
data.data.date_added | integer |
已添加日期 |
|
已更新日期
|
data.data.date_updated | integer |
已更新日期 |
|
传真号码
|
data.data.fax_number | string |
传真号码 |
|
组织名称
|
data.data.organization_name | string |
组织名称 |
|
Email
|
data.data.email | string |
|
|
地址行 1
|
data.data.address_line_1 | string |
地址行 1 |
|
地址行 2
|
data.data.address_line_2 | string |
地址行 2 |
|
地址城市
|
data.data.address_city | string |
地址城市 |
|
地址状态
|
data.data.address_state | string |
地址状态 |
|
地址邮政编码
|
data.data.address_postal_code | string |
地址邮政编码 |
|
地址国家/地区
|
data.data.address_country | string |
地址国家/地区 |
|
列表名称
|
data.data._list_name | string |
列表名称 |
获取联系人列表
获取所有联系人列表，除非在高级选项中指定
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
页码
|
page | integer |
页码 |
|
|
每页记录数
|
limit | integer |
每页记录数 |
返回
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
Http 代码
|
http_code | integer |
Http 代码 |
|
响应代码
|
response_code | string |
响应代码 |
|
响应消息
|
response_msg | string |
响应消息 |
|
Total
|
data.total | integer |
Total |
|
每页
|
data.per_page | integer |
每页 |
|
当前页
|
data.current_page | integer |
当前页 |
|
最后一页
|
data.last_page | integer |
最后一页 |
|
下一页 URL
|
data.next_page_url | string |
下一页 URL |
|
上一页 URL
|
data.prev_page_url | string |
上一页 URL |
|
来自
|
data.from | integer |
来自 |
|
到
|
data.to | integer |
到 |
|
数据
|
data.data | array of object |
数据 |
|
列表 ID
|
data.data.list_id | integer |
列表 ID |
|
列表名称
|
data.data.list_name | string |
列表名称 |
|
列出电子邮件 ID
|
data.data.list_email_id | string |
列出电子邮件 ID |
|
触点计数
|
data.data._contacts_count | integer |
联系人计数 |
|
导入引入
|
data.data._import_in_progress | integer |
导入引入 |
|
OptOut 入口
|
data.data._optout_in_progress | integer |
OptOut 入口 |
转换媒体文件格式
转换媒体文件格式
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
选择文件所需的作
|
convert | True | string |
选择文件所需的作 |
|
文件
|
content | True | byte |
文件内容（base64） |
返回
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
Http 代码
|
http_code | integer |
Http 代码 |
|
响应代码
|
response_code | string |
响应代码 |
|
响应消息
|
response_msg | string |
响应消息 |
|
上传 ID
|
data.upload_id | integer |
上传 ID |
|
文件名
|
data.file_name | string |
文件名 |
|
已添加日期
|
data.date_added | integer |
已添加日期 |
|
日期删除
|
data.date_delete | integer |
日期删除 |
|
用户 ID
|
data.user_id | integer |
用户 ID |
|
网址
|
data._url | string |
网址 |
触发器
| SMS 入站自动化 |
创建新的入站 SMS 自动化 |
SMS 入站自动化
创建新的入站 SMS 自动化
返回
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
Body
|
body | string |
身体 |
|
到
|
to | string |
收件人电话号码 |
|
来自
|
from | string |
发件人 ID |
|
自定义字符串
|
custom_string | string |
custom_string |
|
原始消息 ID
|
original_message_id | string |
original_message_id |
|
原始正文
|
original_body | string |
原始正文 |
|
用户 ID
|
user_id | integer |
发送消息的用户的用户 ID。 |
|
子帐户 ID
|
subaccount_id | integer |
发送消息的用户的子帐户 ID。 |
|
时间戳
|
timestamp | integer |
UNIX 格式的时间戳 |
|
消息 ID
|
message_id | string |
入站消息的消息 ID |