commit 208d1c2718236db1eaa4198202a62df1e1a90a3b Author: tk Date: Fri Nov 22 10:39:22 2024 +0800 添加 Home diff --git a/Home.md b/Home.md new file mode 100644 index 0000000..3bdc3b5 --- /dev/null +++ b/Home.md @@ -0,0 +1,108 @@ +
+

云码平台 - 商家接入文档

+
+ + +## 商家身份鉴权 + +几乎所有的 API 都要求验证权限，请在 HTTP 请求头中添加您账号的 JWT Token ： + +- Header Key：Authorization +- Header Value：XXXXXXXXXXX （查看商家授权令牌） + +## 短信接码流程 + +### 获取手机号 + +接口文档 + +接口地址：https://api.code92.top/api/adm/sms.code/get.phone + +请求示例(POST)： +``` json +{ + "project": "telegram", + "provider": "terminal", // 此项固定不可变 + "countryCode": "us" +} +``` + +成功响应示例： +``` json +{ + "code": "succeed", // 使用if ( code == "succeed" ) 判定获取成功。 + "data": { + "callingCode": 66, // 国际电联ITU-T E.164 callingcodes https://www.itu.int/dms_pub/itu-t/opb/sp/T-SP-E.164D-11-2011-PDF-E.pdf + "id": 552149995081733, // 业务流水号，存下来，在后续的接口调用中要传入。 + "phoneNumber": "858683974" // 去除callingCode前缀的电话号码 + } +} +``` + +失败响应示例： +``` json +{ + "code": "unexpected", // 错误码 + "msg": "外部接口异常 0|-1" // 错误原因 +} +``` + + + +### 获取验证码 + +接口文档 + +此步骤需要多次尝试，建议设定请求间隔为5s，持续5min + +接口地址：https://api.code92.top/api/adm/sms.code/get + +请求示例(POST)： + +``` json +{ + "id": 611987201483781 // 业务流水号 +} +``` + +取到码响应示例： +``` json +{ + "code": "succeed", + "data": { + "receiveStatus": "received", // 如果取到短信验证码 此字段值为 “received” + "smsCode": "1234" // 短信验证码 + } +} +``` + +未取到码示例： +``` json +{ + "code": "succeed", + "data": { + "receiveStatus": "waiting" // 如果是waiting，或者executing ，说明还在取码中，可等待几秒再调用此接口 + } +} +``` + +``` json +{ + "code": "succeed", + "data": { + "receiveStatus": "timeout" // 如果是timeout，说明长时间未收到验证码，系统已经自动释放了该手机号，不会再去收码了。 + } +} +``` + + +### 报告验证码错误 +如您收到验证码输入目标程序后提示验证码不正确，可调用此接口（文档）上报，将该次任务状态重置为waiting， 之后继续执行步骤3，直到状态为received，即收到了新的正确的验证码。 + +### 释放手机号 +如果调用步骤2多次未获取到验证码，需要放弃此号继续做下一个任务时，请调用此接口（文档），释放手机号之后即停止计费，避免损耗。 + +### 拉黑手机号 +如果不希望获取到某个手机号，可以调用此接口（文档）拉黑，拉黑之后可确保24小时内不会再次取到此手机号。 + +