Obtaining Verification Code
Function
Obtain a verification code.
URI
POST /v2/servicerequest/verifycodes/send
Request Parameters
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
X-Auth-Token |
Yes |
String |
Specifies the user token. It can be obtained by calling the IAM API (value of X-Subject-Token in the response header). Minimum length: 1 Maximum length: 5000 |
|
X-Language |
No |
String |
Specifies the language environment. The value is a common language description character string, for example, zh-cn. It is zh-cn by default. Some internationalization information, such as the service ticket type and name, is displayed based on the language environment. Minimum length: 1 Maximum length: 32 |
|
X-Time-Zone |
No |
String |
Specifies the time zone. The value is a common time zone description character string, for example, GMT+8. It is GMT+8 by default. Time-related data is processed based on the time zone of the environment. Minimum length: 1 Maximum length: 32 |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
contact_value |
Yes |
String |
Indicates the contact method value. Minimum length: 0 Maximum length: 64 |
|
contact_way |
Yes |
Integer |
Indicates the contact method type. The options are 0 (SMS message) and 1 (Email). Minimum value: 0 Maximum value: 1 |
|
area_code |
Yes |
String |
Specifies the country/region code. Minimum length: 0 Maximum length: 16 |
Response Parameters
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
Specifies the error code. Minimum length: 0 Maximum length: 32 |
|
error_msg |
String |
Description of the error. Minimum length: 0 Maximum length: 32 |
Request Example
{
"contact_value" : "123456",
"contact_way" : 1,
"area_code" : "86"
}
Response Example
None
Status Codes
|
Status Code |
Description |
|---|---|
|
200 |
Response of status code 200 |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.
