API使用說明
接口地址: http://api.shop.com/api/
接口統一編碼:UTF-8
接口調用方式: HTTP,使用GET方式
GET調用方法:http://api.shop.com/api/?參數1=值&參數2=值(具體方法名及參數請參考接口方法)
參數說明:method指接口類型;account指登錄名;pwd指登錄密碼
客服QQ: 技術QQ:
獲取用戶信息接口
接口地址:http://api.shop.com/api/?method=UserInfo&account=account&pwd=pwd
傳入參數:
method:UserInfo,方法為獲取用戶信息
account:登錄名
pass:登錄密碼
返回值:{"c":1,"score":100}
| c(返回碼) | 返回碼含義 |
|---|---|
| 1 | 成功 |
| -1 | 用戶名密碼錯誤 |
| -2 | 賬戶異常 |
| -3 | 賬戶被鎖定 |
| -6 | 參數錯誤 |
| -100 | 其他錯誤 |
獲取/占用手機號碼接口
接口地址:http://api.shop.com/api/?method=GetPhone&account=account&pwd=pwd&pid=PID&pro=PRO&city=CITY&carr=CARR&pn=PHONE&q=Q
傳入參數:
method:GetPhone,方法為獲取手機號碼
account:登錄名
pwd:登錄密碼
pid:項目ID(項目ID編碼見【項目管理】中的項目ID,只能指定一個項目ID,如果需要多個項目ID,請聯系技術人員)
pn:指定手機號碼占用,如要占用13888888888,則傳13888888888,如獲取新的手機號碼,無需傳該參數
pro:省(非必填,具體代碼值請聯系技術人員)
city:城市(非必填,具體代碼值請聯系技術人員)
carr:運營商 1電信 2移動 3聯通 (非必填)
q:一次獲取手機號個數,默認為1(非必填,取值范圍1~30)
返回值:
{"c":1,"phones":["13788889999"]}
多個手機號返回值:
{"c":1,"phones":["13788889999","13788888888","13788887777"]}
| c(返回碼) | 返回碼含義 |
|---|---|
| 1 | 成功 |
| -1 | 用戶名密碼錯誤 |
| -2 | 賬戶異常 |
| -3 | 賬戶被鎖定 |
| -4 | 積分不足 |
| -5 | 項目不存在 |
| -6 | 參數錯誤 |
| -7 | 系統繁忙,請稍后再試 |
| -8 | 您的綁定項目中不含此項目 |
| -9 | 正在使用的手機號碼過多 |
| -10 | 此項目缺號 |
| -11 | 指定的手機不存在 |
| -100 | 其他錯誤 |
phones : 獲取到的手機號碼
調用例子:
(1)取項目ID為1的手機號:
http://api.shop.com/api/?method=GetPhone&account=account&pwd=pwd&pid=1
返回:{"c":1,"phones":["13888888888"]},則13888888888可以使用
(2)指定號碼使用另一個項目,如占用項目ID為2的手機號13888888888:
http://api.shop.com/api/?method=GetPhone&account=account&pwd=pwd&pid=2&pn=13888888888
返回:{"c":1,"phones":["13888888888"]},則占用ID為2的13888888888手機號成功
(3)再次使用項目ID為2的手機號13888888888:
http://api.shop.com/api/?method=GetPhone&account=account&pwd=pwd&pid=2&pn=13888888888
返回:{"c":1,"phones":["13888888888"]},則13888888888手機號可以再次用來注冊項目2
通過手機號碼獲取驗證碼接口
接口地址:http://api.shop.com/api/?method=GetCode&account=account&pwd=pwd&pid=PID&pn=phone&dev=DEV
傳入參數:
method:GetCode,方法為獲取驗證碼
account:登錄名
pwd:登錄密碼
pid:項目ID
pn:手機號碼
dev:開發者登錄名(對于開發者用戶具有10%的提成,需注冊開發者類型賬戶,非必填項)
返回值:
未接收到驗證碼,返回:{"c":0}
| c(返回碼) | 返回碼含義 |
|---|---|
| 0 | 平臺未接收到驗證碼短信 |
| 1 | 成功 |
| -1 | 用戶名密碼錯誤 |
| -2 | 賬戶異常 |
| -3 | 賬戶被鎖定 |
| -4 | 積分不足 |
| -5 | 項目不存在 |
| -6 | 參數錯誤 |
| -7 | 系統繁忙,請稍后再試 |
| -8 | 您的綁定項目中不含此項目 |
| -11 | 指定的手機不存在 |
| -100 | 其他錯誤 |
接收到驗證碼,返回:{"c":1,"m":"您的驗證碼為888999","mc":"888999"}
m:接收到的短信內容
mc:短信驗證碼,自動提取的驗證碼
釋放號碼
接口地址:http://api.shop.com/api/?method=Release&account=account&pwd=pwd&pid=PID&pn=phone
傳入參數:
method:Release,方法為釋放號碼
account:登錄名
pwd:登錄密碼
pid:項目ID(項目ID編碼見【項目管理】中的項目ID),如不傳此參數,則表示所有項目
pn:要釋放的手機號碼,如要釋放13888888888,則傳13888888888,如不傳此參數,則表示所有手機號碼
返回值:{"c":1}
| c(返回碼) | 返回碼含義 |
|---|---|
| 1 | 釋放成功 |
| -1 | 用戶名密碼錯誤 |
| -5 | 項目不存在 |
手機號碼加入黑名單接口
接口地址:http://api.shop.com/api/?method=AddBlack&account=account&pwd=pwd&pid=PID&pn=phone
傳入參數:
method:AddBlack,方法為加入黑名單
account:登錄名
pwd:登錄密碼
pid:項目ID
pn:手機號碼
返回值:{"c":1}
| c(返回碼) | 返回碼含義 |
|---|---|
| 1 | 成功 |
| -1 | 用戶名密碼錯誤 |
| -2 | 賬戶異常 |
| -3 | 賬戶被鎖定 |
| -5 | 項目不存在 |
| -6 | 參數錯誤 |
| -7 | 系統繁忙,請稍后再試 |
| -8 | 您的綁定項目中不含此項目 |
| -12 | 已經加黑或者無此號碼 |
| -100 | 其他錯誤 |
查詢狀態接口
接口地址:http://api.shop.com/api/?method=GetStatus&account=account&pwd=pwd&pid=PID&pn=phone
傳入參數:
method:GetStatus,方法為查詢短信狀態
account:登錄名
pwd:登錄密碼
pid:項目ID
pn:手機號碼
返回值:{"c":1,"m":"0"}
| c(返回碼) | 返回碼含義 |
|---|---|
| 1 | 查詢成功 |
| -1 | 用戶名密碼錯誤 |
| -5 | 項目不存在 |
| -6 | 參數錯誤 |
| -11 | 指定的手機不存在 |
| -100 | 其他錯誤 |
| m(狀態信息) | 收短信 | 發短碼 |
|---|---|---|
| 0 | 已提交接收短信請求 | 已經占用號碼 |
| 1 | 已成功收到短信 | |
| 2 | 已提交發送短信請求,正在排隊發送 | |
| 3 | 發送短信中 | |
| 9 | 您已獲取短信驗證碼 | 短信已發送成功 |