文本请求

文本请求是一个业务短信平台，旨在激发客户参与度。我们为日常通信问题创建了一个即插即用消息传送解决方案，因此你可以随时随地通过噪音与客户联系。详细了解我们如何帮助你像你这样忙于业务领袖。

此连接器在以下产品和区域中可用：

服务	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	文本请求 API 支持
URL	https://www.textrequest.com/contact
Email	apidev@textrequest.com

连接器元数据
发布者	文本请求
网站	https://www.textrequest.com/
隐私策略	https://www.textrequest.com/privacy-policy/
类别	通信;销售和 CRM

Aranda Service Management Suite （ASMS）

提高公司的工作效率，并通过 Aranda Service Management Suite（多租户解决方案）实现用户体验的转换，该解决方案允许你管理、集成和自动化业务流程和服务。创建、搜索和更新存储在 ASMS 的任何工作区（项目）中的记录，包括事件、要求和更改等。

先决条件

请记住以下先决条件才能继续：

一个订阅和一个 Aranda Service Management Suite 实例（ASMS）。从此处开始： https://arandasoft.com/
具有高级连接器功能的活动Microsoft Power Automate 订阅。

获取凭据

若要执行身份验证，请使用集成令牌。在以下链接中，可以找到有关如何获取集成令牌的信息

连接器入门

需要向 Aranda Service Management Suite（ASMS）订阅。
获取集成令牌
获取 Aranda Service Management ASMS API（ApiAsms）的实例 URL。
与 Aranda Service Management Suite 连接器建立连接。
选择连接器提供的以下函数之一：
有关连接器的详细文档，请参阅 https://docs.arandasoft.com/connectors

可以在以下情况下使用此连接器：

创建、搜索和更新票证以及其他可用作。
获取票证可跟踪性。
下载与票证相关的附件。
在 Aranda Service Management Suite 中搜索知识库（KB）文章。
从知识库（KB）文章下载附件。
创建、搜索和更新配置项目（CIs）。
它允许组织解决其内部支持请求，管理和简化技术问题解决过程。
允许跟踪请求者和支持代理之间的通信。
提供自动响应，以通知请求者其票证的状态。

成功的响应

Code	Name	Description
200	好的	请求已成功
204	无内容	请求中未找到任何数据

常见错误和补救措施

Code	Name	Description	解决方案
400	错误请求	CriteriaNeedsSomeArguments	检查搜索参数是否不为空
400	错误请求	InvalidAdditionalFieldId	检查其他字段的 ID 是否正确
400	错误请求	InvalidItemType	大小写类型不正确，更改大小写类型 ID
400	错误请求	InvalidProjectId	项目 ID 不正确，请更改将事例关联到的项目 ID
400	错误请求	InvalidStateId	在创建或更新票证时检查添加的状态
400	错误请求	InvalidUploadType	附加文件时出错，请从系统管理员请求帮助
400	错误请求	RequestNeedsSomeArguments	检查票证的必填字段，并在连接器中添加相应的值
400	错误请求	SearchListIsRequired	从系统管理员请求帮助
400	错误请求	参数名称：{Name parameter}	检查错误中提到的属性是否不为 null
400	错误请求	为 null 参数名称： {Name parameter}	检查错误中提到的属性是否不为 null
400	错误请求	ItemTypeIsRequired	添加事例类型
400	错误请求	ModelIdIsEmpty	添加 modelId 参数。它是必需的。
400	错误请求	StateIdIsEmpty	添加 stateId 参数。它是必需的。
400	错误请求	ServiceIdIsEmpty	添加 serviceId 参数。它是必需的。
400	错误请求	CategoryIdIsEmpty	添加 categoryId 参数。它是必需的。
400	错误请求	TypesListNeedsSomeArguments	要求在搜索票证时添加案例类型，请求系统管理员的帮助
400	错误请求	“{PARAMETER_NAME}” AdditionalFieldIsRequired	其他字段“{PARAMETER_NAME}”是必需的
400	错误请求	ModelNotActive	与事例关联的模型未处于活动状态
400	错误请求	FailedToCloseTaskPendingCloseTasksPredecessors	如果尝试关闭事例，并且父案例有待关闭的任务
400	错误请求	DuplicatedObject	Ci 已存在于数据库中
400	错误请求	EmptyValue 参数名称： {PARAMETER_NAME}	需要 {PARAMETER_NAME} 参数
400	错误请求	EmptyEnumeration 参数名称： {PARAMETER_NAME}	{PARAMETER_NAME} 参数是列表，并且是必需的
403	已禁止	DoNotHavePermissionForThisAction	与系统管理员联系以分配权限

Code	Name	Description	解决方案
500	内部服务器错误		从系统管理员请求帮助
500	内部服务器错误	FailureExportExcel	从系统管理员请求帮助
500	内部服务器错误	FailureGetAdditionalFields	从系统管理员请求帮助
500	内部服务器错误	FailureGetCategoriesByService	从系统管理员请求帮助
500	内部服务器错误	FailureGetChangeFSC	从系统管理员请求帮助
500	内部服务器错误	FailureGetFields	从系统管理员请求帮助
500	内部服务器错误	FailureGetFieldsList	从系统管理员请求帮助
500	内部服务器错误	FailureGetFiles	从系统管理员请求帮助
500	内部服务器错误	FailureGetLookupValues	从系统管理员请求帮助
500	内部服务器错误	FailureGetMailTemplates	从系统管理员请求帮助
500	内部服务器错误	FailureGetModelByCategory	从系统管理员请求帮助
500	内部服务器错误	FailureGetOperators	从系统管理员请求帮助
500	内部服务器错误	FailureGetReassignmentReasons	从系统管理员请求帮助
500	内部服务器错误	FailureGetSimilarItems	从系统管理员请求帮助
500	内部服务器错误	FailureSearchQuickManagement	从系统管理员请求帮助

FAQ

如何检索连接器中使用不同作所需的属性 ID（例如项目、服务、类别、组、专家）？

可以通过多种方式检索 ID：
- 使用 Aranda Query Manager，可以创建一个报表，用于查询所需数据的 Aranda Service Management Suite （ASMS）表。如果需要有关解决方案中的数据对象的指南，请访问以下链接 https://docs.arandasoft.com/docs/database.html 并识别与 ASMS 安装对应的 Aranda 数据库版本。
- 如果使用 ASMS 本地安装，可以通过 SQL 客户端查询所需数据的 ASMS 表。
- 通过 Aranda 支持中心，通过以下网站支持中指示的联系人渠道创建支持请求。
使用“添加附件”作时要附加的文件的最大大小是多少？

最大大小取决于 ASMS 实例/安装的特定配置。请询问 ASMS 管理员。
在连接器所需的 ASMS 连接配置中使用令牌的技术员帐户需要哪些数据访问级别？

访问级别与定期在 ASMS 中使用的技术人员帐户相同。换句话说，根据 ASMS 中相应技术人员的角色和权限，可以使用连接器访问数据。
连接器中将使用其令牌的技术人员帐户应为命名或并发帐户吗？

由于连接器每小时可以多次访问相关的 ASMS 实例，因此强烈建议该帐户是命名类型。
使用连接器创建或修改事例是否遵循 ASMS 接口中存在的相同数据验证规则？

是的，它遵循相同的验证规则。例如，在为特定项目、服务和类别创建事例时，如果必须填写本机字段和其他字段，则通过连接器提交事例时也需要这些数据。
连接器是否可用于云和本地环境中的 ASMS 实例？

是的，可以在 ASMS 的云和本地安装中使用。在本地安装中，必须考虑 ASMS 服务器与 Power Automate 环境之间的连接。
我有一个 Power Automate 许可证，它只允许我使用标准连接器。是否可以使用 ASMS 连接器？

不可能，ASMS 连接器是高级类型。
我想在 Power Automate 中创建从 ASMS 中的事件开始的流（例如，创建案例时，将事例分配给特定组时）。是否可以使用从 ASMS 中发生的事件开始的触发器？

是的，这是可能的。建议执行以下步骤：
- 初始化触发器“收到 HTTP 请求时”，并创建包含应从 ASMS 接收的数据结构的请求正文 JSON 架构。创建触发器后，你将获得在 ASMS 实例中使用的 HTTP POST URL（WebHook URL）。不要忘记考虑访问 WebHook URL 的身份验证机制（例如令牌）。
- 在 ASMS 中为满足条件集创建业务规则，这些条件应在 Power Automate 中启动流。作为规则中的作，选择“调用 Webhook”并在调用目标 URL 中输入之前获取的 WebHook URL、要发送的参数和请求正文（这必须与请求正文 JSON 架构匹配）。有关如何从 ASMS 中的规则调用 Webhook 的详细信息，请访问以下链接： Webhook 规则
- 测试创建的规则并验证 HTTP 请求是否已发送到 WebHook URL，并在 Power Automate 中初始化流。
是否可以从 Power Automate 中的流调用 ASMS REST API 终结点作为作？

是的，这是可能的。使用“HTTP”作并填写其中所需的数据（URI、方法、标头、正文等）。

正在创建连接

连接器支持以下身份验证类型：


默认	用于创建连接的参数。	所有区域	不可共享

违约

适用：所有区域

用于创建连接的参数。

这是不可共享的连接。如果 Power App 与另一个用户共享，系统会提示其他用户显式创建新连接。

Name	类型	Description	必选
API 密钥	securestring	此 API 的 API 密钥	True

限制

名称	调用	续订期
每个连接的 API 调用数	100	60 秒

操作

使用给定 ID 更新组	使用组的数字 ID 更新组的名称。如果传入的组 ID 不存在，则调用将失败。
创建具有给定名称和电话号码的新仪表板	在帐户中创建新的仪表板。创建仪表板后，管理员将收到有关更改的电子邮件，并可以开始分配用户。此终结点可以为任何预配的数字创建仪表板。可以使用 GET /dashboards/provisioning 在特定区域代码中搜索预配的数字。如果电话号码已在使用中，将引发“错误请求”异常。
创建或更新联系人	创建或更新联系人（具体取决于是否已存在具有给定电话号码）。
创建新的付款	使用提供的联系人的邮件创建新的付款。
创建新组	使用提供的名称创建新组。
删除具有指定 ID 的组	删除具有指定 ID 的组。即使有属于组成员的联系人（不会删除联系人），也会成功。
删除具有指定电话号码的联系人	删除具有指定电话号码的联系人
删除指定的仪表板	删除指定的仪表板。
发送后续文本，提醒用户支付指定的付款	向联系人发送提醒以支付指定的付款。自动生成消息的内容。为了避免垃圾邮件，每个付款只能发送一个提醒
取消对话存档	取消存档对话。一旦对话处于未存档状态，它将再次出现在队列中。它还将显示在 /conversations 终结点返回的对话中。如果对话已未存档，则此方法不起作用。
取消指定的付款	取消指定的付款，向用户发短信指出已取消付款。无法编辑付款，因此取消和发放新付款是更正付款的最佳方式。
向具有给定电话号码的联系人发送消息	发送消息（如果给定的电话号码没有消息历史记录，则启动新对话）。
存档对话	存档会话，将其从所有聊天检索终结点的结果中删除。如果客户向文本请求号码发送文本，或者向客户发送文本请求号码，则对话将自动取消存档。存档对话是删除你以后不打算与客户交谈的混乱的好方法。请注意，如果客户在“STOP”中发短信以防止发送任何进一步的短信，对话将自动存档。
将付款标记为已付款	将付款关闭为“已付款”。通过付款请求门户以外的方式支付付款时，请使用此终结点。这将关闭付款，并将其付款金额添加到统计信息中。通过文本请求发送的付款门户付款不需要此终结点;自动将付款标记为已付款。
批量更新联系人	只有指定的仪表板才会添加联系人;联系人按仪表板进行组织，没有可用号码的帐户级别搜索。
按组 ID 获取组	获取具有指定 ID 的组。
更新特定仪表板的名称	更新仪表板。这不会更改仪表板的电话号码。如果想要具有另一个仪表板联系人的新号码，则必须使用 POST 创建新仪表板，并使用批量导出/导入添加联系人。
获取与指定筛选条件匹配的所有联系人	获取与指定筛选条件匹配的所有联系人。仅搜索指定的仪表板;没有可用的号码的帐户级别搜索。
获取具有指定 ID 的付款	获取具有指定 ID 的付款。
获取具有指定电话号码的联系人	获取具有指定电话号码的联系人
获取帐户中的所有仪表板	获取帐户中的所有仪表板。
获取所有付款	获取所有付款，包括已取消付款和已付款。可以使用查询参数筛选这些参数。
获取所有标记	获取此仪表板的所有标记。标记在仪表板之间是唯一的。
获取所有组	获取用户帐户的所有组。
获取所有自定义字段	获取此仪表板的所有自定义字段。自定义字段在仪表板之间是唯一的。
获取有关此特定仪表板的信息	返回仪表板的名称和电话。
获取此仪表板的所有对话	获取此仪表板的所有对话，并包括有关每个对话的最后一条消息的信息。
通过联系人的电话号码获取对话的消息	获取指定仪表板和电话号码之间的对话。

使用给定 ID 更新组

操作 ID:: UpdateGroup

使用组的数字 ID 更新组的名称。如果传入的组 ID 不存在，则调用将失败。

参数

名称	密钥	必需	类型	说明
要对此调用的仪表板的 ID	dashboard_id	True	integer	要使用的电话号码仪表板。单个帐户可以有多个仪表板，表示客户的不同电话线路。
组的 ID	group_id	True	integer	要更新的组的数字 ID。
组名称	name		string	组的新名称。
组注释	notes		string	描述组的短语。用于方便。

名称	路径	类型	说明
id	id	integer	组的数字 ID。
group_member_count	group_member_count	integer	组的成员数。
is_keyword	is_keyword	boolean	Wheter 此组是关键字组。当用户设置关键字时，会自动生成此类组。联系人在注册时会自动添加。
姓名	name	string	此组的名称。
笔记	notes	string	此组上的任何注释。
last_message_sent_utc	last_message_sent_utc	string	为此组发送最后一封组消息的时间戳。

创建具有给定名称和电话号码的新仪表板

操作 ID:: CreateDashboard

在帐户中创建新的仪表板。创建仪表板后，管理员将收到有关更改的电子邮件，并可以开始分配用户。此终结点可以为任何预配的数字创建仪表板。可以使用 GET /dashboards/provisioning 在特定区域代码中搜索预配的数字。如果电话号码已在使用中，将引发“错误请求”异常。

参数

名称	密钥	必需	类型	说明
姓名	name		string	仪表板的名称。
phone	phone		string	与此仪表板关联的文本编号。

名称	路径	类型	说明
id	id	integer	仪表板的数字 ID。
姓名	name	string	仪表板的名称。
phone	phone	string	与此仪表板关联的文本编号。

创建或更新联系人

操作 ID:: CreateContact

创建或更新联系人（具体取决于是否已存在具有给定电话号码）。

参数

名称	密钥	必需	类型	说明
要对此调用的仪表板的 ID	dashboard_id	True	integer	要使用的电话号码仪表板。单个帐户可以有多个仪表板，表示客户的不同电话线路。
联系人电话号码	phone_number	True	string	要创建或更新的联系人的电话号码。
联系人的名字	first_name		string	联系人的新名字。
联系人的姓氏	last_name		string	联系人的新姓氏。
联系人全名	display_name		string	联系人的新全名。这是查看联系人时 Web 应用中显示的默认名称。
是否禁止来自此联系人的邮件	is_suppressed		boolean	确定是否取消与此联系人的对话，因此在收到消息队列时不会推送到消息队列的顶部。
此联系人的邮件是否已存档	is_archived		boolean	确定与此联系人的对话是否存档，因此在查询对话时（默认情况下）无法看到。
是否阻止来自此联系人的邮件	is_blocked		boolean	确定是否阻止与此联系人的对话，因此不会收到或存储。
取消此联系人的原因	suppressed_reason		string	描述禁止联系人的原因的短语。
联系人说明	note		string	描述联系人的简短短语。用于方便。这永远不会显示给联系人。
联系人组	groups		array of integer	引用此联系人所属组的整数 ID 数组。
联系人标记	contact_tags		array of string	引用附加到此联系人的标记的 guid 数组。
自定义字段 ID	id		string	引用自定义域的 Guid。
自定义字段值	value		string	此联系人对此自定义字段的值。
是否已解决与此联系人的当前对话	is_resolved		boolean	确定是否已解决与此联系人的当前对话。此联系人收到的任何新文本都将设置此 false。

名称	路径	类型	说明
phone_number	phone_number	string	此联系人的电话号码。
first_name	first_name	string	此联系人的名字。
last_name	last_name	string	此联系人的姓氏。
display_name	display_name	string	此联系人的全名。这是查看联系人时 Web 应用中显示的默认名称。
is_suppressed	is_suppressed	boolean	是否取消与此联系人的对话，因此在收到消息队列时不会推送到消息队列的顶部。
is_archived	is_archived	boolean	是否存档与此联系人的对话，因此在查询对话时（默认情况下）无法看到。
is_blocked	is_blocked	boolean	是否阻止了与此联系人的对话，因此不会收到或存储。
suppressed_reason	suppressed_reason	string	描述禁止联系人的原因的短语。如果is_suppressed为 false，则为 null。
注意	note	string	描述联系人的简短短语。用于方便。这永远不会显示给联系人。
groups	groups	array of integer	引用此联系人所属组的整数 ID 数组。
contact_tags	contact_tags	array of string	引用附加到此联系人的标记的 guid 数组。
custom_fields	custom_fields	array of object	为此联系人定义的自定义字段 ID 和值数组。
id	custom_fields.id	string	引用自定义域的 Guid。
value	custom_fields.value	string	此联系人对此自定义字段的值。
is_resolved	is_resolved	boolean	是否解决与此联系人的对话。此联系人收到的任何新文本都将设置此 false。
first_contact_utc	first_contact_utc	string	发送到此联系人的第一封邮件的时间戳。
opted_out_utc	opted_out_utc	string	此联系人选择退出接收消息的时间戳。
last_msg_sent_utc	last_msg_sent_utc	string	发送到此联系人的最后一条消息的时间戳。
last_msg_received_utc	last_msg_received_utc	string	从此联系人收到最后一条消息的时间戳。
total_msgs_sent	total_msgs_sent	integer	发送到此联系人的邮件总数。
total_msgs_received	total_msgs_received	integer	从此联系人收到的邮件总数。
response_count	response_count	integer	来自联系人的响应消息总数。
date_created_utc	date_created_utc	string	创建联系人时的时间戳。
last_contact_date_utc	last_contact_date_utc	string	从此联系人发送或接收最后一条消息的时间戳。
message_id	last_message.message_id	string	消息的 ID。此值对于每条消息都是唯一的。
身体	last_message.body	string	此消息的内容。
message_direction	last_message.message_direction	string	单一字符（R 或 S）表示是从联系人接收此消息还是分别发送给他们。
response_by_username	last_message.response_by_username	string	上次向此用户发送消息的文本请求用户的用户名。
message_timestamp_utc	last_message.message_timestamp_utc	string	文本请求发送或接收消息的时间戳。
delivery_status	last_message.delivery_status	string	此消息的当前状态。这可以是“send”、“delivered”、“error”或“send”。
delivery_error	last_message.delivery_error	string	导致无法传递此消息的错误。如果delivery_status不是“error”，则此值将为 null。
mms_media	last_message.mms_media	array of string	指向此邮件附件的 URL 列表。所有 URL 都是文本请求生成的 URL。

创建新的付款

操作 ID:: CreatePayment

使用提供的联系人的邮件创建新的付款。

参数

名称	密钥	必需	类型	说明
要对此调用的仪表板的 ID	dashboard_id	True	integer	要使用的电话号码仪表板。单个帐户可以有多个仪表板，表示客户的不同电话线路。
付款说明	description		string	付款说明。不会向联系人显示说明，并且仅供内部用户用于有关付款的上下文。
收件人电话号码	customer_phone		string	此付款将发送到的联系人的电话号码。
以美元为单位请求的金额	amount_requested		float	此付款请求的美元金额。
付款消息文本正文	message		string	要发送到联系人以及付款链接的消息文本。
付款的引用字符串	reference_number		string	创建可用于快速查找付款的付款时定义的用户定义的 ID。引用编号不唯一;许多付款可以具有相同的参考。

名称	路径	类型	说明
payment_id	payment_id	integer	付款的数字 ID。
request_date	request_date	string	此付款的初始消息排队发送的时间戳。
收件人	recipient	string	付款收件人的姓名。如果联系人没有与其电话号码关联的姓名，则可能为 null。
描述	description	string	付款的说明。这不会向联系人显示。它仅由内部用户用于有关付款的上下文。
customer_phone	customer_phone	string	正在发送此付款的联系人的电话号码。
amount_requested	amount_requested	float	此付款请求的美元金额。
is_past_due	is_past_due	boolean	此付款是否超过请求日期。
reminder_was_sent	reminder_was_sent	boolean	是否已发送用于此付款的文本提醒。
transaction_status	transaction_status	string	身份验证中事务的状态。此值以“未知”开头。
textrequest_payment_status	textrequest_payment_status	string	文本请求中事务的状态。这表示“文本请求”应用付款页上显示的该状态。它以 Sent 开头。
reference_number	reference_number	string	创建可用于快速查找付款的付款时定义的用户定义的 ID。引用编号不唯一;许多付款可以具有相同的参考。

创建新组

操作 ID:: CreateGroup

使用提供的名称创建新组。

参数

名称	密钥	必需	类型	说明
要对此调用的仪表板的 ID	dashboard_id	True	integer	要使用的电话号码仪表板。单个帐户可以有多个仪表板，表示客户的不同电话线路。
组名称	name		string	组的新名称。
组注释	notes		string	描述组的短语。用于方便。

名称	路径	类型	说明
id	id	integer	组的数字 ID。
group_member_count	group_member_count	integer	组的成员数。
is_keyword	is_keyword	boolean	Wheter 此组是关键字组。当用户设置关键字时，会自动生成此类组。联系人在注册时会自动添加。
姓名	name	string	此组的名称。
笔记	notes	string	此组上的任何注释。
last_message_sent_utc	last_message_sent_utc	string	为此组发送最后一封组消息的时间戳。

删除具有指定 ID 的组

操作 ID:: DeleteGroup

删除具有指定 ID 的组。即使有属于组成员的联系人（不会删除联系人），也会成功。

参数

名称	密钥	必需	类型	说明
要对此调用的仪表板的 ID	dashboard_id	True	integer	要使用的电话号码仪表板。单个帐户可以有多个仪表板，表示客户的不同电话线路。
组的 ID	group_id	True	integer	要删除的组的数字 ID。

response: string

删除具有指定电话号码的联系人

操作 ID:: DeleteContact

删除具有指定电话号码的联系人

参数

名称	密钥	必需	类型	说明
要对此调用的仪表板的 ID	dashboard_id	True	integer	要使用的电话号码仪表板。单个帐户可以有多个仪表板，表示客户的不同电话线路。
联系人电话号码	phone_number	True	string	要删除的联系人的电话号码。

response: string

删除指定的仪表板

操作 ID:: DeleteDashboard

删除指定的仪表板。

参数

名称	密钥	必需	类型	说明
要对此调用的仪表板的 ID	dashboard_id	True	integer	要使用的电话号码仪表板。单个帐户可以有多个仪表板，表示客户的不同电话线路。

response: string

发送后续文本，提醒用户支付指定的付款

操作 ID:: SendPaymentReminder

向联系人发送提醒以支付指定的付款。自动生成消息的内容。为了避免垃圾邮件，每个付款只能发送一个提醒

参数

名称	密钥	必需	类型	说明
要对此调用的仪表板的 ID	dashboard_id	True	integer	要使用的电话号码仪表板。单个帐户可以有多个仪表板，表示客户的不同电话线路。
付款的 ID	payment_id	True	integer	要更新的付款的数字 ID。

名称	路径	类型	说明
payment_id	payment_id	integer	付款的数字 ID。
request_date	request_date	string	此付款的初始消息排队发送的时间戳。
收件人	recipient	string	付款收件人的姓名。如果联系人没有与其电话号码关联的姓名，则可能为 null。
描述	description	string	付款的说明。这不会向联系人显示。它仅由内部用户用于有关付款的上下文。
customer_phone	customer_phone	string	正在发送此付款的联系人的电话号码。
amount_requested	amount_requested	float	此付款请求的美元金额。
is_past_due	is_past_due	boolean	此付款是否超过请求日期。
reminder_was_sent	reminder_was_sent	boolean	是否已发送用于此付款的文本提醒。
transaction_status	transaction_status	string	身份验证中事务的状态。此值以“未知”开头。
textrequest_payment_status	textrequest_payment_status	string	文本请求中事务的状态。这表示“文本请求”应用付款页上显示的该状态。它以 Sent 开头。
reference_number	reference_number	string	创建可用于快速查找付款的付款时定义的用户定义的 ID。引用编号不唯一;许多付款可以具有相同的参考。

取消对话存档

操作 ID:: UnarchiveConversation

取消存档对话。一旦对话处于未存档状态，它将再次出现在队列中。它还将显示在 /conversations 终结点返回的对话中。如果对话已未存档，则此方法不起作用。

参数

名称	密钥	必需	类型	说明
要对此调用的仪表板的 ID	dashboard_id	True	integer	要使用的电话号码仪表板。单个帐户可以有多个仪表板，表示客户的不同电话线路。
聊天电话号码	phone_number	True	string	要存档的对话的电话号码。

response: string

取消指定的付款

操作 ID:: CancelPayment

取消指定的付款，向用户发短信指出已取消付款。无法编辑付款，因此取消和发放新付款是更正付款的最佳方式。

参数

名称	密钥	必需	类型	说明
要对此调用的仪表板的 ID	dashboard_id	True	integer	要使用的电话号码仪表板。单个帐户可以有多个仪表板，表示客户的不同电话线路。
付款的 ID	payment_id	True	integer	要更新的付款的数字 ID。

名称	路径	类型	说明
payment_id	payment_id	integer	付款的数字 ID。
request_date	request_date	string	此付款的初始消息排队发送的时间戳。
收件人	recipient	string	付款收件人的姓名。如果联系人没有与其电话号码关联的姓名，则可能为 null。
描述	description	string	付款的说明。这不会向联系人显示。它仅由内部用户用于有关付款的上下文。
customer_phone	customer_phone	string	正在发送此付款的联系人的电话号码。
amount_requested	amount_requested	float	此付款请求的美元金额。
is_past_due	is_past_due	boolean	此付款是否超过请求日期。
reminder_was_sent	reminder_was_sent	boolean	是否已发送用于此付款的文本提醒。
transaction_status	transaction_status	string	身份验证中事务的状态。此值以“未知”开头。
textrequest_payment_status	textrequest_payment_status	string	文本请求中事务的状态。这表示“文本请求”应用付款页上显示的该状态。它以 Sent 开头。
reference_number	reference_number	string	创建可用于快速查找付款的付款时定义的用户定义的 ID。引用编号不唯一;许多付款可以具有相同的参考。

向具有给定电话号码的联系人发送消息

操作 ID:: SendMessageByPhoneNumber

发送消息（如果给定的电话号码没有消息历史记录，则启动新对话）。

参数

名称	密钥	必需	类型	说明
要对此调用的仪表板的 ID	dashboard_id	True	integer	要使用的电话号码仪表板。单个帐户可以有多个仪表板，表示客户的不同电话线路。
电话号码到邮件	phone_number	True	string	要向其发送消息的联系人的电话号码。
邮件正文	body		string	要发送的消息的内容。
发送方的名称	sender_name		string	邮件发件人的名称。检索此消息时，TextRequest Web 应用和 API 中会显示此消息。
消息状态更新时的回调 URL	status_callback		string	每当此消息的状态从未传递到发送（或错误）时，Web 应用的 URL 就会用 POST 命令命中。
如果此消息包含一个位置请求的回调 URL	location_callback		string	当用户访问并批准与发送方共享其位置时，要命中 POST 命令的位置回调 URL。若要包含链接，请将 [位置请求] 添加到消息正文。位置请求不需要此回调，但它对于 API 非常有用。
此邮件的 MMS 媒体附件	mms_media		array of string	此邮件的 MMS 媒体附件数组。附件必须是从 post /mms 终结点获取的 URL（此连接器中不包括）。将不接受外部附件链接。

名称	路径	类型	说明
message_id	message_id	string	消息的 ID。此值对于每条消息都是唯一的。
身体	body	string	此消息的内容。
message_direction	message_direction	string	单一字符（R 或 S）表示是从联系人接收此消息还是分别发送给他们。
response_by_username	response_by_username	string	上次向此用户发送消息的文本请求用户的用户名。
message_timestamp_utc	message_timestamp_utc	string	文本请求发送或接收消息的时间戳。
delivery_status	delivery_status	string	此消息的当前状态。这可以是“send”、“delivered”、“error”或“send”。
delivery_error	delivery_error	string	导致无法传递此消息的错误。如果delivery_status不是“error”，则此值将为 null。
mms_media	mms_media	array of string	指向此邮件附件的 URL 列表。所有 URL 都是文本请求生成的 URL。

存档对话

操作 ID:: ArchiveConversation

存档会话，将其从所有聊天检索终结点的结果中删除。如果客户向文本请求号码发送文本，或者向客户发送文本请求号码，则对话将自动取消存档。存档对话是删除你以后不打算与客户交谈的混乱的好方法。请注意，如果客户在“STOP”中发短信以防止发送任何进一步的短信，对话将自动存档。

参数

名称	密钥	必需	类型	说明
要对此调用的仪表板的 ID	dashboard_id	True	integer	要使用的电话号码仪表板。单个帐户可以有多个仪表板，表示客户的不同电话线路。
聊天电话号码	phone_number	True	string	要存档的对话的电话号码。

response: string

将付款标记为已付款

操作 ID:: MarkPaymentPaid

将付款关闭为“已付款”。通过付款请求门户以外的方式支付付款时，请使用此终结点。这将关闭付款，并将其付款金额添加到统计信息中。通过文本请求发送的付款门户付款不需要此终结点;自动将付款标记为已付款。

参数

名称	密钥	必需	类型	说明
要对此调用的仪表板的 ID	dashboard_id	True	integer	要使用的电话号码仪表板。单个帐户可以有多个仪表板，表示客户的不同电话线路。
付款的 ID	payment_id	True	integer	要更新的付款的数字 ID。

名称	路径	类型	说明
payment_id	payment_id	integer	付款的数字 ID。
request_date	request_date	string	此付款的初始消息排队发送的时间戳。
收件人	recipient	string	付款收件人的姓名。如果联系人没有与其电话号码关联的姓名，则可能为 null。
描述	description	string	付款的说明。这不会向联系人显示。它仅由内部用户用于有关付款的上下文。
customer_phone	customer_phone	string	正在发送此付款的联系人的电话号码。
amount_requested	amount_requested	float	此付款请求的美元金额。
is_past_due	is_past_due	boolean	此付款是否超过请求日期。
reminder_was_sent	reminder_was_sent	boolean	是否已发送用于此付款的文本提醒。
transaction_status	transaction_status	string	身份验证中事务的状态。此值以“未知”开头。
textrequest_payment_status	textrequest_payment_status	string	文本请求中事务的状态。这表示“文本请求”应用付款页上显示的该状态。它以 Sent 开头。
reference_number	reference_number	string	创建可用于快速查找付款的付款时定义的用户定义的 ID。引用编号不唯一;许多付款可以具有相同的参考。

批量更新联系人

操作 ID:: BulkUpdateContacts

只有指定的仪表板才会添加联系人;联系人按仪表板进行组织，没有可用号码的帐户级别搜索。

参数

名称	密钥	必需	类型	说明
要对此调用的仪表板的 ID	dashboard_id	True	integer	要使用的电话号码仪表板。单个帐户可以有多个仪表板，表示客户的不同电话线路。
联系人电话号码	phone_number		string	要创建或更新的联系人的电话号码。
联系人的名字	first_name		string	联系人的新名字。
联系人的姓氏	last_name		string	联系人的新姓氏。
联系人全名	display_name		string	联系人的新全名。这是查看联系人时 Web 应用中显示的默认名称。
是否禁止来自此联系人的邮件	is_suppressed		boolean	确定是否取消与此联系人的对话，因此在收到消息队列时不会推送到消息队列的顶部。
此联系人的邮件是否已存档	is_archived		boolean	确定与此联系人的对话是否存档，因此在查询对话时（默认情况下）无法看到。
是否阻止来自此联系人的邮件	is_blocked		boolean	确定是否阻止与此联系人的对话，因此不会收到或存储。
取消此联系人的原因	suppressed_reason		string	描述禁止联系人的原因的短语。
联系人说明	note		string	描述联系人的简短短语。用于方便。这永远不会显示给联系人。
联系人组	groups		array of integer	引用此联系人所属组的整数 ID 数组。
联系人标记	contact_tags		array of string	引用附加到此联系人的标记的 guid 数组。
自定义字段 ID	id		string	引用自定义域的 Guid。
自定义字段值	value		string	此联系人对此自定义字段的值。
是否已解决与此联系人的当前对话	is_resolved		boolean	确定是否已解决与此联系人的当前对话。此联系人收到的任何新文本都将设置此 false。

名称	路径	类型	说明
		array of object
phone_number	phone_number	string	此联系人的电话号码。
first_name	first_name	string	此联系人的名字。
last_name	last_name	string	此联系人的姓氏。
display_name	display_name	string	此联系人的全名。这是查看联系人时 Web 应用中显示的默认名称。
is_suppressed	is_suppressed	boolean	是否取消与此联系人的对话，因此在收到消息队列时不会推送到消息队列的顶部。
is_archived	is_archived	boolean	是否存档与此联系人的对话，因此在查询对话时（默认情况下）无法看到。
is_blocked	is_blocked	boolean	是否阻止了与此联系人的对话，因此不会收到或存储。
suppressed_reason	suppressed_reason	string	描述禁止联系人的原因的短语。如果is_suppressed为 false，则为 null。
注意	note	string	描述联系人的简短短语。用于方便。这永远不会显示给联系人。
groups	groups	array of integer	引用此联系人所属组的整数 ID 数组。
contact_tags	contact_tags	array of string	引用附加到此联系人的标记的 guid 数组。
custom_fields	custom_fields	array of object	为此联系人定义的自定义字段 ID 和值数组。
id	custom_fields.id	string	引用自定义域的 Guid。
value	custom_fields.value	string	此联系人对此自定义字段的值。
is_resolved	is_resolved	boolean	是否解决与此联系人的对话。此联系人收到的任何新文本都将设置此 false。
first_contact_utc	first_contact_utc	string	发送到此联系人的第一封邮件的时间戳。
opted_out_utc	opted_out_utc	string	此联系人选择退出接收消息的时间戳。
last_msg_sent_utc	last_msg_sent_utc	string	发送到此联系人的最后一条消息的时间戳。
last_msg_received_utc	last_msg_received_utc	string	从此联系人收到最后一条消息的时间戳。
total_msgs_sent	total_msgs_sent	integer	发送到此联系人的邮件总数。
total_msgs_received	total_msgs_received	integer	从此联系人收到的邮件总数。
response_count	response_count	integer	来自联系人的响应消息总数。
date_created_utc	date_created_utc	string	创建联系人时的时间戳。
last_contact_date_utc	last_contact_date_utc	string	从此联系人发送或接收最后一条消息的时间戳。
message_id	last_message.message_id	string	消息的 ID。此值对于每条消息都是唯一的。
身体	last_message.body	string	此消息的内容。
message_direction	last_message.message_direction	string	单一字符（R 或 S）表示是从联系人接收此消息还是分别发送给他们。
response_by_username	last_message.response_by_username	string	上次向此用户发送消息的文本请求用户的用户名。
message_timestamp_utc	last_message.message_timestamp_utc	string	文本请求发送或接收消息的时间戳。
delivery_status	last_message.delivery_status	string	此消息的当前状态。这可以是“send”、“delivered”、“error”或“send”。
delivery_error	last_message.delivery_error	string	导致无法传递此消息的错误。如果delivery_status不是“error”，则此值将为 null。
mms_media	last_message.mms_media	array of string	指向此邮件附件的 URL 列表。所有 URL 都是文本请求生成的 URL。

按组 ID 获取组

操作 ID:: GetGroupById

获取具有指定 ID 的组。

参数

名称	密钥	必需	类型	说明
要对此调用的仪表板的 ID	dashboard_id	True	integer	要使用的电话号码仪表板。单个帐户可以有多个仪表板，表示客户的不同电话线路。
组的 ID	group_id	True	integer	要获取的组的数字 ID。

名称	路径	类型	说明
id	id	integer	组的数字 ID。
group_member_count	group_member_count	integer	组的成员数。
is_keyword	is_keyword	boolean	Wheter 此组是关键字组。当用户设置关键字时，会自动生成此类组。联系人在注册时会自动添加。
姓名	name	string	此组的名称。
笔记	notes	string	此组上的任何注释。
last_message_sent_utc	last_message_sent_utc	string	为此组发送最后一封组消息的时间戳。

更新特定仪表板的名称

操作 ID:: UpdateDashboardsName

更新仪表板。这不会更改仪表板的电话号码。如果想要具有另一个仪表板联系人的新号码，则必须使用 POST 创建新仪表板，并使用批量导出/导入添加联系人。

参数

名称	密钥	必需	类型	说明
要对此调用的仪表板的 ID	dashboard_id	True	integer	要使用的电话号码仪表板。单个帐户可以有多个仪表板，表示客户的不同电话线路。
仪表板名称	name		string	仪表板的新名称。

名称	路径	类型	说明
id	id	integer	仪表板的数字 ID。
姓名	name	string	仪表板的名称。
phone	phone	string	与此仪表板关联的文本编号。

获取与指定筛选条件匹配的所有联系人

操作 ID:: GetContacts

获取与指定筛选条件匹配的所有联系人。仅搜索指定的仪表板;没有可用的号码的帐户级别搜索。

参数

名称	密钥	必需	类型	说明
要搜索的联系人电话号码	contact_phone_number		string	要按其筛选联系人的电话号码。
“上次发送之前的消息时间”搜索时间戳（UTC 时间）	last_message_timestamp_before_utc		date-time	最后一封已发送或接收的邮件搜索联系人的截止时间。此时不会显示发送消息的联系人。
以 UTC 时间表示的搜索时间戳“发送后的最后一条消息时间”	last_message_timestamp_after_utc		date-time	最后一封已发送或接收的邮件搜索联系人的截止时间。此时不会显示最后一封已发送邮件的联系人。
“创建之前”搜索时间戳	contact_created_before		date-time	创建联系人时搜索联系人的截止时间。此时间后不会显示任何联系人。
“创建后”搜索时间戳	contact_created_after		date-time	创建联系人时搜索联系人的截止时间。此时不会显示之前创建的联系人。
是否已解决联系人的对话	is_resolved		boolean	是否搜索已解决其对话的联系人。
是否已阻止联系人	is_blocked		boolean	是否搜索已被阻止的联系人。
联系人是否已存档	is_archived		boolean	是否搜索已存档的联系人。
是否禁止联系人	is_suppressed		boolean	是否搜索已被禁止的联系人。
联系人是否已选择退出	has_opted_out		boolean	是否搜索已选择不接收短信的联系人。
搜索时间戳“之前发送的最后一条消息时间”	last_message_sent_before		date-time	在向客户发送最后一条消息时搜索联系人的截止时间。此时不会显示发送消息的联系人。使用时间戳作为本地时间。若要按 UTC 时间中的时间戳进行筛选，请使用last_message_sent_before_utc
搜索时间戳“发送后的最后一条消息时间”	last_message_sent_after		date-time	在向客户发送最后一条消息时搜索联系人的截止时间。此时不会显示最后一封已发送邮件的联系人。使用时间戳作为本地时间。若要按 UTC 时间中的时间戳进行筛选，请使用last_message_sent_after_utc
搜索时间戳“之前收到的上次消息时间”	last_message_received_before		date-time	最后一封从客户收到的邮件搜索联系人的截止时间。此时不会显示收到消息的联系人。使用时间戳作为本地时间。若要按 UTC 时间中的时间戳进行筛选，请使用last_message_sent_before_utc
搜索时间戳后收到的“上次消息时间”	last_message_received_after		date-time	最后一封从客户收到的邮件搜索联系人的截止时间。此时不会显示最后一封已发送邮件的联系人。使用时间戳作为本地时间。若要按 UTC 时间中的时间戳进行筛选，请使用last_message_sent_before_utc
联系人标记	tags		string	引用标记以筛选联系人的逗号分隔的 guid 列表。
联系人组	groups		string	引用要筛选联系人的组的整数 ID 的逗号分隔列表。
要筛选的自定义域的 ID	custom_field_id_1		string	引用自定义字段来筛选联系人的 Guid。
要筛选依据的自定义字段的值	custom_field_value_1		string	引用用于筛选联系人的自定义字段的值。
要筛选依据的第二个自定义域的 ID	custom_field_id_2		string	Guid 引用第二个自定义字段来筛选联系人。
要筛选依据的第二个自定义域的值	custom_field_value_2		string	引用第二个用于筛选联系人的自定义字段的值。
要筛选依据的第三个自定义域的 ID	custom_field_id_3		string	引用第三个自定义字段的 Guid 来筛选联系人。
要筛选依据的第三个自定义域的值	custom_field_value_3		string	引用第三个用于筛选联系人的自定义字段的值。
要获取的编号页	page	True	integer	要获取的实体页。获取值时，每个页面的最大大小由page_size定义。如果页面大于最后一页，将返回空数组。
每页要获取的每个实体的数量	page_size	True	integer	要获取的每个页面的大小。获取值时，这是每页的最大大小，访问页面参数完成的后续页面。
要对此调用的仪表板的 ID	dashboard_id	True	integer	要使用的电话号码仪表板。单个帐户可以有多个仪表板，表示客户的不同电话线路。

名称	路径	类型	说明
页面	meta.page	integer	实体页已获取。此页中的实体量由page_size定义。
page_size	meta.page_size	integer	此页面中获取的实体数。
total_items	meta.total_items	integer	数据库中可用的实体数，无论页大小或数字如何。若要查看其他页面，请更改请求中的页码。
items	items	array of object	从文本请求获取的联系人实体列表。
phone_number	items.phone_number	string	此联系人的电话号码。
first_name	items.first_name	string	此联系人的名字。
last_name	items.last_name	string	此联系人的姓氏。
display_name	items.display_name	string	此联系人的全名。这是查看联系人时 Web 应用中显示的默认名称。
is_suppressed	items.is_suppressed	boolean	是否取消与此联系人的对话，因此在收到消息队列时不会推送到消息队列的顶部。
is_archived	items.is_archived	boolean	是否存档与此联系人的对话，因此在查询对话时（默认情况下）无法看到。
is_blocked	items.is_blocked	boolean	是否阻止了与此联系人的对话，因此不会收到或存储。
suppressed_reason	items.suppressed_reason	string	描述禁止联系人的原因的短语。如果is_suppressed为 false，则为 null。
注意	items.note	string	描述联系人的简短短语。用于方便。这永远不会显示给联系人。
groups	items.groups	array of integer	引用此联系人所属组的整数 ID 数组。
contact_tags	items.contact_tags	array of string	引用附加到此联系人的标记的 guid 数组。
custom_fields	items.custom_fields	array of object	为此联系人定义的自定义字段 ID 和值数组。
id	items.custom_fields.id	string	引用自定义域的 Guid。
value	items.custom_fields.value	string	此联系人对此自定义字段的值。
is_resolved	items.is_resolved	boolean	是否解决与此联系人的对话。此联系人收到的任何新文本都将设置此 false。
first_contact_utc	items.first_contact_utc	string	发送到此联系人的第一封邮件的时间戳。
opted_out_utc	items.opted_out_utc	string	此联系人选择退出接收消息的时间戳。
last_msg_sent_utc	items.last_msg_sent_utc	string	发送到此联系人的最后一条消息的时间戳。
last_msg_received_utc	items.last_msg_received_utc	string	从此联系人收到最后一条消息的时间戳。
total_msgs_sent	items.total_msgs_sent	integer	发送到此联系人的邮件总数。
total_msgs_received	items.total_msgs_received	integer	从此联系人收到的邮件总数。
response_count	items.response_count	integer	来自联系人的响应消息总数。
date_created_utc	items.date_created_utc	string	创建联系人时的时间戳。
last_contact_date_utc	items.last_contact_date_utc	string	从此联系人发送或接收最后一条消息的时间戳。
message_id	items.last_message.message_id	string	消息的 ID。此值对于每条消息都是唯一的。
身体	items.last_message.body	string	此消息的内容。
message_direction	items.last_message.message_direction	string	单一字符（R 或 S）表示是从联系人接收此消息还是分别发送给他们。
response_by_username	items.last_message.response_by_username	string	上次向此用户发送消息的文本请求用户的用户名。
message_timestamp_utc	items.last_message.message_timestamp_utc	string	文本请求发送或接收消息的时间戳。
delivery_status	items.last_message.delivery_status	string	此消息的当前状态。这可以是“send”、“delivered”、“error”或“send”。
delivery_error	items.last_message.delivery_error	string	导致无法传递此消息的错误。如果delivery_status不是“error”，则此值将为 null。
mms_media	items.last_message.mms_media	array of string	指向此邮件附件的 URL 列表。所有 URL 都是文本请求生成的 URL。

获取具有指定 ID 的付款

操作 ID:: GetPayment

获取具有指定 ID 的付款。

参数

名称	密钥	必需	类型	说明
要对此调用的仪表板的 ID	dashboard_id	True	integer	要使用的电话号码仪表板。单个帐户可以有多个仪表板，表示客户的不同电话线路。
付款的 ID	payment_id	True	integer	要获取的付款的数字 ID。

名称	路径	类型	说明
payment_id	payment_id	integer	付款的数字 ID。
request_date	request_date	string	此付款的初始消息排队发送的时间戳。
收件人	recipient	string	付款收件人的姓名。如果联系人没有与其电话号码关联的姓名，则可能为 null。
描述	description	string	付款的说明。这不会向联系人显示。它仅由内部用户用于有关付款的上下文。
customer_phone	customer_phone	string	正在发送此付款的联系人的电话号码。
amount_requested	amount_requested	float	此付款请求的美元金额。
is_past_due	is_past_due	boolean	此付款是否超过请求日期。
reminder_was_sent	reminder_was_sent	boolean	是否已发送用于此付款的文本提醒。
transaction_status	transaction_status	string	身份验证中事务的状态。此值以“未知”开头。
textrequest_payment_status	textrequest_payment_status	string	文本请求中事务的状态。这表示“文本请求”应用付款页上显示的该状态。它以 Sent 开头。
reference_number	reference_number	string	创建可用于快速查找付款的付款时定义的用户定义的 ID。引用编号不唯一;许多付款可以具有相同的参考。

获取具有指定电话号码的联系人

操作 ID:: GetContactByPhoneNumber

获取具有指定电话号码的联系人

参数

名称	密钥	必需	类型	说明
要对此调用的仪表板的 ID	dashboard_id	True	integer	要使用的电话号码仪表板。单个帐户可以有多个仪表板，表示客户的不同电话线路。
联系人的电话号码	phone_number	True	string	要获取的联系人的电话号码。

名称	路径	类型	说明
phone_number	phone_number	string	此联系人的电话号码。
first_name	first_name	string	此联系人的名字。
last_name	last_name	string	此联系人的姓氏。
display_name	display_name	string	此联系人的全名。这是查看联系人时 Web 应用中显示的默认名称。
is_suppressed	is_suppressed	boolean	是否取消与此联系人的对话，因此在收到消息队列时不会推送到消息队列的顶部。
is_archived	is_archived	boolean	是否存档与此联系人的对话，因此在查询对话时（默认情况下）无法看到。
is_blocked	is_blocked	boolean	是否阻止了与此联系人的对话，因此不会收到或存储。
suppressed_reason	suppressed_reason	string	描述禁止联系人的原因的短语。如果is_suppressed为 false，则为 null。
注意	note	string	描述联系人的简短短语。用于方便。这永远不会显示给联系人。
groups	groups	array of integer	引用此联系人所属组的整数 ID 数组。
contact_tags	contact_tags	array of string	引用附加到此联系人的标记的 guid 数组。
custom_fields	custom_fields	array of object	为此联系人定义的自定义字段 ID 和值数组。
id	custom_fields.id	string	引用自定义域的 Guid。
value	custom_fields.value	string	此联系人对此自定义字段的值。
is_resolved	is_resolved	boolean	是否解决与此联系人的对话。此联系人收到的任何新文本都将设置此 false。
first_contact_utc	first_contact_utc	string	发送到此联系人的第一封邮件的时间戳。
opted_out_utc	opted_out_utc	string	此联系人选择退出接收消息的时间戳。
last_msg_sent_utc	last_msg_sent_utc	string	发送到此联系人的最后一条消息的时间戳。
last_msg_received_utc	last_msg_received_utc	string	从此联系人收到最后一条消息的时间戳。
total_msgs_sent	total_msgs_sent	integer	发送到此联系人的邮件总数。
total_msgs_received	total_msgs_received	integer	从此联系人收到的邮件总数。
response_count	response_count	integer	联系人的响应消息总数。
date_created_utc	date_created_utc	string	创建联系人时的时间戳。
last_contact_date_utc	last_contact_date_utc	string	从此联系人发送或接收最后一封邮件的时间戳。
message_id	last_message.message_id	string	消息的 ID。此值对于每条消息都是唯一的。
身体	last_message.body	string	此消息的内容。
message_direction	last_message.message_direction	string	单一字符（R 或 S）表示是从联系人接收此消息还是分别发送给他们。
response_by_username	last_message.response_by_username	string	上次向此用户发送消息的文本请求用户的用户名。
message_timestamp_utc	last_message.message_timestamp_utc	string	文本请求发送或接收消息的时间戳。
delivery_status	last_message.delivery_status	string	此消息的当前状态。这可以是“send”、“delivered”、“error”或“send”。
delivery_error	last_message.delivery_error	string	导致无法传递此消息的错误。如果delivery_status不是“error”，则此值将为 null。
mms_media	last_message.mms_media	array of string	指向此邮件附件的 URL 列表。所有 URL 都是文本请求生成的 URL。

获取帐户中的所有仪表板

操作 ID:: GetDashboards

获取帐户中的所有仪表板。

参数

名称	密钥	必需	类型	说明
要获取的编号页	page		integer	要获取的实体页。获取值时，每个页面的最大大小由page_size定义。如果页面大于最后一页，将返回空数组。
每页要获取的每个实体的数量	page_size		integer	要获取的每个页面的大小。获取值时，这是每页的最大大小，访问页面参数完成的后续页面。

名称	路径	类型	说明
页面	meta.page	integer	实体页已获取。此页中的实体量由page_size定义。
page_size	meta.page_size	integer	此页面中获取的实体数。
total_items	meta.total_items	integer	数据库中可用的实体数，无论页大小或数字如何。若要查看其他页面，请更改请求中的页码。
items	items	array of object	从文本请求获取的仪表板实体列表。
id	items.id	integer	仪表板的数字 ID。
姓名	items.name	string	仪表板的名称。
phone	items.phone	string	与此仪表板关联的文本编号。

获取所有付款

操作 ID:: GetPayments

获取所有付款，包括已取消付款和已付款。可以使用查询参数筛选这些参数。

参数

名称	密钥	必需	类型	说明
付款的引用字符串	reference_number		string	创建可用于快速查找付款的付款时定义的用户定义的 ID。引用编号不唯一;许多付款可以具有相同的参考。
付款电话号码	phone_number		string	此付款发送到的联系人的电话号码。
排序依据	sort_type		string	要按其排序付款的属性。可以是“amount”、“contact”、“date”、“status”。
排序方向	sort_direction		string	按方向对付款进行排序。可以是“desc”，可以是最大到小到小，也可以是“asc”。
要获取的编号页	page	True	integer	要获取的实体页。获取值时，每个页面的最大大小由page_size定义。如果页面大于最后一页，将返回空数组。
每页要获取的每个实体的数量	page_size	True	integer	要获取的每个页面的大小。获取值时，这是每页的最大大小，访问页面参数完成的后续页面。
要对此调用的仪表板的 ID	dashboard_id	True	integer	要使用的电话号码仪表板。单个帐户可以有多个仪表板，表示客户的不同电话线路。

名称	路径	类型	说明
页面	meta.page	integer	实体页已获取。此页中的实体量由page_size定义。
page_size	meta.page_size	integer	此页面中获取的实体数。
total_items	meta.total_items	integer	数据库中可用的实体数，无论页大小或数字如何。若要查看其他页面，请更改请求中的页码。
items	items	array of object	从文本请求获取的付款实体列表。
payment_id	items.payment_id	integer	付款的数字 ID。
request_date	items.request_date	string	此付款的初始消息排队发送的时间戳。
收件人	items.recipient	string	付款收件人的姓名。如果联系人没有与其电话号码关联的姓名，则可能为 null。
描述	items.description	string	付款的说明。这不会向联系人显示。它仅由内部用户用于有关付款的上下文。
customer_phone	items.customer_phone	string	正在发送此付款的联系人的电话号码。
amount_requested	items.amount_requested	float	此付款请求的美元金额。
is_past_due	items.is_past_due	boolean	此付款是否超过请求日期。
reminder_was_sent	items.reminder_was_sent	boolean	是否已发送用于此付款的文本提醒。
transaction_status	items.transaction_status	string	身份验证中事务的状态。此值以“未知”开头。
textrequest_payment_status	items.textrequest_payment_status	string	文本请求中事务的状态。这表示“文本请求”应用付款页上显示的该状态。它以 Sent 开头。
reference_number	items.reference_number	string	创建可用于快速查找付款的付款时定义的用户定义的 ID。引用编号不唯一;许多付款可以具有相同的参考。

获取所有标记

操作 ID:: GetTags

获取此仪表板的所有标记。标记在仪表板之间是唯一的。

参数

名称	密钥	必需	类型	说明
要对此调用的仪表板的 ID	dashboard_id	True	integer	要使用的电话号码仪表板。单个帐户可以有多个仪表板，表示客户的不同电话线路。
要获取的编号页	page	True	integer	要获取的实体页。获取值时，每个页面的最大大小由page_size定义。如果页面大于最后一页，将返回空数组。
每页要获取的每个实体的数量	page_size	True	integer	要获取的每个页面的大小。获取值时，这是每页的最大大小，访问页面参数完成的后续页面。

名称	路径	类型	说明
页面	meta.page	integer	实体页已获取。此页中的实体量由page_size定义。
page_size	meta.page_size	integer	此页面中获取的实体数。
total_items	meta.total_items	integer	数据库中可用的实体数，无论页大小或数字如何。若要查看其他页面，请更改请求中的页码。
items	items	array of object	从文本请求获取的标记实体列表。
id	items.id	string	标记的数字 ID。
tag_color	items.tag_color	string	标记的颜色。这应该是有效的十六进制颜色代码。
标签	items.tag	string	标签的名称。

获取所有组

操作 ID:: GetGroups

获取用户帐户的所有组。

参数

名称	密钥	必需	类型	说明
要获取的编号页	page	True	integer	要获取的实体页。获取值时，每个页面的最大大小由page_size定义。如果页面大于最后一页，将返回空数组。
每页要获取的每个实体的数量	page_size	True	integer	要获取的每个页面的大小。获取值时，这是每页的最大大小，访问页面参数完成的后续页面。
要对此调用的仪表板的 ID	dashboard_id	True	integer	要使用的电话号码仪表板。单个帐户可以有多个仪表板，表示客户的不同电话线路。

名称	路径	类型	说明
页面	meta.page	integer	实体页已获取。此页中的实体量由page_size定义。
page_size	meta.page_size	integer	此页面中获取的实体数。
total_items	meta.total_items	integer	数据库中可用的实体数，无论页大小或数字如何。若要查看其他页面，请更改请求中的页码。
items	items	array of object	从文本请求获取的组实体列表。
id	items.id	integer	组的数字 ID。
group_member_count	items.group_member_count	integer	组的成员数。
is_keyword	items.is_keyword	boolean	Wheter 此组是关键字组。当用户设置关键字时，会自动生成此类组。联系人在注册时会自动添加。
姓名	items.name	string	此组的名称。
笔记	items.notes	string	此组上的任何注释。
last_message_sent_utc	items.last_message_sent_utc	string	为此组发送最后一个组消息的时间戳。

获取所有自定义字段

操作 ID:: GetCustomFields

获取此仪表板的所有自定义字段。自定义字段在仪表板之间是唯一的。

参数

名称	密钥	必需	类型	说明
要对此调用的仪表板的 ID	dashboard_id	True	integer	要使用的电话号码仪表板。单个帐户可以有多个仪表板，表示客户的不同电话线路。

名称	路径	类型	说明
		array of object
id	id	string	字段的数字 ID。
姓名	name	string	自定义域的名称。

获取有关此特定仪表板的信息

操作 ID:: GetDashboard

返回仪表板的名称和电话。

参数

名称	密钥	必需	类型	说明
要对此调用的仪表板的 ID	dashboard_id	True	integer	要使用的电话号码仪表板。单个帐户可以有多个仪表板，表示客户的不同电话线路。

名称	路径	类型	说明
id	id	integer	仪表板的数字 ID。
姓名	name	string	仪表板的名称。
phone	phone	string	与此仪表板关联的文本编号。

获取此仪表板的所有对话

操作 ID:: GetConversations

获取此仪表板的所有对话，并包括有关每个对话的最后一条消息的信息。

参数

名称	密钥	必需	类型	说明
联系人标记	tags		string	引用标记以筛选对话的逗号分隔的 guid 列表。
是否仅显示已解析的对话	show_unresolved_only		string	是否仅搜索已解决其对话的联系人。如果为 false，则会显示已解决和未解析的对话。
是否包含存档对话	include_archived		string	是否包含与已存档的联系人的对话。
要按电话号码和联系人姓名进行筛选的术语	search		string	用于按电话号码或显示名称筛选对话的搜索词。如果搜索词小于全名或电话号码，搜索将返回部分匹配的所有对话。
要获取的编号页	page		integer	要获取的实体页。获取值时，每个页面的最大大小由page_size定义。如果页面大于最后一页，将返回空数组。
每页要获取的每个实体的数量	page_size		integer	要获取的每个页面的大小。获取值时，这是每页的最大大小，访问页面参数完成的后续页面。
要对此调用的仪表板的 ID	dashboard_id	True	integer	要使用的电话号码仪表板。单个帐户可以有多个仪表板，表示客户的不同电话线路。

名称	路径	类型	说明
页面	meta.page	integer	实体页已获取。此页中的实体量由page_size定义。
page_size	meta.page_size	integer	此页面中获取的实体数。
total_items	meta.total_items	integer	数据库中可用的实体数，无论页大小或数字如何。若要查看其他页面，请更改请求中的页码。
items	items	array of object	从文本请求获取的对话实体列表。
phone_number	items.phone_number	string	联系人的电话号码。
message_id	items.last_message.message_id	string	消息的 ID。此值对于每条消息都是唯一的。
身体	items.last_message.body	string	此消息的内容。
message_direction	items.last_message.message_direction	string	单一字符（R 或 S）表示是从联系人接收此消息还是分别发送给他们。
response_by_username	items.last_message.response_by_username	string	上次向此用户发送消息的文本请求用户的用户名。
message_timestamp_utc	items.last_message.message_timestamp_utc	string	文本请求发送或接收消息的时间戳。
delivery_status	items.last_message.delivery_status	string	此消息的当前状态。这可以是“send”、“delivered”、“error”或“send”。
delivery_error	items.last_message.delivery_error	string	导致无法传递此消息的错误。如果delivery_status不是“error”，则此值将为 null。
mms_media	items.last_message.mms_media	array of string	指向此邮件附件的 URL 列表。所有 URL 都是文本请求生成的 URL。

通过联系人的电话号码获取对话的消息

操作 ID:: GetMessagesByContactPhone

获取指定仪表板和电话号码之间的对话。

参数

名称	密钥	必需	类型	说明
要获取的编号页	page	True	integer	要获取的实体页。获取值时，每个页面的最大大小由page_size定义。如果页面大于最后一页，将返回空数组。
每页要获取的每个实体的数量	page_size	True	integer	要获取的每个页面的大小。获取值时，这是每页的最大大小，访问页面参数完成的后续页面。
要对此调用的仪表板的 ID	dashboard_id	True	integer	要使用的电话号码仪表板。单个帐户可以有多个仪表板，表示客户的不同电话线路。
要搜索的联系人电话号码	phone_number	True	string	要为其获取消息的联系人的电话号码。

名称	路径	类型	说明
页面	meta.page	integer	实体页已获取。此页中的实体量由page_size定义。
page_size	meta.page_size	integer	此页面中获取的实体数。
total_items	meta.total_items	integer	数据库中可用的实体数，无论页大小或数字如何。若要查看其他页面，请更改请求中的页码。
items	items	array of object	从文本请求获取的消息实体列表。
message_id	items.message_id	string	消息的 ID。此值对于每条消息都是唯一的。
身体	items.body	string	此消息的内容。
message_direction	items.message_direction	string	单一字符（R 或 S）表示是从联系人接收此消息还是分别发送给他们。
response_by_username	items.response_by_username	string	上次向此用户发送消息的文本请求用户的用户名。
message_timestamp_utc	items.message_timestamp_utc	string	文本请求发送或接收消息的时间戳。
delivery_status	items.delivery_status	string	此消息的当前状态。这可以是“send”、“delivered”、“error”或“send”。
delivery_error	items.delivery_error	string	导致无法传递此消息的错误。如果delivery_status不是“error”，则此值将为 null。
mms_media	items.mms_media	array of string	指向此邮件附件的 URL 列表。所有 URL 都是文本请求生成的 URL。

触发器

发送或接收文本时触发

操作 ID:: TextingWebhook

发送或接收文本时触发

参数

名称	密钥	必需	类型	说明
触发器将侦听来自的事件的仪表板	dashboard_id	True	string	要向其添加触发器的仪表板 ID
事件	event	True	string	事件

名称	路径	类型	说明
消息唯一 ID	messageUniqueIdentifier	string	messageUniqueIdentifier
账户 ID	account.id	integer	id
对话 ID	yourPhoneNumber.id	integer	id
仪表板名称	yourPhoneNumber.description	string	描述
仪表板电话号码	yourPhoneNumber.phoneNumber	string	电话号码
仪表板 ID	conversation.id	integer	id
date	conversation.date	string	date
联系人电话号码	conversation.consumerPhoneNumber	string	consumerPhoneNumber
messageDirection	conversation.messageDirection	string	messageDirection
消息	conversation.message	string	消息
numSegments	conversation.numSegments	integer	numSegments
状态	conversation.status	string	状态
对话声明者	conversation.claimedBy	string	claimedBy
联系人显示名称	conversation.consumerFriendlyName	string	consumerFriendlyName

定义

字符串

这是基本数据类型“string”。