按需服务DQ

DQ on Demand 是一个数据质量即服务（DQaaS）数据质量改进平台，旨在简化数据管理任务。

DQ on Demand 适用于那些不准备接受高质量数据的高成本的人，他们对不同级别的质量、冲突的规则和级别和数据治理感到沮丧。

计费是事务性的，即每个请求都将消耗额度，这些额度可以花在任何可用服务上。

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

服务	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	Support
URL	https://dqglobal.com/support
Email	support@dqglobal.com

连接器元数据
发布者	DQ Global
网站	https://www.dqglobal.com
隐私策略	https://www.dqglobal.com/privacy-policy
类别	Data

DQ on Demand 适用于那些不准备接受高质量数据的高成本的人，他们对不同级别的质量、冲突的规则和级别和数据治理感到沮丧。

先决条件

需要满足以下条件才能继续作：

具有高级连接器功能的 Microsoft Power Automate 计划
按需 DQ 帐户
客户端 ID 和客户端密码
服务的信用额度

如何获取凭据

注册新帐户。注册试用期后，将自动启动，你将获得少量的信用额度，以便你可以立即开始。

注册应用程序以获取客户端 ID 和客户端密码。

注意：请确保将重定向 URL 设置为： https://global.consent.azure-apim.net/redirect

限制

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

操作

Classify	识别有关一段数据的额外信息。例如，布赖恩或斯文是一个名字。路，斯特拉西，鲁是地址元素。有限责任公司是公司法律后缀。
Compare	使用可用算法之一在两个值之间评分相似性，包括：Levenshtein、Jaro、JaroWinkler 等...
Congruence Country	检查某个值是否来自预期的国家/地区。
Congruence Salutation	检查称呼是否与名称具有相同的性别。
Congruence 电子邮件	检查电子邮件地址是否与联系人详细信息匹配。
IsAllLower	检查值是否只包含小写字母。
IsAllUpper	检查值是否只包含大写字母。
IsAlphaNumeric	检查值是否由字母和/或数字组成。
IsISO2Code	检查值是否为有效的 ISO3166 Alpha-2 国家/地区代码。 I.GBP、UK、FR、ES 等。
IsISO3Code	检查值是否为有效的 ISO3166 Alpha-3 国家/地区代码。 I.E.GBR、USA、FRA 等。
IsISO4217CurrencyCode	检查值是否为有效的ISO4217代码。 I.E.GBP、USD、EUR 等。
IsMixedCase	检查值是否只包含大写字母和小写字母。
IsNumeric	检查值是否仅包含数字。
RemoveCharacters	从输入中删除指定的字符类型。
RemoveHTML	从输入中删除所有 HTML 标记。
RemoveLeading	从值的开头删除指定的字符串。
SearchAddress - 查找	返回可能的地址匹配项的列表。
SearchAddress - 检索	使用 Find 调用中的 ID 返回地址详细信息。
StartsWith	检查值是否以特定字符串开头。
Transform	以 5 种口语转换数据（缩写、详细、排除或规范化）。从 11 个不同的转换库中进行选择，包括：业务、国家/地区、名字和寻址...例如，缩写国家转型（英国到英国）。
ValidatePlus PostCode	检查 PostCode 的语法有效性。
ValidatePlus URL	检查 URL 的语法有效性。
ValidatePlus 电子邮件	检查电子邮件地址的语法有效性。
二进制到字符串	这会将二进制值转换为其等效字符串。
以...结尾	检查值是否以特定字符串结尾。
以类型开头	检查提供的值是否以所需的字符类型开头。
以类型结尾	检查提供的值是否以所需的字符类型结尾。
保留字符	这将用替换字符替换所提供的输入中的所有字符，但指定保留的字符除外。
分析 URL	将 URL 拆分为其组件部分：主机、方案、端口、路径。
分析电子邮件	将电子邮件拆分为其组件部分：MailBox、域、TLD/
分析电话	将 Phonenumber 拆分为其组件部分：国家/地区、号码、前缀、类型。
删除 StopWords	筛选出基本的英语停止单词，例如，关于，之后和更多。
删除单字符单词	从输入 I.E. `This is a test` 中删除所有单个字符->`This is test`
十六进制到字符串	将十六进制输入转换为其等效字符串。
取消电话 - 公司	检查公司/商务电话号码是否包含在抑制列表中，因此不应调用此类号码。注意：目前此终结点仅支持 `GB` 数据。
字符串到二进制	将字符串值转换为其二进制等效值。
字符串到十六进制	将字符串值转换为其等效的十六进制值。
对电子邮件进行身份验证	请真正确认电子邮件是否真实且将送达。
对电话进行身份验证	请真正确认你的电话号码是否真实，并会拨号。
序列转换	在单个请求中执行多个转换。例如;精心策划的数字和缩写地址。
得分	通过从大量记录评分选项中进行选择来对记录进行评分;自定义组权重，对不对齐的数据进行评分，并从各种数据特定的评分规则中进行选择。
折叠相邻的重复字符	如果最大重复数设置为 1，则单词 `Silly` 将减少 `Sily` 为 1，因为 `l` 重复一次。但是， `Silly` 如果最大重复数设置为 2，单词将保持不变，因为 `l` 不会多次重复。相反，无论 `Global` 重复的最大重复 `l` 次数如何，单词都将保持不变，但不会连续重复。
折叠相邻重复类型	检查并替换同一类型的重复相邻字符。即`Test$$££` ->`Test$£` 注意：$ 和 £ 都算作符号，但它们不是相同的字符，所以没有折叠。
提取字符	从字符串的开头或结尾提取给定数量的字符。
提取字词	从字符串的开头或结尾提取给定数量的单词。
替换 If EndsWith	如果找到的值将找到的值替换为指定的替换值，请检查提供的输入的末尾。
替换 If StartsWith	如果找到的值将找到的值替换为指定的替换值，请检查提供的输入的开始。
替换相邻重复文本	检查并替换重复的相邻字符。
案例	更改数据的大小写。
检索使用情况	检索给定时间范围内每个供应商函数的使用情况统计信息。注意：使用情况统计信息每 24 小时更新一次午夜 UTC 时间。
检索使用情况（V2）	检索给定时间段内每个供应商函数的使用情况统计信息，按使用应用程序进行细分。注意：使用情况统计信息每 24 小时更新一次午夜 UTC 时间。
检索函数定价	检索当前价目表。
检索当前余额	检索当前余额。
派生 CountryFromCity	检索提供地名的国家/地区列表。
派生 EmailType	派生域和邮箱类型。 I.E.is 业务电子邮件？还是个人电子邮件？
派生 FromPostalCode	返回与提供的邮政编码相关的信息，例如：纬度和经度。
派生国家/地区	从提供的数据派生国家/地区。
派生性别	使用名字派生某人的性别。
生成令牌	生成数据的拼音令牌。示例（使用 DQFonetix） Xerox = YQA， Xeroks = YQA
生成模式	生成数据的模式表示形式。即 `Example123` ->`Aaaaaaa999`
确保 EndsWith	检查值是否以所需的字符串结尾，如果该值未追加。
确保 StartsWith	检查值是否以所需的字符串开头，否则将追加该值。
确保开头和结尾	检查值是否以所需字符串开头和结尾，如果不是，该值将追加或追加。
禁止显示地址 - 死者	检查一个人是否已死亡。注意：目前此终结点仅支持 `GB` 数据。
禁止显示地址 - 消失	检查韦瑟一个人已经搬迁，不再住在地址。注意：目前此终结点仅支持 `GB` 数据。
禁止显示地址 - 重新定位	检查人员是否已移动并检索其新地址注意：目前，此终结点仅支持 `GB` 数据。
禁止显示手机 - 个人版	检查抑制列表中是否包含个人电话号码，因此不应调用此类号码。注意：目前此终结点仅支持 `GB` 数据。
规范化字母数字电话	使用手机键盘将字母转换为数字。即 `1-800-flowers` ->`1-800-3569377`
规范化空格	将字符串中的空格转换为单个空格。
设置 PhoneE164 格式	在 E.164 语法中设置电话号码的格式。例如 `+448457909090`
设置 PhoneRFC3966 格式	使用 RFC3966 语法设置电话号码的格式。例如 `tel:+44-845-790-9090`
设置 PostCode 格式	设置邮政编码的格式，使其在语法上对国家/地区有效。即 `SW1A1AA` 自 `SW1A 1AA`
设置 URL 格式	确保所有 URL 都使用相同的协议并更正常见错误。
设置手机国际格式	使用国际语法设置电话号码的格式。例如 `+44 845 790 9090`
设置电子邮件格式	设置电子邮件地址的格式。一个常见示例是，当从 Outlook 中处理电子邮件时，它将返回 `Example <example@example.com>` ，我们将将其 `example@example.com`转换为。
设置电话国家/地区格式	使用国家语法设置电话号码的格式。例如 `0845 790 9090`
还原	反转字符串值。即 `example` ->`elpmaxe`
验证 DateTime	检查 DateTime 值是否采用预期的语法。
验证 PostCode	检查 PostCode 的语法有效性。
验证 URL	检查 URL 的语法有效性。
验证地址	通过针对一组引用数据验证地址是否可交付。
验证电子邮件	检查电子邮件地址的语法有效性。
验证电话	检查 PhoneNumber 的语法有效性。

Classify

操作 ID:: ClassifyGet

识别有关一段数据的额外信息。例如，布赖恩或斯文是一个名字。路，斯特拉西，鲁是地址元素。有限责任公司是公司法律后缀。

参数

名称	密钥	必需	类型	说明
Input	Input	True	string	要分类的值。
类别	Categories	True	csv	要测试的类别的逗号分隔列表。
语言	Language		string	数据所使用的语言。

名称	路径	类型	说明
状态	status	integer	响应的 HTTP 状态代码。
消息	message	string	描述请求状态的消息。
数据	data	ClassifyResponse	回应。

Compare

操作 ID:: CompareGet

使用可用算法之一在两个值之间评分相似性，包括：Levenshtein、Jaro、JaroWinkler 等...

参数

名称	密钥	必需	类型	说明
输入 1	Input1	True	string	要比较的第一个值。
输入 2	Input2	True	string	要比较的第二个值。
比较算法	ComparisonAlgorithm	True	string	要用于比较的算法的名称。

Body: DQGlobalFloat

Congruence Country

操作 ID:: CountryCongruenceGet

检查某个值是否来自预期的国家/地区。

参数

名称	密钥	必需	类型	说明
Input	Input	True	string	要检查的值。
国家/地区标识符	Country	True	string	国家/地区标识符。 I.E.`GB`，`GBRUnited Kingdom`等等。
Action	ActionType	True	string	要执行的一致类型。

响应。

Body: CongruenceResultSingle

Congruence Salutation

操作 ID:: SalutationCongruenceGet

检查称呼是否与名称具有相同的性别。

参数

名称	密钥	必需	类型	说明
称呼	Salutation	True	string	要检查的敬意。
名字	FirstName	True	string	要检查的名字。
语言	Language	True	string	数据所使用的语言。

响应。

Body: CongruenceResultSingle

Congruence 电子邮件

操作 ID:: EmailCongruenceGet

检查电子邮件地址是否与联系人详细信息匹配。

参数

名称	密钥	必需	类型	说明
Email	Email	True	string	要检查的电子邮件。
名字	FirstName	True	string	要查找的名字。
姓氏	LastName	True	string	要查找的姓氏。

响应。

Body: CongruenceResultSingle

IsAllLower

操作 ID:: StringExtIsAllLower

检查值是否只包含小写字母。

参数

名称	密钥	必需	类型	说明
Input	Input	True	string	要检查的值。

Body: DQGlobalBool

IsAllUpper

操作 ID:: StringExtIsAllUpper

检查值是否只包含大写字母。

参数

名称	密钥	必需	类型	说明
Input	Input	True	string	要检查的值。

Body: DQGlobalBool

IsAlphaNumeric

操作 ID:: StringExtIsAlphaNumeric

检查值是否由字母和/或数字组成。

参数

名称	密钥	必需	类型	说明
Input	Input	True	string	要检查的值。

Body: DQGlobalBool

IsISO2Code

操作 ID:: StringExtIsISO2

检查值是否为有效的 ISO3166 Alpha-2 国家/地区代码。 I.GBP、UK、FR、ES 等。

参数

名称	密钥	必需	类型	说明
Input	Input	True	string	要检查的值。

Body: DQGlobalBool

IsISO3Code

操作 ID:: StringExtIsISO3

检查值是否为有效的 ISO3166 Alpha-3 国家/地区代码。 I.E.GBR、USA、FRA 等。

参数

名称	密钥	必需	类型	说明
Input	Input	True	string	要检查的值。

Body: DQGlobalBool

IsISO4217CurrencyCode

操作 ID:: StringExtIsISO4217

检查值是否为有效的ISO4217代码。 I.E.GBP、USD、EUR 等。

参数

名称	密钥	必需	类型	说明
Input	Input	True	string	要检查的值。

Body: DQGlobalBool

IsMixedCase

操作 ID:: StringExtIsMixedCase

检查值是否只包含大写字母和小写字母。

参数

名称	密钥	必需	类型	说明
Input	Input	True	string	要检查的值。

Body: DQGlobalBool

IsNumeric

操作 ID:: StringExtIsNumeric

检查值是否仅包含数字。

参数

名称	密钥	必需	类型	说明
Input	Input	True	string	要检查的值。

Body: DQGlobalBool

RemoveCharacters

操作 ID:: StringExtRemoveChars

从输入中删除指定的字符类型。

参数

名称	密钥	必需	类型	说明
Input	Input	True	string	要更改的值。
字符类型	characterType	True	string	要删除的字符的类型。

Body: DQGlobal

RemoveHTML

操作 ID:: StringExtRemoveHTML

从输入中删除所有 HTML 标记。

参数

名称	密钥	必需	类型	说明
Input	Input	True	string	要更改的值。

Body: DQGlobal

RemoveLeading

操作 ID:: StringExtRemoveLeading

从值的开头删除指定的字符串。

参数

名称	密钥	必需	类型	说明
Input	Input	True	string	要更改的值。
要删除的值	ValToRemove	True	string	要删除的值。
一开始就离开一个？	LeaveOneAtStart	True	boolean	在开始时保留一个匹配项？

Body: DQGlobal

SearchAddress - 查找

操作 ID:: SearchAddressFind

返回可能的地址匹配项的列表。

参数

名称	密钥	必需	类型	说明
Provider	Provider	True	string	要使用的提供程序。
Query	query	True	string	要搜索的地址。
国家/地区标识符	CountryIdentifier	True	string	一个 CountryIdentifier（GB、GBR、44、英国等）供国家搜索。

名称	路径	类型	说明
状态	status	integer	响应的 HTTP 状态代码。
消息	message	string	描述请求状态的消息。
数据	data	array of object	回应。
id	data.id	string	要用于检索调用的 AddressId。
标签	data.label	string	地址预览。
subLabel	data.subLabel	string	地址预览。
附加信息	data.additionalInfo	object

SearchAddress - 检索

操作 ID:: SearchAddressRetrieve

使用 Find 调用中的 ID 返回地址详细信息。

参数

名称	密钥	必需	类型	说明
Provider	Provider	True	string	要使用的提供程序。
地址 ID	Id	True	string	查找请求中的 ID。
国家/地区标识符	CountryIdentifier	True	string	一个 CountryIdentifier（GB、GBR、44、英国等）供国家搜索。

名称	路径	类型	说明
状态	status	integer	响应的 HTTP 状态代码。
消息	message	string	描述请求状态的消息。
数据	data	array of object	回应。
dqLine1	data.dqLine1	string	地址块的第 1 行。
dqLine2	data.dqLine2	string	地址块的第 2 行。
dqLine3	data.dqLine3	string	地址块的第 3 行。
dqLine4	data.dqLine4	string	地址块的第 4 行。
dqCity	data.dqCity	string	地址所在的城市。
dqCounty_District	data.dqCounty_District	string	地址位于的县/区。
dqState_Province	data.dqState_Province	string	地址所在的州/省/ 省。
dqziP_PostalCode	data.dqziP_PostalCode	string	地址 ZIP/PostalCode。
dqCountry	data.dqCountry	string	地址所在的国家/地区的名称。
dqisO3	data.dqisO3	string	地址所在的国家/地区的 ISO 3166-1 alpha-3 代码。
dqisO2	data.dqisO2	string	地址所在的国家/地区的 ISO 3166-1 alpha-2 代码。
附加信息	data.additionalInfo	object

StartsWith

操作 ID:: StringExtStartsWith

检查值是否以特定字符串开头。

参数

名称	密钥	必需	类型	说明
Input	Input	True	string	要检查的值。
查找	checkfor	True	string	要检查的值。

Body: DQGlobalBool

Transform

操作 ID:: TransformGet

以 5 种口语转换数据（缩写、详细、排除或规范化）。从 11 个不同的转换库中进行选择，包括：业务、国家/地区、名字和寻址...例如，缩写国家转型（英国到英国）。

参数

名称	密钥	必需	类型	说明
Input	Input	True	string	要转换的值。
类别	EntityType	True	string	要用于转换的类别。
Action	OperationType	True	string	要执行的转换类型。
语言	Language		string	要提供的数据的输入语言。

Body: DQGlobal

ValidatePlus PostCode

操作 ID:: ValidatePlusPostCodeGet

检查 PostCode 的语法有效性。

参数

名称	密钥	必需	类型	说明
邮政编码	Input	True	string	要验证的邮政编码。
国家/地区标识符	CountryIdentifier	True	string	国家/地区标识符。 I.E.`GB`，`GBRUnited Kingdom`等等。

名称	路径	类型	说明
状态	status	integer	响应的 HTTP 状态代码。
消息	message	string	描述请求状态的消息。
isValid	data.isValid	boolean	指示提供值有效性的布尔值。
messages	data.messages	array of string	提供的值无效的原因列表。

ValidatePlus URL

操作 ID:: ValidatePlusURLGet

检查 URL 的语法有效性。

参数

名称	密钥	必需	类型	说明
网站	Input	True	string	要验证的 URL。

名称	路径	类型	说明
状态	status	integer	响应的 HTTP 状态代码。
消息	message	string	描述请求状态的消息。
isValid	data.isValid	boolean	指示提供值有效性的布尔值。
messages	data.messages	array of string	提供的值无效的原因列表。

ValidatePlus 电子邮件

操作 ID:: ValidatePlusEmailGet

检查电子邮件地址的语法有效性。

参数

名称	密钥	必需	类型	说明
Email	Input	True	string	要验证的电子邮件。

名称	路径	类型	说明
状态	status	integer	响应的 HTTP 状态代码。
消息	message	string	描述请求状态的消息。
isValid	data.isValid	boolean	指示提供值有效性的布尔值。
messages	data.messages	array of string	提供的值无效的原因列表。

二进制到字符串

操作 ID:: StringExtBinaryToString

这会将二进制值转换为其等效字符串。

参数

名称	密钥	必需	类型	说明
Input	Input	True	string	要转换的值。

Body: DQGlobal

以...结尾

操作 ID:: StringExtEndsWith

检查值是否以特定字符串结尾。

参数

名称	密钥	必需	类型	说明
Input	Input	True	string	要检查的值。
查找	checkfor	True	string	要检查的值。

Body: DQGlobalBool

以类型开头

操作 ID:: StringExtStartWithType

检查提供的值是否以所需的字符类型开头。

参数

名称	密钥	必需	类型	说明
Input	Input	True	string	要检查的值。
字符类型	type	True	string	要检查的字符类型。

Body: DQGlobalBool

以类型结尾

操作 ID:: StringExtEndsWithType

检查提供的值是否以所需的字符类型结尾。

参数

名称	密钥	必需	类型	说明
Input	Input	True	string	要检查的值。
字符类型	type	True	string	要检查的字符类型。

Body: DQGlobalBool

保留字符

操作 ID:: StringExtRetainChars

这将用替换字符替换所提供的输入中的所有字符，但指定保留的字符除外。

参数

名称	密钥	必需	类型	说明
Input	Input	True	string	要更改的值。
替换字符	replacement	True	string	替换字符。
要保留的字符	charactersToRetain	True	string	要保留的字符串联列表。 I.E. 保留元音使用 `aeiou`

Body: DQGlobal

分析 URL

操作 ID:: ParseURLGet

将 URL 拆分为其组件部分：主机、方案、端口、路径。

参数

名称	密钥	必需	类型	说明
网站	Input	True	string	要拆分的网站。

名称	路径	类型	说明
状态	status	integer	响应的 HTTP 状态代码。
消息	message	string	描述请求状态的消息。
主持人	data.host	string	域名。即 `www.example.com`
scheme	data.scheme	string	URL 中使用的协议。例如 HTTP、HTTPS 等。
hostName类型	data.hostNameType	string	URL 中指定的主机名的类型。
pathAndQuery	data.pathAndQuery	string	所使用的路径和查询参数。即 `http://www.example.com/Path` 将返回 `/Path`
移植	data.port	string	使用的端口。

分析电子邮件

操作 ID:: ParseEmailGet

将电子邮件拆分为其组件部分：MailBox、域、TLD/

参数

名称	密钥	必需	类型	说明
Email	Input	True	string	要拆分的电子邮件。

名称	路径	类型	说明
状态	status	integer	响应的 HTTP 状态代码。
消息	message	string	描述请求状态的消息。
邮箱	data.mailbox	string	输入电子邮件。
localPart	data.localPart	string	“电子邮件本地”部分。即`support`
域	data.domain	string	电子邮件域。即 `gmail.com`
tld	data.tld	string	顶级域。即 `.co.uk`

分析电话

操作 ID:: ParsePhoneGet

将 Phonenumber 拆分为其组件部分：国家/地区、号码、前缀、类型。

参数

名称	密钥	必需	类型	说明
电话	Input	True	string	要拆分的电话号码。
国家/地区标识符	CountryIdentifier	True	string	国家/地区标识符。 I.E.`GB`，`GBRUnited Kingdom`等等。

名称	路径	类型	说明
状态	status	integer	响应的 HTTP 状态代码。
消息	message	string	描述请求状态的消息。
countryCode （国家代码）	data.countryCode	string	国家/地区拨号代码。
扩展	data.extension	string	分机号。（如果适用）
nationalNumber	data.nationalNumber	string	PhoneNumber 提供，格式为国家语法。
numberType	data.numberType	string	数字的类型。 I.E.Mobile、Fixed_Line等。

删除 StopWords

操作 ID:: StringExtRemoveStopWords

筛选出基本的英语停止单词，例如，关于，之后和更多。

参数

名称	密钥	必需	类型	说明
Input	Input	True	string	要更改的值。

Body: DQGlobal

删除单字符单词

操作 ID:: StringExtRemoveSingleWords

从输入 I.E. This is a test 中删除所有单个字符->This is test

参数

名称	密钥	必需	类型	说明
Input	Input	True	string	要更改的值。

Body: DQGlobal

十六进制到字符串

操作 ID:: StringExtHexToString

将十六进制输入转换为其等效字符串。

参数

名称	密钥	必需	类型	说明
Input	Input	True	string	要转换的值。

Body: DQGlobal

取消电话 - 公司

操作 ID:: SuppressPhoneCorporate

检查公司/商务电话号码是否包含在抑制列表中，因此不应调用此类号码。注意：目前此终结点仅支持 GB 数据。

参数

名称	密钥	必需	类型	说明
Provider	Provider	True	string	要使用的提供程序。
电话号码	Input	True	string	要检查的电话号码。
国家/地区标识符	CountryIdentifier	True	string	要检查的抑制列表的国家/地区标识符（GB、GBR、英国等）。

名称	路径	类型	说明
状态	status	integer	响应的 HTTP 状态代码。
消息	message	string	描述请求状态的消息。
结果	data.result	boolean	在抑制列表中找到提供的电话号码的布尔响应。
附加信息	data.additionalInfo	object

字符串到二进制

操作 ID:: StringExtStringToBinary

将字符串值转换为其二进制等效值。

参数

名称	密钥	必需	类型	说明
Input	Input	True	string	要转换的值。

Body: DQGlobal

字符串到十六进制

操作 ID:: StringExtStringToHex

将字符串值转换为其等效的十六进制值。

参数

名称	密钥	必需	类型	说明
Input	Input	True	string	要转换的值。

Body: DQGlobal

对电子邮件进行身份验证

操作 ID:: AuthenticateEmailGet

请真正确认电子邮件是否真实且将送达。

参数

名称	密钥	必需	类型	说明
Provider	Provider	True	string	要使用的提供程序。
Email	Email	True	string	要进行身份验证的电子邮件地址。

名称	路径	类型	说明
状态	status	integer	响应的 HTTP 状态代码。
消息	message	string	描述请求状态的消息。
电子邮件地址	data.emailAddress	string	已提供的电子邮件。
domainPart	data.domainPart	string	电子邮件的域部分。即`Bob.Smith@Example.com` ->`Example.com`
isCorporate	data.isCorporate	boolean	提供的电子邮件是业务电子邮件还是来自免费电子邮件提供商（`hotmailgmail`等）
isDisposable	data.isDisposable	boolean	提供的电子邮件地址是否为可释放邮箱。
isRoleBased	data.isRoleBased	boolean	基于电子邮件角色的本地部分（`support`、`salesmarketing`等）
localPart	data.localPart	string	电子邮件的“本地”部分。即`Bob.Smith@Example.com` ->`Bob.Smith`
结果	data.result	boolean	身份验证结果。
附加信息	data.additionalInfo	object	提供程序返回的其他字段的字典。

对电话进行身份验证

操作 ID:: AuthenticatePhoneGet

请真正确认你的电话号码是否真实，并会拨号。

参数

名称	密钥	必需	类型	说明
Provider	Provider	True	string	要使用的提供程序。
电话	Phone	True	string	要进行身份验证的电话号码。
国家/地区标识符	CountryIdentifier	True	string	国家/地区标识符（GB、GBR、英国等）。注意：仅当提供的电话号码不采用国际格式时，才是必需的。（从 +开始）

名称	路径	类型	说明
状态	status	integer	响应的 HTTP 状态代码。
消息	message	string	描述请求状态的消息。
numberType	data.numberType	string	提供的数字类型。
isO2	data.isO2	string	ISO 3166-1 alpha-2 国家/地区代码。
isO3	data.isO3	string	ISO 3166-1 alpha-3 国家/地区代码。
dialingCode	data.dialingCode	string	国家/地区电话前缀。
nationalFormat	data.nationalFormat	string	国家格式的 Phonenumber。
结果	data.result	boolean	身份验证结果。
附加信息	data.additionalInfo	object	提供程序返回的其他字段的字典。

序列转换

操作 ID:: SequenceTransform

在单个请求中执行多个转换。例如;精心策划的数字和缩写地址。

参数

名称	密钥	必需	类型	说明
Input	Input	True	string	要转换的值。
类别	EntityType	True	string	要用于转换的类别。
Action	OperationType	True	string	要执行的转换类型。
语言	Language	True	string	值位于的口语。
记录 ID	UID		string	将回显回给你的记录标识符。

名称	路径	类型	说明
状态	status	integer	响应的 HTTP 状态代码。
消息	message	string	描述请求状态的消息。
数据	data	array of object
输入	data.input	string	原始值。
输出	data.output	string	回应。
uid	data.uid	string	提供的唯一标识符。
状态	data.status	integer	此项的 HTTP 状态代码。
消息	data.message	string	描述请求状态的消息。

得分

操作 ID:: Scoring

通过从大量记录评分选项中进行选择来对记录进行评分;自定义组权重，对不对齐的数据进行评分，并从各种数据特定的评分规则中进行选择。

参数

名称	密钥	必需	类型	说明
Datum 吗？	IsDatum	True	boolean	此记录是 Datum/Master 记录。也就是说，你会比较其他人的记录。
记录 ID	UniqueId	True	string	RecordId，以便可以在输出列表中标识它。
记录源	RecordSource	True	string	此记录的来源名称，以便可以在输出列表中标识它。
组名称	GroupFieldId	True	string	组名称。
ScoringType	ScoringType	True	string	`IntraScore`：用于包含单个字段中数据的组。 `InterScore`：用于包含来自多个字段的数据的组。 I.E.Email1 vs Email2 vs Email3。
评分方法	ScoreMethod	True	string	应执行哪种类型的评分？
比较算法	ComparisonAlgorithm	True	string	要使用哪种算法？注意：我们的首选算法是 `JaroWinkler`
Null 与 Null 匹配？	IsNullToNullScored		boolean	执行比较时，空值与另一个空值是否应视为匹配项？
Null 与值匹配？	IsNullToValueScored		boolean	执行比较时，应将空值与填充的值视为匹配项？
区分大小写？	IsCaseSensitiveScore	True	boolean	执行比较时应考虑大小写？
Alpha 序列	AlphaSequenceParameter	True	string	是否应对数据应用字母排序？这有助于最大程度地减少未对齐数据的影响。
将双空间替换为单个空间？	IsReplaceDoubleSpaceWithSingle	True	boolean	是否应将两个空格字符连接到单个空格字符？
删除所有空格？	IsRemoveAllWhiteSpaces	True	boolean	是否应从输入中删除所有空格字符？（空格、非中断空间、制表符等）
剪裁字符串？	IsTrimString	True	boolean	是否应删除输入开头和末尾的空格？
包括标点符号？	IsIncludePunctuation	True	boolean	执行比较时是否应包含标点符号？
包括符号？	IsIncludeSymbols	True	boolean	执行比较时是否应包含符号？
包括非打印？	IsIncludeNonPrinting	True	boolean	执行比较时是否应包含非打印字符？
包括数字？	IsIncludeNumbers	True	boolean	执行比较时是否应包含数字？
包括字母？	IsIncludeAlphaChars	True	boolean	执行比较时是否应包含字母？
应用加权？	IsWeightingFactorUsed	True	boolean	是否应将权重应用于组的结果？注意：使用 `Weighting` 属性设置权重值。
包括预转换的数据进行评分？	IsIncludeOriginalDataForScoring	True	boolean	原始输入是否应在分数计算中使用？（即在排除任何字符之前）。
包括用于评分的令牌？	IncludeTokenForScoring	True	boolean	是否应在评分计算中使用 Tokenized 值？
包括用于评分的转换数据？	IncludeTransformedDataForScoring	True	boolean	转换后的值是否应在评分计算中使用？（即排除字符后）。
当为空时自动填充 TransformedValue？	AutoPopulateEmptyTransformed	True	boolean	如果为 `GroupValues.TransformedValue` null，`GroupValues.TransformedValue`则自动填充属性`GroupValues.Value`？
当为空时自动填充令牌？	AutoPopulateEmptyToken	True	boolean	如果`GroupValues.Token`为 null，则使用`GroupValues.TransformedValue`（转换后）自动填充`GroupValues.Token`属性？
组权重	Weighting		integer	必须是介于 -100 和 100 之间的数字。（100 = 不更改结果）（如果组匹配中的值，则使用负权重来降低总体分数）
PostalCodeNChars	PostalCodeNChars		integer	应从邮政编码中提取多少个字符？注意：仅当 ScoreMethod 是：PostalCodeLeftN、PostalCodeRightN 时适用。
正有效范围	PositiveValidRange		integer	上面的数字可以走多远，仍然有效。 I.E.5 vs 10 是 5 的正范围，但 5 与 4 是负范围 1。注意：仅当 scoreMethod 是：PostalCodeAsZip、AddressLine1WholeInput、AddressLine1Premise 时适用。
负有效范围	NegativeValidRange		integer	数字可以走得更远，仍然有效。 I.E.5 vs 10 是 5 的正范围，但 5 与 4 是负范围 1。注意：仅当 scoreMethod 是：PostalCodeAsZip、AddressLine1WholeInput、AddressLine1Premise 时适用。
日期格式	DateFormat		string	日期值的格式是什么？
评分方法	InterScoreMethodType		string	应使用哪种类型的多字段比较？
阈值	ThresholdValue		integer	匹配项的相似性阈值。（介于 0 和 100 之间，默认值 = 100）
价值	Value	True	string	原始字段值。
转换后的值	TransformedValue		string	转换后的字段值。（即删除空格、数字等后。
令牌值	Token		string	数据的标记化表示形式。

名称	路径	类型	说明
状态	status	integer	响应的 HTTP 状态代码。
消息	message	string	描述请求状态的消息。
数据	data	array of object	评分结果列表。
datumRecordSource	data.datumRecordSource	string	`RecordSource`输入基准记录上提供的值。
datumUniqueId	data.datumUniqueId	string	`UniqueId`输入基准记录上提供的值。
secondaryRecordSource	data.secondaryRecordSource	string	`RecordSource`输入辅助记录上提供的值。
secondaryUniqueId	data.secondaryUniqueId	string	`UniqueId`输入辅助记录上提供的值。
percentageScore	data.percentageScore	float	记录 0 和 100 之间的相似性。
groupOutput	data.groupOutput	array of object	提供的每个字段组的评分结果列表。
groupFieldID	data.groupOutput.groupFieldID	string	组名称。
groupPercentageScore	data.groupOutput.groupPercentageScore	float	组的相似性分数。
警告	data.groupOutput.warnings	array of string	组的警告列表（如果有）。

折叠相邻的重复字符

操作 ID:: StringExtCollapseRepeatedChars

如果最大重复数设置为 1，则单词 Silly 将减少 Sily 为 1，因为 l 重复一次。但是， Silly 如果最大重复数设置为 2，单词将保持不变，因为 l 不会多次重复。相反，无论 Global 重复的最大重复 l 次数如何，单词都将保持不变，但不会连续重复。

参数

名称	密钥	必需	类型	说明
Input	Input	True	string	要更改的值。
折叠数字？	collapseNumerics	True	boolean	在支票中包含数字？
最大重复数	maximumRepeat		integer	在折叠之前允许的最大重复字符数。

Body: DQGlobal

折叠相邻重复类型

操作 ID:: StringExtCollapseRepeatedType

检查并替换同一类型的重复相邻字符。即Test$$££ ->Test$£ 注意：$ 和 £ 都算作符号，但它们不是相同的字符，所以没有折叠。

参数

名称	密钥	必需	类型	说明
Input	Input	True	string	要更改的值。
最大重复数	MaximumRepeat	True	integer	在折叠之前允许的最大重复字符数。
字符类型	type	True	string	要检查的字符类型。

Body: DQGlobal

提取字符

操作 ID:: StringExtExtractChars

从字符串的开头或结尾提取给定数量的字符。

参数

名称	密钥	必需	类型	说明
Input	Input	True	string	要从中提取的值。
提取长度	extractLength	True	integer	要提取的字符数。
提取位置	extractFrom	True	string	值中应发生提取的位置。

Body: DQGlobal

提取字词

操作 ID:: StringExtExtractWords

从字符串的开头或结尾提取给定数量的单词。

参数

名称	密钥	必需	类型	说明
Input	Input	True	string	要从中提取的值。
提取长度	extractLength	True	integer	要提取的单词数。
提取位置	extractFrom	True	string	值中应发生提取的位置。

Body: DQGlobal

替换 If EndsWith

操作 ID:: StringExtReplaceEndsWith

如果找到的值将找到的值替换为指定的替换值，请检查提供的输入的末尾。

参数

名称	密钥	必需	类型	说明
Input	Input	True	string	要更改的值。
要替换的值	stringToReplace	True	string	要替换的值。
替换值	replacement	True	string	替换值。

Body: DQGlobal

替换 If StartsWith

操作 ID:: StringExtReplaceStartsWith

如果找到的值将找到的值替换为指定的替换值，请检查提供的输入的开始。

参数

名称	密钥	必需	类型	说明
Input	Input	True	string	要更改的值。
要替换的值	stringToReplace	True	string	要替换的值。
替换值	replacement	True	string	替换值。

Body: DQGlobal

替换相邻重复文本

操作 ID:: StringExtReplaceRepeatingText

检查并替换重复的相邻字符。

参数

名称	密钥	必需	类型	说明
Input	Input	True	string	要更改的值。
重复字符	RepeatingValue	True	string	要删除的重复字符。
替换字符	Replacement	True	string	替换字符。

Body: DQGlobal

案例

操作 ID:: CaseSingular

更改数据的大小写。

参数

名称	密钥	必需	类型	说明
Input	Input	True	string	要提交大小写的值。
大小写类型	CaseType	True	string	要执行的大小写类型。
语言	Language	True	string	数据所使用的语言。

Body: DQGlobal

检索使用情况

操作 ID:: UsageGet

检索给定时间范围内每个供应商函数的使用情况统计信息。注意：使用情况统计信息每 24 小时更新一次午夜 UTC 时间。

参数

名称	密钥	必需	类型	说明
开始时间（yyyy-MM-dd HH：mm：ss.fff）	StartDate	True	date-time	使用周期开始。
结束时间（yyyy-MM-dd HH：mm：ss.fff）	EndDate	True	date-time	使用期结束。

Body: GetUsage

检索使用情况（V2）

操作 ID:: UsageGetV2

检索给定时间段内每个供应商函数的使用情况统计信息，按使用应用程序进行细分。注意：使用情况统计信息每 24 小时更新一次午夜 UTC 时间。

参数

名称	密钥	必需	类型	说明
开始时间（yyyy-MM-dd HH：mm：ss.fff）	StartDate	True	date-time	使用周期开始。
结束时间（yyyy-MM-dd HH：mm：ss.fff）	EndDate	True	date-time	使用期结束。
摘要依据	SummariseBy		string	按给定时间段内的时间间隔对信用额度使用情况进行分组。

Body: GetUsageV2

检索函数定价

操作 ID:: PricingGet

检索当前价目表。

Body: GetPricesOutput

检索当前余额

操作 ID:: BalanceGet

检索当前余额。

Body: DQGlobalInt

派生 CountryFromCity

操作 ID:: DeriveCityGet

检索提供地名的国家/地区列表。

参数

名称	密钥	必需	类型	说明
City	Input	True	string	要为其查找国家/地区的城市。

名称	路径	类型	说明
状态	status	integer	响应的 HTTP 状态代码。
消息	message	string	描述请求状态的消息。
数据	data	array of object	响应。
countryName	data.countryName	string	派生国家/地区的名称。
iSO2	data.iSO2	string	派生国家/地区的 ISO 3166-1 alpha-2 代码。
iSO3	data.iSO3	string	派生国家/地区的 ISO 3166-1 alpha-3 代码。
iDD	data.iDD	string	派生国的国际拨号代码。

派生 EmailType

操作 ID:: DeriveEmailGet

派生域和邮箱类型。 I.E.is 业务电子邮件？还是个人电子邮件？

参数

名称	密钥	必需	类型	说明
Email	Input	True	string	要用于派生的电子邮件。

名称	路径	类型	说明
状态	status	integer	响应的 HTTP 状态代码。
消息	message	string	描述请求状态的消息。
domainType	data.domainType	string	域的类型。（Business、FreeProvider）
mailBoxType	data.mailBoxType	string	邮箱的类型。（个人、通用）

派生 FromPostalCode

操作 ID:: DerivePostCodeGet

返回与提供的邮政编码相关的信息，例如：纬度和经度。

参数

名称	密钥	必需	类型	说明
邮政编码	Input	True	string	要检查的邮政编码。
国家/地区标识符	CountryIdentifier	True	string	提供的邮政编码的国家/地区标识符（`GB`等`GBRUnited Kingdom`）。

名称	路径	类型	说明
状态	status	integer	响应的 HTTP 状态代码。
消息	message	string	描述请求状态的消息。
县	data.county	string	邮政编码所在的县。
latitude	data.latitude	string	postCode 区域的纬度。
longitude	data.longitude	string	postCode 区域的经度。

派生国家/地区

操作 ID:: DeriveISOGet

从提供的数据派生国家/地区。

参数

名称	密钥	类型	说明
Email	Email	string	要用于派生的电子邮件。
网站	Url	string	要用于派生的 URL。
电话	Phone	string	要用于派生的电话。
国家/地区标识符	Country	string	派生的国家/地区标识符（`GB`、`GBRUnited Kingdom`等）。
City	City	string	要用于派生的 City。
阈值	Threshold	integer	应返回可能值的匹配百分比。
返回最高匹配项？	OnlyReturnBest	boolean	仅返回最高评分结果？
默认为国家/地区？	DefaultToCountry	boolean	如果响应将 `Unknown` 仅使用国家/地区派生。

名称	路径	类型	说明
状态	status	integer	响应的 HTTP 状态代码。
消息	message	string	描述请求状态的消息。
数据	data	array of object	可能的国家/地区列表。
countryName	data.countryName	string	派生国家/地区的名称。
congruentToGivenCountry	data.congruentToGivenCountry	boolean	派生国家/地区是否与提供的国家/地区匹配？
matchCertainty	data.matchCertainty	integer	确定性分数。 (0-100)
isO2	data.isO2	string	派生国家/地区的 ISO 3166-1 alpha-2 代码。
isO3	data.isO3	string	派生国家/地区的 ISO 3166-1 alpha-3 代码。
diallingCode	data.diallingCode	string	派生国的国际拨号代码。

派生性别

操作 ID:: DeriveGenderGet

使用名字派生某人的性别。

参数

名称	密钥	必需	类型	说明
名字	Input	True	string	要尝试从中派生性别的第一个名称。

名称	路径	类型	说明
状态	status	integer	响应的 HTTP 状态代码。
消息	message	string	描述请求状态的消息。
gender	data.gender	string	性别。（女、男、任一、未知）
resultCode	data.resultCode	integer	与“性别”等效的数字。（0 女， 1 男， 2 任一， 3 未知）

生成令牌

操作 ID:: GenerateTokenGet

生成数据的拼音令牌。示例（使用 DQFonetix） Xerox = YQA， Xeroks = YQA

参数

名称	密钥	必需	类型	说明
Input	Input	True	string	要标记的值。
算法	generateAlgorithmType	True	string	应使用哪种算法？
语言	Language		string	数据的语言（使用 DQFonetix、DQMetaphone、DQSoundex 时需要）。

Body: DQGlobal

生成模式

操作 ID:: GeneratePattern

生成数据的模式表示形式。即 Example123 ->Aaaaaaa999

参数

名称	密钥	必需	类型	说明
Input	Input	True	string	要标记的值。
从令牌中排除	DoNotTokenize	True	array of string	列出不标记的字符类型。
CaseSensitive	CaseSensitive	True	boolean	返回上字母和下字母标记？
LetterCategories	LetterCategories	True	boolean	按类型对字母进行分类？（类别：UpperCaseVowel = V，LowerCaseVowel = v，UpperCaseConsonant = C，LowerCaseConsonant = c）
排除	Exclude	True	array of string	从模式中排除以下类型的字母？
折叠	Collapse	True	array of string	在模式中折叠以下类型的字母？
NumberCategories	NumberCategories	True	boolean	按类型划分的类别编号？（类别：OddNumber = 1，EvenNumber = 2）
排除	Exclude	True	array of string	从模式中排除以下类型的数字？
折叠	Collapse	True	array of string	在模式中折叠以下类型的数字？
排除	Exclude	True	boolean	从模式中排除符号？
折叠	Collapse	True	boolean	将重复符号折叠成单个符号？ I.E.@@ -> @
排除	Exclude	True	boolean	从模式中排除空格？
折叠	Collapse	True	boolean	将多个空格字符折叠成单个字符？
排除	Exclude	True	boolean	从模式中排除非打印字符？
折叠	Collapse	True	boolean	将多个非打印字符折叠成单个字符？
用户唯一标识 (UID)	UID		string	将回显回给你的记录标识符。

名称	路径	类型	说明
状态	status	integer	响应的 HTTP 状态代码。
消息	message	string	描述请求状态的消息。
数据	data	array of object
输入	data.input	string	原始值。
输出	data.output	string	回应。
uid	data.uid	string	提供的唯一标识符。
状态	data.status	integer	此项的 HTTP 状态代码。
消息	data.message	string	描述请求状态的消息。

确保 EndsWith

操作 ID:: StringExtEnsureEndsWith

检查值是否以所需的字符串结尾，如果该值未追加。

参数

名称	密钥	必需	类型	说明
Input	Input	True	string	要检查的值。
查找	checkFor	True	string	最终所需的值。

Body: DQGlobal

确保 StartsWith

操作 ID:: StringExtEnsureStartsWith

检查值是否以所需的字符串开头，否则将追加该值。

参数

名称	密钥	必需	类型	说明
Input	Input	True	string	要检查的值。
查找	checkFor	True	string	开始时所需的值。

Body: DQGlobal

确保开头和结尾

操作 ID:: StringExtEnsureStartEndsWith

检查值是否以所需字符串开头和结尾，如果不是，该值将追加或追加。

参数

名称	密钥	必需	类型	说明
Input	Input	True	string	要检查的值。
查找	checkFor	True	string	要查找的值。

Body: DQGlobal

禁止显示地址 - 死者

操作 ID:: SuppressDeceased

检查一个人是否已死亡。注意：目前此终结点仅支持 GB 数据。

参数

名称	密钥	必需	类型	说明
Provider	Provider	True	string	要使用的提供程序。
Title	Title		string	要检查的人员的敬礼。
名字	FirstName		string	要检查的人员的名字。
姓氏	LastName	True	string	要检查的人员的姓氏。
第 1 行	Line1		string	要检查的人员的第 1 行地址。
第 2 行	Line2		string	要检查的人员的第 2 行地址。
第 3 行	Line3		string	要检查的人员的第 3 行地址。
镇	Town		string	要检查的人员的地址城镇。
县	County		string	要检查的人员地址县。
邮政编码	Postcode	True	string	要检查的人员的邮政编码地址。
国家/地区标识符	CountryIdentifier	True	string	要检查的地址的国家/地区标识符（GB、GBR、英国等）。

名称	路径	类型	说明
状态	status	integer	响应的 HTTP 状态代码。
消息	message	string	描述请求状态的消息。
状态	data.status	string	基于置信度百分比的抑制状态。
可信度	data.confidence	double	应取消记录的自信百分比。
附加信息	data.additionalInfo	object

禁止显示地址 - 消失

操作 ID:: SuppressGoneAway

检查韦瑟一个人已经搬迁，不再住在地址。注意：目前此终结点仅支持 GB 数据。

参数

名称	密钥	必需	类型	说明
Provider	Provider	True	string	要使用的提供程序。
Title	Title		string	要检查的人员的敬礼。
名字	FirstName		string	要检查的人员的名字。
姓氏	LastName	True	string	要检查的人员的姓氏。
第 1 行	Line1		string	要检查的人员的第 1 行地址。
第 2 行	Line2		string	要检查的人员的第 2 行地址。
第 3 行	Line3		string	要检查的人员的第 3 行地址。
镇	Town		string	要检查的人员的地址城镇。
县	County		string	要检查的人员地址县。
邮政编码	Postcode	True	string	要检查的人员的邮政编码地址。
国家/地区标识符	ISO2	True	string	要检查的地址的国家/地区标识符（GB、GBR、英国等）。

名称	路径	类型	说明
状态	status	integer	响应的 HTTP 状态代码。
消息	message	string	描述请求状态的消息。
状态	data.status	string	基于置信度百分比的抑制状态。
可信度	data.confidence	double	应取消记录的自信百分比。
附加信息	data.additionalInfo	object

禁止显示地址 - 重新定位

操作 ID:: SuppressRelocated

检查人员是否已移动并检索其新地址注意：目前，此终结点仅支持 GB 数据。

参数

名称	密钥	必需	类型	说明
Provider	Provider	True	string	要使用的提供程序。
Title	Title		string	要检查的人员的敬礼。
名字	FirstName		string	要检查的人员的名字。
姓氏	LastName	True	string	要检查的人员的姓氏。
第 1 行	Line1		string	要检查的人员的第 1 行地址。
第 2 行	Line2		string	要检查的人员的第 2 行地址。
第 3 行	Line3		string	要检查的人员的第 3 行地址。
镇	Town		string	要检查的人员的地址城镇。
县	County		string	要检查的人员地址县。
邮政编码	Postcode	True	string	要检查的人员的邮政编码地址。
国家/地区标识符	ISO2	True	string	要检查的地址的国家/地区标识符（GB、GBR、英国等）。

名称	路径	类型	说明
状态	status	integer	响应的 HTTP 状态代码。
消息	message	string	描述请求状态的消息。
状态	data.status	string	基于置信度百分比的抑制状态。
可信度	data.confidence	double	应取消记录的自信百分比。
title	data.newAddress.title	string	标题/敬礼。
名字	data.newAddress.forename	string	名字。
姓	data.newAddress.surname	string	姓。
moveDate	data.newAddress.moveDate	date-time	移动日期。
地址1	data.newAddress.address1	string	地址行 1。
地址2	data.newAddress.address2	string	地址行 2。
address3	data.newAddress.address3	string	地址行 3。
镇	data.newAddress.town	string	地址城镇。
县	data.newAddress.county	string	地址县。
邮政编码	data.newAddress.postcode	string	地址邮政编码。
附加信息	data.additionalInfo	object

禁止显示手机 - 个人版

操作 ID:: SuppressPhonePersonal

检查抑制列表中是否包含个人电话号码，因此不应调用此类号码。注意：目前此终结点仅支持 GB 数据。

参数

名称	密钥	必需	类型	说明
Provider	Provider	True	string	要使用的提供程序。
电话号码	Input	True	string	要检查的电话号码。
国家/地区标识符	CountryIdentifier	True	string	要检查的抑制列表的国家/地区标识符（GB、GBR、英国等）。

名称	路径	类型	说明
状态	status	integer	响应的 HTTP 状态代码。
消息	message	string	描述请求状态的消息。
结果	data.result	boolean	在抑制列表中找到提供的电话号码的布尔响应。
附加信息	data.additionalInfo	object

规范化字母数字电话

操作 ID:: StringExtNormPhone

使用手机键盘将字母转换为数字。即 1-800-flowers ->1-800-3569377

参数

名称	密钥	必需	类型	说明
Input	Input	True	string	要更改的值。

Body: DQGlobal

规范化空格

操作 ID:: StringExtNormWhiteSpace

将字符串中的空格转换为单个空格。

参数

名称	密钥	必需	类型	说明
Input	Input	True	string	要更改的值。

Body: DQGlobal

设置 PhoneE164 格式

操作 ID:: FormatE164Get

在 E.164 语法中设置电话号码的格式。例如 +448457909090

参数

名称	密钥	必需	类型	说明
电话	Input	True	string	要设置格式的电话号码。
国家/地区标识符	CountryIdentifier	True	string	要对其设置格式的国家/地区标识符（`GB`、`GBRUnited Kingdom`等）。

Body: DQGlobal

设置 PhoneRFC3966 格式

操作 ID:: FormatRFC3966Get

使用 RFC3966 语法设置电话号码的格式。例如 tel:+44-845-790-9090

参数

名称	密钥	必需	类型	说明
电话	Input	True	string	要设置格式的电话号码。
国家/地区标识符	CountryIdentifier	True	string	要对其设置格式的国家/地区标识符（`GB`、`GBRUnited Kingdom`等）。

Body: DQGlobal

设置 PostCode 格式

操作 ID:: FormatPostCodeGet

设置邮政编码的格式，使其在语法上对国家/地区有效。即 SW1A1AA 自 SW1A 1AA

参数

名称	密钥	必需	类型	说明
邮政编码	Input	True	string	要设置格式的邮政编码。
国家/地区标识符	CountryIdentifier	True	string	要对其设置格式的国家/地区标识符（`GB`、`GBRUnited Kingdom`等）。

Body: DQGlobal

设置 URL 格式

操作 ID:: FormatURLGet

确保所有 URL 都使用相同的协议并更正常见错误。

参数

名称	密钥	必需	类型	说明
网站	Input	True	string	要设置格式的 URL。
URL 前缀	URLPrefix	True	string	要追加到 URL 的前缀。

Body: DQGlobal

设置手机国际格式

操作 ID:: FormatInternationalGet

使用国际语法设置电话号码的格式。例如 +44 845 790 9090

参数

名称	密钥	必需	类型	说明
电话	Input	True	string	要设置格式的电话号码。
国家/地区标识符	CountryIdentifier	True	string	要对其设置格式的国家/地区标识符（`GB`、`GBRUnited Kingdom`等）。

Body: DQGlobal

设置电子邮件格式

操作 ID:: FormatEmailGet

设置电子邮件地址的格式。一个常见示例是，当从 Outlook 中处理电子邮件时，它将返回 Example <example@example.com> ，我们将将其 example@example.com转换为。

参数

名称	密钥	必需	类型	说明
Email	Input	True	string	要设置格式的电子邮件地址。

Body: DQGlobal

设置电话国家/地区格式

操作 ID:: FormatNationalGet

使用国家语法设置电话号码的格式。例如 0845 790 9090

参数

名称	密钥	必需	类型	说明
电话	Input	True	string	要设置格式的电话号码。
国家/地区标识符	CountryIdentifier	True	string	要对其设置格式的国家/地区标识符（`GB`、`GBRUnited Kingdom`等）。

Body: DQGlobal

还原

操作 ID:: StringExtReverse

反转字符串值。即 example ->elpmaxe

参数

名称	密钥	必需	类型	说明
Input	Input	True	string	要反转的值。

Body: DQGlobal

验证 DateTime

操作 ID:: ValidateDateTimeGet

检查 DateTime 值是否采用预期的语法。

参数

名称	密钥	必需	类型	说明
日期时间	Input	True	string	要验证的日期时间。
Format	DateTimeFormat	True	string	预期格式。示例： `yyyy-mm-dd`

Body: DQGlobalBool

验证 PostCode

操作 ID:: ValidatePostCodeGet

检查 PostCode 的语法有效性。

参数

名称	密钥	必需	类型	说明
邮政编码	Input	True	string	要验证的邮政编码。
国家/地区标识符	CountryIdentifier	True	string	国家/地区标识符。 I.E.`GB`，`GBRUnited Kingdom`等等。

Body: DQGlobalBool

验证 URL

操作 ID:: ValidateURLGet

检查 URL 的语法有效性。

参数

名称	密钥	必需	类型	说明
网站	Input	True	string	要验证的 URL。

Body: DQGlobalBool

验证地址

操作 ID:: VerifyAddressGet

通过针对一组引用数据验证地址是否可交付。

参数

名称	密钥	必需	类型	说明
Provider	Provider	True	string	要使用的提供程序。
第 1 行	Line1		string	地址行 1。
第 2 行	Line2		string	地址行 2。
第 3 行	Line3		string	地址行 3。
邮政编码	PostalCode		string	地址邮政编码。
City	City		string	地址城市。
州/省/省	State		string	地址州/省/ 省。
国家/地区标识符	CountryIdentifier	True	string	CountryIdentifier I.E.（GB、GBR、44、英国等）
地理编码？	Geocode	True	boolean	如果已知，则返回纬度和经度信息？

名称	路径	类型	说明
状态	status	integer	响应的 HTTP 状态代码。
消息	message	string	描述请求状态的消息。
dqLine1	data.dqLine1	string	地址块的第 1 行。
dqLine2	data.dqLine2	string	地址块的第 2 行。
dqLine3	data.dqLine3	string	地址块的第 3 行。
dqLine4	data.dqLine4	string	地址块的第 4 行。
dqCity	data.dqCity	string	地址所在的城市。
dqCounty_District	data.dqCounty_District	string	地址位于的县/区。
dqState_Province	data.dqState_Province	string	地址所在的州/省/ 省。
dqziP_PostalCode	data.dqziP_PostalCode	string	地址 ZIP/PostalCode。
dqCountry	data.dqCountry	string	地址所在的国家/地区的名称。
dqisO3	data.dqisO3	string	地址所在的国家/地区的 ISO 3166-1 alpha-3 代码。
dqisO2	data.dqisO2	string	地址所在的国家/地区的 ISO 3166-1 alpha-2 代码。
dqLatitude	data.dqLatitude	string	地址的纬度。
dqLongitude	data.dqLongitude	string	地址的经度。
状态	data.status	string	地址验证状态。
附加信息	data.additionalInfo	object

验证电子邮件

操作 ID:: ValidateEmailGet

检查电子邮件地址的语法有效性。

参数

名称	密钥	必需	类型	说明
Email	Input	True	string	要验证的电子邮件。

Body: DQGlobalBool

验证电话

操作 ID:: ValidatePhoneGet

检查 PhoneNumber 的语法有效性。

参数

名称	密钥	必需	类型	说明
电话	Input	True	string	要验证的电话。
国家/地区标识符	CountryIdentifier	True	string	国家/地区标识符。 I.E.`GB`，`GBRUnited Kingdom`等等。

Body: DQGlobalBool

定义

GetUsage

名称	路径	类型	说明
状态	status	integer	响应的 HTTP 状态代码。
消息	message	string	描述请求状态的消息。
startDate	data.FilterCriteria.startDate	date-time	输入的 StartDate。
结束日期	data.FilterCriteria.endDate	date-time	输入的 EndDate。
Results	data.Results	array of object	使用情况详细信息的列表。
providerName （提供商名称）	data.Results.providerName	string	提供程序的名称。
使用情况	data.Results.usage	array of object	一个数组，其中包含提供程序的所有函数以及每个函数的用法。
functionName	data.Results.usage.functionName	string	函数的名称。
creditsUsed	data.Results.usage.creditsUsed	integer	在此函数上花费的积分数。

GetUsageV2

名称	路径	类型	说明
状态	status	integer	响应的 HTTP 状态代码。
消息	message	string	描述请求状态的消息。
startDate	data.FilterCriteria.startDate	date-time	输入的 StartDate。
结束日期	data.FilterCriteria.endDate	date-time	输入的 EndDate。
Results	data.Results	array of object	使用情况详细信息的列表。
providerName （提供商名称）	data.Results.providerName	string	提供程序的名称。
使用情况	data.Results.usage	array of object	一个数组，其中包含提供程序的所有函数以及每个函数的用法。
functionName	data.Results.usage.functionName	string	函数的名称。
creditsUsed	data.Results.usage.creditsUsed	integer	在此函数上花费的积分数。
creditsUsedBy	data.Results.usage.creditsUsedBy	array of object	在此函数上花费了额度的应用程序列表以及每个应用花费的额度数。
应用程序名称	data.Results.usage.creditsUsedBy.applicationName	string	使用额度的应用程序的名称。
creditsUsed	data.Results.usage.creditsUsedBy.creditsUsed	integer	此应用程序在此函数上花费的积分数。
概要	data.Summary	array of object	按时间汇总的使用情况列表。
periodStart	data.Summary.periodStart	date-time	间隔的开始时间。
periodEnd	data.Summary.periodEnd	date-time	间隔的结束时间。
标签	data.Summary.label	string	显示摘要间隔的标签。
creditsUsed	data.Summary.creditsUsed	integer	间隔内使用的积分数。
creditsUsedBy	data.Summary.creditsUsedBy	array of object	按应用程序在间隔内的消耗细分。
应用程序名称	data.Summary.creditsUsedBy.applicationName	string	使用额度的应用程序的名称。
creditsUsed	data.Summary.creditsUsedBy.creditsUsed	integer	此应用程序使用的积分数。

GetPricesOutput

名称	路径	类型	说明
状态	status	integer	响应的 HTTP 状态代码。
消息	message	string	描述请求状态的消息。
数据	data	array of object	响应。
providerName （提供商名称）	data.providerName	string	提供程序的名称。
functions	data.functions	array of object	提供程序提供的 Functions 列表。
functionName	data.functions.functionName	string	提供的函数的名称。
creditCost	data.functions.creditCost	integer	函数的成本。
functionDescription	data.functions.functionDescription	string	有关函数的简要说明。

ClassifyResponse

回应。

名称	路径	类型	说明
地址	addresses	array of string	与地址类别匹配的值列表。
数字	numbers	array of string	与数字类别匹配的值列表。
givenNames	givenNames	array of string	与给定名称类别匹配的值列表。
企业	businesses	array of string	与业务类别匹配的值列表。
businessJobTitles	businessJobTitles	array of string	与职务类别匹配的值列表。
日期	dates	array of string	与“日期”类别匹配的值列表。
杂项	miscellaneous	array of string	与“杂项”类别匹配的值列表。
weightsAndMeasures	weightsAndMeasures	array of string	与“权重和度量”类别匹配的值列表。
资格	qualifications	array of string	与“限定”类别匹配的值列表。
打招呼	salutations	array of string	与“敬礼”类别匹配的值列表。
国家	countries	array of string	与“国家/地区”类别匹配的值列表。
familyNames	familyNames	array of string	与“姓氏”类别匹配的值列表。
臭名昭著	salacious	array of string	与 Salacious 类别匹配的值列表。

CongruenceResultSingle

响应。

名称	路径	类型	说明
状态	status	integer	响应的 HTTP 状态代码。
消息	message	string	描述请求状态的消息。
congruenceString	data.congruenceString	string	有关找到哪种类型的协调的说明。
代码	data.code	string	找到哪种类型的协调的代码。

DQGlobal

名称	路径	类型	说明
状态	status	integer	响应的 HTTP 状态代码。
消息	message	string	描述请求状态的消息。
数据	data	string	回应。

DQGlobalInt

名称	路径	类型	说明
状态	status	integer	响应的 HTTP 状态代码。
消息	message	string	描述请求状态的消息。
数据	data	integer	回应。

DQGlobalFloat

名称	路径	类型	说明
状态	status	integer	响应的 HTTP 状态代码。
消息	message	string	描述请求状态的消息。
数据	data	float	回应。

DQGlobalBool

名称	路径	类型	说明
状态	status	integer	响应的 HTTP 状态代码。
消息	message	string	描述请求状态的消息。
数据	data	boolean	回应。