卡商端API 文档示例

上传号码

请求URL： /splatform/uploadPhoneNumbers

请求方式： POST

{
  "mkey": "46c19aa565a34f96bbdee6cadf0a2af3",
  "status": 0,
  "numbers": [
    {
      "country": "44",
      "phone": "123456787",
      "iccid": "...",
      "imsi": "..."
    },
    {
      "country": "44",
      "phone": "123456788",
      "iccid": "...",
      "imsi": "..."
    },
    {
      "country": "44",
      "phone": "123456789",
      "iccid": "...",
      "imsi": "..."
    }
  ]
}

请求参数说明

参数名	类型	必填	说明
mkey	string	是	卡商key
status	int	是	0 上架状态, -1下架状态
country	string	是	国家区号如：44
phone	string	是	号码

返回值 (JSON)

{
  "ret": 0,
  "successCount": 3,
  "failureCount": 0
}

获取已上传的号码

请求URL： /splatform/getMerchantNumberPool?mkey=46c19aa565a34f96bbdee6cadf0a2af3&status=99&country=&page=1

请求方式： GET

请求参数说明

参数名	类型	必填	说明
status	int	否	过滤状态, 0 上架状态, 1 下架状态, 99 所有状态
country	string	否	过滤国家区号, 留空则获取全部
page	int	是	分页获取, 请求后会返回总页数每页1000条号码信息

返回值 (JSON)

 {
  "ret": 0,
  "page": 1,
  "totalPage": 1,
  "result": [
    {
      "country": "GB",
      "areaCode": "44",
      "phone": "123456789",
      "PID": "199106252000372",
      "status": 0,
      "poolStatus": 2,
      "poolInfo": {
        "inPublicPool": true,
        "InPrivateChannel": []
      },
      "blockInfo": []
    },
    {
      "country": "GB",
      "areaCode": "44",
      "phone": "123456788",
      "PID": "199106249000287",
      "status": 0,
      "poolStatus": 2,
      "poolInfo": {
        "inPublicPool": true,
        "InPrivateChannel": []
      },
      "blockInfo": [
        {
          "ProjectID": "10000",
          "BlockCount": 1
        }
      ]
    }
  ]
}

返回参数说明

参数名	类型	说明
ret	int	状态码
page	int	当前页数
totalPage	int	总页数
result	json数组	号码详情
country	string	国家代码
areaCode	string	区号
phone	string	号码
PID	string	号码唯一PID用于后续操作
status	int	号码状态 0 上架 -1 下架
poolStatus	int	号码池上架状态 0 = 号码状态为-1不可上架，1 = 等待加入，2 = 已在池中，3 = 已售出/或当前规则无法加入任何池
poolInfo	json	inPublicPool: true = 在公开池中， InPrivateChannel: 已加入的频道池对接码

获取等待收码中的号码

请求URL： /splatform/getMerchantWaitingNumber?mkey=46c19aa565a34f96bbdee6cadf0a2af3

请求方式： GET

返回值 (JSON)

{
  "ret": 0,
  "result": [
    {
      "phone": "1304717596",
      "country": "91",
      "count": 1
    }
  ]
}}

更改号码状态

请求URL： /splatform/changePhoneNumberStatus

请求方式： POST

{
  "mkey": "46c19aa565a34f96bbdee6cadf0a2af3",
  "status": 1,
  "numbers": [
    {
      "country": "44",
      "phone": "123456787"
    },
    {
      "country": "44",
      "phone": "123456788"
    },
    {
      "country": "44",
      "phone": "123456789"
    }
  ]
}

请求参数说明

参数名	类型	必填	说明
mkey	string	是	卡商key
status	int	是	0 上架状态, -1下架状态
country	string	是	号码国家区号如：44
phone	string	是	号码

返回值 (JSON)

{
  "ret": 0
}

批量更改名下号码状态

请求URL： /splatform/changePhoneNumberStatusBatch

请求方式： POST

{
  "mkey": "46c19aa565a34f96bbdee6cadf0a2af3",
  "status": 0,
  "country": ""
}

请求参数说明

参数名	类型	必填	说明
mkey	string	是	卡商key
status	int	是	0 上架状态, -1 下架状态
country	string	否	更改指定区号的状态，留空修改所有号码

返回值 (JSON)

{
  "ret": 0
}

上传短信

请求URL： /splatform/uploadSMS

请求方式： POST

{
  "mkey": "46c19aa565a34f96bbdee6cadf0a2af3",
  "country": "44",
  "phone": "1304717596",
  "content": "www测试~"
}

请求参数说明

参数名	类型	必填	说明
mkey	string	是	卡商key
country	string	是	号码国家区号
phone	string	是	号码
content	string	是	短信明文 UTF-8

返回值 (JSON)

{
  "ret": 0,
  "msg": "Success",
  "projectName": "test",
  "projectID": "10000"
}

删除号码

请求URL： /splatform/deletePhoneNumber

请求方式： POST

{
  "mkey": "46c19aa565a34f96bbdee6cadf0a2af3",
  "numbers": [
    {
      "country": "44",
      "phone": "123456787"
    },
    {
      "country": "44",
      "phone": "123456788"
    },
    {
      "country": "44",
      "phone": "123456789"
    }
  ]
}

请求参数说明

参数名	类型	必填	说明
mkey	string	是	卡商key
country	string	是	号码国家区号
phone	string	是	号码

返回值 (JSON)

{
  "ret": 0
}

清空号码

请求URL： /splatform/clearPhoneNumber

请求方式： POST

{
  "mkey": "46c19aa565a34f96bbdee6cadf0a2af3",
  "country": ""
}

请求参数说明

参数名	类型	必填	说明
mkey	string	是	卡商key
country	string	否	删除指定区号的号码，留空删除所有号码

返回值 (JSON)

{
  "ret": 0
}

状态码说明

ret	名称	说明
0	Success	请求成功
-1	ERROR	执行异常
-2	Failure	操作失败
1	NotFound	未找到相关数据
2	AlreadyReceived	号码已收码
3	WaitSMS	等待收码
4	ProjectNotFound	项目不存在
5	UserNotFound	用户不存在
6	UserSPRefundFailed	用户积分返还失败
7	NoNumber	暂无可用号码
8	InsufficientSP	用户积分不足
9	UpdateError	数据更新失败
10	NumberAlreadyExists	号码已存在
11	DuplicateNumbersPresent	存在重复号码
12	ReceiveAndRelease	到码且已主动释放
13	NotReceivedSPRefunded	未收到已返还SP
14	MerchantNotFound	卡商未找到
15	MerchantPIDNotFound	存在无权操作的PID
16	ProjectIDorPIDNotMatchuKey	项目/PID 与 ukey 不匹配
17	ReceiveAndAutoRelease	到码系统自动释放（释放短信内容）
18	ReceiveNOSMSData	收到码但短信内容为空（可能被释放）
19	KeywordMatchingFailed	关键词匹配失败，未能识别项目ID
20	PhonNumberCountLimit	等待收码的号码超限
21	ChannelIsNotPublic	频道未公开
22	ChannelAlreadyExists	频道已存在
23	ChannelCreateLimit	创建的频道或项目规则已达上限
24	ChannelNotFound	未找到频道
25	NoAuthorityOperateChannel	无权操作此频道
26	BadCaptcha	验证码错误
27	BadRequestParameters	错误的请求参数
28	AlreadyExists	数据已存在
29	OfilineCheck	号码已离线
30	BadPrice	项目未定价
31	BadUserNameORPassword	用户名或密码错误