packages/api-client/BasicModuleVerifyActionModuleInterfaceApi.md
All URIs are relative to http://backend/api/v1
| Method | HTTP request | Description |
|---|---|---|
| inviteTokenValid | POST /base/action/invite/valid | Invitation temporary code verification |
| POST /base/action/mail/code | Send email verification code | |
| send | POST /base/action/sms/code | Send SMS verification code |
| validateEmail | POST /base/action/email/code/validate | Email verification code verification |
| verifyPhone1 | POST /base/action/sms/code/validate | Mobile verification code verification |
ResponseDataInviteInfoVo inviteTokenValid(inviteValidRo)
Invitation link token verification, the relevant invitation information can be obtained after the verification is successful
import { } from '';
import * as fs from 'fs';
const configuration = .createConfiguration();
const apiInstance = new .BasicModuleVerifyActionModuleInterfaceApi(configuration);
let body:.BasicModuleVerifyActionModuleInterfaceApiInviteTokenValidRequest = {
// InviteValidRo
inviteValidRo: {
token: "b10e5e36cd7249bdaeab3e424308deed",
nodeId: "dst****",
data: "FutureIsComing",
},
};
apiInstance.inviteTokenValid(body).then((data:any) => {
console.log('API called successfully. Returned data: ' + data);
}).catch((error:any) => console.error(error));
| Name | Type | Description | Notes |
|---|---|---|---|
| inviteValidRo | InviteValidRo |
ResponseDataInviteInfoVo
No authorization required
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 500 | Internal Server Error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ResponseDataVoid mail(emailOpRo)
Email verification code; 1:Email binding, 2: Email registration, 3: General verification
import { } from '';
import * as fs from 'fs';
const configuration = .createConfiguration();
const apiInstance = new .BasicModuleVerifyActionModuleInterfaceApi(configuration);
let body:.BasicModuleVerifyActionModuleInterfaceApiMailRequest = {
// EmailOpRo
emailOpRo: {
email: "[email protected]",
type: 1,
},
};
apiInstance.mail(body).then((data:any) => {
console.log('API called successfully. Returned data: ' + data);
}).catch((error:any) => console.error(error));
| Name | Type | Description | Notes |
|---|---|---|---|
| emailOpRo | EmailOpRo |
ResponseDataVoid
No authorization required
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 500 | Internal Server Error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ResponseDataVoid send(smsOpRo)
SMS type; 1: Registration, 2:Login, 3: Modify login password, 4: DingTalk binding, 5: Bind mobile phone, 6: (Remove replacement) mobile phone binding 7: Modify mailbox binding,8: Delete space, 9: Replace main administrator 10: General verification, 11: Change developer configuration, 12: Bind third-party platform account
import { } from '';
import * as fs from 'fs';
const configuration = .createConfiguration();
const apiInstance = new .BasicModuleVerifyActionModuleInterfaceApi(configuration);
let body:.BasicModuleVerifyActionModuleInterfaceApiSendRequest = {
// SmsOpRo
smsOpRo: {
areaCode: "+86",
phone: "131...",
type: 1,
data: "BornForFuture",
},
};
apiInstance.send(body).then((data:any) => {
console.log('API called successfully. Returned data: ' + data);
}).catch((error:any) => console.error(error));
| Name | Type | Description | Notes |
|---|---|---|---|
| smsOpRo | SmsOpRo |
ResponseDataVoid
No authorization required
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 500 | Internal Server Error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ResponseDataVoid validateEmail(emailCodeValidateRo)
Usage scenario: Verify identity before changing email address when no mobile phone, change the main administrator
import { } from '';
import * as fs from 'fs';
const configuration = .createConfiguration();
const apiInstance = new .BasicModuleVerifyActionModuleInterfaceApi(configuration);
let body:.BasicModuleVerifyActionModuleInterfaceApiValidateEmailRequest = {
// EmailCodeValidateRo
emailCodeValidateRo: {
email: "[email protected]",
code: "123456",
},
};
apiInstance.validateEmail(body).then((data:any) => {
console.log('API called successfully. Returned data: ' + data);
}).catch((error:any) => console.error(error));
| Name | Type | Description | Notes |
|---|---|---|---|
| emailCodeValidateRo | EmailCodeValidateRo |
ResponseDataVoid
No authorization required
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 500 | Internal Server Error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ResponseDataVoid verifyPhone1(smsCodeValidateRo)
Usage scenarios: DingTalk binding, identity verification before changing the mobile phone mailbox, changing the main administrator
import { } from '';
import * as fs from 'fs';
const configuration = .createConfiguration();
const apiInstance = new .BasicModuleVerifyActionModuleInterfaceApi(configuration);
let body:.BasicModuleVerifyActionModuleInterfaceApiVerifyPhone1Request = {
// SmsCodeValidateRo
smsCodeValidateRo: {
areaCode: "+86",
phone: "13411112222",
code: "123456",
},
};
apiInstance.verifyPhone1(body).then((data:any) => {
console.log('API called successfully. Returned data: ' + data);
}).catch((error:any) => console.error(error));
| Name | Type | Description | Notes |
|---|---|---|---|
| smsCodeValidateRo | SmsCodeValidateRo |
ResponseDataVoid
No authorization required
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 500 | Internal Server Error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]