短信

处理短信消息的发送操作，以及用于追踪已发送通信的审计日志记录

---

查询短信详情

GET

/api/v1/sms/{id}

授权

UserHttpBearer

使用现有不透明令牌进行身份验证

类型HTTP (bearer)

参数

路径参数

id*

短信ID

类型integer

必填

格式"int64"

响应

成功

Content-Type

*/*

"string"

GET

/api/v1/sms/{id}

试验场

授权

UserHttpBearer

变量

键

值

id*

示例

cURL

JavaScript

PHP

Python

---

发送短信

POST

/api/v1/sms/send

授权

UserHttpBearer

使用现有不透明令牌进行身份验证

类型HTTP (bearer)

请求体

application/json

"string"

响应

成功

Content-Type

*/*

"string"

POST

/api/v1/sms/send

试验场

授权

UserHttpBearer

主体

示例

cURL

JavaScript

PHP

Python

---

验证短信验证码

GET

/api/v1/sms/verificationCode/check

授权

UserHttpBearer

使用现有不透明令牌进行身份验证

类型HTTP (bearer)

参数

查询参数

bizKey*

短信业务键。

类型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*

验证手机号。

类型string

必填

最小长度1

verificationCode*

类型string

必填

示例"Sms verification code."

最大长度6

最小长度1

响应

成功

Content-Type

*/*

"string"

GET

/api/v1/sms/verificationCode/check

试验场

授权

UserHttpBearer

变量

键

值

bizKey*

mobile*

verificationCode*

示例

cURL

JavaScript

PHP

Python

---

查询短信列表

GET

/api/v1/sms

授权

UserHttpBearer

使用现有不透明令牌进行身份验证

类型HTTP (bearer)

参数

查询参数

dto*

必填

响应

成功

Content-Type

*/*

"string"

GET

/api/v1/sms

试验场

授权

UserHttpBearer

变量

键

值

dto*

示例

cURL

JavaScript

PHP

Python

---

删除短信

DELETE

/api/v1/sms

授权

UserHttpBearer

使用现有不透明令牌进行身份验证

类型HTTP (bearer)

参数

查询参数

ids*

类型array

必填

最大项数200

最小项数0

唯一项true

响应

成功

Content-Type

*/*

"string"

DELETE

/api/v1/sms

试验场

授权

UserHttpBearer

变量

键

值

ids*

示例

cURL

JavaScript

PHP

Python

---

发送测试短信至通道

POST

/api/v1/sms/channel/test

授权

UserHttpBearer

使用现有不透明令牌进行身份验证

类型HTTP (bearer)

请求体

application/json

"string"

响应

成功

Content-Type

*/*

"string"

POST

/api/v1/sms/channel/test

试验场

授权

UserHttpBearer

主体

示例

cURL

JavaScript

PHP

Python

---