diff --git a/Home.md b/Home.md index 1a376eb..2bac4e5 100644 --- a/Home.md +++ b/Home.md @@ -22,9 +22,62 @@ ## 短信接码流程 1. 获取手机号(文档) + +成功响应示例: +``` 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" // 错误原因 +} +``` + 2. 拿到手机号输入目标程序发送验证码 + + 3. 获取验证码(文档),此步骤需要多次尝试,建议设定请求间隔为5s,持续5min +取到码响应示例: +``` json +{ + "code": "succeed", + "data": { + "receiveStatus": "received", // 如果取到短信验证码 此字段值为 “received” + "smsCode": "1234" // 短信验证码 + } +} +``` + +未取到码示例: +``` json +{ + "code": "succeed", + "data": { + "receiveStatus": "waiting" // 如果是waiting,说明还在取码中,可等待几秒再调用此接口 + } +} +``` + +``` json +{ + "code": "succeed", + "data": { + "receiveStatus": "timeout" // 如果是timeout,说明长时间未收到验证码,系统已经自动释放了该手机号,不会再去收码了。 + } +} +``` + ### 释放手机号 如果调用步骤2多次未获取到验证码,需要放弃此号继续做下一个任务时,请调用此接口(文档),释放手机号之后即停止计费,避免损耗。