本产品用于印尼手机号关联检测,可以帮助客户触达活跃客群、激活沉默客群。
API 方式
Base URL
API
URL | 请求方式 | Content-Type | 输出格式 | 字符集 |
---|---|---|---|---|
api-base-url?partner_code=xxx&partner_key=xxx | POST | application/json | JSON | UTF-8 |
认证参数
字段 | 类型 | 含义 | 建议 | 备注 |
---|---|---|---|---|
partner_code | String | 合作方标识 | 必须 | 由 TD 分配 |
partner_key | String | 合作方密钥 | 必须 | 由 TD 分配 |
请求参数
字段 | 类型 | 含义 | 建议 | 备注 |
---|---|---|---|---|
id_number | String | 身份证件 ID 号码 | 必须 | ID number |
id_type | String | 身份证件 ID 类型 | 必须 | 印尼-枚举值: KTP |
phone_number | String | 手机号 / 电话号码 | 必须 | 样例:081234567890,必须以08开头 |
emergency_contact_id | String | 紧急联系人ID | 强烈建议 | 紧急联系人ID number,如不传入则不返回紧急联系人结果 |
emergency_contact_phone | String | 紧急联系人手机号 / 电话号码 | 强烈建议 | 样例:08123456789,如不传入则不返回紧急联系人结果中的手机号相关信息 |
emergency_contact_name | String | 紧急联系人姓名 | 强烈建议 | |
name | String | 姓名 | 强烈建议 | |
country | String | 国家 | 必须 | 国家,必填. 两位国家码,符合 ISO 3166 标准。目前支持:印尼(ID) |
请求示例
{
"country": "ID",
"phone_number": "081234567890",
"id_type": "KTP",
"id_number": "3310225629467",
"name": "Joe",
"emergency_contact_id": "3310225629467",
"emergency_contact_phone": "081234567890",
"emergency_contact_name": "Joe"
}
响应参数
字段 | 类型 | 含义 | 建议 | 备注 |
---|---|---|---|---|
code | Integer | API 状态码 | 必须 | |
message | String | 状态信息 | 必须 | 在 API 异常状态下会输出具体的异常原因 |
sequence_id | String | 响应唯一码 | 必须 | 用于跟踪每次请求记录的唯一标识 |
result | Object | 核验结果 | 必须 | |
phone_number_count | Int | 关联手机号个数 | 必须 | |
applicator_result | Object | 申请人结果 | 必须 | |
is_recently_used | String | 是否为最近使用手机号 | 必须 | True:是最近使用 False:不是最近使用 |
is_frequently_used | String | 是否为最常用手机号 | 必须 | True:是最常使用 False:不是最常使用 |
is_other | String | 是否为其他手机号 | 必须 | True:是其他使用 False:不是其他使用 |
emergency_contact_result | Object | 紧急联系人结果 | 条件必须 | |
relation_with_applicator | String | 和申请人的关系,传入紧急联系人ID的返回 | 条件必须 | 枚举值: Spouse 配偶 Parents 父母/岳父母 Children 子女 Grandparents 祖父母/外祖父母 Grandchildren 孙子女 Brothers&sisters 兄弟姐妹 Others 其他亲属关系 Unknown-无关系内容 |
is_recently_used | String | 是否为最近使用手机号,传入紧急联系人手机号的返回 | 条件必须 | True:是最近使用 False:不是最近使用 Unknown:库无记录 |
is_frequently_used | String | 是否为最常用手机号,传入紧急联系人手机号的返回 | 条件必须 | True:是最常使用 False:不是最常使用 Unknown:库无记录 |
is_other | String | 是否为其他手机号,传入紧急联系人手机号的返回 | 条件必须 | True:其他使用 False:不是其他使用 Unknown:库无记录 |
API状态码
code | Message | 含义 | 是否收费 |
---|---|---|---|
200 | 成功 | 是 | |
300 | Service not purchased or not effective | 服务不可⽤ | 否 |
301 | Service not purchased | 服务未购买 | 否 |
302 | Service has been suspend | 服务已被禁⽤ | 否 |
303 | Not enough balance | 流量不足 | 否 |
304 | Service expired | 服务已过期 | 否 |
11350 | Internal error | 系统错误 | 否 |
11301 | {parameter} empty | {参数}为空 | 否 |
11304 | The country partner located is not open | 国家不支持 | 否 |
11340 | {parameter} error | {参数}错误 | 否 |
12701 | No record | 库无记录 | 否 |
响应示例
-当紧急联系人ID和手机号都传入时
{
"code": 200,
"message": "",
"sequence_id": "1648777165770866F82AC7F326307055",
"result": {
"phone_number_count": 2,
"applicator_result": {
"is_recently_used": "True",
"is_frequently_used": "False",
"is_other": "False"
},
"emergency_contact_result": {
"relation_with_applicator": "Spouse",
"is_recently_used":"True",
"is_frequently_used": "False",
"is_other": "False"
}
}
}
-当紧急联系人ID传入、手机号不传入时
{
"code": 200,
"message": "",
"sequence_id": "1648777165770866F82AC7F326307055",
"result": {
"phone_number_count": 2,
"applicator_result": {
"is_recently_used": "True",
"is_frequently_used": "False",
"is_other": "False"
},
"emergency_contact_result": {
"relation_with_applicator": "Spouse"
}
}
}
-当紧急联系人ID不传入、手机号传入时
{
"code": 200,
"message": "",
"sequence_id": "1648777165770866F82AC7F326307055",
"result": {
"phone_number_count": 2,
"applicator_result": {
"is_recently_used": "True",
"is_frequently_used": "False",
"is_other": "False"
},
"emergency_contact_result": {
"relation_with_applicator": "Unknown",
"is_recently_used":"Unknown",
"is_frequently_used": "Unknown",
"is_other": "Unknown"
}
}
}
-当紧急联系人ID和手机号都不传入时
{
"code": 200,
"message": "",
"sequence_id": "1648777165770866F82AC7F326307055",
"result": {
"phone_number_count": 2,
"applicator_result": {
"is_recently_used": "True",
"is_frequently_used": "False",
"is_other": "False"
}
}
}