Sms

Handles sms message delivery operations, and audit logging for tracking sent communications

---

Send sms

POST

/api/v1/sms/send

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

请求体

application/json

{

"outId": "string",

"bizKey": "SIGNUP",

"urgent": "false",

"language": "zh_CN",

"mobiles": [

"string"

],

"expectedSendDate": "string",

"verificationCode": "false",

"verificationCodeValidSecond": "300",

"templateParams": {

"additionalProperties": "string"

},

"receiveObjectType": "string",

"receiveObjectIds": [

0

],

"receivePolicyCodes": [

"string"

]

}

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

POST

/api/v1/sms/send

试验场

服务器

授权

UserHttpBearer

主体

示例

cURL

JavaScript

PHP

Python

---

Send the test sms to channel

POST

/api/v1/sms/channel/test

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

请求体

application/json

{

"channelId": "Test Channel Id",

"mobiles": [

"string"

]

}

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

POST

/api/v1/sms/channel/test

试验场

服务器

授权

UserHttpBearer

主体

示例

cURL

JavaScript

PHP

Python

---

Query the list of sms

GET

/api/v1/sms

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

查询参数

dto*

类型object

必填

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

GET

/api/v1/sms

试验场

服务器

授权

UserHttpBearer

变量

键

值

dto*

示例

cURL

JavaScript

PHP

Python

---

Delete sms

DELETE

/api/v1/sms

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

查询参数

ids*

类型array

必填

最大项数200

最小项数0

唯一项true

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

DELETE

/api/v1/sms

试验场

服务器

授权

UserHttpBearer

变量

键

值

ids*

示例

cURL

JavaScript

PHP

Python

---

Query the detail of sms

GET

/api/v1/sms/{id}

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

路径参数

id*

Sms id

类型integer

必填

格式"int64"

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

GET

/api/v1/sms/{id}

试验场

服务器

授权

UserHttpBearer

变量

键

值

id*

示例

cURL

JavaScript

PHP

Python

---

Check sms verification code

GET

/api/v1/sms/verificationCode/check

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

查询参数

bizKey*

Sms business key.

类型string

必填

有效值

"SIGNUP""SIGNIN""PASSWORD_FORGET""PASSWORD_UPDATE""SIGN_CANCEL""MODIFY_MOBILE""BIND_MOBILE""PAY_PASSWORD_UPDATE""REALNAME_AUTH_SUBMIT""REALNAME_AUTH_PASSED""REALNAME_AUDIT_FAILURE""SYS_EXCEPTION_NOTICE""SYS_RECOVERY_NOTICE""SYS_SECURITY_NOTICE""LICENSE_SENT""CHANNEL_TEST""TODO_REALNAME_AUTH""TODO_BUSINESS_CONSULTATION""TODO_OFFLINE_SERVICE""TODO_TICKET""TODO_TRANSFER_CONFIRM""TODO_INVOICE_CONFIRM""TODO_WITHDRAW_CONFIRM""RECHARGE_SUCCESS""WITHDRAW_SUCCESS""ORDER_PAY_SUCCESS""ORDER_PAY_PENDING""ORDER_PAY_TIMEOUT""ORDER_TO_EXPIRE""ORDER_CHANGE_SUCCESS""TICKET_REPLY_REMINDER""TESTING_EXEC_STARTED""TESTING_EXEC_FINISHED""TESTING_EXEC_FAILED""TESTING_TASK_OVERDUE""INDICATOR_MODIFY_SUBMIT""INDICATOR_AUDIT_PASSED""INDICATOR_AUDIT_FAILED""EVENT_NOTICE"

示例"SIGNUP"

mobile*

Verification mobile.

类型string

必填

最小长度1

verificationCode*

类型string

必填

示例"Sms verification code."

最大长度6

最小长度1

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

GET

/api/v1/sms/verificationCode/check

试验场

服务器

授权

UserHttpBearer

变量

键

值

bizKey*

mobile*

verificationCode*

示例

cURL

JavaScript

PHP

Python

---