接口说明
获取一个用于接收短信或发送短信的号码。获取成功后必须保存返回的 pid，后续所有号码操作都依赖该 PID。
请求方式
GET /splatform/getPhoneNumber
请求参数
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
uKey | string | 是 | 用户 API Key。 |
projectID | string | 是 | 项目 ID。 |
country | string | 否 | 国家代码，例如 GB；留空时随机选择。 |
mID | string | 否 | 指定卡商 ID；留空时随机选择。 |
ChannelOnly | bool | 否 | true 仅从频道获取；false 优先频道，不足时从公开池获取。 |
type | int | 否 | 0 接收短信；1 发送短信。 |
请求示例
GET /splatform/getPhoneNumber?uKey=YOUR_UKEY&projectID=10000&country=GB&mID=&ChannelOnly=false&type=0返回示例
{
"ret": 0,
"country": "GB",
"countryCode": "44",
"phoneNumber": "7979496197",
"pid": "1157123308979568",
"iccid": "...",
"imsi": "..."
}返回字段
| 字段 | 说明 |
|---|---|
ret | 业务状态码，0 表示成功。 |
country | 号码所属国家代码。 |
countryCode | 国际区号。 |
phoneNumber | 号码主体。 |
pid | 该号码对应的业务 PID。 |
iccid | SIM 卡 ICCID。 |
imsi | SIM 卡 IMSI。 |
频道号码价格提醒
当 ChannelOnly=false 时，系统会优先使用频道号码；频道不足时可能从公开池获取。公开池与频道号码价格可能不同，请根据业务需要正确设置。
使用限制
- 号码获取本身免费，短信到达或发送成功后自动扣费。
- 收码等待时间为 6 分钟，超时后自动释放。
- 最多同时获取 3,000 个等待收码的号码，超过后返回
ret = 20。 - 不再使用时请及时释放号码。
- 超过频率限制可能返回
ret = -99。
常见状态码
0：获取成功。7：暂无可用号码。8：账户积分不足。20：等待收码的号码数量超限。30：项目未定价。-99：请求频率过快。503：系统维护，仅支持收码，暂停获取新号码。