ӿĵ
λ: ҳ >> ƽ̨API

ؽӿڹ淶(JSON)

version 2.0

 

汾޶ʷ

˵

1.0

2020-06-03

ӿڹ淶

 

 

 

Ŀ¼

1. ǰ 3

http://sms.it1688.com.cn 3

2. ͽӿ 3

2.1 õַ 3

2.2 ͷ 3

2.3 4

2.4 Ӧ 4

2.5 ʾ 4

3. һһͽӿ 4

3.1 õַ 4

3.2 ͷ 5

3.3 5

3.4 Ӧ 5

3.5 ʾ 5

4. ִ״̬ͽӿ 6

4.1 õַ 6

4.2 ͷ 6

4.3 6

4.4 Ӧ 7

4.5 ʾ 7

5. лظͽӿ 7

5.1 õַ 7

5.2 ͷ 7

5.3 7

5.4 Ӧ 8

5.5 ʾ 8

6. ִ״̬ȡӿ 8

6.1 õַ 8

6.2 ͷ 8

6.3 8

6.4 Ӧ 9

6.5 ʾ 9

7. лظȡӿ 10

7.1 õַ 10

7.2 ͷ 10

7.3 10

7.4 Ӧ 10

7.5 ʾ 11

8. ѯӿ 11

8.1 õַ 11

8.2 ͷ 12

8.3 12

8.4 Ӧ 12

8.5 ʾ 12

9. Ӧ״̬б 12

 

1. ǰ

ЭHTTPʹPOSTʽӦΪJSONʽ.

ֶʽշ巨

ͳһӦ룺UTF-8

 

2. ͽӿ

2.1 õַ

ַhttp://sms.it1688.com.cn/api/sendMessage

󷽷POST

2.2 ͷ

Accept: application/json

Content-Type: application/json;charset=utf-8

2.3 

˵

userName

String

ʺû

password

String

ʺ

content

String

phoneList

[Array]

ֻ룬JSONʽ

ó10000롣

sendTime

String

Ŷʱʱ䣬ʽyyyy-MM-dd HH:mm:ss

ʱʱ15ڡ

callData

String

ûشݣ󳤶64

ûݴ˲ڻִʱشû

2.4 Ӧ

˵

code

String

0ΪɹʧܣϸοӦ״̬

message

String

msgId

String

code=0ʱϵͳΨһϢId

 

2.5 ʾ

POST http://sms.it1688.com.cn/api/sendMessag

Accept: application/json

Content-Type: application/json;charset=utf-8

 

{

userName: "myUserName",

password: "myPassword",

content: "ǩ֤123456",

phoneList: ["13500000001", "13500000002", "13500000003"]

}

Ӧ

{

code: 0,

message: "ɹ",

smsId: 123456

}

3. һһͽӿ

3.1 õַ

ַhttp://sms.it1688.com.cn/api/batchSendMessage

󷽷POST

3.2 ͷ

Accept: application/json

Content-Type: application/json;charset=utf-8

3.3 

˵

userName

String

ʺû

password

String

ʺ

messageList

[Array]

ʽJSON󣬶±

ÿJSONݺͺݣ1000롣

callData

String

ûشݣ󳤶64

ûݴ˲ڻִʱشû

messageListɶJSON󹹳ɵJSON飬б

˵

phone

String

ֻ

content

String

extcode

String

ѡͨչ

3.4 Ӧ

˵

code

String

0ΪɹʧܣϸοӦ״̬

message

String

data

[Array]

code=0ʱϵͳش󼯺ϣ±

dataɶJSON󹹳ɵJSON飬б

˵

code

String

0ΪɹʧܣϸοӦ״̬

message

String

msgId

String

code=0ʱϵͳΨһϢId

3.5 ʾ

POST http://sms.it1688.com.cn/api/batchSendMessage

Accept: application/json

Content-Type: application/json;charset=utf-8

 

{

"userName": "myUserName",

"password": "myPassword",

"messageList": [

{

"phone": "13500000001",

"content" : "ǩ𾴵ι211.45Ԫ"

},

{

"phone": "13500000002",

"content" : "ǩ𾴵Ůʿι78.00Ԫ"

}

]

}

Ӧ

{

"code": 0,

"message": "ɹ",

"data": [

{

"code": 0,

"message": "ɹ",

"msgId": 11600001

},

{

"code": 0,

"message": "ɹ",

"msgId": 11600002

}

]

}

4. ִ״̬ͽӿ

4.1 õַ

ַͻ˾ύջִ״ַ̬ƽ̨ͻִ״̬

󷽷POST

4.2 ͷ

Content-Type: application/json;charset=utf-8

4.3 

ΪJSONʽÿͲ2000ֶ£

˵

msgId

String

ϢidӦͳɹʱϵͳӦmsgId

phone

String

ֻ

status

String

ִ״̬DELIVRDɹʧ

receiveTime

String

ִʱ䣬ʽyyyy-MM-dd HH:mm:ss

callData

String

ûشݣύʱдݴ˲ԭʹ

4.4 Ӧ

ӦHTTP״̬200ɡ200״̬뽫תΪͻȡʽ

4.5 ʾ

[

{

"msgId": 11600001,

"phone": "13500000001",

"receiveTime": "2020-06-09 11:10:32",

"status": "DELIVRD"

},

{

"msgId": 11600002,

"phone": "13500000002",

"receiveTime": "2020-06-09 11:10:32",

"status": "FAILURE"

}

]

5. лظͽӿ

5.1 õַ

ַͻ˾ύлظַƽ̨лظ

󷽷POST

5.2 ͷ

Content-Type: application/json;charset=utf-8

5.3 

ΪJSONʽÿͲ2000ֶ£

˵

content

String

лظ

phone

String

ֻ

receiveTime

String

ִʱ䣬ʽyyyy-MM-dd HH:mm:ss

destId

String

ͨ˿ں

5.4 Ӧ

ӦHTTP״̬200ɡ200״̬뽫תΪͻȡʽ

5.5 ʾ

[

{

"content": "õ, յ",

"destId": "106203069598",

"phone": "13500000001",

"receiveTime": "2020-06-09 11:10:32"

},

{

"content": "OK",

"phone": "13500000002",

"receiveTime": "2020-06-09 11:10:32"

}

]

6. ִ״̬ȡӿ

6.1 õַ

ַhttp://sms.it1688.com.cn/api/getReport

󷽷POST

6.2 ͷ

Accept: application/json

Content-Type: application/json;charset=utf-8

6.3 

˵

userName

String

ʺû

password

String

ʺ

6.4 Ӧ

ӦΪJSONʽÿλȡ2000ѻȡݲᱻٴλȡ

ÿʱ䲻С30룬ȡΪ2000ʾлִδȡٴȡִ

˵

code

String

0ΪɹʧܣϸοӦ״̬

message

String

data

[Array]

ȡĻִбJSONʽֶ

 

dataֶ£4.4Ͳһ£

˵

msgId

String

ϢidӦͳɹʱϵͳӦmsgId

phone

String

ֻ

status

String

ִ״̬DELIVRDɹʧ

receiveTime

String

ִʱ䣬ʽyyyy-MM-dd HH:mm:ss

callData

String

ûشݣύʱдݴ˲ԭʹ

 

6.5 ʾ

״̬ȡ

POST http://sms.it1688.com.cn/api/getReport

Accept: application/json

Content-Type: application/json;charset=utf-8

 

{

userName: "myUserName",

password: "myPassword"

}

Ӧ

{

"code": 0,

"message": "ɹ",

"data": [

{

"msgId": 11600001,

"phone": "13500000001",

"receiveTime": "2020-06-09 11:10:32",

"status": "DELIVRD"

},

{

"msgId": 11600002,

"phone": "13500000002",

"receiveTime": "2020-06-09 11:10:32",

"status": "FAILURE"

}

]

}

7. лظȡӿ

7.1 õַ

ַhttp://sms.it1688.com.cn/api/getUpstream

󷽷POST

7.2 ͷ

Accept: application/json

Content-Type: application/json;charset=utf-8

7.3 

˵

userName

String

ʺû

password

String

ʺ

7.4 Ӧ

ӦΪJSONʽÿλȡ2000ѻȡݲᱻٴλȡ

ÿʱ䲻С30룬ȡΪ2000ʾлִδȡٴȡִ

˵

code

String

0ΪɹʧܣϸοӦ״̬

message

String

data

[Array]

ȡĻִбJSONʽֶ

 

dataֶ£5.4Ͳһ£

˵

content

String

лظ

phone

String

ֻ

receiveTime

String

ִʱ䣬ʽyyyy-MM-dd HH:mm:ss

destId

String

ͨ˿ں

 

7.5 ʾ

״̬ȡ

POST http://sms.it1688.com.cn/api/getReport

Accept: application/json

Content-Type: application/json;charset=utf-8

 

{

userName: "myUserName",

password: "myPassword"

}

Ӧ

{

"code": 0,

"message": "ɹ",

"data": [

{

"content": "õ, յ",

"destId": "106203069598",

"phone": "13500000001",

"receiveTime": "2020-06-09 11:10:32"

},

{

"content": "OK",

"phone": "13500000002",

"receiveTime": "2020-06-09 11:10:32"

}

]

}

8. ѯӿ

8.1 õַ

ַhttp://sms.it1688.com.cn/api/getBalance

󷽷POST

8.2 ͷ

Accept: application/json

Content-Type: application/json;charset=utf-8

8.3 

˵

userName

String

ʺû

password

String

ʺ

8.4 Ӧ

˵

code

String

0ΪɹʧܣϸοӦ״̬

message

String

balance

String

code=0ʱϵͳʺŶ

 

8.5 ʾ

״̬ȡ

POST http://sms.it1688.com.cn/api/getBalance

Accept: application/json

Content-Type: application/json;charset=utf-8

 

{

userName: "myUserName",

password: "myPassword"

}

Ӧ

{

"code": 0,

"message": "ɹ",

"balance": 967793

}

 

9. Ӧ״̬б

״̬

˵

0

ɹ

1

ʺΪ

2

ʺ

3

ʺѱ

4

ʺҵδͨ

5

ʺ

6

ȱٷͺ

7

ͺ10000

8

ϢΪ

9

ЧRCSģID

10

ǷIPַύԴIPַʺŰIPһ

11

24Сʱʱ

12

ʱʱ򳬹15

13

ƵÿʱΪһ

14

ûչ

50

ȱģ

51

ȱģ

52

ģݲȫ

53

ֵ֧ģ֡

54

ֵ֧ļ

99

JSONַ

500

ϵͳ쳣

 

 


ɨһɨ

ɨע ֤˽֪ͨ ŷͽ֪ͨ ƽ̨Ϣ

ض